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