Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e633be11dbb412e5030b5afca31111fa4074dff1 / . / docs / dyn / blogger_v3.comments.html
blob: 604e3fb8c573c0dc9d6da089e2932844f943ec21 [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.comments.html">comments</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#approve">approve(blogId, postId, commentId)</a></code></p>
79<p class="firstline">Marks a comment as not spam.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(blogId, postId, commentId)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]82<p class="firstline">Delete a comment by ID.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]83<p class="toc_element">
84 <code><a href="#get">get(blogId, postId, commentId, view=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]85<p class="firstline">Gets one comment by ID.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]86<p class="toc_element">
87 <code><a href="#list">list(blogId, postId, status=None, startDate=None, fetchBodies=None, endDate=None, pageToken=None, maxResults=None, view=None)</a></code></p>
88<p class="firstline">Retrieves the comments for a post, possibly filtered.</p>
89<p class="toc_element">
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]90 <code><a href="#listByBlog">listByBlog(blogId, status=None, startDate=None, endDate=None, pageToken=None, maxResults=None, fetchBodies=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]91<p class="firstline">Retrieves the comments for a blog, across all posts, possibly filtered.</p>
92<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">
99 <code><a href="#markAsSpam">markAsSpam(blogId, postId, commentId)</a></code></p>
100<p class="firstline">Marks a comment as spam.</p>
101<p class="toc_element">
102 <code><a href="#removeContent">removeContent(blogId, postId, commentId)</a></code></p>
103<p class="firstline">Removes the content of a comment.</p>
104<h3>Method Details</h3>
105<div class="method">
106 <code class="details" id="approve">approve(blogId, postId, commentId)</code>
107 <pre>Marks a comment as not spam.
108
109Args:
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]110 blogId: string, The ID of the Blog. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]111 postId: string, The ID of the Post. (required)
112 commentId: string, The ID of the comment to mark as not spam. (required)
113
114Returns:
115 An object of the form:
116
117 {
118 "status": "A String", # The status of the comment (only populated for admin users)
119 "content": "A String", # The actual content of the comment. May include HTML markup.
120 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
121 "inReplyTo": { # Data about the comment this is in reply to.
122 "id": "A String", # The identified of the parent of this comment.
123 },
124 "author": { # The author of this Comment.
125 "url": "A String", # The URL of the Comment creator's Profile page.
126 "image": { # The comment creator's avatar.
127 "url": "A String", # The comment creator's avatar URL.
128 },
129 "displayName": "A String", # The display name.
130 "id": "A String", # The identifier of the Comment creator.
131 },
132 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
133 "blog": { # Data about the blog containing this comment.
134 "id": "A String", # The identifier of the blog containing this comment.
135 },
136 "published": "A String", # RFC 3339 date-time when this comment was published.
137 "post": { # Data about the post containing this comment.
138 "id": "A String", # The identifier of the post containing this comment.
139 },
140 "id": "A String", # The identifier for this resource.
141 "selfLink": "A String", # The API REST URL to fetch this resource from.
142 }</pre>
143</div>
144
145<div class="method">
146 <code class="details" id="delete">delete(blogId, postId, commentId)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]147 <pre>Delete a comment by ID.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]148
149Args:
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]150 blogId: string, The ID of the Blog. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]151 postId: string, The ID of the Post. (required)
152 commentId: string, The ID of the comment to delete. (required)
153</pre>
154</div>
155
156<div class="method">
157 <code class="details" id="get">get(blogId, postId, commentId, view=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]158 <pre>Gets one comment by ID.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]159
160Args:
161 blogId: string, ID of the blog to containing the comment. (required)
162 postId: string, ID of the post to fetch posts from. (required)
163 commentId: string, The ID of the comment to get. (required)
164 view: string, Access level for the requested comment (default: READER). Note that some comments will require elevated permissions, for example comments where the parent posts which is in a draft state, or comments that are pending moderation.
165 Allowed values
166 ADMIN - Admin level detail
167 AUTHOR - Author level detail
168 READER - Admin level detail
169
170Returns:
171 An object of the form:
172
173 {
174 "status": "A String", # The status of the comment (only populated for admin users)
175 "content": "A String", # The actual content of the comment. May include HTML markup.
176 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
177 "inReplyTo": { # Data about the comment this is in reply to.
178 "id": "A String", # The identified of the parent of this comment.
179 },
180 "author": { # The author of this Comment.
181 "url": "A String", # The URL of the Comment creator's Profile page.
182 "image": { # The comment creator's avatar.
183 "url": "A String", # The comment creator's avatar URL.
184 },
185 "displayName": "A String", # The display name.
186 "id": "A String", # The identifier of the Comment creator.
187 },
188 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
189 "blog": { # Data about the blog containing this comment.
190 "id": "A String", # The identifier of the blog containing this comment.
191 },
192 "published": "A String", # RFC 3339 date-time when this comment was published.
193 "post": { # Data about the post containing this comment.
194 "id": "A String", # The identifier of the post containing this comment.
195 },
196 "id": "A String", # The identifier for this resource.
197 "selfLink": "A String", # The API REST URL to fetch this resource from.
198 }</pre>
199</div>
200
201<div class="method">
202 <code class="details" id="list">list(blogId, postId, status=None, startDate=None, fetchBodies=None, endDate=None, pageToken=None, maxResults=None, view=None)</code>
203 <pre>Retrieves the comments for a post, possibly filtered.
204
205Args:
206 blogId: string, ID of the blog to fetch comments from. (required)
207 postId: string, ID of the post to fetch posts from. (required)
208 status: string, A parameter (repeated)
209 Allowed values
210 emptied - Comments that have had their content removed
211 live - Comments that are publicly visible
212 pending - Comments that are awaiting administrator approval
213 spam - Comments marked as spam by the administrator
214 startDate: string, Earliest date of comment to fetch, a date-time with RFC 3339 formatting.
215 fetchBodies: boolean, Whether the body content of the comments is included.
216 endDate: string, Latest date of comment to fetch, a date-time with RFC 3339 formatting.
217 pageToken: string, Continuation token if request is paged.
218 maxResults: integer, Maximum number of comments to include in the result.
219 view: string, Access level with which to view the returned result. Note that some fields require elevated access.
220 Allowed values
221 ADMIN - Admin level detail
222 AUTHOR - Author level detail
223 READER - Reader level detail
224
225Returns:
226 An object of the form:
227
228 {
229 "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
230 "items": [ # The List of Comments for a Post.
231 {
232 "status": "A String", # The status of the comment (only populated for admin users)
233 "content": "A String", # The actual content of the comment. May include HTML markup.
234 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
235 "inReplyTo": { # Data about the comment this is in reply to.
236 "id": "A String", # The identified of the parent of this comment.
237 },
238 "author": { # The author of this Comment.
239 "url": "A String", # The URL of the Comment creator's Profile page.
240 "image": { # The comment creator's avatar.
241 "url": "A String", # The comment creator's avatar URL.
242 },
243 "displayName": "A String", # The display name.
244 "id": "A String", # The identifier of the Comment creator.
245 },
246 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
247 "blog": { # Data about the blog containing this comment.
248 "id": "A String", # The identifier of the blog containing this comment.
249 },
250 "published": "A String", # RFC 3339 date-time when this comment was published.
251 "post": { # Data about the post containing this comment.
252 "id": "A String", # The identifier of the post containing this comment.
253 },
254 "id": "A String", # The identifier for this resource.
255 "selfLink": "A String", # The API REST URL to fetch this resource from.
256 },
257 ],
258 "kind": "blogger#commentList", # The kind of this entry. Always blogger#commentList
259 "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
260 }</pre>
261</div>
262
263<div class="method">
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]264 <code class="details" id="listByBlog">listByBlog(blogId, status=None, startDate=None, endDate=None, pageToken=None, maxResults=None, fetchBodies=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]265 <pre>Retrieves the comments for a blog, across all posts, possibly filtered.
266
267Args:
268 blogId: string, ID of the blog to fetch comments from. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]269 status: string, A parameter (repeated)
270 Allowed values
271 emptied - Comments that have had their content removed
272 live - Comments that are publicly visible
273 pending - Comments that are awaiting administrator approval
274 spam - Comments marked as spam by the administrator
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]275 startDate: string, Earliest date of comment to fetch, a date-time with RFC 3339 formatting.
276 endDate: string, Latest date of comment to fetch, a date-time with RFC 3339 formatting.
277 pageToken: string, Continuation token if request is paged.
278 maxResults: integer, Maximum number of comments to include in the result.
279 fetchBodies: boolean, Whether the body content of the comments is included.
280
281Returns:
282 An object of the form:
283
284 {
285 "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
286 "items": [ # The List of Comments for a Post.
287 {
288 "status": "A String", # The status of the comment (only populated for admin users)
289 "content": "A String", # The actual content of the comment. May include HTML markup.
290 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
291 "inReplyTo": { # Data about the comment this is in reply to.
292 "id": "A String", # The identified of the parent of this comment.
293 },
294 "author": { # The author of this Comment.
295 "url": "A String", # The URL of the Comment creator's Profile page.
296 "image": { # The comment creator's avatar.
297 "url": "A String", # The comment creator's avatar URL.
298 },
299 "displayName": "A String", # The display name.
300 "id": "A String", # The identifier of the Comment creator.
301 },
302 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
303 "blog": { # Data about the blog containing this comment.
304 "id": "A String", # The identifier of the blog containing this comment.
305 },
306 "published": "A String", # RFC 3339 date-time when this comment was published.
307 "post": { # Data about the post containing this comment.
308 "id": "A String", # The identifier of the post containing this comment.
309 },
310 "id": "A String", # The identifier for this resource.
311 "selfLink": "A String", # The API REST URL to fetch this resource from.
312 },
313 ],
314 "kind": "blogger#commentList", # The kind of this entry. Always blogger#commentList
315 "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
316 }</pre>
317</div>
318
319<div class="method">
320 <code class="details" id="listByBlog_next">listByBlog_next(previous_request, previous_response)</code>
321 <pre>Retrieves the next page of results.
322
323Args:
324 previous_request: The request for the previous page. (required)
325 previous_response: The response from the request for the previous page. (required)
326
327Returns:
328 A request object that you can call 'execute()' on to request the next
329 page. Returns None if there are no more items in the collection.
330 </pre>
331</div>
332
333<div class="method">
334 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
335 <pre>Retrieves the next page of results.
336
337Args:
338 previous_request: The request for the previous page. (required)
339 previous_response: The response from the request for the previous page. (required)
340
341Returns:
342 A request object that you can call 'execute()' on to request the next
343 page. Returns None if there are no more items in the collection.
344 </pre>
345</div>
346
347<div class="method">
348 <code class="details" id="markAsSpam">markAsSpam(blogId, postId, commentId)</code>
349 <pre>Marks a comment as spam.
350
351Args:
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]352 blogId: string, The ID of the Blog. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]353 postId: string, The ID of the Post. (required)
354 commentId: string, The ID of the comment to mark as spam. (required)
355
356Returns:
357 An object of the form:
358
359 {
360 "status": "A String", # The status of the comment (only populated for admin users)
361 "content": "A String", # The actual content of the comment. May include HTML markup.
362 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
363 "inReplyTo": { # Data about the comment this is in reply to.
364 "id": "A String", # The identified of the parent of this comment.
365 },
366 "author": { # The author of this Comment.
367 "url": "A String", # The URL of the Comment creator's Profile page.
368 "image": { # The comment creator's avatar.
369 "url": "A String", # The comment creator's avatar URL.
370 },
371 "displayName": "A String", # The display name.
372 "id": "A String", # The identifier of the Comment creator.
373 },
374 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
375 "blog": { # Data about the blog containing this comment.
376 "id": "A String", # The identifier of the blog containing this comment.
377 },
378 "published": "A String", # RFC 3339 date-time when this comment was published.
379 "post": { # Data about the post containing this comment.
380 "id": "A String", # The identifier of the post containing this comment.
381 },
382 "id": "A String", # The identifier for this resource.
383 "selfLink": "A String", # The API REST URL to fetch this resource from.
384 }</pre>
385</div>
386
387<div class="method">
388 <code class="details" id="removeContent">removeContent(blogId, postId, commentId)</code>
389 <pre>Removes the content of a comment.
390
391Args:
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]392 blogId: string, The ID of the Blog. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]393 postId: string, The ID of the Post. (required)
394 commentId: string, The ID of the comment to delete content from. (required)
395
396Returns:
397 An object of the form:
398
399 {
400 "status": "A String", # The status of the comment (only populated for admin users)
401 "content": "A String", # The actual content of the comment. May include HTML markup.
402 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
403 "inReplyTo": { # Data about the comment this is in reply to.
404 "id": "A String", # The identified of the parent of this comment.
405 },
406 "author": { # The author of this Comment.
407 "url": "A String", # The URL of the Comment creator's Profile page.
408 "image": { # The comment creator's avatar.
409 "url": "A String", # The comment creator's avatar URL.
410 },
411 "displayName": "A String", # The display name.
412 "id": "A String", # The identifier of the Comment creator.
413 },
414 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
415 "blog": { # Data about the blog containing this comment.
416 "id": "A String", # The identifier of the blog containing this comment.
417 },
418 "published": "A String", # RFC 3339 date-time when this comment was published.
419 "post": { # Data about the post containing this comment.
420 "id": "A String", # The identifier of the post containing this comment.
421 },
422 "id": "A String", # The identifier for this resource.
423 "selfLink": "A String", # The API REST URL to fetch this resource from.
424 }</pre>
425</div>
426
427</body></html>