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