1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="blogger_v3.html">Blogger API</a> . <a href="blogger_v3.blogs.html">blogs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(blogId, maxPosts=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a blog by id.</p>
<p class="toc_element">
<code><a href="#getByUrl">getByUrl(url, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a blog by url.</p>
<p class="toc_element">
<code><a href="#listByUser">listByUser(userId, fetchUserInfo=None, role=None, status=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists blogs by user.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(blogId, maxPosts=None, view=None, x__xgafv=None)</code>
<pre>Gets a blog by id.
Args:
blogId: string, A parameter (required)
maxPosts: integer, A parameter
view: string, A parameter
Allowed values
VIEW_TYPE_UNSPECIFIED -
READER -
AUTHOR -
ADMIN -
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"customMetaData": "A String", # The JSON custom meta-data for the Blog.
"description": "A String", # The description of this blog. This is displayed underneath the title.
"id": "A String", # The identifier for this resource.
"kind": "A String", # The kind of this entry. Always blogger#blog.
"locale": { # The locale this Blog is set to.
"country": "A String", # The country this blog's locale is set to.
"language": "A String", # The language this blog is authored in.
"variant": "A String", # The language variant this blog is authored in.
},
"name": "A String", # The name of this blog. This is displayed as the title.
"pages": { # The container of pages in this blog.
"selfLink": "A String", # The URL of the container for pages in this blog.
"totalItems": 42, # The count of pages in this blog.
},
"posts": { # The container of posts in this blog.
"items": [ # The List of Posts for this Blog.
{
"author": { # The author of this Post.
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"url": "A String", # The URL of the creator's Profile page.
},
"blog": { # Data about the blog containing this Post.
"id": "A String", # The identifier of the Blog that contains this Post.
},
"content": "A String", # The content of the Post. May contain HTML markup.
"customMetaData": "A String", # The JSON meta-data for the Post.
"etag": "A String", # Etag of the resource.
"id": "A String", # The identifier of this Post.
"images": [ # Display image for the Post.
{
"url": "A String",
},
],
"kind": "A String", # The kind of this entity. Always blogger#post.
"labels": [ # The list of labels this Post was tagged with.
"A String",
],
"location": { # The location for geotagged posts.
"lat": 3.14, # Location's latitude.
"lng": 3.14, # Location's longitude.
"name": "A String", # Location name.
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
},
"published": "A String", # RFC 3339 date-time when this Post was published.
"readerComments": "A String", # Comment control and display setting for readers of this post.
"replies": { # The container of comments on this Post.
"items": [ # The List of Comments for this Post.
{
"author": { # The author of this Comment.
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"url": "A String", # The URL of the creator's Profile page.
},
"blog": { # Data about the blog containing this comment.
"id": "A String", # The identifier of the blog containing this comment.
},
"content": "A String", # The actual content of the comment. May include HTML markup.
"id": "A String", # The identifier for this resource.
"inReplyTo": { # Data about the comment this is in reply to.
"id": "A String", # The identified of the parent of this comment.
},
"kind": "A String", # The kind of this entry. Always blogger#comment.
"post": { # Data about the post containing this comment.
"id": "A String", # The identifier of the post containing this comment.
},
"published": "A String", # RFC 3339 date-time when this comment was published.
"selfLink": "A String", # The API REST URL to fetch this resource from.
"status": "A String", # The status of the comment (only populated for admin users).
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
},
],
"selfLink": "A String", # The URL of the comments on this post.
"totalItems": "A String", # The count of comments on this post.
},
"selfLink": "A String", # The API REST URL to fetch this resource from.
"status": "A String", # Status of the post. Only set for admin-level requests.
"title": "A String", # The title of the Post.
"titleLink": "A String", # The title link URL, similar to atom's related link.
"trashed": "A String", # RFC 3339 date-time when this Post was last trashed.
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
"url": "A String", # The URL where this Post is displayed.
},
],
"selfLink": "A String", # The URL of the container for posts in this blog.
"totalItems": 42, # The count of posts in this blog.
},
"published": "A String", # RFC 3339 date-time when this blog was published.
"selfLink": "A String", # The API REST URL to fetch this resource from.
"status": "A String", # The status of the blog.
"updated": "A String", # RFC 3339 date-time when this blog was last updated.
"url": "A String", # The URL where this blog is published.
}</pre>
</div>
<div class="method">
<code class="details" id="getByUrl">getByUrl(url, view=None, x__xgafv=None)</code>
<pre>Gets a blog by url.
Args:
url: string, A parameter (required)
view: string, A parameter
Allowed values
VIEW_TYPE_UNSPECIFIED -
READER -
AUTHOR -
ADMIN -
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"customMetaData": "A String", # The JSON custom meta-data for the Blog.
"description": "A String", # The description of this blog. This is displayed underneath the title.
"id": "A String", # The identifier for this resource.
"kind": "A String", # The kind of this entry. Always blogger#blog.
"locale": { # The locale this Blog is set to.
"country": "A String", # The country this blog's locale is set to.
"language": "A String", # The language this blog is authored in.
"variant": "A String", # The language variant this blog is authored in.
},
"name": "A String", # The name of this blog. This is displayed as the title.
"pages": { # The container of pages in this blog.
"selfLink": "A String", # The URL of the container for pages in this blog.
"totalItems": 42, # The count of pages in this blog.
},
"posts": { # The container of posts in this blog.
"items": [ # The List of Posts for this Blog.
{
"author": { # The author of this Post.
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"url": "A String", # The URL of the creator's Profile page.
},
"blog": { # Data about the blog containing this Post.
"id": "A String", # The identifier of the Blog that contains this Post.
},
"content": "A String", # The content of the Post. May contain HTML markup.
"customMetaData": "A String", # The JSON meta-data for the Post.
"etag": "A String", # Etag of the resource.
"id": "A String", # The identifier of this Post.
"images": [ # Display image for the Post.
{
"url": "A String",
},
],
"kind": "A String", # The kind of this entity. Always blogger#post.
"labels": [ # The list of labels this Post was tagged with.
"A String",
],
"location": { # The location for geotagged posts.
"lat": 3.14, # Location's latitude.
"lng": 3.14, # Location's longitude.
"name": "A String", # Location name.
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
},
"published": "A String", # RFC 3339 date-time when this Post was published.
"readerComments": "A String", # Comment control and display setting for readers of this post.
"replies": { # The container of comments on this Post.
"items": [ # The List of Comments for this Post.
{
"author": { # The author of this Comment.
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"url": "A String", # The URL of the creator's Profile page.
},
"blog": { # Data about the blog containing this comment.
"id": "A String", # The identifier of the blog containing this comment.
},
"content": "A String", # The actual content of the comment. May include HTML markup.
"id": "A String", # The identifier for this resource.
"inReplyTo": { # Data about the comment this is in reply to.
"id": "A String", # The identified of the parent of this comment.
},
"kind": "A String", # The kind of this entry. Always blogger#comment.
"post": { # Data about the post containing this comment.
"id": "A String", # The identifier of the post containing this comment.
},
"published": "A String", # RFC 3339 date-time when this comment was published.
"selfLink": "A String", # The API REST URL to fetch this resource from.
"status": "A String", # The status of the comment (only populated for admin users).
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
},
],
"selfLink": "A String", # The URL of the comments on this post.
"totalItems": "A String", # The count of comments on this post.
},
"selfLink": "A String", # The API REST URL to fetch this resource from.
"status": "A String", # Status of the post. Only set for admin-level requests.
"title": "A String", # The title of the Post.
"titleLink": "A String", # The title link URL, similar to atom's related link.
"trashed": "A String", # RFC 3339 date-time when this Post was last trashed.
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
"url": "A String", # The URL where this Post is displayed.
},
],
"selfLink": "A String", # The URL of the container for posts in this blog.
"totalItems": 42, # The count of posts in this blog.
},
"published": "A String", # RFC 3339 date-time when this blog was published.
"selfLink": "A String", # The API REST URL to fetch this resource from.
"status": "A String", # The status of the blog.
"updated": "A String", # RFC 3339 date-time when this blog was last updated.
"url": "A String", # The URL where this blog is published.
}</pre>
</div>
<div class="method">
<code class="details" id="listByUser">listByUser(userId, fetchUserInfo=None, role=None, status=None, view=None, x__xgafv=None)</code>
<pre>Lists blogs by user.
Args:
userId: string, A parameter (required)
fetchUserInfo: boolean, A parameter
role: string, A parameter (repeated)
Allowed values
VIEW_TYPE_UNSPECIFIED -
READER -
AUTHOR -
ADMIN -
status: string, Default value of status is LIVE. (repeated)
Allowed values
LIVE -
DELETED -
view: string, A parameter
Allowed values
VIEW_TYPE_UNSPECIFIED -
READER -
AUTHOR -
ADMIN -
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"blogUserInfos": [ # Admin level list of blog per-user information.
{
"blog": { # The Blog resource.
"customMetaData": "A String", # The JSON custom meta-data for the Blog.
"description": "A String", # The description of this blog. This is displayed underneath the title.
"id": "A String", # The identifier for this resource.
"kind": "A String", # The kind of this entry. Always blogger#blog.
"locale": { # The locale this Blog is set to.
"country": "A String", # The country this blog's locale is set to.
"language": "A String", # The language this blog is authored in.
"variant": "A String", # The language variant this blog is authored in.
},
"name": "A String", # The name of this blog. This is displayed as the title.
"pages": { # The container of pages in this blog.
"selfLink": "A String", # The URL of the container for pages in this blog.
"totalItems": 42, # The count of pages in this blog.
},
"posts": { # The container of posts in this blog.
"items": [ # The List of Posts for this Blog.
{
"author": { # The author of this Post.
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"url": "A String", # The URL of the creator's Profile page.
},
"blog": { # Data about the blog containing this Post.
"id": "A String", # The identifier of the Blog that contains this Post.
},
"content": "A String", # The content of the Post. May contain HTML markup.
"customMetaData": "A String", # The JSON meta-data for the Post.
"etag": "A String", # Etag of the resource.
"id": "A String", # The identifier of this Post.
"images": [ # Display image for the Post.
{
"url": "A String",
},
],
"kind": "A String", # The kind of this entity. Always blogger#post.
"labels": [ # The list of labels this Post was tagged with.
"A String",
],
"location": { # The location for geotagged posts.
"lat": 3.14, # Location's latitude.
"lng": 3.14, # Location's longitude.
"name": "A String", # Location name.
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
},
"published": "A String", # RFC 3339 date-time when this Post was published.
"readerComments": "A String", # Comment control and display setting for readers of this post.
"replies": { # The container of comments on this Post.
"items": [ # The List of Comments for this Post.
{
"author": { # The author of this Comment.
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"url": "A String", # The URL of the creator's Profile page.
},
"blog": { # Data about the blog containing this comment.
"id": "A String", # The identifier of the blog containing this comment.
},
"content": "A String", # The actual content of the comment. May include HTML markup.
"id": "A String", # The identifier for this resource.
"inReplyTo": { # Data about the comment this is in reply to.
"id": "A String", # The identified of the parent of this comment.
},
"kind": "A String", # The kind of this entry. Always blogger#comment.
"post": { # Data about the post containing this comment.
"id": "A String", # The identifier of the post containing this comment.
},
"published": "A String", # RFC 3339 date-time when this comment was published.
"selfLink": "A String", # The API REST URL to fetch this resource from.
"status": "A String", # The status of the comment (only populated for admin users).
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
},
],
"selfLink": "A String", # The URL of the comments on this post.
"totalItems": "A String", # The count of comments on this post.
},
"selfLink": "A String", # The API REST URL to fetch this resource from.
"status": "A String", # Status of the post. Only set for admin-level requests.
"title": "A String", # The title of the Post.
"titleLink": "A String", # The title link URL, similar to atom's related link.
"trashed": "A String", # RFC 3339 date-time when this Post was last trashed.
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
"url": "A String", # The URL where this Post is displayed.
},
],
"selfLink": "A String", # The URL of the container for posts in this blog.
"totalItems": 42, # The count of posts in this blog.
},
"published": "A String", # RFC 3339 date-time when this blog was published.
"selfLink": "A String", # The API REST URL to fetch this resource from.
"status": "A String", # The status of the blog.
"updated": "A String", # RFC 3339 date-time when this blog was last updated.
"url": "A String", # The URL where this blog is published.
},
"blog_user_info": { # Information about a User for the Blog.
"blogId": "A String", # ID of the Blog resource.
"hasAdminAccess": True or False, # True if the user has Admin level access to the blog.
"kind": "A String", # The kind of this entity. Always blogger#blogPerUserInfo.
"photosAlbumKey": "A String", # The Photo Album Key for the user when adding photos to the blog.
"role": "A String", # Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER).
"userId": "A String", # ID of the User.
},
"kind": "A String", # The kind of this entity. Always blogger#blogUserInfo.
},
],
"items": [ # The list of Blogs this user has Authorship or Admin rights over.
{
"customMetaData": "A String", # The JSON custom meta-data for the Blog.
"description": "A String", # The description of this blog. This is displayed underneath the title.
"id": "A String", # The identifier for this resource.
"kind": "A String", # The kind of this entry. Always blogger#blog.
"locale": { # The locale this Blog is set to.
"country": "A String", # The country this blog's locale is set to.
"language": "A String", # The language this blog is authored in.
"variant": "A String", # The language variant this blog is authored in.
},
"name": "A String", # The name of this blog. This is displayed as the title.
"pages": { # The container of pages in this blog.
"selfLink": "A String", # The URL of the container for pages in this blog.
"totalItems": 42, # The count of pages in this blog.
},
"posts": { # The container of posts in this blog.
"items": [ # The List of Posts for this Blog.
{
"author": { # The author of this Post.
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"url": "A String", # The URL of the creator's Profile page.
},
"blog": { # Data about the blog containing this Post.
"id": "A String", # The identifier of the Blog that contains this Post.
},
"content": "A String", # The content of the Post. May contain HTML markup.
"customMetaData": "A String", # The JSON meta-data for the Post.
"etag": "A String", # Etag of the resource.
"id": "A String", # The identifier of this Post.
"images": [ # Display image for the Post.
{
"url": "A String",
},
],
"kind": "A String", # The kind of this entity. Always blogger#post.
"labels": [ # The list of labels this Post was tagged with.
"A String",
],
"location": { # The location for geotagged posts.
"lat": 3.14, # Location's latitude.
"lng": 3.14, # Location's longitude.
"name": "A String", # Location name.
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
},
"published": "A String", # RFC 3339 date-time when this Post was published.
"readerComments": "A String", # Comment control and display setting for readers of this post.
"replies": { # The container of comments on this Post.
"items": [ # The List of Comments for this Post.
{
"author": { # The author of this Comment.
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"url": "A String", # The URL of the creator's Profile page.
},
"blog": { # Data about the blog containing this comment.
"id": "A String", # The identifier of the blog containing this comment.
},
"content": "A String", # The actual content of the comment. May include HTML markup.
"id": "A String", # The identifier for this resource.
"inReplyTo": { # Data about the comment this is in reply to.
"id": "A String", # The identified of the parent of this comment.
},
"kind": "A String", # The kind of this entry. Always blogger#comment.
"post": { # Data about the post containing this comment.
"id": "A String", # The identifier of the post containing this comment.
},
"published": "A String", # RFC 3339 date-time when this comment was published.
"selfLink": "A String", # The API REST URL to fetch this resource from.
"status": "A String", # The status of the comment (only populated for admin users).
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
},
],
"selfLink": "A String", # The URL of the comments on this post.
"totalItems": "A String", # The count of comments on this post.
},
"selfLink": "A String", # The API REST URL to fetch this resource from.
"status": "A String", # Status of the post. Only set for admin-level requests.
"title": "A String", # The title of the Post.
"titleLink": "A String", # The title link URL, similar to atom's related link.
"trashed": "A String", # RFC 3339 date-time when this Post was last trashed.
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
"url": "A String", # The URL where this Post is displayed.
},
],
"selfLink": "A String", # The URL of the container for posts in this blog.
"totalItems": 42, # The count of posts in this blog.
},
"published": "A String", # RFC 3339 date-time when this blog was published.
"selfLink": "A String", # The API REST URL to fetch this resource from.
"status": "A String", # The status of the blog.
"updated": "A String", # RFC 3339 date-time when this blog was last updated.
"url": "A String", # The URL where this blog is published.
},
],
"kind": "A String", # The kind of this entity. Always blogger#blogList.
}</pre>
</div>
</body></html>
|
