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
|
<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.comments.html">comments</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#approve">approve(blogId, postId, commentId, x__xgafv=None)</a></code></p>
<p class="firstline">Marks a comment as not spam by blog id, post id and comment id.</p>
<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="#delete">delete(blogId, postId, commentId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a comment by blog id, post id and comment id.</p>
<p class="toc_element">
<code><a href="#get">get(blogId, postId, commentId, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a comment by id.</p>
<p class="toc_element">
<code><a href="#list">list(blogId, postId, endDate=None, fetchBodies=None, maxResults=None, pageToken=None, startDate=None, status=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists comments.</p>
<p class="toc_element">
<code><a href="#listByBlog">listByBlog(blogId, endDate=None, fetchBodies=None, maxResults=None, pageToken=None, startDate=None, status=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists comments by blog.</p>
<p class="toc_element">
<code><a href="#listByBlog_next">listByBlog_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#markAsSpam">markAsSpam(blogId, postId, commentId, x__xgafv=None)</a></code></p>
<p class="firstline">Marks a comment as spam by blog id, post id and comment id.</p>
<p class="toc_element">
<code><a href="#removeContent">removeContent(blogId, postId, commentId, x__xgafv=None)</a></code></p>
<p class="firstline">Removes the content of a comment by blog id, post id and comment id.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="approve">approve(blogId, postId, commentId, x__xgafv=None)</code>
<pre>Marks a comment as not spam by blog id, post id and comment id.
Args:
blogId: string, A parameter (required)
postId: string, A parameter (required)
commentId: string, A parameter (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(blogId, postId, commentId, x__xgafv=None)</code>
<pre>Deletes a comment by blog id, post id and comment id.
Args:
blogId: string, A parameter (required)
postId: string, A parameter (required)
commentId: string, A parameter (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="get">get(blogId, postId, commentId, view=None, x__xgafv=None)</code>
<pre>Gets a comment by id.
Args:
blogId: string, A parameter (required)
postId: string, A parameter (required)
commentId: 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:
{
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(blogId, postId, endDate=None, fetchBodies=None, maxResults=None, pageToken=None, startDate=None, status=None, view=None, x__xgafv=None)</code>
<pre>Lists comments.
Args:
blogId: string, A parameter (required)
postId: string, A parameter (required)
endDate: string, A parameter
fetchBodies: boolean, A parameter
maxResults: integer, A parameter
pageToken: string, A parameter
startDate: string, A parameter
status: string, A parameter
Allowed values
LIVE -
EMPTIED -
PENDING -
SPAM -
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:
{
"etag": "A String", # Etag of the response.
"items": [ # The List of Comments for a 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.
},
],
"kind": "A String", # The kind of this entry. Always blogger#commentList.
"nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
"prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
}</pre>
</div>
<div class="method">
<code class="details" id="listByBlog">listByBlog(blogId, endDate=None, fetchBodies=None, maxResults=None, pageToken=None, startDate=None, status=None, x__xgafv=None)</code>
<pre>Lists comments by blog.
Args:
blogId: string, A parameter (required)
endDate: string, A parameter
fetchBodies: boolean, A parameter
maxResults: integer, A parameter
pageToken: string, A parameter
startDate: string, A parameter
status: string, A parameter (repeated)
Allowed values
LIVE -
EMPTIED -
PENDING -
SPAM -
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"etag": "A String", # Etag of the response.
"items": [ # The List of Comments for a 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.
},
],
"kind": "A String", # The kind of this entry. Always blogger#commentList.
"nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
"prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
}</pre>
</div>
<div class="method">
<code class="details" id="listByBlog_next">listByBlog_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="markAsSpam">markAsSpam(blogId, postId, commentId, x__xgafv=None)</code>
<pre>Marks a comment as spam by blog id, post id and comment id.
Args:
blogId: string, A parameter (required)
postId: string, A parameter (required)
commentId: string, A parameter (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="removeContent">removeContent(blogId, postId, commentId, x__xgafv=None)</code>
<pre>Removes the content of a comment by blog id, post id and comment id.
Args:
blogId: string, A parameter (required)
postId: string, A parameter (required)
commentId: string, A parameter (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"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.
}</pre>
</div>
</body></html>
|
