Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / blogger_v3.postUserInfos.html
blob: 6b7da7d889eb14ba42722a69259add0440239378 [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
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]75<h1><a href="blogger_v3.html">Blogger API v3</a> . <a href="blogger_v3.postUserInfos.html">postUserInfos</a></h1>
John Asmuth614db982014-04-24 15:46:26 -0400[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(userId, blogId, postId, maxComments=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Gets one post and user info pair, by post_id and user_id.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]81 <code><a href="#list">list(userId, blogId, orderBy=None, startDate=None, endDate=None, labels=None, x__xgafv=None, pageToken=None, status=None, maxResults=None, fetchBodies=None, view=None)</a></code></p>
82<p class="firstline">Lists post and user info pairs.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[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(userId, blogId, postId, maxComments=None, x__xgafv=None)</code>
89 <pre>Gets one post and user info pair, by post_id and user_id.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]90
91Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]92 userId: string, A parameter (required)
93 blogId: string, A parameter (required)
94 postId: string, A parameter (required)
95 maxComments: integer, A parameter
96 x__xgafv: string, V1 error format.
97 Allowed values
98 1 - v1 error format
99 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]100
101Returns:
102 An object of the form:
103
104 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]105 "kind": "A String", # The kind of this entity. Always blogger#postUserInfo.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]106 "post": { # The Post resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]107 "status": "A String", # Status of the post. Only set for admin-level requests.
108 "blog": { # Data about the blog containing this Post.
109 "id": "A String", # The identifier of the Blog that contains this Post.
110 },
111 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]112 "titleLink": "A String", # The title link URL, similar to atom's related link.
113 "author": { # The author of this Post.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]114 "url": "A String", # The URL of the creator's Profile page.
115 "image": { # The creator's avatar.
116 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]117 },
118 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]119 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]120 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]121 "title": "A String", # The title of the Post.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]122 "replies": { # The container of comments on this Post.
123 "totalItems": "A String", # The count of comments on this post.
124 "items": [ # The List of Comments for this Post.
125 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]126 "status": "A String", # The status of the comment (only populated for admin users).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]127 "inReplyTo": { # Data about the comment this is in reply to.
128 "id": "A String", # The identified of the parent of this comment.
129 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]130 "kind": "A String", # The kind of this entry. Always blogger#comment.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]131 "author": { # The author of this Comment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]132 "url": "A String", # The URL of the creator's Profile page.
133 "image": { # The creator's avatar.
134 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]135 },
136 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]137 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]138 },
139 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
140 "blog": { # Data about the blog containing this comment.
141 "id": "A String", # The identifier of the blog containing this comment.
142 },
143 "published": "A String", # RFC 3339 date-time when this comment was published.
144 "post": { # Data about the post containing this comment.
145 "id": "A String", # The identifier of the post containing this comment.
146 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]147 "content": "A String", # The actual content of the comment. May include HTML markup.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]148 "id": "A String", # The identifier for this resource.
149 "selfLink": "A String", # The API REST URL to fetch this resource from.
150 },
151 ],
152 "selfLink": "A String", # The URL of the comments on this post.
153 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]154 "readerComments": "A String", # Comment control and display setting for readers of this post.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]155 "labels": [ # The list of labels this Post was tagged with.
156 "A String",
157 ],
158 "customMetaData": "A String", # The JSON meta-data for the Post.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]159 "kind": "A String", # The kind of this entity. Always blogger#post.
160 "content": "A String", # The content of the Post. May contain HTML markup.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]161 "url": "A String", # The URL where this Post is displayed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]162 "etag": "A String", # Etag of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]163 "location": { # The location for geotagged posts.
164 "lat": 3.14, # Location's latitude.
165 "lng": 3.14, # Location's longitude.
166 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
167 "name": "A String", # Location name.
168 },
169 "published": "A String", # RFC 3339 date-time when this Post was published.
170 "images": [ # Display image for the Post.
171 {
172 "url": "A String",
173 },
174 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]175 "id": "A String", # The identifier of this Post.
176 "selfLink": "A String", # The API REST URL to fetch this resource from.
177 },
178 "post_user_info": { # Information about a User for the Post.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]179 "kind": "A String", # The kind of this entity. Always blogger#postPerUserInfo.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]180 "postId": "A String", # ID of the Post resource.
181 "userId": "A String", # ID of the User.
182 "blogId": "A String", # ID of the Blog that the post resource belongs to.
183 "hasEditAccess": True or False, # True if the user has Author level access to the post.
184 },
185 }</pre>
186</div>
187
188<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]189 <code class="details" id="list">list(userId, blogId, orderBy=None, startDate=None, endDate=None, labels=None, x__xgafv=None, pageToken=None, status=None, maxResults=None, fetchBodies=None, view=None)</code>
190 <pre>Lists post and user info pairs.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]191
192Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]193 userId: string, A parameter (required)
194 blogId: string, A parameter (required)
195 orderBy: string, A parameter
196 startDate: string, A parameter
197 endDate: string, A parameter
198 labels: string, A parameter
199 x__xgafv: string, V1 error format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]200 Allowed values
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]201 1 - v1 error format
202 2 - v2 error format
203 pageToken: string, A parameter
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]204 status: string, A parameter (repeated)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]205 maxResults: integer, A parameter
206 fetchBodies: boolean, A parameter
207 view: string, A parameter
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]208
209Returns:
210 An object of the form:
211
212 {
213 "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
214 "items": [ # The list of Posts with User information for the post, for this Blog.
215 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]216 "kind": "A String", # The kind of this entity. Always blogger#postUserInfo.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]217 "post": { # The Post resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]218 "status": "A String", # Status of the post. Only set for admin-level requests.
219 "blog": { # Data about the blog containing this Post.
220 "id": "A String", # The identifier of the Blog that contains this Post.
221 },
222 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]223 "titleLink": "A String", # The title link URL, similar to atom's related link.
224 "author": { # The author of this Post.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]225 "url": "A String", # The URL of the creator's Profile page.
226 "image": { # The creator's avatar.
227 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]228 },
229 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]230 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]231 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]232 "title": "A String", # The title of the Post.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]233 "replies": { # The container of comments on this Post.
234 "totalItems": "A String", # The count of comments on this post.
235 "items": [ # The List of Comments for this Post.
236 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]237 "status": "A String", # The status of the comment (only populated for admin users).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]238 "inReplyTo": { # Data about the comment this is in reply to.
239 "id": "A String", # The identified of the parent of this comment.
240 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]241 "kind": "A String", # The kind of this entry. Always blogger#comment.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]242 "author": { # The author of this Comment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]243 "url": "A String", # The URL of the creator's Profile page.
244 "image": { # The creator's avatar.
245 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]246 },
247 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]248 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]249 },
250 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
251 "blog": { # Data about the blog containing this comment.
252 "id": "A String", # The identifier of the blog containing this comment.
253 },
254 "published": "A String", # RFC 3339 date-time when this comment was published.
255 "post": { # Data about the post containing this comment.
256 "id": "A String", # The identifier of the post containing this comment.
257 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]258 "content": "A String", # The actual content of the comment. May include HTML markup.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]259 "id": "A String", # The identifier for this resource.
260 "selfLink": "A String", # The API REST URL to fetch this resource from.
261 },
262 ],
263 "selfLink": "A String", # The URL of the comments on this post.
264 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]265 "readerComments": "A String", # Comment control and display setting for readers of this post.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]266 "labels": [ # The list of labels this Post was tagged with.
267 "A String",
268 ],
269 "customMetaData": "A String", # The JSON meta-data for the Post.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]270 "kind": "A String", # The kind of this entity. Always blogger#post.
271 "content": "A String", # The content of the Post. May contain HTML markup.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]272 "url": "A String", # The URL where this Post is displayed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]273 "etag": "A String", # Etag of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]274 "location": { # The location for geotagged posts.
275 "lat": 3.14, # Location's latitude.
276 "lng": 3.14, # Location's longitude.
277 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
278 "name": "A String", # Location name.
279 },
280 "published": "A String", # RFC 3339 date-time when this Post was published.
281 "images": [ # Display image for the Post.
282 {
283 "url": "A String",
284 },
285 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]286 "id": "A String", # The identifier of this Post.
287 "selfLink": "A String", # The API REST URL to fetch this resource from.
288 },
289 "post_user_info": { # Information about a User for the Post.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]290 "kind": "A String", # The kind of this entity. Always blogger#postPerUserInfo.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]291 "postId": "A String", # ID of the Post resource.
292 "userId": "A String", # ID of the User.
293 "blogId": "A String", # ID of the Blog that the post resource belongs to.
294 "hasEditAccess": True or False, # True if the user has Author level access to the post.
295 },
296 },
297 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]298 "kind": "A String", # The kind of this entity. Always blogger#postList.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]299 }</pre>
300</div>
301
302<div class="method">
303 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
304 <pre>Retrieves the next page of results.
305
306Args:
307 previous_request: The request for the previous page. (required)
308 previous_response: The response from the request for the previous page. (required)
309
310Returns:
311 A request object that you can call 'execute()' on to request the next
312 page. Returns None if there are no more items in the collection.
313 </pre>
314</div>
315
316</body></html>