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.blogs.html">blogs</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#get">get(blogId, maxPosts=None, view=None)</a></code></p>
79<p class="firstline">Gets one blog by ID.</p>
80<p class="toc_element">
81  <code><a href="#getByUrl">getByUrl(url, view=None)</a></code></p>
82<p class="firstline">Retrieve a Blog by URL.</p>
83<p class="toc_element">
84  <code><a href="#listByUser">listByUser(userId, status=None, fetchUserInfo=None, role=None, view=None)</a></code></p>
85<p class="firstline">Retrieves a list of blogs, possibly filtered.</p>
86<h3>Method Details</h3>
87<div class="method">
88    <code class="details" id="get">get(blogId, maxPosts=None, view=None)</code>
89  <pre>Gets one blog by ID.
90
91Args:
92  blogId: string, The ID of the blog to get. (required)
93  maxPosts: integer, Maximum number of posts to pull back with the blog.
94  view: string, Access level with which to view the blog. Note that some fields require elevated access.
95    Allowed values
96      ADMIN - Admin level detail.
97      AUTHOR - Author level detail.
98      READER - Reader level detail.
99
100Returns:
101  An object of the form:
102
103    {
104    "status": "A String", # The status of the blog.
105    "kind": "blogger#blog", # The kind of this entry. Always blogger#blog
106    "description": "A String", # The description of this blog. This is displayed underneath the title.
107    "locale": { # The locale this Blog is set to.
108      "country": "A String", # The country this blog's locale is set to.
109      "variant": "A String", # The language variant this blog is authored in.
110      "language": "A String", # The language this blog is authored in.
111    },
112    "posts": { # The container of posts in this blog.
113      "totalItems": 42, # The count of posts in this blog.
114      "items": [ # The List of Posts for this Blog.
115        {
116          "status": "A String", # Status of the post. Only set for admin-level requests
117          "content": "A String", # The content of the Post. May contain HTML markup.
118          "kind": "blogger#post", # The kind of this entity. Always blogger#post
119          "titleLink": "A String", # The title link URL, similar to atom's related link.
120          "author": { # The author of this Post.
121            "url": "A String", # The URL of the Post creator's Profile page.
122            "image": { # The Post author's avatar.
123              "url": "A String", # The Post author's avatar URL.
124            },
125            "displayName": "A String", # The display name.
126            "id": "A String", # The identifier of the Post creator.
127          },
128          "replies": { # The container of comments on this Post.
129            "totalItems": "A String", # The count of comments on this post.
130            "items": [ # The List of Comments for this Post.
131              {
132                "status": "A String", # The status of the comment (only populated for admin users)
133                "content": "A String", # The actual content of the comment. May include HTML markup.
134                "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
135                "inReplyTo": { # Data about the comment this is in reply to.
136                  "id": "A String", # The identified of the parent of this comment.
137                },
138                "author": { # The author of this Comment.
139                  "url": "A String", # The URL of the Comment creator's Profile page.
140                  "image": { # The comment creator's avatar.
141                    "url": "A String", # The comment creator's avatar URL.
142                  },
143                  "displayName": "A String", # The display name.
144                  "id": "A String", # The identifier of the Comment creator.
145                },
146                "updated": "A String", # RFC 3339 date-time when this comment was last updated.
147                "blog": { # Data about the blog containing this comment.
148                  "id": "A String", # The identifier of the blog containing this comment.
149                },
150                "published": "A String", # RFC 3339 date-time when this comment was published.
151                "post": { # Data about the post containing this comment.
152                  "id": "A String", # The identifier of the post containing this comment.
153                },
154                "id": "A String", # The identifier for this resource.
155                "selfLink": "A String", # The API REST URL to fetch this resource from.
156              },
157            ],
158            "selfLink": "A String", # The URL of the comments on this post.
159          },
160          "readerComments": "A String", # Comment control and display setting for readers of this post.
161          "labels": [ # The list of labels this Post was tagged with.
162            "A String",
163          ],
164          "customMetaData": "A String", # The JSON meta-data for the Post.
165          "updated": "A String", # RFC 3339 date-time when this Post was last updated.
166          "blog": { # Data about the blog containing this Post.
167            "id": "A String", # The identifier of the Blog that contains this Post.
168          },
169          "url": "A String", # The URL where this Post is displayed.
170          "etag": "A String", # Etag of the resource.
171          "location": { # The location for geotagged posts.
172            "lat": 3.14, # Location's latitude.
173            "lng": 3.14, # Location's longitude.
174            "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
175            "name": "A String", # Location name.
176          },
177          "published": "A String", # RFC 3339 date-time when this Post was published.
178          "images": [ # Display image for the Post.
179            {
180              "url": "A String",
181            },
182          ],
183          "title": "A String", # The title of the Post.
184          "id": "A String", # The identifier of this Post.
185          "selfLink": "A String", # The API REST URL to fetch this resource from.
186        },
187      ],
188      "selfLink": "A String", # The URL of the container for posts in this blog.
189    },
190    "customMetaData": "A String", # The JSON custom meta-data for the Blog
191    "updated": "A String", # RFC 3339 date-time when this blog was last updated.
192    "pages": { # The container of pages in this blog.
193      "totalItems": 42, # The count of pages in this blog.
194      "selfLink": "A String", # The URL of the container for pages in this blog.
195    },
196    "url": "A String", # The URL where this blog is published.
197    "published": "A String", # RFC 3339 date-time when this blog was published.
198    "id": "A String", # The identifier for this resource.
199    "selfLink": "A String", # The API REST URL to fetch this resource from.
200    "name": "A String", # The name of this blog. This is displayed as the title.
201  }</pre>
202</div>
203
204<div class="method">
205    <code class="details" id="getByUrl">getByUrl(url, view=None)</code>
206  <pre>Retrieve a Blog by URL.
207
208Args:
209  url: string, The URL of the blog to retrieve. (required)
210  view: string, Access level with which to view the blog. Note that some fields require elevated access.
211    Allowed values
212      ADMIN - Admin level detail.
213      AUTHOR - Author level detail.
214      READER - Reader level detail.
215
216Returns:
217  An object of the form:
218
219    {
220    "status": "A String", # The status of the blog.
221    "kind": "blogger#blog", # The kind of this entry. Always blogger#blog
222    "description": "A String", # The description of this blog. This is displayed underneath the title.
223    "locale": { # The locale this Blog is set to.
224      "country": "A String", # The country this blog's locale is set to.
225      "variant": "A String", # The language variant this blog is authored in.
226      "language": "A String", # The language this blog is authored in.
227    },
228    "posts": { # The container of posts in this blog.
229      "totalItems": 42, # The count of posts in this blog.
230      "items": [ # The List of Posts for this Blog.
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          },
276          "readerComments": "A String", # Comment control and display setting for readers of this post.
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.
286          "etag": "A String", # Etag of the resource.
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        },
303      ],
304      "selfLink": "A String", # The URL of the container for posts in this blog.
305    },
306    "customMetaData": "A String", # The JSON custom meta-data for the Blog
307    "updated": "A String", # RFC 3339 date-time when this blog was last updated.
308    "pages": { # The container of pages in this blog.
309      "totalItems": 42, # The count of pages in this blog.
310      "selfLink": "A String", # The URL of the container for pages in this blog.
311    },
312    "url": "A String", # The URL where this blog is published.
313    "published": "A String", # RFC 3339 date-time when this blog was published.
314    "id": "A String", # The identifier for this resource.
315    "selfLink": "A String", # The API REST URL to fetch this resource from.
316    "name": "A String", # The name of this blog. This is displayed as the title.
317  }</pre>
318</div>
319
320<div class="method">
321    <code class="details" id="listByUser">listByUser(userId, status=None, fetchUserInfo=None, role=None, view=None)</code>
322  <pre>Retrieves a list of blogs, possibly filtered.
323
324Args:
325  userId: string, ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. (required)
326  status: string, Blog statuses to include in the result (default: Live blogs only). Note that ADMIN access is required to view deleted blogs. (repeated)
327    Allowed values
328      DELETED - Blog has been deleted by an administrator.
329      LIVE - Blog is currently live.
330  fetchUserInfo: boolean, Whether the response is a list of blogs with per-user information instead of just blogs.
331  role: string, User access types for blogs to include in the results, e.g. AUTHOR will return blogs where the user has author level access. If no roles are specified, defaults to ADMIN and AUTHOR roles. (repeated)
332    Allowed values
333      ADMIN - Admin role - Blogs where the user has Admin level access.
334      AUTHOR - Author role - Blogs where the user has Author level access.
335      READER - Reader role - Blogs where the user has Reader level access (to a private blog).
336  view: string, Access level with which to view the blogs. Note that some fields require elevated access.
337    Allowed values
338      ADMIN - Admin level detail.
339      AUTHOR - Author level detail.
340      READER - Reader level detail.
341
342Returns:
343  An object of the form:
344
345    {
346    "items": [ # The list of Blogs this user has Authorship or Admin rights over.
347      {
348        "status": "A String", # The status of the blog.
349        "kind": "blogger#blog", # The kind of this entry. Always blogger#blog
350        "description": "A String", # The description of this blog. This is displayed underneath the title.
351        "locale": { # The locale this Blog is set to.
352          "country": "A String", # The country this blog's locale is set to.
353          "variant": "A String", # The language variant this blog is authored in.
354          "language": "A String", # The language this blog is authored in.
355        },
356        "posts": { # The container of posts in this blog.
357          "totalItems": 42, # The count of posts in this blog.
358          "items": [ # The List of Posts for this Blog.
359            {
360              "status": "A String", # Status of the post. Only set for admin-level requests
361              "content": "A String", # The content of the Post. May contain HTML markup.
362              "kind": "blogger#post", # The kind of this entity. Always blogger#post
363              "titleLink": "A String", # The title link URL, similar to atom's related link.
364              "author": { # The author of this Post.
365                "url": "A String", # The URL of the Post creator's Profile page.
366                "image": { # The Post author's avatar.
367                  "url": "A String", # The Post author's avatar URL.
368                },
369                "displayName": "A String", # The display name.
370                "id": "A String", # The identifier of the Post creator.
371              },
372              "replies": { # The container of comments on this Post.
373                "totalItems": "A String", # The count of comments on this post.
374                "items": [ # The List of Comments for this Post.
375                  {
376                    "status": "A String", # The status of the comment (only populated for admin users)
377                    "content": "A String", # The actual content of the comment. May include HTML markup.
378                    "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
379                    "inReplyTo": { # Data about the comment this is in reply to.
380                      "id": "A String", # The identified of the parent of this comment.
381                    },
382                    "author": { # The author of this Comment.
383                      "url": "A String", # The URL of the Comment creator's Profile page.
384                      "image": { # The comment creator's avatar.
385                        "url": "A String", # The comment creator's avatar URL.
386                      },
387                      "displayName": "A String", # The display name.
388                      "id": "A String", # The identifier of the Comment creator.
389                    },
390                    "updated": "A String", # RFC 3339 date-time when this comment was last updated.
391                    "blog": { # Data about the blog containing this comment.
392                      "id": "A String", # The identifier of the blog containing this comment.
393                    },
394                    "published": "A String", # RFC 3339 date-time when this comment was published.
395                    "post": { # Data about the post containing this comment.
396                      "id": "A String", # The identifier of the post containing this comment.
397                    },
398                    "id": "A String", # The identifier for this resource.
399                    "selfLink": "A String", # The API REST URL to fetch this resource from.
400                  },
401                ],
402                "selfLink": "A String", # The URL of the comments on this post.
403              },
404              "readerComments": "A String", # Comment control and display setting for readers of this post.
405              "labels": [ # The list of labels this Post was tagged with.
406                "A String",
407              ],
408              "customMetaData": "A String", # The JSON meta-data for the Post.
409              "updated": "A String", # RFC 3339 date-time when this Post was last updated.
410              "blog": { # Data about the blog containing this Post.
411                "id": "A String", # The identifier of the Blog that contains this Post.
412              },
413              "url": "A String", # The URL where this Post is displayed.
414              "etag": "A String", # Etag of the resource.
415              "location": { # The location for geotagged posts.
416                "lat": 3.14, # Location's latitude.
417                "lng": 3.14, # Location's longitude.
418                "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
419                "name": "A String", # Location name.
420              },
421              "published": "A String", # RFC 3339 date-time when this Post was published.
422              "images": [ # Display image for the Post.
423                {
424                  "url": "A String",
425                },
426              ],
427              "title": "A String", # The title of the Post.
428              "id": "A String", # The identifier of this Post.
429              "selfLink": "A String", # The API REST URL to fetch this resource from.
430            },
431          ],
432          "selfLink": "A String", # The URL of the container for posts in this blog.
433        },
434        "customMetaData": "A String", # The JSON custom meta-data for the Blog
435        "updated": "A String", # RFC 3339 date-time when this blog was last updated.
436        "pages": { # The container of pages in this blog.
437          "totalItems": 42, # The count of pages in this blog.
438          "selfLink": "A String", # The URL of the container for pages in this blog.
439        },
440        "url": "A String", # The URL where this blog is published.
441        "published": "A String", # RFC 3339 date-time when this blog was published.
442        "id": "A String", # The identifier for this resource.
443        "selfLink": "A String", # The API REST URL to fetch this resource from.
444        "name": "A String", # The name of this blog. This is displayed as the title.
445      },
446    ],
447    "kind": "blogger#blogList", # The kind of this entity. Always blogger#blogList
448    "blogUserInfos": [ # Admin level list of blog per-user information
449      {
450        "blog": { # The Blog resource.
451          "status": "A String", # The status of the blog.
452          "kind": "blogger#blog", # The kind of this entry. Always blogger#blog
453          "description": "A String", # The description of this blog. This is displayed underneath the title.
454          "locale": { # The locale this Blog is set to.
455            "country": "A String", # The country this blog's locale is set to.
456            "variant": "A String", # The language variant this blog is authored in.
457            "language": "A String", # The language this blog is authored in.
458          },
459          "posts": { # The container of posts in this blog.
460            "totalItems": 42, # The count of posts in this blog.
461            "items": [ # The List of Posts for this Blog.
462              {
463                "status": "A String", # Status of the post. Only set for admin-level requests
464                "content": "A String", # The content of the Post. May contain HTML markup.
465                "kind": "blogger#post", # The kind of this entity. Always blogger#post
466                "titleLink": "A String", # The title link URL, similar to atom's related link.
467                "author": { # The author of this Post.
468                  "url": "A String", # The URL of the Post creator's Profile page.
469                  "image": { # The Post author's avatar.
470                    "url": "A String", # The Post author's avatar URL.
471                  },
472                  "displayName": "A String", # The display name.
473                  "id": "A String", # The identifier of the Post creator.
474                },
475                "replies": { # The container of comments on this Post.
476                  "totalItems": "A String", # The count of comments on this post.
477                  "items": [ # The List of Comments for this Post.
478                    {
479                      "status": "A String", # The status of the comment (only populated for admin users)
480                      "content": "A String", # The actual content of the comment. May include HTML markup.
481                      "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
482                      "inReplyTo": { # Data about the comment this is in reply to.
483                        "id": "A String", # The identified of the parent of this comment.
484                      },
485                      "author": { # The author of this Comment.
486                        "url": "A String", # The URL of the Comment creator's Profile page.
487                        "image": { # The comment creator's avatar.
488                          "url": "A String", # The comment creator's avatar URL.
489                        },
490                        "displayName": "A String", # The display name.
491                        "id": "A String", # The identifier of the Comment creator.
492                      },
493                      "updated": "A String", # RFC 3339 date-time when this comment was last updated.
494                      "blog": { # Data about the blog containing this comment.
495                        "id": "A String", # The identifier of the blog containing this comment.
496                      },
497                      "published": "A String", # RFC 3339 date-time when this comment was published.
498                      "post": { # Data about the post containing this comment.
499                        "id": "A String", # The identifier of the post containing this comment.
500                      },
501                      "id": "A String", # The identifier for this resource.
502                      "selfLink": "A String", # The API REST URL to fetch this resource from.
503                    },
504                  ],
505                  "selfLink": "A String", # The URL of the comments on this post.
506                },
507                "readerComments": "A String", # Comment control and display setting for readers of this post.
508                "labels": [ # The list of labels this Post was tagged with.
509                  "A String",
510                ],
511                "customMetaData": "A String", # The JSON meta-data for the Post.
512                "updated": "A String", # RFC 3339 date-time when this Post was last updated.
513                "blog": { # Data about the blog containing this Post.
514                  "id": "A String", # The identifier of the Blog that contains this Post.
515                },
516                "url": "A String", # The URL where this Post is displayed.
517                "etag": "A String", # Etag of the resource.
518                "location": { # The location for geotagged posts.
519                  "lat": 3.14, # Location's latitude.
520                  "lng": 3.14, # Location's longitude.
521                  "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
522                  "name": "A String", # Location name.
523                },
524                "published": "A String", # RFC 3339 date-time when this Post was published.
525                "images": [ # Display image for the Post.
526                  {
527                    "url": "A String",
528                  },
529                ],
530                "title": "A String", # The title of the Post.
531                "id": "A String", # The identifier of this Post.
532                "selfLink": "A String", # The API REST URL to fetch this resource from.
533              },
534            ],
535            "selfLink": "A String", # The URL of the container for posts in this blog.
536          },
537          "customMetaData": "A String", # The JSON custom meta-data for the Blog
538          "updated": "A String", # RFC 3339 date-time when this blog was last updated.
539          "pages": { # The container of pages in this blog.
540            "totalItems": 42, # The count of pages in this blog.
541            "selfLink": "A String", # The URL of the container for pages in this blog.
542          },
543          "url": "A String", # The URL where this blog is published.
544          "published": "A String", # RFC 3339 date-time when this blog was published.
545          "id": "A String", # The identifier for this resource.
546          "selfLink": "A String", # The API REST URL to fetch this resource from.
547          "name": "A String", # The name of this blog. This is displayed as the title.
548        },
549        "kind": "blogger#blogUserInfo", # The kind of this entity. Always blogger#blogUserInfo
550        "blog_user_info": { # Information about a User for the Blog.
551          "hasAdminAccess": True or False, # True if the user has Admin level access to the blog.
552          "kind": "blogger#blogPerUserInfo", # The kind of this entity. Always blogger#blogPerUserInfo
553          "userId": "A String", # ID of the User
554          "role": "A String", # Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER).
555          "photosAlbumKey": "A String", # The Photo Album Key for the user when adding photos to the blog
556          "blogId": "A String", # ID of the Blog resource
557        },
558      },
559    ],
560  }</pre>
561</div>
562
563</body></html>