Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 614db98bf45b9da1f29c35a9d942536111e99d41 / . / docs / dyn / blogger_v3.blogs.html
blob: f53f6c17ee690a3b7775f4e6c44d79f43f877041 [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.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, 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 blogs. 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 "kind": "blogger#blog", # The kind of this entry. Always blogger#blog
105 "description": "A String", # The description of this blog. This is displayed underneath the title.
106 "locale": { # The locale this Blog is set to.
107 "country": "A String", # The country this blog's locale is set to.
108 "variant": "A String", # The language variant this blog is authored in.
109 "language": "A String", # The language this blog is authored in.
110 },
111 "posts": { # The container of posts in this blog.
112 "totalItems": 42, # The count of posts in this blog.
113 "items": [ # The List of Posts for this Blog.
114 {
115 "status": "A String", # Status of the post. Only set for admin-level requests
116 "content": "A String", # The content of the Post. May contain HTML markup.
117 "kind": "blogger#post", # The kind of this entity. Always blogger#post
118 "titleLink": "A String", # The title link URL, similar to atom's related link.
119 "author": { # The author of this Post.
120 "url": "A String", # The URL of the Post creator's Profile page.
121 "image": { # The Post author's avatar.
122 "url": "A String", # The Post author's avatar URL.
123 },
124 "displayName": "A String", # The display name.
125 "id": "A String", # The identifier of the Post creator.
126 },
127 "replies": { # The container of comments on this Post.
128 "totalItems": "A String", # The count of comments on this post.
129 "items": [ # The List of Comments for this Post.
130 {
131 "status": "A String", # The status of the comment (only populated for admin users)
132 "content": "A String", # The actual content of the comment. May include HTML markup.
133 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
134 "inReplyTo": { # Data about the comment this is in reply to.
135 "id": "A String", # The identified of the parent of this comment.
136 },
137 "author": { # The author of this Comment.
138 "url": "A String", # The URL of the Comment creator's Profile page.
139 "image": { # The comment creator's avatar.
140 "url": "A String", # The comment creator's avatar URL.
141 },
142 "displayName": "A String", # The display name.
143 "id": "A String", # The identifier of the Comment creator.
144 },
145 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
146 "blog": { # Data about the blog containing this comment.
147 "id": "A String", # The identifier of the blog containing this comment.
148 },
149 "published": "A String", # RFC 3339 date-time when this comment was published.
150 "post": { # Data about the post containing this comment.
151 "id": "A String", # The identifier of the post containing this comment.
152 },
153 "id": "A String", # The identifier for this resource.
154 "selfLink": "A String", # The API REST URL to fetch this resource from.
155 },
156 ],
157 "selfLink": "A String", # The URL of the comments on this post.
158 },
159 "labels": [ # The list of labels this Post was tagged with.
160 "A String",
161 ],
162 "customMetaData": "A String", # The JSON meta-data for the Post.
163 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
164 "blog": { # Data about the blog containing this Post.
165 "id": "A String", # The identifier of the Blog that contains this Post.
166 },
167 "url": "A String", # The URL where this Post is displayed.
168 "location": { # The location for geotagged posts.
169 "lat": 3.14, # Location's latitude.
170 "lng": 3.14, # Location's longitude.
171 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
172 "name": "A String", # Location name.
173 },
174 "published": "A String", # RFC 3339 date-time when this Post was published.
175 "images": [ # Display image for the Post.
176 {
177 "url": "A String",
178 },
179 ],
180 "title": "A String", # The title of the Post.
181 "id": "A String", # The identifier of this Post.
182 "selfLink": "A String", # The API REST URL to fetch this resource from.
183 },
184 ],
185 "selfLink": "A String", # The URL of the container for posts in this blog.
186 },
187 "customMetaData": "A String", # The JSON custom meta-data for the Blog
188 "updated": "A String", # RFC 3339 date-time when this blog was last updated.
189 "pages": { # The container of pages in this blog.
190 "totalItems": 42, # The count of pages in this blog.
191 "selfLink": "A String", # The URL of the container for pages in this blog.
192 },
193 "url": "A String", # The URL where this blog is published.
194 "published": "A String", # RFC 3339 date-time when this blog was published.
195 "id": "A String", # The identifier for this resource.
196 "selfLink": "A String", # The API REST URL to fetch this resource from.
197 "name": "A String", # The name of this blog. This is displayed as the title.
198 }</pre>
199</div>
200
201<div class="method">
202 <code class="details" id="getByUrl">getByUrl(url, view=None)</code>
203 <pre>Retrieve a Blog by URL.
204
205Args:
206 url: string, The URL of the blog to retrieve. (required)
207 view: string, Access level with which to view the blogs. Note that some fields require elevated access.
208 Allowed values
209 ADMIN - Admin level detail
210 AUTHOR - Author level detail
211 READER - Reader level detail
212
213Returns:
214 An object of the form:
215
216 {
217 "kind": "blogger#blog", # The kind of this entry. Always blogger#blog
218 "description": "A String", # The description of this blog. This is displayed underneath the title.
219 "locale": { # The locale this Blog is set to.
220 "country": "A String", # The country this blog's locale is set to.
221 "variant": "A String", # The language variant this blog is authored in.
222 "language": "A String", # The language this blog is authored in.
223 },
224 "posts": { # The container of posts in this blog.
225 "totalItems": 42, # The count of posts in this blog.
226 "items": [ # The List of Posts for this Blog.
227 {
228 "status": "A String", # Status of the post. Only set for admin-level requests
229 "content": "A String", # The content of the Post. May contain HTML markup.
230 "kind": "blogger#post", # The kind of this entity. Always blogger#post
231 "titleLink": "A String", # The title link URL, similar to atom's related link.
232 "author": { # The author of this Post.
233 "url": "A String", # The URL of the Post creator's Profile page.
234 "image": { # The Post author's avatar.
235 "url": "A String", # The Post author's avatar URL.
236 },
237 "displayName": "A String", # The display name.
238 "id": "A String", # The identifier of the Post creator.
239 },
240 "replies": { # The container of comments on this Post.
241 "totalItems": "A String", # The count of comments on this post.
242 "items": [ # The List of Comments for this Post.
243 {
244 "status": "A String", # The status of the comment (only populated for admin users)
245 "content": "A String", # The actual content of the comment. May include HTML markup.
246 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
247 "inReplyTo": { # Data about the comment this is in reply to.
248 "id": "A String", # The identified of the parent of this comment.
249 },
250 "author": { # The author of this Comment.
251 "url": "A String", # The URL of the Comment creator's Profile page.
252 "image": { # The comment creator's avatar.
253 "url": "A String", # The comment creator's avatar URL.
254 },
255 "displayName": "A String", # The display name.
256 "id": "A String", # The identifier of the Comment creator.
257 },
258 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
259 "blog": { # Data about the blog containing this comment.
260 "id": "A String", # The identifier of the blog containing this comment.
261 },
262 "published": "A String", # RFC 3339 date-time when this comment was published.
263 "post": { # Data about the post containing this comment.
264 "id": "A String", # The identifier of the post containing this comment.
265 },
266 "id": "A String", # The identifier for this resource.
267 "selfLink": "A String", # The API REST URL to fetch this resource from.
268 },
269 ],
270 "selfLink": "A String", # The URL of the comments on this post.
271 },
272 "labels": [ # The list of labels this Post was tagged with.
273 "A String",
274 ],
275 "customMetaData": "A String", # The JSON meta-data for the Post.
276 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
277 "blog": { # Data about the blog containing this Post.
278 "id": "A String", # The identifier of the Blog that contains this Post.
279 },
280 "url": "A String", # The URL where this Post is displayed.
281 "location": { # The location for geotagged posts.
282 "lat": 3.14, # Location's latitude.
283 "lng": 3.14, # Location's longitude.
284 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
285 "name": "A String", # Location name.
286 },
287 "published": "A String", # RFC 3339 date-time when this Post was published.
288 "images": [ # Display image for the Post.
289 {
290 "url": "A String",
291 },
292 ],
293 "title": "A String", # The title of the Post.
294 "id": "A String", # The identifier of this Post.
295 "selfLink": "A String", # The API REST URL to fetch this resource from.
296 },
297 ],
298 "selfLink": "A String", # The URL of the container for posts in this blog.
299 },
300 "customMetaData": "A String", # The JSON custom meta-data for the Blog
301 "updated": "A String", # RFC 3339 date-time when this blog was last updated.
302 "pages": { # The container of pages in this blog.
303 "totalItems": 42, # The count of pages in this blog.
304 "selfLink": "A String", # The URL of the container for pages in this blog.
305 },
306 "url": "A String", # The URL where this blog is published.
307 "published": "A String", # RFC 3339 date-time when this blog was published.
308 "id": "A String", # The identifier for this resource.
309 "selfLink": "A String", # The API REST URL to fetch this resource from.
310 "name": "A String", # The name of this blog. This is displayed as the title.
311 }</pre>
312</div>
313
314<div class="method">
315 <code class="details" id="listByUser">listByUser(userId, fetchUserInfo=None, role=None, view=None)</code>
316 <pre>Retrieves a list of blogs, possibly filtered.
317
318Args:
319 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)
320 fetchUserInfo: boolean, Whether the response is a list of blogs with per-user information instead of just blogs.
321 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)
322 Allowed values
323 ADMIN - Admin role - User has Admin level access.
324 AUTHOR - Author role - User has Author level access.
325 READER - Reader role - User has Reader level access.
326 view: string, Access level with which to view the blogs. Note that some fields require elevated access.
327 Allowed values
328 ADMIN - Admin level detail
329 AUTHOR - Author level detail
330 READER - Reader level detail
331
332Returns:
333 An object of the form:
334
335 {
336 "items": [ # The list of Blogs this user has Authorship or Admin rights over.
337 {
338 "kind": "blogger#blog", # The kind of this entry. Always blogger#blog
339 "description": "A String", # The description of this blog. This is displayed underneath the title.
340 "locale": { # The locale this Blog is set to.
341 "country": "A String", # The country this blog's locale is set to.
342 "variant": "A String", # The language variant this blog is authored in.
343 "language": "A String", # The language this blog is authored in.
344 },
345 "posts": { # The container of posts in this blog.
346 "totalItems": 42, # The count of posts in this blog.
347 "items": [ # The List of Posts for this Blog.
348 {
349 "status": "A String", # Status of the post. Only set for admin-level requests
350 "content": "A String", # The content of the Post. May contain HTML markup.
351 "kind": "blogger#post", # The kind of this entity. Always blogger#post
352 "titleLink": "A String", # The title link URL, similar to atom's related link.
353 "author": { # The author of this Post.
354 "url": "A String", # The URL of the Post creator's Profile page.
355 "image": { # The Post author's avatar.
356 "url": "A String", # The Post author's avatar URL.
357 },
358 "displayName": "A String", # The display name.
359 "id": "A String", # The identifier of the Post creator.
360 },
361 "replies": { # The container of comments on this Post.
362 "totalItems": "A String", # The count of comments on this post.
363 "items": [ # The List of Comments for this Post.
364 {
365 "status": "A String", # The status of the comment (only populated for admin users)
366 "content": "A String", # The actual content of the comment. May include HTML markup.
367 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
368 "inReplyTo": { # Data about the comment this is in reply to.
369 "id": "A String", # The identified of the parent of this comment.
370 },
371 "author": { # The author of this Comment.
372 "url": "A String", # The URL of the Comment creator's Profile page.
373 "image": { # The comment creator's avatar.
374 "url": "A String", # The comment creator's avatar URL.
375 },
376 "displayName": "A String", # The display name.
377 "id": "A String", # The identifier of the Comment creator.
378 },
379 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
380 "blog": { # Data about the blog containing this comment.
381 "id": "A String", # The identifier of the blog containing this comment.
382 },
383 "published": "A String", # RFC 3339 date-time when this comment was published.
384 "post": { # Data about the post containing this comment.
385 "id": "A String", # The identifier of the post containing this comment.
386 },
387 "id": "A String", # The identifier for this resource.
388 "selfLink": "A String", # The API REST URL to fetch this resource from.
389 },
390 ],
391 "selfLink": "A String", # The URL of the comments on this post.
392 },
393 "labels": [ # The list of labels this Post was tagged with.
394 "A String",
395 ],
396 "customMetaData": "A String", # The JSON meta-data for the Post.
397 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
398 "blog": { # Data about the blog containing this Post.
399 "id": "A String", # The identifier of the Blog that contains this Post.
400 },
401 "url": "A String", # The URL where this Post is displayed.
402 "location": { # The location for geotagged posts.
403 "lat": 3.14, # Location's latitude.
404 "lng": 3.14, # Location's longitude.
405 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
406 "name": "A String", # Location name.
407 },
408 "published": "A String", # RFC 3339 date-time when this Post was published.
409 "images": [ # Display image for the Post.
410 {
411 "url": "A String",
412 },
413 ],
414 "title": "A String", # The title of the Post.
415 "id": "A String", # The identifier of this Post.
416 "selfLink": "A String", # The API REST URL to fetch this resource from.
417 },
418 ],
419 "selfLink": "A String", # The URL of the container for posts in this blog.
420 },
421 "customMetaData": "A String", # The JSON custom meta-data for the Blog
422 "updated": "A String", # RFC 3339 date-time when this blog was last updated.
423 "pages": { # The container of pages in this blog.
424 "totalItems": 42, # The count of pages in this blog.
425 "selfLink": "A String", # The URL of the container for pages in this blog.
426 },
427 "url": "A String", # The URL where this blog is published.
428 "published": "A String", # RFC 3339 date-time when this blog was published.
429 "id": "A String", # The identifier for this resource.
430 "selfLink": "A String", # The API REST URL to fetch this resource from.
431 "name": "A String", # The name of this blog. This is displayed as the title.
432 },
433 ],
434 "kind": "blogger#blogList", # The kind of this entity. Always blogger#blogList
435 "blogUserInfos": [ # Admin level list of blog per-user information
436 {
437 "blog": { # The Blog resource.
438 "kind": "blogger#blog", # The kind of this entry. Always blogger#blog
439 "description": "A String", # The description of this blog. This is displayed underneath the title.
440 "locale": { # The locale this Blog is set to.
441 "country": "A String", # The country this blog's locale is set to.
442 "variant": "A String", # The language variant this blog is authored in.
443 "language": "A String", # The language this blog is authored in.
444 },
445 "posts": { # The container of posts in this blog.
446 "totalItems": 42, # The count of posts in this blog.
447 "items": [ # The List of Posts for this Blog.
448 {
449 "status": "A String", # Status of the post. Only set for admin-level requests
450 "content": "A String", # The content of the Post. May contain HTML markup.
451 "kind": "blogger#post", # The kind of this entity. Always blogger#post
452 "titleLink": "A String", # The title link URL, similar to atom's related link.
453 "author": { # The author of this Post.
454 "url": "A String", # The URL of the Post creator's Profile page.
455 "image": { # The Post author's avatar.
456 "url": "A String", # The Post author's avatar URL.
457 },
458 "displayName": "A String", # The display name.
459 "id": "A String", # The identifier of the Post creator.
460 },
461 "replies": { # The container of comments on this Post.
462 "totalItems": "A String", # The count of comments on this post.
463 "items": [ # The List of Comments for this Post.
464 {
465 "status": "A String", # The status of the comment (only populated for admin users)
466 "content": "A String", # The actual content of the comment. May include HTML markup.
467 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
468 "inReplyTo": { # Data about the comment this is in reply to.
469 "id": "A String", # The identified of the parent of this comment.
470 },
471 "author": { # The author of this Comment.
472 "url": "A String", # The URL of the Comment creator's Profile page.
473 "image": { # The comment creator's avatar.
474 "url": "A String", # The comment creator's avatar URL.
475 },
476 "displayName": "A String", # The display name.
477 "id": "A String", # The identifier of the Comment creator.
478 },
479 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
480 "blog": { # Data about the blog containing this comment.
481 "id": "A String", # The identifier of the blog containing this comment.
482 },
483 "published": "A String", # RFC 3339 date-time when this comment was published.
484 "post": { # Data about the post containing this comment.
485 "id": "A String", # The identifier of the post containing this comment.
486 },
487 "id": "A String", # The identifier for this resource.
488 "selfLink": "A String", # The API REST URL to fetch this resource from.
489 },
490 ],
491 "selfLink": "A String", # The URL of the comments on this post.
492 },
493 "labels": [ # The list of labels this Post was tagged with.
494 "A String",
495 ],
496 "customMetaData": "A String", # The JSON meta-data for the Post.
497 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
498 "blog": { # Data about the blog containing this Post.
499 "id": "A String", # The identifier of the Blog that contains this Post.
500 },
501 "url": "A String", # The URL where this Post is displayed.
502 "location": { # The location for geotagged posts.
503 "lat": 3.14, # Location's latitude.
504 "lng": 3.14, # Location's longitude.
505 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
506 "name": "A String", # Location name.
507 },
508 "published": "A String", # RFC 3339 date-time when this Post was published.
509 "images": [ # Display image for the Post.
510 {
511 "url": "A String",
512 },
513 ],
514 "title": "A String", # The title of the Post.
515 "id": "A String", # The identifier of this Post.
516 "selfLink": "A String", # The API REST URL to fetch this resource from.
517 },
518 ],
519 "selfLink": "A String", # The URL of the container for posts in this blog.
520 },
521 "customMetaData": "A String", # The JSON custom meta-data for the Blog
522 "updated": "A String", # RFC 3339 date-time when this blog was last updated.
523 "pages": { # The container of pages in this blog.
524 "totalItems": 42, # The count of pages in this blog.
525 "selfLink": "A String", # The URL of the container for pages in this blog.
526 },
527 "url": "A String", # The URL where this blog is published.
528 "published": "A String", # RFC 3339 date-time when this blog was published.
529 "id": "A String", # The identifier for this resource.
530 "selfLink": "A String", # The API REST URL to fetch this resource from.
531 "name": "A String", # The name of this blog. This is displayed as the title.
532 },
533 "kind": "blogger#blogUserInfo", # The kind of this entity. Always blogger#blogUserInfo
534 "blog_user_info": { # Information about a User for the Blog.
535 "hasAdminAccess": True or False, # True if the user has Admin level access to the blog.
536 "kind": "blogger#blogPerUserInfo", # The kind of this entity. Always blogger#blogPerUserInfo
537 "userId": "A String", # ID of the User
538 "role": "A String", # Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER).
539 "photosAlbumKey": "A String", # The Photo Album Key for the user when adding photos to the blog
540 "blogId": "A String", # ID of the Blog resource
541 },
542 },
543 ],
544 }</pre>
545</div>
546
547</body></html>