Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 614db98bf45b9da1f29c35a9d942536111e99d41 / . / docs / dyn / blogger_v3.posts.html
blob: d4ffe1cfc213a1a0be3c4f5dcb9347a2c6830635 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame^]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="blogger_v3.html">Blogger API</a> . <a href="blogger_v3.posts.html">posts</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(blogId, postId)</a></code></p>
79<p class="firstline">Delete a post by id.</p>
80<p class="toc_element">
81 <code><a href="#get">get(blogId, postId, maxComments=None, fetchImages=None, fetchBody=None, view=None)</a></code></p>
82<p class="firstline">Get a post by id.</p>
83<p class="toc_element">
84 <code><a href="#getByPath">getByPath(blogId, path, maxComments=None, view=None)</a></code></p>
85<p class="firstline">Retrieve a Post by Path.</p>
86<p class="toc_element">
87 <code><a href="#insert">insert(blogId, body, isDraft=None, fetchImages=None, fetchBody=None)</a></code></p>
88<p class="firstline">Add a post.</p>
89<p class="toc_element">
90 <code><a href="#list">list(blogId, orderBy=None, startDate=None, endDate=None, labels=None, pageToken=None, status=None, maxResults=None, fetchBodies=None, fetchImages=None, view=None)</a></code></p>
91<p class="firstline">Retrieves a list of posts, possibly filtered.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96 <code><a href="#patch">patch(blogId, postId, body, maxComments=None, revert=None, publish=None, fetchImages=None, fetchBody=None)</a></code></p>
97<p class="firstline">Update a post. This method supports patch semantics.</p>
98<p class="toc_element">
99 <code><a href="#publish">publish(blogId, postId, publishDate=None)</a></code></p>
100<p class="firstline">Publish a draft post.</p>
101<p class="toc_element">
102 <code><a href="#revert">revert(blogId, postId)</a></code></p>
103<p class="firstline">Revert a published or scheduled post to draft state.</p>
104<p class="toc_element">
105 <code><a href="#search">search(blogId, q, orderBy=None, fetchBodies=None)</a></code></p>
106<p class="firstline">Search for a post.</p>
107<p class="toc_element">
108 <code><a href="#update">update(blogId, postId, body, maxComments=None, revert=None, publish=None, fetchImages=None, fetchBody=None)</a></code></p>
109<p class="firstline">Update a post.</p>
110<h3>Method Details</h3>
111<div class="method">
112 <code class="details" id="delete">delete(blogId, postId)</code>
113 <pre>Delete a post by id.
114
115Args:
116 blogId: string, The Id of the Blog. (required)
117 postId: string, The ID of the Post. (required)
118</pre>
119</div>
120
121<div class="method">
122 <code class="details" id="get">get(blogId, postId, maxComments=None, fetchImages=None, fetchBody=None, view=None)</code>
123 <pre>Get a post by id.
124
125Args:
126 blogId: string, ID of the blog to fetch the post from. (required)
127 postId: string, The ID of the post (required)
128 maxComments: integer, Maximum number of comments to pull back on a post.
129 fetchImages: boolean, Whether image URL metadata for each post is included (default: false).
130 fetchBody: boolean, Whether the body content of the post is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic.
131 view: string, Access level with which to view the returned result. Note that some fields require elevated access.
132 Allowed values
133 ADMIN - Admin level detail
134 AUTHOR - Author level detail
135 READER - Reader level detail
136
137Returns:
138 An object of the form:
139
140 {
141 "status": "A String", # Status of the post. Only set for admin-level requests
142 "content": "A String", # The content of the Post. May contain HTML markup.
143 "kind": "blogger#post", # The kind of this entity. Always blogger#post
144 "titleLink": "A String", # The title link URL, similar to atom's related link.
145 "author": { # The author of this Post.
146 "url": "A String", # The URL of the Post creator's Profile page.
147 "image": { # The Post author's avatar.
148 "url": "A String", # The Post author's avatar URL.
149 },
150 "displayName": "A String", # The display name.
151 "id": "A String", # The identifier of the Post creator.
152 },
153 "replies": { # The container of comments on this Post.
154 "totalItems": "A String", # The count of comments on this post.
155 "items": [ # The List of Comments for this Post.
156 {
157 "status": "A String", # The status of the comment (only populated for admin users)
158 "content": "A String", # The actual content of the comment. May include HTML markup.
159 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
160 "inReplyTo": { # Data about the comment this is in reply to.
161 "id": "A String", # The identified of the parent of this comment.
162 },
163 "author": { # The author of this Comment.
164 "url": "A String", # The URL of the Comment creator's Profile page.
165 "image": { # The comment creator's avatar.
166 "url": "A String", # The comment creator's avatar URL.
167 },
168 "displayName": "A String", # The display name.
169 "id": "A String", # The identifier of the Comment creator.
170 },
171 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
172 "blog": { # Data about the blog containing this comment.
173 "id": "A String", # The identifier of the blog containing this comment.
174 },
175 "published": "A String", # RFC 3339 date-time when this comment was published.
176 "post": { # Data about the post containing this comment.
177 "id": "A String", # The identifier of the post containing this comment.
178 },
179 "id": "A String", # The identifier for this resource.
180 "selfLink": "A String", # The API REST URL to fetch this resource from.
181 },
182 ],
183 "selfLink": "A String", # The URL of the comments on this post.
184 },
185 "labels": [ # The list of labels this Post was tagged with.
186 "A String",
187 ],
188 "customMetaData": "A String", # The JSON meta-data for the Post.
189 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
190 "blog": { # Data about the blog containing this Post.
191 "id": "A String", # The identifier of the Blog that contains this Post.
192 },
193 "url": "A String", # The URL where this Post is displayed.
194 "location": { # The location for geotagged posts.
195 "lat": 3.14, # Location's latitude.
196 "lng": 3.14, # Location's longitude.
197 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
198 "name": "A String", # Location name.
199 },
200 "published": "A String", # RFC 3339 date-time when this Post was published.
201 "images": [ # Display image for the Post.
202 {
203 "url": "A String",
204 },
205 ],
206 "title": "A String", # The title of the Post.
207 "id": "A String", # The identifier of this Post.
208 "selfLink": "A String", # The API REST URL to fetch this resource from.
209 }</pre>
210</div>
211
212<div class="method">
213 <code class="details" id="getByPath">getByPath(blogId, path, maxComments=None, view=None)</code>
214 <pre>Retrieve a Post by Path.
215
216Args:
217 blogId: string, ID of the blog to fetch the post from. (required)
218 path: string, Path of the Post to retrieve. (required)
219 maxComments: integer, Maximum number of comments to pull back on a post.
220 view: string, Access level with which to view the returned result. Note that some fields require elevated access.
221 Allowed values
222 ADMIN - Admin level detail
223 AUTHOR - Author level detail
224 READER - Reader level detail
225
226Returns:
227 An object of the form:
228
229 {
230 "status": "A String", # Status of the post. Only set for admin-level requests
231 "content": "A String", # The content of the Post. May contain HTML markup.
232 "kind": "blogger#post", # The kind of this entity. Always blogger#post
233 "titleLink": "A String", # The title link URL, similar to atom's related link.
234 "author": { # The author of this Post.
235 "url": "A String", # The URL of the Post creator's Profile page.
236 "image": { # The Post author's avatar.
237 "url": "A String", # The Post author's avatar URL.
238 },
239 "displayName": "A String", # The display name.
240 "id": "A String", # The identifier of the Post creator.
241 },
242 "replies": { # The container of comments on this Post.
243 "totalItems": "A String", # The count of comments on this post.
244 "items": [ # The List of Comments for this Post.
245 {
246 "status": "A String", # The status of the comment (only populated for admin users)
247 "content": "A String", # The actual content of the comment. May include HTML markup.
248 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
249 "inReplyTo": { # Data about the comment this is in reply to.
250 "id": "A String", # The identified of the parent of this comment.
251 },
252 "author": { # The author of this Comment.
253 "url": "A String", # The URL of the Comment creator's Profile page.
254 "image": { # The comment creator's avatar.
255 "url": "A String", # The comment creator's avatar URL.
256 },
257 "displayName": "A String", # The display name.
258 "id": "A String", # The identifier of the Comment creator.
259 },
260 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
261 "blog": { # Data about the blog containing this comment.
262 "id": "A String", # The identifier of the blog containing this comment.
263 },
264 "published": "A String", # RFC 3339 date-time when this comment was published.
265 "post": { # Data about the post containing this comment.
266 "id": "A String", # The identifier of the post containing this comment.
267 },
268 "id": "A String", # The identifier for this resource.
269 "selfLink": "A String", # The API REST URL to fetch this resource from.
270 },
271 ],
272 "selfLink": "A String", # The URL of the comments on this post.
273 },
274 "labels": [ # The list of labels this Post was tagged with.
275 "A String",
276 ],
277 "customMetaData": "A String", # The JSON meta-data for the Post.
278 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
279 "blog": { # Data about the blog containing this Post.
280 "id": "A String", # The identifier of the Blog that contains this Post.
281 },
282 "url": "A String", # The URL where this Post is displayed.
283 "location": { # The location for geotagged posts.
284 "lat": 3.14, # Location's latitude.
285 "lng": 3.14, # Location's longitude.
286 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
287 "name": "A String", # Location name.
288 },
289 "published": "A String", # RFC 3339 date-time when this Post was published.
290 "images": [ # Display image for the Post.
291 {
292 "url": "A String",
293 },
294 ],
295 "title": "A String", # The title of the Post.
296 "id": "A String", # The identifier of this Post.
297 "selfLink": "A String", # The API REST URL to fetch this resource from.
298 }</pre>
299</div>
300
301<div class="method">
302 <code class="details" id="insert">insert(blogId, body, isDraft=None, fetchImages=None, fetchBody=None)</code>
303 <pre>Add a post.
304
305Args:
306 blogId: string, ID of the blog to add the post to. (required)
307 body: object, The request body. (required)
308 The object takes the form of:
309
310{
311 "status": "A String", # Status of the post. Only set for admin-level requests
312 "content": "A String", # The content of the Post. May contain HTML markup.
313 "kind": "blogger#post", # The kind of this entity. Always blogger#post
314 "titleLink": "A String", # The title link URL, similar to atom's related link.
315 "author": { # The author of this Post.
316 "url": "A String", # The URL of the Post creator's Profile page.
317 "image": { # The Post author's avatar.
318 "url": "A String", # The Post author's avatar URL.
319 },
320 "displayName": "A String", # The display name.
321 "id": "A String", # The identifier of the Post creator.
322 },
323 "replies": { # The container of comments on this Post.
324 "totalItems": "A String", # The count of comments on this post.
325 "items": [ # The List of Comments for this Post.
326 {
327 "status": "A String", # The status of the comment (only populated for admin users)
328 "content": "A String", # The actual content of the comment. May include HTML markup.
329 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
330 "inReplyTo": { # Data about the comment this is in reply to.
331 "id": "A String", # The identified of the parent of this comment.
332 },
333 "author": { # The author of this Comment.
334 "url": "A String", # The URL of the Comment creator's Profile page.
335 "image": { # The comment creator's avatar.
336 "url": "A String", # The comment creator's avatar URL.
337 },
338 "displayName": "A String", # The display name.
339 "id": "A String", # The identifier of the Comment creator.
340 },
341 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
342 "blog": { # Data about the blog containing this comment.
343 "id": "A String", # The identifier of the blog containing this comment.
344 },
345 "published": "A String", # RFC 3339 date-time when this comment was published.
346 "post": { # Data about the post containing this comment.
347 "id": "A String", # The identifier of the post containing this comment.
348 },
349 "id": "A String", # The identifier for this resource.
350 "selfLink": "A String", # The API REST URL to fetch this resource from.
351 },
352 ],
353 "selfLink": "A String", # The URL of the comments on this post.
354 },
355 "labels": [ # The list of labels this Post was tagged with.
356 "A String",
357 ],
358 "customMetaData": "A String", # The JSON meta-data for the Post.
359 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
360 "blog": { # Data about the blog containing this Post.
361 "id": "A String", # The identifier of the Blog that contains this Post.
362 },
363 "url": "A String", # The URL where this Post is displayed.
364 "location": { # The location for geotagged posts.
365 "lat": 3.14, # Location's latitude.
366 "lng": 3.14, # Location's longitude.
367 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
368 "name": "A String", # Location name.
369 },
370 "published": "A String", # RFC 3339 date-time when this Post was published.
371 "images": [ # Display image for the Post.
372 {
373 "url": "A String",
374 },
375 ],
376 "title": "A String", # The title of the Post.
377 "id": "A String", # The identifier of this Post.
378 "selfLink": "A String", # The API REST URL to fetch this resource from.
379}
380
381 isDraft: boolean, Whether to create the post as a draft (default: false).
382 fetchImages: boolean, Whether image URL metadata for each post is included in the returned result (default: false).
383 fetchBody: boolean, Whether the body content of the post is included with the result (default: true).
384
385Returns:
386 An object of the form:
387
388 {
389 "status": "A String", # Status of the post. Only set for admin-level requests
390 "content": "A String", # The content of the Post. May contain HTML markup.
391 "kind": "blogger#post", # The kind of this entity. Always blogger#post
392 "titleLink": "A String", # The title link URL, similar to atom's related link.
393 "author": { # The author of this Post.
394 "url": "A String", # The URL of the Post creator's Profile page.
395 "image": { # The Post author's avatar.
396 "url": "A String", # The Post author's avatar URL.
397 },
398 "displayName": "A String", # The display name.
399 "id": "A String", # The identifier of the Post creator.
400 },
401 "replies": { # The container of comments on this Post.
402 "totalItems": "A String", # The count of comments on this post.
403 "items": [ # The List of Comments for this Post.
404 {
405 "status": "A String", # The status of the comment (only populated for admin users)
406 "content": "A String", # The actual content of the comment. May include HTML markup.
407 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
408 "inReplyTo": { # Data about the comment this is in reply to.
409 "id": "A String", # The identified of the parent of this comment.
410 },
411 "author": { # The author of this Comment.
412 "url": "A String", # The URL of the Comment creator's Profile page.
413 "image": { # The comment creator's avatar.
414 "url": "A String", # The comment creator's avatar URL.
415 },
416 "displayName": "A String", # The display name.
417 "id": "A String", # The identifier of the Comment creator.
418 },
419 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
420 "blog": { # Data about the blog containing this comment.
421 "id": "A String", # The identifier of the blog containing this comment.
422 },
423 "published": "A String", # RFC 3339 date-time when this comment was published.
424 "post": { # Data about the post containing this comment.
425 "id": "A String", # The identifier of the post containing this comment.
426 },
427 "id": "A String", # The identifier for this resource.
428 "selfLink": "A String", # The API REST URL to fetch this resource from.
429 },
430 ],
431 "selfLink": "A String", # The URL of the comments on this post.
432 },
433 "labels": [ # The list of labels this Post was tagged with.
434 "A String",
435 ],
436 "customMetaData": "A String", # The JSON meta-data for the Post.
437 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
438 "blog": { # Data about the blog containing this Post.
439 "id": "A String", # The identifier of the Blog that contains this Post.
440 },
441 "url": "A String", # The URL where this Post is displayed.
442 "location": { # The location for geotagged posts.
443 "lat": 3.14, # Location's latitude.
444 "lng": 3.14, # Location's longitude.
445 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
446 "name": "A String", # Location name.
447 },
448 "published": "A String", # RFC 3339 date-time when this Post was published.
449 "images": [ # Display image for the Post.
450 {
451 "url": "A String",
452 },
453 ],
454 "title": "A String", # The title of the Post.
455 "id": "A String", # The identifier of this Post.
456 "selfLink": "A String", # The API REST URL to fetch this resource from.
457 }</pre>
458</div>
459
460<div class="method">
461 <code class="details" id="list">list(blogId, orderBy=None, startDate=None, endDate=None, labels=None, pageToken=None, status=None, maxResults=None, fetchBodies=None, fetchImages=None, view=None)</code>
462 <pre>Retrieves a list of posts, possibly filtered.
463
464Args:
465 blogId: string, ID of the blog to fetch posts from. (required)
466 orderBy: string, Sort search results
467 Allowed values
468 published - Order by the date the post was published
469 updated - Order by the date the post was last updated
470 startDate: string, Earliest post date to fetch, a date-time with RFC 3339 formatting.
471 endDate: string, Latest post date to fetch, a date-time with RFC 3339 formatting.
472 labels: string, Comma-separated list of labels to search for.
473 pageToken: string, Continuation token if the request is paged.
474 status: string, Statuses to include in the results. (repeated)
475 Allowed values
476 draft - Draft (non-published) posts.
477 live - Published posts
478 scheduled - Posts that are scheduled to publish in the future.
479 maxResults: integer, Maximum number of posts to fetch.
480 fetchBodies: boolean, Whether the body content of posts is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic.
481 fetchImages: boolean, Whether image URL metadata for each post is included.
482 view: string, Access level with which to view the returned result. Note that some fields require escalated access.
483 Allowed values
484 ADMIN - Admin level detail
485 AUTHOR - Author level detail
486 READER - Reader level detail
487
488Returns:
489 An object of the form:
490
491 {
492 "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
493 "items": [ # The list of Posts for this Blog.
494 {
495 "status": "A String", # Status of the post. Only set for admin-level requests
496 "content": "A String", # The content of the Post. May contain HTML markup.
497 "kind": "blogger#post", # The kind of this entity. Always blogger#post
498 "titleLink": "A String", # The title link URL, similar to atom's related link.
499 "author": { # The author of this Post.
500 "url": "A String", # The URL of the Post creator's Profile page.
501 "image": { # The Post author's avatar.
502 "url": "A String", # The Post author's avatar URL.
503 },
504 "displayName": "A String", # The display name.
505 "id": "A String", # The identifier of the Post creator.
506 },
507 "replies": { # The container of comments on this Post.
508 "totalItems": "A String", # The count of comments on this post.
509 "items": [ # The List of Comments for this Post.
510 {
511 "status": "A String", # The status of the comment (only populated for admin users)
512 "content": "A String", # The actual content of the comment. May include HTML markup.
513 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
514 "inReplyTo": { # Data about the comment this is in reply to.
515 "id": "A String", # The identified of the parent of this comment.
516 },
517 "author": { # The author of this Comment.
518 "url": "A String", # The URL of the Comment creator's Profile page.
519 "image": { # The comment creator's avatar.
520 "url": "A String", # The comment creator's avatar URL.
521 },
522 "displayName": "A String", # The display name.
523 "id": "A String", # The identifier of the Comment creator.
524 },
525 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
526 "blog": { # Data about the blog containing this comment.
527 "id": "A String", # The identifier of the blog containing this comment.
528 },
529 "published": "A String", # RFC 3339 date-time when this comment was published.
530 "post": { # Data about the post containing this comment.
531 "id": "A String", # The identifier of the post containing this comment.
532 },
533 "id": "A String", # The identifier for this resource.
534 "selfLink": "A String", # The API REST URL to fetch this resource from.
535 },
536 ],
537 "selfLink": "A String", # The URL of the comments on this post.
538 },
539 "labels": [ # The list of labels this Post was tagged with.
540 "A String",
541 ],
542 "customMetaData": "A String", # The JSON meta-data for the Post.
543 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
544 "blog": { # Data about the blog containing this Post.
545 "id": "A String", # The identifier of the Blog that contains this Post.
546 },
547 "url": "A String", # The URL where this Post is displayed.
548 "location": { # The location for geotagged posts.
549 "lat": 3.14, # Location's latitude.
550 "lng": 3.14, # Location's longitude.
551 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
552 "name": "A String", # Location name.
553 },
554 "published": "A String", # RFC 3339 date-time when this Post was published.
555 "images": [ # Display image for the Post.
556 {
557 "url": "A String",
558 },
559 ],
560 "title": "A String", # The title of the Post.
561 "id": "A String", # The identifier of this Post.
562 "selfLink": "A String", # The API REST URL to fetch this resource from.
563 },
564 ],
565 "kind": "blogger#postList", # The kind of this entity. Always blogger#postList
566 }</pre>
567</div>
568
569<div class="method">
570 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
571 <pre>Retrieves the next page of results.
572
573Args:
574 previous_request: The request for the previous page. (required)
575 previous_response: The response from the request for the previous page. (required)
576
577Returns:
578 A request object that you can call 'execute()' on to request the next
579 page. Returns None if there are no more items in the collection.
580 </pre>
581</div>
582
583<div class="method">
584 <code class="details" id="patch">patch(blogId, postId, body, maxComments=None, revert=None, publish=None, fetchImages=None, fetchBody=None)</code>
585 <pre>Update a post. This method supports patch semantics.
586
587Args:
588 blogId: string, The ID of the Blog. (required)
589 postId: string, The ID of the Post. (required)
590 body: object, The request body. (required)
591 The object takes the form of:
592
593{
594 "status": "A String", # Status of the post. Only set for admin-level requests
595 "content": "A String", # The content of the Post. May contain HTML markup.
596 "kind": "blogger#post", # The kind of this entity. Always blogger#post
597 "titleLink": "A String", # The title link URL, similar to atom's related link.
598 "author": { # The author of this Post.
599 "url": "A String", # The URL of the Post creator's Profile page.
600 "image": { # The Post author's avatar.
601 "url": "A String", # The Post author's avatar URL.
602 },
603 "displayName": "A String", # The display name.
604 "id": "A String", # The identifier of the Post creator.
605 },
606 "replies": { # The container of comments on this Post.
607 "totalItems": "A String", # The count of comments on this post.
608 "items": [ # The List of Comments for this Post.
609 {
610 "status": "A String", # The status of the comment (only populated for admin users)
611 "content": "A String", # The actual content of the comment. May include HTML markup.
612 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
613 "inReplyTo": { # Data about the comment this is in reply to.
614 "id": "A String", # The identified of the parent of this comment.
615 },
616 "author": { # The author of this Comment.
617 "url": "A String", # The URL of the Comment creator's Profile page.
618 "image": { # The comment creator's avatar.
619 "url": "A String", # The comment creator's avatar URL.
620 },
621 "displayName": "A String", # The display name.
622 "id": "A String", # The identifier of the Comment creator.
623 },
624 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
625 "blog": { # Data about the blog containing this comment.
626 "id": "A String", # The identifier of the blog containing this comment.
627 },
628 "published": "A String", # RFC 3339 date-time when this comment was published.
629 "post": { # Data about the post containing this comment.
630 "id": "A String", # The identifier of the post containing this comment.
631 },
632 "id": "A String", # The identifier for this resource.
633 "selfLink": "A String", # The API REST URL to fetch this resource from.
634 },
635 ],
636 "selfLink": "A String", # The URL of the comments on this post.
637 },
638 "labels": [ # The list of labels this Post was tagged with.
639 "A String",
640 ],
641 "customMetaData": "A String", # The JSON meta-data for the Post.
642 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
643 "blog": { # Data about the blog containing this Post.
644 "id": "A String", # The identifier of the Blog that contains this Post.
645 },
646 "url": "A String", # The URL where this Post is displayed.
647 "location": { # The location for geotagged posts.
648 "lat": 3.14, # Location's latitude.
649 "lng": 3.14, # Location's longitude.
650 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
651 "name": "A String", # Location name.
652 },
653 "published": "A String", # RFC 3339 date-time when this Post was published.
654 "images": [ # Display image for the Post.
655 {
656 "url": "A String",
657 },
658 ],
659 "title": "A String", # The title of the Post.
660 "id": "A String", # The identifier of this Post.
661 "selfLink": "A String", # The API REST URL to fetch this resource from.
662}
663
664 maxComments: integer, Maximum number of comments to retrieve with the returned post.
665 revert: boolean, Whether a revert action should be performed when the post is updated (default: false).
666 publish: boolean, Whether a publish action should be performed when the post is updated (default: false).
667 fetchImages: boolean, Whether image URL metadata for each post is included in the returned result (default: false).
668 fetchBody: boolean, Whether the body content of the post is included with the result (default: true).
669
670Returns:
671 An object of the form:
672
673 {
674 "status": "A String", # Status of the post. Only set for admin-level requests
675 "content": "A String", # The content of the Post. May contain HTML markup.
676 "kind": "blogger#post", # The kind of this entity. Always blogger#post
677 "titleLink": "A String", # The title link URL, similar to atom's related link.
678 "author": { # The author of this Post.
679 "url": "A String", # The URL of the Post creator's Profile page.
680 "image": { # The Post author's avatar.
681 "url": "A String", # The Post author's avatar URL.
682 },
683 "displayName": "A String", # The display name.
684 "id": "A String", # The identifier of the Post creator.
685 },
686 "replies": { # The container of comments on this Post.
687 "totalItems": "A String", # The count of comments on this post.
688 "items": [ # The List of Comments for this Post.
689 {
690 "status": "A String", # The status of the comment (only populated for admin users)
691 "content": "A String", # The actual content of the comment. May include HTML markup.
692 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
693 "inReplyTo": { # Data about the comment this is in reply to.
694 "id": "A String", # The identified of the parent of this comment.
695 },
696 "author": { # The author of this Comment.
697 "url": "A String", # The URL of the Comment creator's Profile page.
698 "image": { # The comment creator's avatar.
699 "url": "A String", # The comment creator's avatar URL.
700 },
701 "displayName": "A String", # The display name.
702 "id": "A String", # The identifier of the Comment creator.
703 },
704 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
705 "blog": { # Data about the blog containing this comment.
706 "id": "A String", # The identifier of the blog containing this comment.
707 },
708 "published": "A String", # RFC 3339 date-time when this comment was published.
709 "post": { # Data about the post containing this comment.
710 "id": "A String", # The identifier of the post containing this comment.
711 },
712 "id": "A String", # The identifier for this resource.
713 "selfLink": "A String", # The API REST URL to fetch this resource from.
714 },
715 ],
716 "selfLink": "A String", # The URL of the comments on this post.
717 },
718 "labels": [ # The list of labels this Post was tagged with.
719 "A String",
720 ],
721 "customMetaData": "A String", # The JSON meta-data for the Post.
722 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
723 "blog": { # Data about the blog containing this Post.
724 "id": "A String", # The identifier of the Blog that contains this Post.
725 },
726 "url": "A String", # The URL where this Post is displayed.
727 "location": { # The location for geotagged posts.
728 "lat": 3.14, # Location's latitude.
729 "lng": 3.14, # Location's longitude.
730 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
731 "name": "A String", # Location name.
732 },
733 "published": "A String", # RFC 3339 date-time when this Post was published.
734 "images": [ # Display image for the Post.
735 {
736 "url": "A String",
737 },
738 ],
739 "title": "A String", # The title of the Post.
740 "id": "A String", # The identifier of this Post.
741 "selfLink": "A String", # The API REST URL to fetch this resource from.
742 }</pre>
743</div>
744
745<div class="method">
746 <code class="details" id="publish">publish(blogId, postId, publishDate=None)</code>
747 <pre>Publish a draft post.
748
749Args:
750 blogId: string, The ID of the Blog. (required)
751 postId: string, The ID of the Post. (required)
752 publishDate: string, The date and time to schedule the publishing of the Blog.
753
754Returns:
755 An object of the form:
756
757 {
758 "status": "A String", # Status of the post. Only set for admin-level requests
759 "content": "A String", # The content of the Post. May contain HTML markup.
760 "kind": "blogger#post", # The kind of this entity. Always blogger#post
761 "titleLink": "A String", # The title link URL, similar to atom's related link.
762 "author": { # The author of this Post.
763 "url": "A String", # The URL of the Post creator's Profile page.
764 "image": { # The Post author's avatar.
765 "url": "A String", # The Post author's avatar URL.
766 },
767 "displayName": "A String", # The display name.
768 "id": "A String", # The identifier of the Post creator.
769 },
770 "replies": { # The container of comments on this Post.
771 "totalItems": "A String", # The count of comments on this post.
772 "items": [ # The List of Comments for this Post.
773 {
774 "status": "A String", # The status of the comment (only populated for admin users)
775 "content": "A String", # The actual content of the comment. May include HTML markup.
776 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
777 "inReplyTo": { # Data about the comment this is in reply to.
778 "id": "A String", # The identified of the parent of this comment.
779 },
780 "author": { # The author of this Comment.
781 "url": "A String", # The URL of the Comment creator's Profile page.
782 "image": { # The comment creator's avatar.
783 "url": "A String", # The comment creator's avatar URL.
784 },
785 "displayName": "A String", # The display name.
786 "id": "A String", # The identifier of the Comment creator.
787 },
788 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
789 "blog": { # Data about the blog containing this comment.
790 "id": "A String", # The identifier of the blog containing this comment.
791 },
792 "published": "A String", # RFC 3339 date-time when this comment was published.
793 "post": { # Data about the post containing this comment.
794 "id": "A String", # The identifier of the post containing this comment.
795 },
796 "id": "A String", # The identifier for this resource.
797 "selfLink": "A String", # The API REST URL to fetch this resource from.
798 },
799 ],
800 "selfLink": "A String", # The URL of the comments on this post.
801 },
802 "labels": [ # The list of labels this Post was tagged with.
803 "A String",
804 ],
805 "customMetaData": "A String", # The JSON meta-data for the Post.
806 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
807 "blog": { # Data about the blog containing this Post.
808 "id": "A String", # The identifier of the Blog that contains this Post.
809 },
810 "url": "A String", # The URL where this Post is displayed.
811 "location": { # The location for geotagged posts.
812 "lat": 3.14, # Location's latitude.
813 "lng": 3.14, # Location's longitude.
814 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
815 "name": "A String", # Location name.
816 },
817 "published": "A String", # RFC 3339 date-time when this Post was published.
818 "images": [ # Display image for the Post.
819 {
820 "url": "A String",
821 },
822 ],
823 "title": "A String", # The title of the Post.
824 "id": "A String", # The identifier of this Post.
825 "selfLink": "A String", # The API REST URL to fetch this resource from.
826 }</pre>
827</div>
828
829<div class="method">
830 <code class="details" id="revert">revert(blogId, postId)</code>
831 <pre>Revert a published or scheduled post to draft state.
832
833Args:
834 blogId: string, The ID of the Blog. (required)
835 postId: string, The ID of the Post. (required)
836
837Returns:
838 An object of the form:
839
840 {
841 "status": "A String", # Status of the post. Only set for admin-level requests
842 "content": "A String", # The content of the Post. May contain HTML markup.
843 "kind": "blogger#post", # The kind of this entity. Always blogger#post
844 "titleLink": "A String", # The title link URL, similar to atom's related link.
845 "author": { # The author of this Post.
846 "url": "A String", # The URL of the Post creator's Profile page.
847 "image": { # The Post author's avatar.
848 "url": "A String", # The Post author's avatar URL.
849 },
850 "displayName": "A String", # The display name.
851 "id": "A String", # The identifier of the Post creator.
852 },
853 "replies": { # The container of comments on this Post.
854 "totalItems": "A String", # The count of comments on this post.
855 "items": [ # The List of Comments for this Post.
856 {
857 "status": "A String", # The status of the comment (only populated for admin users)
858 "content": "A String", # The actual content of the comment. May include HTML markup.
859 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
860 "inReplyTo": { # Data about the comment this is in reply to.
861 "id": "A String", # The identified of the parent of this comment.
862 },
863 "author": { # The author of this Comment.
864 "url": "A String", # The URL of the Comment creator's Profile page.
865 "image": { # The comment creator's avatar.
866 "url": "A String", # The comment creator's avatar URL.
867 },
868 "displayName": "A String", # The display name.
869 "id": "A String", # The identifier of the Comment creator.
870 },
871 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
872 "blog": { # Data about the blog containing this comment.
873 "id": "A String", # The identifier of the blog containing this comment.
874 },
875 "published": "A String", # RFC 3339 date-time when this comment was published.
876 "post": { # Data about the post containing this comment.
877 "id": "A String", # The identifier of the post containing this comment.
878 },
879 "id": "A String", # The identifier for this resource.
880 "selfLink": "A String", # The API REST URL to fetch this resource from.
881 },
882 ],
883 "selfLink": "A String", # The URL of the comments on this post.
884 },
885 "labels": [ # The list of labels this Post was tagged with.
886 "A String",
887 ],
888 "customMetaData": "A String", # The JSON meta-data for the Post.
889 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
890 "blog": { # Data about the blog containing this Post.
891 "id": "A String", # The identifier of the Blog that contains this Post.
892 },
893 "url": "A String", # The URL where this Post is displayed.
894 "location": { # The location for geotagged posts.
895 "lat": 3.14, # Location's latitude.
896 "lng": 3.14, # Location's longitude.
897 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
898 "name": "A String", # Location name.
899 },
900 "published": "A String", # RFC 3339 date-time when this Post was published.
901 "images": [ # Display image for the Post.
902 {
903 "url": "A String",
904 },
905 ],
906 "title": "A String", # The title of the Post.
907 "id": "A String", # The identifier of this Post.
908 "selfLink": "A String", # The API REST URL to fetch this resource from.
909 }</pre>
910</div>
911
912<div class="method">
913 <code class="details" id="search">search(blogId, q, orderBy=None, fetchBodies=None)</code>
914 <pre>Search for a post.
915
916Args:
917 blogId: string, ID of the blog to fetch the post from. (required)
918 q: string, Query terms to search this blog for matching posts. (required)
919 orderBy: string, Sort search results
920 Allowed values
921 published - Order by the date the post was published
922 updated - Order by the date the post was last updated
923 fetchBodies: boolean, Whether the body content of posts is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic.
924
925Returns:
926 An object of the form:
927
928 {
929 "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
930 "items": [ # The list of Posts for this Blog.
931 {
932 "status": "A String", # Status of the post. Only set for admin-level requests
933 "content": "A String", # The content of the Post. May contain HTML markup.
934 "kind": "blogger#post", # The kind of this entity. Always blogger#post
935 "titleLink": "A String", # The title link URL, similar to atom's related link.
936 "author": { # The author of this Post.
937 "url": "A String", # The URL of the Post creator's Profile page.
938 "image": { # The Post author's avatar.
939 "url": "A String", # The Post author's avatar URL.
940 },
941 "displayName": "A String", # The display name.
942 "id": "A String", # The identifier of the Post creator.
943 },
944 "replies": { # The container of comments on this Post.
945 "totalItems": "A String", # The count of comments on this post.
946 "items": [ # The List of Comments for this Post.
947 {
948 "status": "A String", # The status of the comment (only populated for admin users)
949 "content": "A String", # The actual content of the comment. May include HTML markup.
950 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
951 "inReplyTo": { # Data about the comment this is in reply to.
952 "id": "A String", # The identified of the parent of this comment.
953 },
954 "author": { # The author of this Comment.
955 "url": "A String", # The URL of the Comment creator's Profile page.
956 "image": { # The comment creator's avatar.
957 "url": "A String", # The comment creator's avatar URL.
958 },
959 "displayName": "A String", # The display name.
960 "id": "A String", # The identifier of the Comment creator.
961 },
962 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
963 "blog": { # Data about the blog containing this comment.
964 "id": "A String", # The identifier of the blog containing this comment.
965 },
966 "published": "A String", # RFC 3339 date-time when this comment was published.
967 "post": { # Data about the post containing this comment.
968 "id": "A String", # The identifier of the post containing this comment.
969 },
970 "id": "A String", # The identifier for this resource.
971 "selfLink": "A String", # The API REST URL to fetch this resource from.
972 },
973 ],
974 "selfLink": "A String", # The URL of the comments on this post.
975 },
976 "labels": [ # The list of labels this Post was tagged with.
977 "A String",
978 ],
979 "customMetaData": "A String", # The JSON meta-data for the Post.
980 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
981 "blog": { # Data about the blog containing this Post.
982 "id": "A String", # The identifier of the Blog that contains this Post.
983 },
984 "url": "A String", # The URL where this Post is displayed.
985 "location": { # The location for geotagged posts.
986 "lat": 3.14, # Location's latitude.
987 "lng": 3.14, # Location's longitude.
988 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
989 "name": "A String", # Location name.
990 },
991 "published": "A String", # RFC 3339 date-time when this Post was published.
992 "images": [ # Display image for the Post.
993 {
994 "url": "A String",
995 },
996 ],
997 "title": "A String", # The title of the Post.
998 "id": "A String", # The identifier of this Post.
999 "selfLink": "A String", # The API REST URL to fetch this resource from.
1000 },
1001 ],
1002 "kind": "blogger#postList", # The kind of this entity. Always blogger#postList
1003 }</pre>
1004</div>
1005
1006<div class="method">
1007 <code class="details" id="update">update(blogId, postId, body, maxComments=None, revert=None, publish=None, fetchImages=None, fetchBody=None)</code>
1008 <pre>Update a post.
1009
1010Args:
1011 blogId: string, The ID of the Blog. (required)
1012 postId: string, The ID of the Post. (required)
1013 body: object, The request body. (required)
1014 The object takes the form of:
1015
1016{
1017 "status": "A String", # Status of the post. Only set for admin-level requests
1018 "content": "A String", # The content of the Post. May contain HTML markup.
1019 "kind": "blogger#post", # The kind of this entity. Always blogger#post
1020 "titleLink": "A String", # The title link URL, similar to atom's related link.
1021 "author": { # The author of this Post.
1022 "url": "A String", # The URL of the Post creator's Profile page.
1023 "image": { # The Post author's avatar.
1024 "url": "A String", # The Post author's avatar URL.
1025 },
1026 "displayName": "A String", # The display name.
1027 "id": "A String", # The identifier of the Post creator.
1028 },
1029 "replies": { # The container of comments on this Post.
1030 "totalItems": "A String", # The count of comments on this post.
1031 "items": [ # The List of Comments for this Post.
1032 {
1033 "status": "A String", # The status of the comment (only populated for admin users)
1034 "content": "A String", # The actual content of the comment. May include HTML markup.
1035 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
1036 "inReplyTo": { # Data about the comment this is in reply to.
1037 "id": "A String", # The identified of the parent of this comment.
1038 },
1039 "author": { # The author of this Comment.
1040 "url": "A String", # The URL of the Comment creator's Profile page.
1041 "image": { # The comment creator's avatar.
1042 "url": "A String", # The comment creator's avatar URL.
1043 },
1044 "displayName": "A String", # The display name.
1045 "id": "A String", # The identifier of the Comment creator.
1046 },
1047 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
1048 "blog": { # Data about the blog containing this comment.
1049 "id": "A String", # The identifier of the blog containing this comment.
1050 },
1051 "published": "A String", # RFC 3339 date-time when this comment was published.
1052 "post": { # Data about the post containing this comment.
1053 "id": "A String", # The identifier of the post containing this comment.
1054 },
1055 "id": "A String", # The identifier for this resource.
1056 "selfLink": "A String", # The API REST URL to fetch this resource from.
1057 },
1058 ],
1059 "selfLink": "A String", # The URL of the comments on this post.
1060 },
1061 "labels": [ # The list of labels this Post was tagged with.
1062 "A String",
1063 ],
1064 "customMetaData": "A String", # The JSON meta-data for the Post.
1065 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
1066 "blog": { # Data about the blog containing this Post.
1067 "id": "A String", # The identifier of the Blog that contains this Post.
1068 },
1069 "url": "A String", # The URL where this Post is displayed.
1070 "location": { # The location for geotagged posts.
1071 "lat": 3.14, # Location's latitude.
1072 "lng": 3.14, # Location's longitude.
1073 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
1074 "name": "A String", # Location name.
1075 },
1076 "published": "A String", # RFC 3339 date-time when this Post was published.
1077 "images": [ # Display image for the Post.
1078 {
1079 "url": "A String",
1080 },
1081 ],
1082 "title": "A String", # The title of the Post.
1083 "id": "A String", # The identifier of this Post.
1084 "selfLink": "A String", # The API REST URL to fetch this resource from.
1085}
1086
1087 maxComments: integer, Maximum number of comments to retrieve with the returned post.
1088 revert: boolean, Whether a revert action should be performed when the post is updated (default: false).
1089 publish: boolean, Whether a publish action should be performed when the post is updated (default: false).
1090 fetchImages: boolean, Whether image URL metadata for each post is included in the returned result (default: false).
1091 fetchBody: boolean, Whether the body content of the post is included with the result (default: true).
1092
1093Returns:
1094 An object of the form:
1095
1096 {
1097 "status": "A String", # Status of the post. Only set for admin-level requests
1098 "content": "A String", # The content of the Post. May contain HTML markup.
1099 "kind": "blogger#post", # The kind of this entity. Always blogger#post
1100 "titleLink": "A String", # The title link URL, similar to atom's related link.
1101 "author": { # The author of this Post.
1102 "url": "A String", # The URL of the Post creator's Profile page.
1103 "image": { # The Post author's avatar.
1104 "url": "A String", # The Post author's avatar URL.
1105 },
1106 "displayName": "A String", # The display name.
1107 "id": "A String", # The identifier of the Post creator.
1108 },
1109 "replies": { # The container of comments on this Post.
1110 "totalItems": "A String", # The count of comments on this post.
1111 "items": [ # The List of Comments for this Post.
1112 {
1113 "status": "A String", # The status of the comment (only populated for admin users)
1114 "content": "A String", # The actual content of the comment. May include HTML markup.
1115 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
1116 "inReplyTo": { # Data about the comment this is in reply to.
1117 "id": "A String", # The identified of the parent of this comment.
1118 },
1119 "author": { # The author of this Comment.
1120 "url": "A String", # The URL of the Comment creator's Profile page.
1121 "image": { # The comment creator's avatar.
1122 "url": "A String", # The comment creator's avatar URL.
1123 },
1124 "displayName": "A String", # The display name.
1125 "id": "A String", # The identifier of the Comment creator.
1126 },
1127 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
1128 "blog": { # Data about the blog containing this comment.
1129 "id": "A String", # The identifier of the blog containing this comment.
1130 },
1131 "published": "A String", # RFC 3339 date-time when this comment was published.
1132 "post": { # Data about the post containing this comment.
1133 "id": "A String", # The identifier of the post containing this comment.
1134 },
1135 "id": "A String", # The identifier for this resource.
1136 "selfLink": "A String", # The API REST URL to fetch this resource from.
1137 },
1138 ],
1139 "selfLink": "A String", # The URL of the comments on this post.
1140 },
1141 "labels": [ # The list of labels this Post was tagged with.
1142 "A String",
1143 ],
1144 "customMetaData": "A String", # The JSON meta-data for the Post.
1145 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
1146 "blog": { # Data about the blog containing this Post.
1147 "id": "A String", # The identifier of the Blog that contains this Post.
1148 },
1149 "url": "A String", # The URL where this Post is displayed.
1150 "location": { # The location for geotagged posts.
1151 "lat": 3.14, # Location's latitude.
1152 "lng": 3.14, # Location's longitude.
1153 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
1154 "name": "A String", # Location name.
1155 },
1156 "published": "A String", # RFC 3339 date-time when this Post was published.
1157 "images": [ # Display image for the Post.
1158 {
1159 "url": "A String",
1160 },
1161 ],
1162 "title": "A String", # The title of the Post.
1163 "id": "A String", # The identifier of this Post.
1164 "selfLink": "A String", # The API REST URL to fetch this resource from.
1165 }</pre>
1166</div>
1167
1168</body></html>