blob: 536e5a0eb8e7db462011a325c0690e13cda3cf16 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<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
Dan O'Mearadd494642020-05-01 07:42:23 -070075<h1><a href="blogger_v3.html">Blogger API v3</a> . <a href="blogger_v3.comments.html">comments</a></h1>
John Asmuth614db982014-04-24 15:46:26 -040076<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <code><a href="#approve">approve(blogId, postId, commentId, x__xgafv=None)</a></code></p>
79<p class="firstline">Marks a comment as not spam by blog id, post id and comment id.</p>
John Asmuth614db982014-04-24 15:46:26 -040080<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070081 <code><a href="#delete">delete(blogId, postId, commentId, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a comment by blog id, post id and comment id.</p>
John Asmuth614db982014-04-24 15:46:26 -040083<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070084 <code><a href="#get">get(blogId, postId, commentId, x__xgafv=None, view=None)</a></code></p>
85<p class="firstline">Gets a comment by id.</p>
John Asmuth614db982014-04-24 15:46:26 -040086<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070087 <code><a href="#list">list(blogId, postId, startDate=None, endDate=None, x__xgafv=None, pageToken=None, status=None, maxResults=None, fetchBodies=None, view=None)</a></code></p>
88<p class="firstline">Lists comments.</p>
John Asmuth614db982014-04-24 15:46:26 -040089<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070090 <code><a href="#listByBlog">listByBlog(blogId, startDate=None, endDate=None, x__xgafv=None, pageToken=None, status=None, maxResults=None, fetchBodies=None)</a></code></p>
91<p class="firstline">Lists comments by blog.</p>
John Asmuth614db982014-04-24 15:46:26 -040092<p class="toc_element">
93 <code><a href="#listByBlog_next">listByBlog_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070099 <code><a href="#markAsSpam">markAsSpam(blogId, postId, commentId, x__xgafv=None)</a></code></p>
100<p class="firstline">Marks a comment as spam by blog id, post id and comment id.</p>
John Asmuth614db982014-04-24 15:46:26 -0400101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700102 <code><a href="#removeContent">removeContent(blogId, postId, commentId, x__xgafv=None)</a></code></p>
103<p class="firstline">Removes the content of a comment by blog id, post id and comment id.</p>
John Asmuth614db982014-04-24 15:46:26 -0400104<h3>Method Details</h3>
105<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700106 <code class="details" id="approve">approve(blogId, postId, commentId, x__xgafv=None)</code>
107 <pre>Marks a comment as not spam by blog id, post id and comment id.
John Asmuth614db982014-04-24 15:46:26 -0400108
109Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700110 blogId: string, A parameter (required)
111 postId: string, A parameter (required)
112 commentId: string, A parameter (required)
113 x__xgafv: string, V1 error format.
114 Allowed values
115 1 - v1 error format
116 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400117
118Returns:
119 An object of the form:
120
121 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700122 "status": "A String", # The status of the comment (only populated for admin users).
John Asmuth614db982014-04-24 15:46:26 -0400123 "inReplyTo": { # Data about the comment this is in reply to.
124 "id": "A String", # The identified of the parent of this comment.
125 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700126 "kind": "A String", # The kind of this entry. Always blogger#comment.
John Asmuth614db982014-04-24 15:46:26 -0400127 "author": { # The author of this Comment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700128 "url": "A String", # The URL of the creator's Profile page.
129 "image": { # The creator's avatar.
130 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -0400131 },
132 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700133 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400134 },
135 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
136 "blog": { # Data about the blog containing this comment.
137 "id": "A String", # The identifier of the blog containing this comment.
138 },
139 "published": "A String", # RFC 3339 date-time when this comment was published.
140 "post": { # Data about the post containing this comment.
141 "id": "A String", # The identifier of the post containing this comment.
142 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700143 "content": "A String", # The actual content of the comment. May include HTML markup.
John Asmuth614db982014-04-24 15:46:26 -0400144 "id": "A String", # The identifier for this resource.
145 "selfLink": "A String", # The API REST URL to fetch this resource from.
146 }</pre>
147</div>
148
149<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700150 <code class="details" id="delete">delete(blogId, postId, commentId, x__xgafv=None)</code>
151 <pre>Deletes a comment by blog id, post id and comment id.
John Asmuth614db982014-04-24 15:46:26 -0400152
153Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700154 blogId: string, A parameter (required)
155 postId: string, A parameter (required)
156 commentId: string, A parameter (required)
157 x__xgafv: string, V1 error format.
158 Allowed values
159 1 - v1 error format
160 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400161</pre>
162</div>
163
164<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700165 <code class="details" id="get">get(blogId, postId, commentId, x__xgafv=None, view=None)</code>
166 <pre>Gets a comment by id.
John Asmuth614db982014-04-24 15:46:26 -0400167
168Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700169 blogId: string, A parameter (required)
170 postId: string, A parameter (required)
171 commentId: string, A parameter (required)
172 x__xgafv: string, V1 error format.
John Asmuth614db982014-04-24 15:46:26 -0400173 Allowed values
Dan O'Mearadd494642020-05-01 07:42:23 -0700174 1 - v1 error format
175 2 - v2 error format
176 view: string, A parameter
John Asmuth614db982014-04-24 15:46:26 -0400177
178Returns:
179 An object of the form:
180
181 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700182 "status": "A String", # The status of the comment (only populated for admin users).
John Asmuth614db982014-04-24 15:46:26 -0400183 "inReplyTo": { # Data about the comment this is in reply to.
184 "id": "A String", # The identified of the parent of this comment.
185 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700186 "kind": "A String", # The kind of this entry. Always blogger#comment.
John Asmuth614db982014-04-24 15:46:26 -0400187 "author": { # The author of this Comment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700188 "url": "A String", # The URL of the creator's Profile page.
189 "image": { # The creator's avatar.
190 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -0400191 },
192 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700193 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400194 },
195 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
196 "blog": { # Data about the blog containing this comment.
197 "id": "A String", # The identifier of the blog containing this comment.
198 },
199 "published": "A String", # RFC 3339 date-time when this comment was published.
200 "post": { # Data about the post containing this comment.
201 "id": "A String", # The identifier of the post containing this comment.
202 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700203 "content": "A String", # The actual content of the comment. May include HTML markup.
John Asmuth614db982014-04-24 15:46:26 -0400204 "id": "A String", # The identifier for this resource.
205 "selfLink": "A String", # The API REST URL to fetch this resource from.
206 }</pre>
207</div>
208
209<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700210 <code class="details" id="list">list(blogId, postId, startDate=None, endDate=None, x__xgafv=None, pageToken=None, status=None, maxResults=None, fetchBodies=None, view=None)</code>
211 <pre>Lists comments.
John Asmuth614db982014-04-24 15:46:26 -0400212
213Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700214 blogId: string, A parameter (required)
215 postId: string, A parameter (required)
216 startDate: string, A parameter
217 endDate: string, A parameter
218 x__xgafv: string, V1 error format.
John Asmuth614db982014-04-24 15:46:26 -0400219 Allowed values
Dan O'Mearadd494642020-05-01 07:42:23 -0700220 1 - v1 error format
221 2 - v2 error format
222 pageToken: string, A parameter
223 status: string, A parameter
224 maxResults: integer, A parameter
225 fetchBodies: boolean, A parameter
226 view: string, A parameter
John Asmuth614db982014-04-24 15:46:26 -0400227
228Returns:
229 An object of the form:
230
231 {
232 "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
233 "items": [ # The List of Comments for a Post.
234 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700235 "status": "A String", # The status of the comment (only populated for admin users).
John Asmuth614db982014-04-24 15:46:26 -0400236 "inReplyTo": { # Data about the comment this is in reply to.
237 "id": "A String", # The identified of the parent of this comment.
238 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700239 "kind": "A String", # The kind of this entry. Always blogger#comment.
John Asmuth614db982014-04-24 15:46:26 -0400240 "author": { # The author of this Comment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700241 "url": "A String", # The URL of the creator's Profile page.
242 "image": { # The creator's avatar.
243 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -0400244 },
245 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700246 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400247 },
248 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
249 "blog": { # Data about the blog containing this comment.
250 "id": "A String", # The identifier of the blog containing this comment.
251 },
252 "published": "A String", # RFC 3339 date-time when this comment was published.
253 "post": { # Data about the post containing this comment.
254 "id": "A String", # The identifier of the post containing this comment.
255 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700256 "content": "A String", # The actual content of the comment. May include HTML markup.
John Asmuth614db982014-04-24 15:46:26 -0400257 "id": "A String", # The identifier for this resource.
258 "selfLink": "A String", # The API REST URL to fetch this resource from.
259 },
260 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700261 "kind": "A String", # The kind of this entry. Always blogger#commentList.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000262 "etag": "A String", # Etag of the response.
John Asmuth614db982014-04-24 15:46:26 -0400263 "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
264 }</pre>
265</div>
266
267<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700268 <code class="details" id="listByBlog">listByBlog(blogId, startDate=None, endDate=None, x__xgafv=None, pageToken=None, status=None, maxResults=None, fetchBodies=None)</code>
269 <pre>Lists comments by blog.
John Asmuth614db982014-04-24 15:46:26 -0400270
271Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700272 blogId: string, A parameter (required)
273 startDate: string, A parameter
274 endDate: string, A parameter
275 x__xgafv: string, V1 error format.
Craig Citroe633be12015-03-02 13:40:36 -0800276 Allowed values
Dan O'Mearadd494642020-05-01 07:42:23 -0700277 1 - v1 error format
278 2 - v2 error format
279 pageToken: string, A parameter
280 status: string, A parameter (repeated)
281 maxResults: integer, A parameter
282 fetchBodies: boolean, A parameter
John Asmuth614db982014-04-24 15:46:26 -0400283
284Returns:
285 An object of the form:
286
287 {
288 "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
289 "items": [ # The List of Comments for a Post.
290 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700291 "status": "A String", # The status of the comment (only populated for admin users).
John Asmuth614db982014-04-24 15:46:26 -0400292 "inReplyTo": { # Data about the comment this is in reply to.
293 "id": "A String", # The identified of the parent of this comment.
294 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700295 "kind": "A String", # The kind of this entry. Always blogger#comment.
John Asmuth614db982014-04-24 15:46:26 -0400296 "author": { # The author of this Comment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700297 "url": "A String", # The URL of the creator's Profile page.
298 "image": { # The creator's avatar.
299 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -0400300 },
301 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700302 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400303 },
304 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
305 "blog": { # Data about the blog containing this comment.
306 "id": "A String", # The identifier of the blog containing this comment.
307 },
308 "published": "A String", # RFC 3339 date-time when this comment was published.
309 "post": { # Data about the post containing this comment.
310 "id": "A String", # The identifier of the post containing this comment.
311 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700312 "content": "A String", # The actual content of the comment. May include HTML markup.
John Asmuth614db982014-04-24 15:46:26 -0400313 "id": "A String", # The identifier for this resource.
314 "selfLink": "A String", # The API REST URL to fetch this resource from.
315 },
316 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700317 "kind": "A String", # The kind of this entry. Always blogger#commentList.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000318 "etag": "A String", # Etag of the response.
John Asmuth614db982014-04-24 15:46:26 -0400319 "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
320 }</pre>
321</div>
322
323<div class="method">
324 <code class="details" id="listByBlog_next">listByBlog_next(previous_request, previous_response)</code>
325 <pre>Retrieves the next page of results.
326
327Args:
328 previous_request: The request for the previous page. (required)
329 previous_response: The response from the request for the previous page. (required)
330
331Returns:
332 A request object that you can call 'execute()' on to request the next
333 page. Returns None if there are no more items in the collection.
334 </pre>
335</div>
336
337<div class="method">
338 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
339 <pre>Retrieves the next page of results.
340
341Args:
342 previous_request: The request for the previous page. (required)
343 previous_response: The response from the request for the previous page. (required)
344
345Returns:
346 A request object that you can call 'execute()' on to request the next
347 page. Returns None if there are no more items in the collection.
348 </pre>
349</div>
350
351<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700352 <code class="details" id="markAsSpam">markAsSpam(blogId, postId, commentId, x__xgafv=None)</code>
353 <pre>Marks a comment as spam by blog id, post id and comment id.
John Asmuth614db982014-04-24 15:46:26 -0400354
355Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700356 blogId: string, A parameter (required)
357 postId: string, A parameter (required)
358 commentId: string, A parameter (required)
359 x__xgafv: string, V1 error format.
360 Allowed values
361 1 - v1 error format
362 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400363
364Returns:
365 An object of the form:
366
367 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700368 "status": "A String", # The status of the comment (only populated for admin users).
John Asmuth614db982014-04-24 15:46:26 -0400369 "inReplyTo": { # Data about the comment this is in reply to.
370 "id": "A String", # The identified of the parent of this comment.
371 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700372 "kind": "A String", # The kind of this entry. Always blogger#comment.
John Asmuth614db982014-04-24 15:46:26 -0400373 "author": { # The author of this Comment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700374 "url": "A String", # The URL of the creator's Profile page.
375 "image": { # The creator's avatar.
376 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -0400377 },
378 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700379 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400380 },
381 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
382 "blog": { # Data about the blog containing this comment.
383 "id": "A String", # The identifier of the blog containing this comment.
384 },
385 "published": "A String", # RFC 3339 date-time when this comment was published.
386 "post": { # Data about the post containing this comment.
387 "id": "A String", # The identifier of the post containing this comment.
388 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700389 "content": "A String", # The actual content of the comment. May include HTML markup.
John Asmuth614db982014-04-24 15:46:26 -0400390 "id": "A String", # The identifier for this resource.
391 "selfLink": "A String", # The API REST URL to fetch this resource from.
392 }</pre>
393</div>
394
395<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700396 <code class="details" id="removeContent">removeContent(blogId, postId, commentId, x__xgafv=None)</code>
397 <pre>Removes the content of a comment by blog id, post id and comment id.
John Asmuth614db982014-04-24 15:46:26 -0400398
399Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700400 blogId: string, A parameter (required)
401 postId: string, A parameter (required)
402 commentId: string, A parameter (required)
403 x__xgafv: string, V1 error format.
404 Allowed values
405 1 - v1 error format
406 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400407
408Returns:
409 An object of the form:
410
411 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700412 "status": "A String", # The status of the comment (only populated for admin users).
John Asmuth614db982014-04-24 15:46:26 -0400413 "inReplyTo": { # Data about the comment this is in reply to.
414 "id": "A String", # The identified of the parent of this comment.
415 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700416 "kind": "A String", # The kind of this entry. Always blogger#comment.
John Asmuth614db982014-04-24 15:46:26 -0400417 "author": { # The author of this Comment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700418 "url": "A String", # The URL of the creator's Profile page.
419 "image": { # The creator's avatar.
420 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -0400421 },
422 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700423 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400424 },
425 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
426 "blog": { # Data about the blog containing this comment.
427 "id": "A String", # The identifier of the blog containing this comment.
428 },
429 "published": "A String", # RFC 3339 date-time when this comment was published.
430 "post": { # Data about the post containing this comment.
431 "id": "A String", # The identifier of the post containing this comment.
432 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700433 "content": "A String", # The actual content of the comment. May include HTML markup.
John Asmuth614db982014-04-24 15:46:26 -0400434 "id": "A String", # The identifier for this resource.
435 "selfLink": "A String", # The API REST URL to fetch this resource from.
436 }</pre>
437</div>
438
439</body></html>