Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4f877e562986034f25ea4246ad1256eabd339526 / . / docs / dyn / blogger_v3.posts.html
blob: 300f88d3112800d09c5d38e8dcbc5375add70496 [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
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]576 "etag": "A String", # Etag of the response.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]577 }</pre>
578</div>
579
580<div class="method">
581 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
582 <pre>Retrieves the next page of results.
583
584Args:
585 previous_request: The request for the previous page. (required)
586 previous_response: The response from the request for the previous page. (required)
587
588Returns:
589 A request object that you can call 'execute()' on to request the next
590 page. Returns None if there are no more items in the collection.
591 </pre>
592</div>
593
594<div class="method">
595 <code class="details" id="patch">patch(blogId, postId, body, maxComments=None, revert=None, publish=None, fetchImages=None, fetchBody=None)</code>
596 <pre>Update a post. This method supports patch semantics.
597
598Args:
599 blogId: string, The ID of the Blog. (required)
600 postId: string, The ID of the Post. (required)
601 body: object, The request body. (required)
602 The object takes the form of:
603
604{
605 "status": "A String", # Status of the post. Only set for admin-level requests
606 "content": "A String", # The content of the Post. May contain HTML markup.
607 "kind": "blogger#post", # The kind of this entity. Always blogger#post
608 "titleLink": "A String", # The title link URL, similar to atom's related link.
609 "author": { # The author of this Post.
610 "url": "A String", # The URL of the Post creator's Profile page.
611 "image": { # The Post author's avatar.
612 "url": "A String", # The Post author's avatar URL.
613 },
614 "displayName": "A String", # The display name.
615 "id": "A String", # The identifier of the Post creator.
616 },
617 "replies": { # The container of comments on this Post.
618 "totalItems": "A String", # The count of comments on this post.
619 "items": [ # The List of Comments for this Post.
620 {
621 "status": "A String", # The status of the comment (only populated for admin users)
622 "content": "A String", # The actual content of the comment. May include HTML markup.
623 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
624 "inReplyTo": { # Data about the comment this is in reply to.
625 "id": "A String", # The identified of the parent of this comment.
626 },
627 "author": { # The author of this Comment.
628 "url": "A String", # The URL of the Comment creator's Profile page.
629 "image": { # The comment creator's avatar.
630 "url": "A String", # The comment creator's avatar URL.
631 },
632 "displayName": "A String", # The display name.
633 "id": "A String", # The identifier of the Comment creator.
634 },
635 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
636 "blog": { # Data about the blog containing this comment.
637 "id": "A String", # The identifier of the blog containing this comment.
638 },
639 "published": "A String", # RFC 3339 date-time when this comment was published.
640 "post": { # Data about the post containing this comment.
641 "id": "A String", # The identifier of the post containing this comment.
642 },
643 "id": "A String", # The identifier for this resource.
644 "selfLink": "A String", # The API REST URL to fetch this resource from.
645 },
646 ],
647 "selfLink": "A String", # The URL of the comments on this post.
648 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]649 "readerComments": "A String", # Comment control and display setting for readers of this post.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]650 "labels": [ # The list of labels this Post was tagged with.
651 "A String",
652 ],
653 "customMetaData": "A String", # The JSON meta-data for the Post.
654 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
655 "blog": { # Data about the blog containing this Post.
656 "id": "A String", # The identifier of the Blog that contains this Post.
657 },
658 "url": "A String", # The URL where this Post is displayed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]659 "etag": "A String", # Etag of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]660 "location": { # The location for geotagged posts.
661 "lat": 3.14, # Location's latitude.
662 "lng": 3.14, # Location's longitude.
663 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
664 "name": "A String", # Location name.
665 },
666 "published": "A String", # RFC 3339 date-time when this Post was published.
667 "images": [ # Display image for the Post.
668 {
669 "url": "A String",
670 },
671 ],
672 "title": "A String", # The title of the Post.
673 "id": "A String", # The identifier of this Post.
674 "selfLink": "A String", # The API REST URL to fetch this resource from.
675}
676
677 maxComments: integer, Maximum number of comments to retrieve with the returned post.
678 revert: boolean, Whether a revert action should be performed when the post is updated (default: false).
679 publish: boolean, Whether a publish action should be performed when the post is updated (default: false).
680 fetchImages: boolean, Whether image URL metadata for each post is included in the returned result (default: false).
681 fetchBody: boolean, Whether the body content of the post is included with the result (default: true).
682
683Returns:
684 An object of the form:
685
686 {
687 "status": "A String", # Status of the post. Only set for admin-level requests
688 "content": "A String", # The content of the Post. May contain HTML markup.
689 "kind": "blogger#post", # The kind of this entity. Always blogger#post
690 "titleLink": "A String", # The title link URL, similar to atom's related link.
691 "author": { # The author of this Post.
692 "url": "A String", # The URL of the Post creator's Profile page.
693 "image": { # The Post author's avatar.
694 "url": "A String", # The Post author's avatar URL.
695 },
696 "displayName": "A String", # The display name.
697 "id": "A String", # The identifier of the Post creator.
698 },
699 "replies": { # The container of comments on this Post.
700 "totalItems": "A String", # The count of comments on this post.
701 "items": [ # The List of Comments for this Post.
702 {
703 "status": "A String", # The status of the comment (only populated for admin users)
704 "content": "A String", # The actual content of the comment. May include HTML markup.
705 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
706 "inReplyTo": { # Data about the comment this is in reply to.
707 "id": "A String", # The identified of the parent of this comment.
708 },
709 "author": { # The author of this Comment.
710 "url": "A String", # The URL of the Comment creator's Profile page.
711 "image": { # The comment creator's avatar.
712 "url": "A String", # The comment creator's avatar URL.
713 },
714 "displayName": "A String", # The display name.
715 "id": "A String", # The identifier of the Comment creator.
716 },
717 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
718 "blog": { # Data about the blog containing this comment.
719 "id": "A String", # The identifier of the blog containing this comment.
720 },
721 "published": "A String", # RFC 3339 date-time when this comment was published.
722 "post": { # Data about the post containing this comment.
723 "id": "A String", # The identifier of the post containing this comment.
724 },
725 "id": "A String", # The identifier for this resource.
726 "selfLink": "A String", # The API REST URL to fetch this resource from.
727 },
728 ],
729 "selfLink": "A String", # The URL of the comments on this post.
730 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]731 "readerComments": "A String", # Comment control and display setting for readers of this post.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]732 "labels": [ # The list of labels this Post was tagged with.
733 "A String",
734 ],
735 "customMetaData": "A String", # The JSON meta-data for the Post.
736 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
737 "blog": { # Data about the blog containing this Post.
738 "id": "A String", # The identifier of the Blog that contains this Post.
739 },
740 "url": "A String", # The URL where this Post is displayed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]741 "etag": "A String", # Etag of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]742 "location": { # The location for geotagged posts.
743 "lat": 3.14, # Location's latitude.
744 "lng": 3.14, # Location's longitude.
745 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
746 "name": "A String", # Location name.
747 },
748 "published": "A String", # RFC 3339 date-time when this Post was published.
749 "images": [ # Display image for the Post.
750 {
751 "url": "A String",
752 },
753 ],
754 "title": "A String", # The title of the Post.
755 "id": "A String", # The identifier of this Post.
756 "selfLink": "A String", # The API REST URL to fetch this resource from.
757 }</pre>
758</div>
759
760<div class="method">
761 <code class="details" id="publish">publish(blogId, postId, publishDate=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]762 <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]763
764Args:
765 blogId: string, The ID of the Blog. (required)
766 postId: string, The ID of the Post. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]767 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]768
769Returns:
770 An object of the form:
771
772 {
773 "status": "A String", # Status of the post. Only set for admin-level requests
774 "content": "A String", # The content of the Post. May contain HTML markup.
775 "kind": "blogger#post", # The kind of this entity. Always blogger#post
776 "titleLink": "A String", # The title link URL, similar to atom's related link.
777 "author": { # The author of this Post.
778 "url": "A String", # The URL of the Post creator's Profile page.
779 "image": { # The Post author's avatar.
780 "url": "A String", # The Post author's avatar URL.
781 },
782 "displayName": "A String", # The display name.
783 "id": "A String", # The identifier of the Post creator.
784 },
785 "replies": { # The container of comments on this Post.
786 "totalItems": "A String", # The count of comments on this post.
787 "items": [ # The List of Comments for this Post.
788 {
789 "status": "A String", # The status of the comment (only populated for admin users)
790 "content": "A String", # The actual content of the comment. May include HTML markup.
791 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
792 "inReplyTo": { # Data about the comment this is in reply to.
793 "id": "A String", # The identified of the parent of this comment.
794 },
795 "author": { # The author of this Comment.
796 "url": "A String", # The URL of the Comment creator's Profile page.
797 "image": { # The comment creator's avatar.
798 "url": "A String", # The comment creator's avatar URL.
799 },
800 "displayName": "A String", # The display name.
801 "id": "A String", # The identifier of the Comment creator.
802 },
803 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
804 "blog": { # Data about the blog containing this comment.
805 "id": "A String", # The identifier of the blog containing this comment.
806 },
807 "published": "A String", # RFC 3339 date-time when this comment was published.
808 "post": { # Data about the post containing this comment.
809 "id": "A String", # The identifier of the post containing this comment.
810 },
811 "id": "A String", # The identifier for this resource.
812 "selfLink": "A String", # The API REST URL to fetch this resource from.
813 },
814 ],
815 "selfLink": "A String", # The URL of the comments on this post.
816 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]817 "readerComments": "A String", # Comment control and display setting for readers of this post.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]818 "labels": [ # The list of labels this Post was tagged with.
819 "A String",
820 ],
821 "customMetaData": "A String", # The JSON meta-data for the Post.
822 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
823 "blog": { # Data about the blog containing this Post.
824 "id": "A String", # The identifier of the Blog that contains this Post.
825 },
826 "url": "A String", # The URL where this Post is displayed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]827 "etag": "A String", # Etag of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]828 "location": { # The location for geotagged posts.
829 "lat": 3.14, # Location's latitude.
830 "lng": 3.14, # Location's longitude.
831 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
832 "name": "A String", # Location name.
833 },
834 "published": "A String", # RFC 3339 date-time when this Post was published.
835 "images": [ # Display image for the Post.
836 {
837 "url": "A String",
838 },
839 ],
840 "title": "A String", # The title of the Post.
841 "id": "A String", # The identifier of this Post.
842 "selfLink": "A String", # The API REST URL to fetch this resource from.
843 }</pre>
844</div>
845
846<div class="method">
847 <code class="details" id="revert">revert(blogId, postId)</code>
848 <pre>Revert a published or scheduled post to draft state.
849
850Args:
851 blogId: string, The ID of the Blog. (required)
852 postId: string, The ID of the Post. (required)
853
854Returns:
855 An object of the form:
856
857 {
858 "status": "A String", # Status of the post. Only set for admin-level requests
859 "content": "A String", # The content of the Post. May contain HTML markup.
860 "kind": "blogger#post", # The kind of this entity. Always blogger#post
861 "titleLink": "A String", # The title link URL, similar to atom's related link.
862 "author": { # The author of this Post.
863 "url": "A String", # The URL of the Post creator's Profile page.
864 "image": { # The Post author's avatar.
865 "url": "A String", # The Post author's avatar URL.
866 },
867 "displayName": "A String", # The display name.
868 "id": "A String", # The identifier of the Post creator.
869 },
870 "replies": { # The container of comments on this Post.
871 "totalItems": "A String", # The count of comments on this post.
872 "items": [ # The List of Comments for this Post.
873 {
874 "status": "A String", # The status of the comment (only populated for admin users)
875 "content": "A String", # The actual content of the comment. May include HTML markup.
876 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
877 "inReplyTo": { # Data about the comment this is in reply to.
878 "id": "A String", # The identified of the parent of this comment.
879 },
880 "author": { # The author of this Comment.
881 "url": "A String", # The URL of the Comment creator's Profile page.
882 "image": { # The comment creator's avatar.
883 "url": "A String", # The comment creator's avatar URL.
884 },
885 "displayName": "A String", # The display name.
886 "id": "A String", # The identifier of the Comment creator.
887 },
888 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
889 "blog": { # Data about the blog containing this comment.
890 "id": "A String", # The identifier of the blog containing this comment.
891 },
892 "published": "A String", # RFC 3339 date-time when this comment was published.
893 "post": { # Data about the post containing this comment.
894 "id": "A String", # The identifier of the post containing this comment.
895 },
896 "id": "A String", # The identifier for this resource.
897 "selfLink": "A String", # The API REST URL to fetch this resource from.
898 },
899 ],
900 "selfLink": "A String", # The URL of the comments on this post.
901 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]902 "readerComments": "A String", # Comment control and display setting for readers of this post.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]903 "labels": [ # The list of labels this Post was tagged with.
904 "A String",
905 ],
906 "customMetaData": "A String", # The JSON meta-data for the Post.
907 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
908 "blog": { # Data about the blog containing this Post.
909 "id": "A String", # The identifier of the Blog that contains this Post.
910 },
911 "url": "A String", # The URL where this Post is displayed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]912 "etag": "A String", # Etag of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]913 "location": { # The location for geotagged posts.
914 "lat": 3.14, # Location's latitude.
915 "lng": 3.14, # Location's longitude.
916 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
917 "name": "A String", # Location name.
918 },
919 "published": "A String", # RFC 3339 date-time when this Post was published.
920 "images": [ # Display image for the Post.
921 {
922 "url": "A String",
923 },
924 ],
925 "title": "A String", # The title of the Post.
926 "id": "A String", # The identifier of this Post.
927 "selfLink": "A String", # The API REST URL to fetch this resource from.
928 }</pre>
929</div>
930
931<div class="method">
932 <code class="details" id="search">search(blogId, q, orderBy=None, fetchBodies=None)</code>
933 <pre>Search for a post.
934
935Args:
936 blogId: string, ID of the blog to fetch the post from. (required)
937 q: string, Query terms to search this blog for matching posts. (required)
938 orderBy: string, Sort search results
939 Allowed values
940 published - Order by the date the post was published
941 updated - Order by the date the post was last updated
942 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.
943
944Returns:
945 An object of the form:
946
947 {
948 "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
949 "items": [ # The list of Posts for this Blog.
950 {
951 "status": "A String", # Status of the post. Only set for admin-level requests
952 "content": "A String", # The content of the Post. May contain HTML markup.
953 "kind": "blogger#post", # The kind of this entity. Always blogger#post
954 "titleLink": "A String", # The title link URL, similar to atom's related link.
955 "author": { # The author of this Post.
956 "url": "A String", # The URL of the Post creator's Profile page.
957 "image": { # The Post author's avatar.
958 "url": "A String", # The Post author's avatar URL.
959 },
960 "displayName": "A String", # The display name.
961 "id": "A String", # The identifier of the Post creator.
962 },
963 "replies": { # The container of comments on this Post.
964 "totalItems": "A String", # The count of comments on this post.
965 "items": [ # The List of Comments for this Post.
966 {
967 "status": "A String", # The status of the comment (only populated for admin users)
968 "content": "A String", # The actual content of the comment. May include HTML markup.
969 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
970 "inReplyTo": { # Data about the comment this is in reply to.
971 "id": "A String", # The identified of the parent of this comment.
972 },
973 "author": { # The author of this Comment.
974 "url": "A String", # The URL of the Comment creator's Profile page.
975 "image": { # The comment creator's avatar.
976 "url": "A String", # The comment creator's avatar URL.
977 },
978 "displayName": "A String", # The display name.
979 "id": "A String", # The identifier of the Comment creator.
980 },
981 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
982 "blog": { # Data about the blog containing this comment.
983 "id": "A String", # The identifier of the blog containing this comment.
984 },
985 "published": "A String", # RFC 3339 date-time when this comment was published.
986 "post": { # Data about the post containing this comment.
987 "id": "A String", # The identifier of the post containing this comment.
988 },
989 "id": "A String", # The identifier for this resource.
990 "selfLink": "A String", # The API REST URL to fetch this resource from.
991 },
992 ],
993 "selfLink": "A String", # The URL of the comments on this post.
994 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]995 "readerComments": "A String", # Comment control and display setting for readers of this post.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]996 "labels": [ # The list of labels this Post was tagged with.
997 "A String",
998 ],
999 "customMetaData": "A String", # The JSON meta-data for the Post.
1000 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
1001 "blog": { # Data about the blog containing this Post.
1002 "id": "A String", # The identifier of the Blog that contains this Post.
1003 },
1004 "url": "A String", # The URL where this Post is displayed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1005 "etag": "A String", # Etag of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1006 "location": { # The location for geotagged posts.
1007 "lat": 3.14, # Location's latitude.
1008 "lng": 3.14, # Location's longitude.
1009 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
1010 "name": "A String", # Location name.
1011 },
1012 "published": "A String", # RFC 3339 date-time when this Post was published.
1013 "images": [ # Display image for the Post.
1014 {
1015 "url": "A String",
1016 },
1017 ],
1018 "title": "A String", # The title of the Post.
1019 "id": "A String", # The identifier of this Post.
1020 "selfLink": "A String", # The API REST URL to fetch this resource from.
1021 },
1022 ],
1023 "kind": "blogger#postList", # The kind of this entity. Always blogger#postList
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]1024 "etag": "A String", # Etag of the response.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1025 }</pre>
1026</div>
1027
1028<div class="method">
1029 <code class="details" id="update">update(blogId, postId, body, maxComments=None, revert=None, publish=None, fetchImages=None, fetchBody=None)</code>
1030 <pre>Update a post.
1031
1032Args:
1033 blogId: string, The ID of the Blog. (required)
1034 postId: string, The ID of the Post. (required)
1035 body: object, The request body. (required)
1036 The object takes the form of:
1037
1038{
1039 "status": "A String", # Status of the post. Only set for admin-level requests
1040 "content": "A String", # The content of the Post. May contain HTML markup.
1041 "kind": "blogger#post", # The kind of this entity. Always blogger#post
1042 "titleLink": "A String", # The title link URL, similar to atom's related link.
1043 "author": { # The author of this Post.
1044 "url": "A String", # The URL of the Post creator's Profile page.
1045 "image": { # The Post author's avatar.
1046 "url": "A String", # The Post author's avatar URL.
1047 },
1048 "displayName": "A String", # The display name.
1049 "id": "A String", # The identifier of the Post creator.
1050 },
1051 "replies": { # The container of comments on this Post.
1052 "totalItems": "A String", # The count of comments on this post.
1053 "items": [ # The List of Comments for this Post.
1054 {
1055 "status": "A String", # The status of the comment (only populated for admin users)
1056 "content": "A String", # The actual content of the comment. May include HTML markup.
1057 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
1058 "inReplyTo": { # Data about the comment this is in reply to.
1059 "id": "A String", # The identified of the parent of this comment.
1060 },
1061 "author": { # The author of this Comment.
1062 "url": "A String", # The URL of the Comment creator's Profile page.
1063 "image": { # The comment creator's avatar.
1064 "url": "A String", # The comment creator's avatar URL.
1065 },
1066 "displayName": "A String", # The display name.
1067 "id": "A String", # The identifier of the Comment creator.
1068 },
1069 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
1070 "blog": { # Data about the blog containing this comment.
1071 "id": "A String", # The identifier of the blog containing this comment.
1072 },
1073 "published": "A String", # RFC 3339 date-time when this comment was published.
1074 "post": { # Data about the post containing this comment.
1075 "id": "A String", # The identifier of the post containing this comment.
1076 },
1077 "id": "A String", # The identifier for this resource.
1078 "selfLink": "A String", # The API REST URL to fetch this resource from.
1079 },
1080 ],
1081 "selfLink": "A String", # The URL of the comments on this post.
1082 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1083 "readerComments": "A String", # Comment control and display setting for readers of this post.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1084 "labels": [ # The list of labels this Post was tagged with.
1085 "A String",
1086 ],
1087 "customMetaData": "A String", # The JSON meta-data for the Post.
1088 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
1089 "blog": { # Data about the blog containing this Post.
1090 "id": "A String", # The identifier of the Blog that contains this Post.
1091 },
1092 "url": "A String", # The URL where this Post is displayed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1093 "etag": "A String", # Etag of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1094 "location": { # The location for geotagged posts.
1095 "lat": 3.14, # Location's latitude.
1096 "lng": 3.14, # Location's longitude.
1097 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
1098 "name": "A String", # Location name.
1099 },
1100 "published": "A String", # RFC 3339 date-time when this Post was published.
1101 "images": [ # Display image for the Post.
1102 {
1103 "url": "A String",
1104 },
1105 ],
1106 "title": "A String", # The title of the Post.
1107 "id": "A String", # The identifier of this Post.
1108 "selfLink": "A String", # The API REST URL to fetch this resource from.
1109}
1110
1111 maxComments: integer, Maximum number of comments to retrieve with the returned post.
1112 revert: boolean, Whether a revert action should be performed when the post is updated (default: false).
1113 publish: boolean, Whether a publish action should be performed when the post is updated (default: false).
1114 fetchImages: boolean, Whether image URL metadata for each post is included in the returned result (default: false).
1115 fetchBody: boolean, Whether the body content of the post is included with the result (default: true).
1116
1117Returns:
1118 An object of the form:
1119
1120 {
1121 "status": "A String", # Status of the post. Only set for admin-level requests
1122 "content": "A String", # The content of the Post. May contain HTML markup.
1123 "kind": "blogger#post", # The kind of this entity. Always blogger#post
1124 "titleLink": "A String", # The title link URL, similar to atom's related link.
1125 "author": { # The author of this Post.
1126 "url": "A String", # The URL of the Post creator's Profile page.
1127 "image": { # The Post author's avatar.
1128 "url": "A String", # The Post author's avatar URL.
1129 },
1130 "displayName": "A String", # The display name.
1131 "id": "A String", # The identifier of the Post creator.
1132 },
1133 "replies": { # The container of comments on this Post.
1134 "totalItems": "A String", # The count of comments on this post.
1135 "items": [ # The List of Comments for this Post.
1136 {
1137 "status": "A String", # The status of the comment (only populated for admin users)
1138 "content": "A String", # The actual content of the comment. May include HTML markup.
1139 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
1140 "inReplyTo": { # Data about the comment this is in reply to.
1141 "id": "A String", # The identified of the parent of this comment.
1142 },
1143 "author": { # The author of this Comment.
1144 "url": "A String", # The URL of the Comment creator's Profile page.
1145 "image": { # The comment creator's avatar.
1146 "url": "A String", # The comment creator's avatar URL.
1147 },
1148 "displayName": "A String", # The display name.
1149 "id": "A String", # The identifier of the Comment creator.
1150 },
1151 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
1152 "blog": { # Data about the blog containing this comment.
1153 "id": "A String", # The identifier of the blog containing this comment.
1154 },
1155 "published": "A String", # RFC 3339 date-time when this comment was published.
1156 "post": { # Data about the post containing this comment.
1157 "id": "A String", # The identifier of the post containing this comment.
1158 },
1159 "id": "A String", # The identifier for this resource.
1160 "selfLink": "A String", # The API REST URL to fetch this resource from.
1161 },
1162 ],
1163 "selfLink": "A String", # The URL of the comments on this post.
1164 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1165 "readerComments": "A String", # Comment control and display setting for readers of this post.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1166 "labels": [ # The list of labels this Post was tagged with.
1167 "A String",
1168 ],
1169 "customMetaData": "A String", # The JSON meta-data for the Post.
1170 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
1171 "blog": { # Data about the blog containing this Post.
1172 "id": "A String", # The identifier of the Blog that contains this Post.
1173 },
1174 "url": "A String", # The URL where this Post is displayed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1175 "etag": "A String", # Etag of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1176 "location": { # The location for geotagged posts.
1177 "lat": 3.14, # Location's latitude.
1178 "lng": 3.14, # Location's longitude.
1179 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
1180 "name": "A String", # Location name.
1181 },
1182 "published": "A String", # RFC 3339 date-time when this Post was published.
1183 "images": [ # Display image for the Post.
1184 {
1185 "url": "A String",
1186 },
1187 ],
1188 "title": "A String", # The title of the Post.
1189 "id": "A String", # The identifier of this Post.
1190 "selfLink": "A String", # The API REST URL to fetch this resource from.
1191 }</pre>
1192</div>
1193
1194</body></html>