Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f4839b0d74d8678a8e08964ce3e5899a77d8375f / . / docs / dyn / blogger_v3.posts.html
blob: ba3807079734ada0779011020083063683ca1075 [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="blogger_v3.html">Blogger API</a> . <a href="blogger_v3.posts.html">posts</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(blogId, postId)</a></code></p>
79<p class="firstline">Delete a post by id.</p>
80<p class="toc_element">
81 <code><a href="#get">get(blogId, postId, maxComments=None)</a></code></p>
82<p class="firstline">Get a post by id.</p>
83<p class="toc_element">
84 <code><a href="#getByPath">getByPath(blogId, path=None, maxComments=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)</a></code></p>
88<p class="firstline">Add a post.</p>
89<p class="toc_element">
90 <code><a href="#list">list(blogId, startDate=None, endDate=None, pageToken=None, labels=None, maxResults=None, fetchBodies=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)</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="#search">search(blogId, q=None)</a></code></p>
100<p class="firstline">Search for a post.</p>
101<p class="toc_element">
102 <code><a href="#update">update(blogId, postId, body)</a></code></p>
103<p class="firstline">Update a post.</p>
104<h3>Method Details</h3>
105<div class="method">
106 <code class="details" id="delete">delete(blogId, postId)</code>
107 <pre>Delete a post by id.
108
109Args:
110 blogId: string, The Id of the Blog. (required)
111 postId: string, The ID of the Post. (required)
112</pre>
113</div>
114
115<div class="method">
116 <code class="details" id="get">get(blogId, postId, maxComments=None)</code>
117 <pre>Get a post by id.
118
119Args:
120 blogId: string, ID of the blog to fetch the post from. (required)
121 postId: string, The ID of the post (required)
122 maxComments: integer, Maximum number of comments to pull back on a post.
123
124Returns:
125 An object of the form:
126
127 {
128 "content": "A String", # The content of the Post. May contain HTML markup.
129 "kind": "blogger#post", # The kind of this entity. Always blogger#post
130 "author": { # The author of this Post.
131 "url": "A String", # The URL of the Post creator's Profile page.
132 "image": { # The Post author's avatar.
133 "url": "A String", # The Post author's avatar URL.
134 },
135 "displayName": "A String", # The display name.
136 "id": "A String", # The identifier of the Post creator.
137 },
138 "replies": { # The container of comments on this Post.
139 "totalItems": "A String", # The count of comments on this post.
140 "items": [ # The List of Comments for this Post.
141 {
142 "content": "A String", # The actual content of the comment. May include HTML markup.
143 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
144 "inReplyTo": { # Data about the comment this is in reply to.
145 "id": "A String", # The identified of the parent of this comment.
146 },
147 "author": { # The author of this Comment.
148 "url": "A String", # The URL of the Comment creator's Profile page.
149 "image": { # The comment creator's avatar.
150 "url": "A String", # The comment creator's avatar URL.
151 },
152 "displayName": "A String", # The display name.
153 "id": "A String", # The identifier of the Comment creator.
154 },
155 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
156 "blog": { # Data about the blog containing this comment.
157 "id": "A String", # The identifier of the blog containing this comment.
158 },
159 "published": "A String", # RFC 3339 date-time when this comment was published.
160 "post": { # Data about the post containing this comment.
161 "id": "A String", # The identifier of the post containing this comment.
162 },
163 "id": "A String", # The identifier for this resource.
164 "selfLink": "A String", # The API REST URL to fetch this resource from.
165 },
166 ],
167 "selfLink": "A String", # The URL of the comments on this post.
168 },
169 "labels": [ # The list of labels this Post was tagged with.
170 "A String",
171 ],
172 "customMetaData": "A String", # The JSON meta-data for the Post.
173 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
174 "blog": { # Data about the blog containing this Post.
175 "id": "A String", # The identifier of the Blog that contains this Post.
176 },
177 "url": "A String", # The URL where this Post is displayed.
178 "location": { # The location for geotagged posts.
179 "lat": 3.14, # Location's latitude.
180 "lng": 3.14, # Location's longitude.
181 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
182 "name": "A String", # Location name.
183 },
184 "published": "A String", # RFC 3339 date-time when this Post was published.
185 "title": "A String", # The title of the Post.
186 "id": "A String", # The identifier of this Post.
187 "selfLink": "A String", # The API REST URL to fetch this resource from.
188 }</pre>
189</div>
190
191<div class="method">
192 <code class="details" id="getByPath">getByPath(blogId, path=None, maxComments=None)</code>
193 <pre>Retrieve a Post by Path.
194
195Args:
196 blogId: string, ID of the blog to fetch the post from. (required)
197 path: string, Path of the Post to retrieve.
198 maxComments: integer, Maximum number of comments to pull back on a post.
199
200Returns:
201 An object of the form:
202
203 {
204 "content": "A String", # The content of the Post. May contain HTML markup.
205 "kind": "blogger#post", # The kind of this entity. Always blogger#post
206 "author": { # The author of this Post.
207 "url": "A String", # The URL of the Post creator's Profile page.
208 "image": { # The Post author's avatar.
209 "url": "A String", # The Post author's avatar URL.
210 },
211 "displayName": "A String", # The display name.
212 "id": "A String", # The identifier of the Post creator.
213 },
214 "replies": { # The container of comments on this Post.
215 "totalItems": "A String", # The count of comments on this post.
216 "items": [ # The List of Comments for this Post.
217 {
218 "content": "A String", # The actual content of the comment. May include HTML markup.
219 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
220 "inReplyTo": { # Data about the comment this is in reply to.
221 "id": "A String", # The identified of the parent of this comment.
222 },
223 "author": { # The author of this Comment.
224 "url": "A String", # The URL of the Comment creator's Profile page.
225 "image": { # The comment creator's avatar.
226 "url": "A String", # The comment creator's avatar URL.
227 },
228 "displayName": "A String", # The display name.
229 "id": "A String", # The identifier of the Comment creator.
230 },
231 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
232 "blog": { # Data about the blog containing this comment.
233 "id": "A String", # The identifier of the blog containing this comment.
234 },
235 "published": "A String", # RFC 3339 date-time when this comment was published.
236 "post": { # Data about the post containing this comment.
237 "id": "A String", # The identifier of the post containing this comment.
238 },
239 "id": "A String", # The identifier for this resource.
240 "selfLink": "A String", # The API REST URL to fetch this resource from.
241 },
242 ],
243 "selfLink": "A String", # The URL of the comments on this post.
244 },
245 "labels": [ # The list of labels this Post was tagged with.
246 "A String",
247 ],
248 "customMetaData": "A String", # The JSON meta-data for the Post.
249 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
250 "blog": { # Data about the blog containing this Post.
251 "id": "A String", # The identifier of the Blog that contains this Post.
252 },
253 "url": "A String", # The URL where this Post is displayed.
254 "location": { # The location for geotagged posts.
255 "lat": 3.14, # Location's latitude.
256 "lng": 3.14, # Location's longitude.
257 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
258 "name": "A String", # Location name.
259 },
260 "published": "A String", # RFC 3339 date-time when this Post was published.
261 "title": "A String", # The title of the Post.
262 "id": "A String", # The identifier of this Post.
263 "selfLink": "A String", # The API REST URL to fetch this resource from.
264 }</pre>
265</div>
266
267<div class="method">
268 <code class="details" id="insert">insert(blogId, body)</code>
269 <pre>Add a post.
270
271Args:
272 blogId: string, ID of the blog to fetch the post from. (required)
273 body: object, The request body. (required)
274 The object takes the form of:
275
276{
277 "content": "A String", # The content of the Post. May contain HTML markup.
278 "kind": "blogger#post", # The kind of this entity. Always blogger#post
279 "author": { # The author of this Post.
280 "url": "A String", # The URL of the Post creator's Profile page.
281 "image": { # The Post author's avatar.
282 "url": "A String", # The Post author's avatar URL.
283 },
284 "displayName": "A String", # The display name.
285 "id": "A String", # The identifier of the Post creator.
286 },
287 "replies": { # The container of comments on this Post.
288 "totalItems": "A String", # The count of comments on this post.
289 "items": [ # The List of Comments for this Post.
290 {
291 "content": "A String", # The actual content of the comment. May include HTML markup.
292 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
293 "inReplyTo": { # Data about the comment this is in reply to.
294 "id": "A String", # The identified of the parent of this comment.
295 },
296 "author": { # The author of this Comment.
297 "url": "A String", # The URL of the Comment creator's Profile page.
298 "image": { # The comment creator's avatar.
299 "url": "A String", # The comment creator's avatar URL.
300 },
301 "displayName": "A String", # The display name.
302 "id": "A String", # The identifier of the Comment creator.
303 },
304 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
305 "blog": { # Data about the blog containing this comment.
306 "id": "A String", # The identifier of the blog containing this comment.
307 },
308 "published": "A String", # RFC 3339 date-time when this comment was published.
309 "post": { # Data about the post containing this comment.
310 "id": "A String", # The identifier of the post containing this comment.
311 },
312 "id": "A String", # The identifier for this resource.
313 "selfLink": "A String", # The API REST URL to fetch this resource from.
314 },
315 ],
316 "selfLink": "A String", # The URL of the comments on this post.
317 },
318 "labels": [ # The list of labels this Post was tagged with.
319 "A String",
320 ],
321 "customMetaData": "A String", # The JSON meta-data for the Post.
322 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
323 "blog": { # Data about the blog containing this Post.
324 "id": "A String", # The identifier of the Blog that contains this Post.
325 },
326 "url": "A String", # The URL where this Post is displayed.
327 "location": { # The location for geotagged posts.
328 "lat": 3.14, # Location's latitude.
329 "lng": 3.14, # Location's longitude.
330 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
331 "name": "A String", # Location name.
332 },
333 "published": "A String", # RFC 3339 date-time when this Post was published.
334 "title": "A String", # The title of the Post.
335 "id": "A String", # The identifier of this Post.
336 "selfLink": "A String", # The API REST URL to fetch this resource from.
337}
338
339
340Returns:
341 An object of the form:
342
343 {
344 "content": "A String", # The content of the Post. May contain HTML markup.
345 "kind": "blogger#post", # The kind of this entity. Always blogger#post
346 "author": { # The author of this Post.
347 "url": "A String", # The URL of the Post creator's Profile page.
348 "image": { # The Post author's avatar.
349 "url": "A String", # The Post author's avatar URL.
350 },
351 "displayName": "A String", # The display name.
352 "id": "A String", # The identifier of the Post creator.
353 },
354 "replies": { # The container of comments on this Post.
355 "totalItems": "A String", # The count of comments on this post.
356 "items": [ # The List of Comments for this Post.
357 {
358 "content": "A String", # The actual content of the comment. May include HTML markup.
359 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
360 "inReplyTo": { # Data about the comment this is in reply to.
361 "id": "A String", # The identified of the parent of this comment.
362 },
363 "author": { # The author of this Comment.
364 "url": "A String", # The URL of the Comment creator's Profile page.
365 "image": { # The comment creator's avatar.
366 "url": "A String", # The comment creator's avatar URL.
367 },
368 "displayName": "A String", # The display name.
369 "id": "A String", # The identifier of the Comment creator.
370 },
371 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
372 "blog": { # Data about the blog containing this comment.
373 "id": "A String", # The identifier of the blog containing this comment.
374 },
375 "published": "A String", # RFC 3339 date-time when this comment was published.
376 "post": { # Data about the post containing this comment.
377 "id": "A String", # The identifier of the post containing this comment.
378 },
379 "id": "A String", # The identifier for this resource.
380 "selfLink": "A String", # The API REST URL to fetch this resource from.
381 },
382 ],
383 "selfLink": "A String", # The URL of the comments on this post.
384 },
385 "labels": [ # The list of labels this Post was tagged with.
386 "A String",
387 ],
388 "customMetaData": "A String", # The JSON meta-data for the Post.
389 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
390 "blog": { # Data about the blog containing this Post.
391 "id": "A String", # The identifier of the Blog that contains this Post.
392 },
393 "url": "A String", # The URL where this Post is displayed.
394 "location": { # The location for geotagged posts.
395 "lat": 3.14, # Location's latitude.
396 "lng": 3.14, # Location's longitude.
397 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
398 "name": "A String", # Location name.
399 },
400 "published": "A String", # RFC 3339 date-time when this Post was published.
401 "title": "A String", # The title of the Post.
402 "id": "A String", # The identifier of this Post.
403 "selfLink": "A String", # The API REST URL to fetch this resource from.
404 }</pre>
405</div>
406
407<div class="method">
408 <code class="details" id="list">list(blogId, startDate=None, endDate=None, pageToken=None, labels=None, maxResults=None, fetchBodies=None)</code>
409 <pre>Retrieves a list of posts, possibly filtered.
410
411Args:
412 blogId: string, ID of the blog to fetch posts from. (required)
413 startDate: string, Earliest post date to fetch, a date-time with RFC 3339 formatting.
414 endDate: string, Latest post date to fetch, a date-time with RFC 3339 formatting.
415 pageToken: string, Continuation token if the request is paged.
416 labels: string, Comma-separated list of labels to search for.
417 maxResults: integer, Maximum number of posts to fetch.
418 fetchBodies: boolean, Whether the body content of posts is included.
419
420Returns:
421 An object of the form:
422
423 {
424 "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
425 "items": [ # The list of Posts for this Blog.
426 {
427 "content": "A String", # The content of the Post. May contain HTML markup.
428 "kind": "blogger#post", # The kind of this entity. Always blogger#post
429 "author": { # The author of this Post.
430 "url": "A String", # The URL of the Post creator's Profile page.
431 "image": { # The Post author's avatar.
432 "url": "A String", # The Post author's avatar URL.
433 },
434 "displayName": "A String", # The display name.
435 "id": "A String", # The identifier of the Post creator.
436 },
437 "replies": { # The container of comments on this Post.
438 "totalItems": "A String", # The count of comments on this post.
439 "items": [ # The List of Comments for this Post.
440 {
441 "content": "A String", # The actual content of the comment. May include HTML markup.
442 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
443 "inReplyTo": { # Data about the comment this is in reply to.
444 "id": "A String", # The identified of the parent of this comment.
445 },
446 "author": { # The author of this Comment.
447 "url": "A String", # The URL of the Comment creator's Profile page.
448 "image": { # The comment creator's avatar.
449 "url": "A String", # The comment creator's avatar URL.
450 },
451 "displayName": "A String", # The display name.
452 "id": "A String", # The identifier of the Comment creator.
453 },
454 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
455 "blog": { # Data about the blog containing this comment.
456 "id": "A String", # The identifier of the blog containing this comment.
457 },
458 "published": "A String", # RFC 3339 date-time when this comment was published.
459 "post": { # Data about the post containing this comment.
460 "id": "A String", # The identifier of the post containing this comment.
461 },
462 "id": "A String", # The identifier for this resource.
463 "selfLink": "A String", # The API REST URL to fetch this resource from.
464 },
465 ],
466 "selfLink": "A String", # The URL of the comments on this post.
467 },
468 "labels": [ # The list of labels this Post was tagged with.
469 "A String",
470 ],
471 "customMetaData": "A String", # The JSON meta-data for the Post.
472 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
473 "blog": { # Data about the blog containing this Post.
474 "id": "A String", # The identifier of the Blog that contains this Post.
475 },
476 "url": "A String", # The URL where this Post is displayed.
477 "location": { # The location for geotagged posts.
478 "lat": 3.14, # Location's latitude.
479 "lng": 3.14, # Location's longitude.
480 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
481 "name": "A String", # Location name.
482 },
483 "published": "A String", # RFC 3339 date-time when this Post was published.
484 "title": "A String", # The title of the Post.
485 "id": "A String", # The identifier of this Post.
486 "selfLink": "A String", # The API REST URL to fetch this resource from.
487 },
488 ],
489 "kind": "blogger#postList", # The kind of this entity. Always blogger#postList
490 "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
491 }</pre>
492</div>
493
494<div class="method">
495 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
496 <pre>Retrieves the next page of results.
497
498Args:
499 previous_request: The request for the previous page. (required)
500 previous_response: The response from the request for the previous page. (required)
501
502Returns:
503 A request object that you can call 'execute()' on to request the next
504 page. Returns None if there are no more items in the collection.
505 </pre>
506</div>
507
508<div class="method">
509 <code class="details" id="patch">patch(blogId, postId, body)</code>
510 <pre>Update a post. This method supports patch semantics.
511
512Args:
513 blogId: string, The ID of the Blog. (required)
514 postId: string, The ID of the Post. (required)
515 body: object, The request body. (required)
516 The object takes the form of:
517
518{
519 "content": "A String", # The content of the Post. May contain HTML markup.
520 "kind": "blogger#post", # The kind of this entity. Always blogger#post
521 "author": { # The author of this Post.
522 "url": "A String", # The URL of the Post creator's Profile page.
523 "image": { # The Post author's avatar.
524 "url": "A String", # The Post author's avatar URL.
525 },
526 "displayName": "A String", # The display name.
527 "id": "A String", # The identifier of the Post creator.
528 },
529 "replies": { # The container of comments on this Post.
530 "totalItems": "A String", # The count of comments on this post.
531 "items": [ # The List of Comments for this Post.
532 {
533 "content": "A String", # The actual content of the comment. May include HTML markup.
534 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
535 "inReplyTo": { # Data about the comment this is in reply to.
536 "id": "A String", # The identified of the parent of this comment.
537 },
538 "author": { # The author of this Comment.
539 "url": "A String", # The URL of the Comment creator's Profile page.
540 "image": { # The comment creator's avatar.
541 "url": "A String", # The comment creator's avatar URL.
542 },
543 "displayName": "A String", # The display name.
544 "id": "A String", # The identifier of the Comment creator.
545 },
546 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
547 "blog": { # Data about the blog containing this comment.
548 "id": "A String", # The identifier of the blog containing this comment.
549 },
550 "published": "A String", # RFC 3339 date-time when this comment was published.
551 "post": { # Data about the post containing this comment.
552 "id": "A String", # The identifier of the post containing this comment.
553 },
554 "id": "A String", # The identifier for this resource.
555 "selfLink": "A String", # The API REST URL to fetch this resource from.
556 },
557 ],
558 "selfLink": "A String", # The URL of the comments on this post.
559 },
560 "labels": [ # The list of labels this Post was tagged with.
561 "A String",
562 ],
563 "customMetaData": "A String", # The JSON meta-data for the Post.
564 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
565 "blog": { # Data about the blog containing this Post.
566 "id": "A String", # The identifier of the Blog that contains this Post.
567 },
568 "url": "A String", # The URL where this Post is displayed.
569 "location": { # The location for geotagged posts.
570 "lat": 3.14, # Location's latitude.
571 "lng": 3.14, # Location's longitude.
572 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
573 "name": "A String", # Location name.
574 },
575 "published": "A String", # RFC 3339 date-time when this Post was published.
576 "title": "A String", # The title of the Post.
577 "id": "A String", # The identifier of this Post.
578 "selfLink": "A String", # The API REST URL to fetch this resource from.
579}
580
581
582Returns:
583 An object of the form:
584
585 {
586 "content": "A String", # The content of the Post. May contain HTML markup.
587 "kind": "blogger#post", # The kind of this entity. Always blogger#post
588 "author": { # The author of this Post.
589 "url": "A String", # The URL of the Post creator's Profile page.
590 "image": { # The Post author's avatar.
591 "url": "A String", # The Post author's avatar URL.
592 },
593 "displayName": "A String", # The display name.
594 "id": "A String", # The identifier of the Post creator.
595 },
596 "replies": { # The container of comments on this Post.
597 "totalItems": "A String", # The count of comments on this post.
598 "items": [ # The List of Comments for this Post.
599 {
600 "content": "A String", # The actual content of the comment. May include HTML markup.
601 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
602 "inReplyTo": { # Data about the comment this is in reply to.
603 "id": "A String", # The identified of the parent of this comment.
604 },
605 "author": { # The author of this Comment.
606 "url": "A String", # The URL of the Comment creator's Profile page.
607 "image": { # The comment creator's avatar.
608 "url": "A String", # The comment creator's avatar URL.
609 },
610 "displayName": "A String", # The display name.
611 "id": "A String", # The identifier of the Comment creator.
612 },
613 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
614 "blog": { # Data about the blog containing this comment.
615 "id": "A String", # The identifier of the blog containing this comment.
616 },
617 "published": "A String", # RFC 3339 date-time when this comment was published.
618 "post": { # Data about the post containing this comment.
619 "id": "A String", # The identifier of the post containing this comment.
620 },
621 "id": "A String", # The identifier for this resource.
622 "selfLink": "A String", # The API REST URL to fetch this resource from.
623 },
624 ],
625 "selfLink": "A String", # The URL of the comments on this post.
626 },
627 "labels": [ # The list of labels this Post was tagged with.
628 "A String",
629 ],
630 "customMetaData": "A String", # The JSON meta-data for the Post.
631 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
632 "blog": { # Data about the blog containing this Post.
633 "id": "A String", # The identifier of the Blog that contains this Post.
634 },
635 "url": "A String", # The URL where this Post is displayed.
636 "location": { # The location for geotagged posts.
637 "lat": 3.14, # Location's latitude.
638 "lng": 3.14, # Location's longitude.
639 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
640 "name": "A String", # Location name.
641 },
642 "published": "A String", # RFC 3339 date-time when this Post was published.
643 "title": "A String", # The title of the Post.
644 "id": "A String", # The identifier of this Post.
645 "selfLink": "A String", # The API REST URL to fetch this resource from.
646 }</pre>
647</div>
648
649<div class="method">
650 <code class="details" id="search">search(blogId, q=None)</code>
651 <pre>Search for a post.
652
653Args:
654 blogId: string, ID of the blog to fetch the post from. (required)
655 q: string, Query terms to search this blog for matching posts.
656
657Returns:
658 An object of the form:
659
660 {
661 "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
662 "items": [ # The list of Posts for this Blog.
663 {
664 "content": "A String", # The content of the Post. May contain HTML markup.
665 "kind": "blogger#post", # The kind of this entity. Always blogger#post
666 "author": { # The author of this Post.
667 "url": "A String", # The URL of the Post creator's Profile page.
668 "image": { # The Post author's avatar.
669 "url": "A String", # The Post author's avatar URL.
670 },
671 "displayName": "A String", # The display name.
672 "id": "A String", # The identifier of the Post creator.
673 },
674 "replies": { # The container of comments on this Post.
675 "totalItems": "A String", # The count of comments on this post.
676 "items": [ # The List of Comments for this Post.
677 {
678 "content": "A String", # The actual content of the comment. May include HTML markup.
679 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
680 "inReplyTo": { # Data about the comment this is in reply to.
681 "id": "A String", # The identified of the parent of this comment.
682 },
683 "author": { # The author of this Comment.
684 "url": "A String", # The URL of the Comment creator's Profile page.
685 "image": { # The comment creator's avatar.
686 "url": "A String", # The comment creator's avatar URL.
687 },
688 "displayName": "A String", # The display name.
689 "id": "A String", # The identifier of the Comment creator.
690 },
691 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
692 "blog": { # Data about the blog containing this comment.
693 "id": "A String", # The identifier of the blog containing this comment.
694 },
695 "published": "A String", # RFC 3339 date-time when this comment was published.
696 "post": { # Data about the post containing this comment.
697 "id": "A String", # The identifier of the post containing this comment.
698 },
699 "id": "A String", # The identifier for this resource.
700 "selfLink": "A String", # The API REST URL to fetch this resource from.
701 },
702 ],
703 "selfLink": "A String", # The URL of the comments on this post.
704 },
705 "labels": [ # The list of labels this Post was tagged with.
706 "A String",
707 ],
708 "customMetaData": "A String", # The JSON meta-data for the Post.
709 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
710 "blog": { # Data about the blog containing this Post.
711 "id": "A String", # The identifier of the Blog that contains this Post.
712 },
713 "url": "A String", # The URL where this Post is displayed.
714 "location": { # The location for geotagged posts.
715 "lat": 3.14, # Location's latitude.
716 "lng": 3.14, # Location's longitude.
717 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
718 "name": "A String", # Location name.
719 },
720 "published": "A String", # RFC 3339 date-time when this Post was published.
721 "title": "A String", # The title of the Post.
722 "id": "A String", # The identifier of this Post.
723 "selfLink": "A String", # The API REST URL to fetch this resource from.
724 },
725 ],
726 "kind": "blogger#postList", # The kind of this entity. Always blogger#postList
727 "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
728 }</pre>
729</div>
730
731<div class="method">
732 <code class="details" id="update">update(blogId, postId, body)</code>
733 <pre>Update a post.
734
735Args:
736 blogId: string, The ID of the Blog. (required)
737 postId: string, The ID of the Post. (required)
738 body: object, The request body. (required)
739 The object takes the form of:
740
741{
742 "content": "A String", # The content of the Post. May contain HTML markup.
743 "kind": "blogger#post", # The kind of this entity. Always blogger#post
744 "author": { # The author of this Post.
745 "url": "A String", # The URL of the Post creator's Profile page.
746 "image": { # The Post author's avatar.
747 "url": "A String", # The Post author's avatar URL.
748 },
749 "displayName": "A String", # The display name.
750 "id": "A String", # The identifier of the Post creator.
751 },
752 "replies": { # The container of comments on this Post.
753 "totalItems": "A String", # The count of comments on this post.
754 "items": [ # The List of Comments for this Post.
755 {
756 "content": "A String", # The actual content of the comment. May include HTML markup.
757 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
758 "inReplyTo": { # Data about the comment this is in reply to.
759 "id": "A String", # The identified of the parent of this comment.
760 },
761 "author": { # The author of this Comment.
762 "url": "A String", # The URL of the Comment creator's Profile page.
763 "image": { # The comment creator's avatar.
764 "url": "A String", # The comment creator's avatar URL.
765 },
766 "displayName": "A String", # The display name.
767 "id": "A String", # The identifier of the Comment creator.
768 },
769 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
770 "blog": { # Data about the blog containing this comment.
771 "id": "A String", # The identifier of the blog containing this comment.
772 },
773 "published": "A String", # RFC 3339 date-time when this comment was published.
774 "post": { # Data about the post containing this comment.
775 "id": "A String", # The identifier of the post containing this comment.
776 },
777 "id": "A String", # The identifier for this resource.
778 "selfLink": "A String", # The API REST URL to fetch this resource from.
779 },
780 ],
781 "selfLink": "A String", # The URL of the comments on this post.
782 },
783 "labels": [ # The list of labels this Post was tagged with.
784 "A String",
785 ],
786 "customMetaData": "A String", # The JSON meta-data for the Post.
787 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
788 "blog": { # Data about the blog containing this Post.
789 "id": "A String", # The identifier of the Blog that contains this Post.
790 },
791 "url": "A String", # The URL where this Post is displayed.
792 "location": { # The location for geotagged posts.
793 "lat": 3.14, # Location's latitude.
794 "lng": 3.14, # Location's longitude.
795 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
796 "name": "A String", # Location name.
797 },
798 "published": "A String", # RFC 3339 date-time when this Post was published.
799 "title": "A String", # The title of the Post.
800 "id": "A String", # The identifier of this Post.
801 "selfLink": "A String", # The API REST URL to fetch this resource from.
802}
803
804
805Returns:
806 An object of the form:
807
808 {
809 "content": "A String", # The content of the Post. May contain HTML markup.
810 "kind": "blogger#post", # The kind of this entity. Always blogger#post
811 "author": { # The author of this Post.
812 "url": "A String", # The URL of the Post creator's Profile page.
813 "image": { # The Post author's avatar.
814 "url": "A String", # The Post author's avatar URL.
815 },
816 "displayName": "A String", # The display name.
817 "id": "A String", # The identifier of the Post creator.
818 },
819 "replies": { # The container of comments on this Post.
820 "totalItems": "A String", # The count of comments on this post.
821 "items": [ # The List of Comments for this Post.
822 {
823 "content": "A String", # The actual content of the comment. May include HTML markup.
824 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
825 "inReplyTo": { # Data about the comment this is in reply to.
826 "id": "A String", # The identified of the parent of this comment.
827 },
828 "author": { # The author of this Comment.
829 "url": "A String", # The URL of the Comment creator's Profile page.
830 "image": { # The comment creator's avatar.
831 "url": "A String", # The comment creator's avatar URL.
832 },
833 "displayName": "A String", # The display name.
834 "id": "A String", # The identifier of the Comment creator.
835 },
836 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
837 "blog": { # Data about the blog containing this comment.
838 "id": "A String", # The identifier of the blog containing this comment.
839 },
840 "published": "A String", # RFC 3339 date-time when this comment was published.
841 "post": { # Data about the post containing this comment.
842 "id": "A String", # The identifier of the post containing this comment.
843 },
844 "id": "A String", # The identifier for this resource.
845 "selfLink": "A String", # The API REST URL to fetch this resource from.
846 },
847 ],
848 "selfLink": "A String", # The URL of the comments on this post.
849 },
850 "labels": [ # The list of labels this Post was tagged with.
851 "A String",
852 ],
853 "customMetaData": "A String", # The JSON meta-data for the Post.
854 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
855 "blog": { # Data about the blog containing this Post.
856 "id": "A String", # The identifier of the Blog that contains this Post.
857 },
858 "url": "A String", # The URL where this Post is displayed.
859 "location": { # The location for geotagged posts.
860 "lat": 3.14, # Location's latitude.
861 "lng": 3.14, # Location's longitude.
862 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
863 "name": "A String", # Location name.
864 },
865 "published": "A String", # RFC 3339 date-time when this Post was published.
866 "title": "A String", # The title of the Post.
867 "id": "A String", # The identifier of this Post.
868 "selfLink": "A String", # The API REST URL to fetch this resource from.
869 }</pre>
870</div>
871
872</body></html>