Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / df61397973d36909a46fc4c3bf0e006dbb69f79a / . / docs / dyn / blogger_v2.comments.html
blob: b96fdfb481ea0ad06552e4fbd9bd66821319ca02 [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
75<h1><a href="blogger_v2.html">Blogger API</a> . <a href="blogger_v2.comments.html">comments</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(blogId, postId, commentId)</a></code></p>
79<p class="firstline">Gets one comment by id.</p>
80<p class="toc_element">
81 <code><a href="#list">list(blogId, postId, startDate=None, fetchBodies=None, pageToken=None, maxResults=None)</a></code></p>
82<p class="firstline">Retrieves the comments for a blog, possibly filtered.</p>
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">
88 <code class="details" id="get">get(blogId, postId, commentId)</code>
89 <pre>Gets one comment by id.
90
91Args:
92 blogId: string, ID of the blog to containing the comment. (required)
93 postId: string, ID of the post to fetch posts from. (required)
94 commentId: string, The ID of the comment to get. (required)
95
96Returns:
97 An object of the form:
98
99 {
100 "content": "A String", # The actual content of the comment. May include HTML markup.
101 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
102 "inReplyTo": { # Data about the comment this is in reply to.
103 "id": "A String", # The identified of the parent of this comment.
104 },
105 "author": { # The author of this Comment.
106 "url": "A String", # The URL of the Comment creator's Profile page.
107 "image": { # The comment creator's avatar.
108 "url": "A String", # The comment creator's avatar URL.
109 },
110 "displayName": "A String", # The display name.
111 "id": "A String", # The identifier of the Comment creator.
112 },
113 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
114 "blog": { # Data about the blog containing this comment.
115 "id": "A String", # The identifier of the blog containing this comment.
116 },
117 "published": "A String", # RFC 3339 date-time when this comment was published.
118 "post": { # Data about the post containing this comment.
119 "id": "A String", # The identifier of the post containing this comment.
120 },
121 "id": "A String", # The identifier for this resource.
122 "selfLink": "A String", # The API REST URL to fetch this resource from.
123 }</pre>
124</div>
125
126<div class="method">
127 <code class="details" id="list">list(blogId, postId, startDate=None, fetchBodies=None, pageToken=None, maxResults=None)</code>
128 <pre>Retrieves the comments for a blog, possibly filtered.
129
130Args:
131 blogId: string, ID of the blog to fetch comments from. (required)
132 postId: string, ID of the post to fetch posts from. (required)
133 startDate: string, Earliest date of comment to fetch, a date-time with RFC 3339 formatting.
134 fetchBodies: boolean, Whether the body content of the comments is included.
135 pageToken: string, Continuation token if request is paged.
136 maxResults: integer, Maximum number of comments to include in the result.
137
138Returns:
139 An object of the form:
140
141 {
142 "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
143 "items": [ # The List of Comments for a Post.
144 {
145 "content": "A String", # The actual content of the comment. May include HTML markup.
146 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
147 "inReplyTo": { # Data about the comment this is in reply to.
148 "id": "A String", # The identified of the parent of this comment.
149 },
150 "author": { # The author of this Comment.
151 "url": "A String", # The URL of the Comment creator's Profile page.
152 "image": { # The comment creator's avatar.
153 "url": "A String", # The comment creator's avatar URL.
154 },
155 "displayName": "A String", # The display name.
156 "id": "A String", # The identifier of the Comment creator.
157 },
158 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
159 "blog": { # Data about the blog containing this comment.
160 "id": "A String", # The identifier of the blog containing this comment.
161 },
162 "published": "A String", # RFC 3339 date-time when this comment was published.
163 "post": { # Data about the post containing this comment.
164 "id": "A String", # The identifier of the post containing this comment.
165 },
166 "id": "A String", # The identifier for this resource.
167 "selfLink": "A String", # The API REST URL to fetch this resource from.
168 },
169 ],
170 "kind": "blogger#commentList", # The kind of this entry. Always blogger#commentList
171 "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
172 }</pre>
173</div>
174
175<div class="method">
176 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
177 <pre>Retrieves the next page of results.
178
179Args:
180 previous_request: The request for the previous page. (required)
181 previous_response: The response from the request for the previous page. (required)
182
183Returns:
184 A request object that you can call 'execute()' on to request the next
185 page. Returns None if there are no more items in the collection.
186 </pre>
187</div>
188
189</body></html>