Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / blogger_v2.comments.html
blob: d9bee04264871e303bad9dd90105655e4fbd9f70 [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[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
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]75<h1><a href="blogger_v2.html">Blogger API v3</a> . <a href="blogger_v2.comments.html">comments</a></h1>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#get">get(blogId, postId, commentId, x__xgafv=None)</a></code></p>
79<p class="firstline">Gets a comment by blog id, post id and comment id.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]81 <code><a href="#list">list(blogId, postId, startDate=None, fetchBodies=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Lists comments.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]88 <code class="details" id="get">get(blogId, postId, commentId, x__xgafv=None)</code>
89 <pre>Gets a comment by blog id, post id and comment id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]90
91Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]92 blogId: string, A parameter (required)
93 postId: string, A parameter (required)
94 commentId: string, A parameter (required)
95 x__xgafv: string, V1 error format.
96 Allowed values
97 1 - v1 error format
98 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]99
100Returns:
101 An object of the form:
102
103 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]104 "status": "A String", # The status of the comment (only populated for admin users).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]105 "inReplyTo": { # Data about the comment this is in reply to.
106 "id": "A String", # The identified of the parent of this comment.
107 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]108 "kind": "A String", # The kind of this entry. Always blogger#comment.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]109 "author": { # The author of this Comment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]110 "url": "A String", # The URL of the creator's Profile page.
111 "image": { # The creator's avatar.
112 "url": "A String", # The creator's avatar URL.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]113 },
114 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]115 "id": "A String", # The identifier of the creator.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]116 },
117 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
118 "blog": { # Data about the blog containing this comment.
119 "id": "A String", # The identifier of the blog containing this comment.
120 },
121 "published": "A String", # RFC 3339 date-time when this comment was published.
122 "post": { # Data about the post containing this comment.
123 "id": "A String", # The identifier of the post containing this comment.
124 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]125 "content": "A String", # The actual content of the comment. May include HTML markup.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]126 "id": "A String", # The identifier for this resource.
127 "selfLink": "A String", # The API REST URL to fetch this resource from.
128 }</pre>
129</div>
130
131<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]132 <code class="details" id="list">list(blogId, postId, startDate=None, fetchBodies=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
133 <pre>Lists comments.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]134
135Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]136 blogId: string, A parameter (required)
137 postId: string, A parameter (required)
138 startDate: string, A parameter
139 fetchBodies: boolean, A parameter
140 maxResults: integer, A parameter
141 pageToken: string, A parameter
142 x__xgafv: string, V1 error format.
143 Allowed values
144 1 - v1 error format
145 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]146
147Returns:
148 An object of the form:
149
150 {
151 "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
152 "items": [ # The List of Comments for a Post.
153 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]154 "status": "A String", # The status of the comment (only populated for admin users).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]155 "inReplyTo": { # Data about the comment this is in reply to.
156 "id": "A String", # The identified of the parent of this comment.
157 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]158 "kind": "A String", # The kind of this entry. Always blogger#comment.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]159 "author": { # The author of this Comment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]160 "url": "A String", # The URL of the creator's Profile page.
161 "image": { # The creator's avatar.
162 "url": "A String", # The creator's avatar URL.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]163 },
164 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]165 "id": "A String", # The identifier of the creator.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]166 },
167 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
168 "blog": { # Data about the blog containing this comment.
169 "id": "A String", # The identifier of the blog containing this comment.
170 },
171 "published": "A String", # RFC 3339 date-time when this comment was published.
172 "post": { # Data about the post containing this comment.
173 "id": "A String", # The identifier of the post containing this comment.
174 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]175 "content": "A String", # The actual content of the comment. May include HTML markup.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]176 "id": "A String", # The identifier for this resource.
177 "selfLink": "A String", # The API REST URL to fetch this resource from.
178 },
179 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]180 "kind": "A String", # The kind of this entry. Always blogger#commentList.
181 "etag": "A String", # Etag of the response.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]182 "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
183 }</pre>
184</div>
185
186<div class="method">
187 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
188 <pre>Retrieves the next page of results.
189
190Args:
191 previous_request: The request for the previous page. (required)
192 previous_response: The response from the request for the previous page. (required)
193
194Returns:
195 A request object that you can call 'execute()' on to request the next
196 page. Returns None if there are no more items in the collection.
197 </pre>
198</div>
199
200</body></html>