blob: d9ef889b3b32c0e34fad554682c646bb5e0c852a [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<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 -070075<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 -040076<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <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 -070081 <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 -040083<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080084 <code><a href="#list">list(userId, blogId, endDate=None, fetchBodies=None, labels=None, maxResults=None, orderBy=None, pageToken=None, startDate=None, status=None, view=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -070085<p class="firstline">Lists post and user info pairs.</p>
John Asmuth614db982014-04-24 15:46:26 -040086<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 -070091 <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 -070096 <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 -040098
99Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700100 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 -0400108
109Returns:
110 An object of the form:
111
112 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800113 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#postUserInfo.
114 &quot;post&quot;: { # The Post resource.
115 &quot;author&quot;: { # The author of this Post.
116 &quot;displayName&quot;: &quot;A String&quot;, # The display name.
117 &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
118 &quot;image&quot;: { # The creator&#x27;s avatar.
119 &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
120 },
121 &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800122 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800123 &quot;blog&quot;: { # Data about the blog containing this Post.
124 &quot;id&quot;: &quot;A String&quot;, # The identifier of the Blog that contains this Post.
125 },
126 &quot;content&quot;: &quot;A String&quot;, # The content of the Post. May contain HTML markup.
127 &quot;customMetaData&quot;: &quot;A String&quot;, # The JSON meta-data for the Post.
128 &quot;etag&quot;: &quot;A String&quot;, # Etag of the resource.
129 &quot;id&quot;: &quot;A String&quot;, # The identifier of this Post.
130 &quot;images&quot;: [ # Display image for the Post.
131 {
132 &quot;url&quot;: &quot;A String&quot;,
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800133 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800134 ],
135 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#post.
136 &quot;labels&quot;: [ # The list of labels this Post was tagged with.
137 &quot;A String&quot;,
138 ],
139 &quot;location&quot;: { # The location for geotagged posts.
140 &quot;lat&quot;: 3.14, # Location&#x27;s latitude.
141 &quot;lng&quot;: 3.14, # Location&#x27;s longitude.
142 &quot;name&quot;: &quot;A String&quot;, # Location name.
143 &quot;span&quot;: &quot;A String&quot;, # Location&#x27;s viewport span. Can be used when rendering a map preview.
144 },
145 &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this Post was published.
146 &quot;readerComments&quot;: &quot;A String&quot;, # Comment control and display setting for readers of this post.
147 &quot;replies&quot;: { # The container of comments on this Post.
148 &quot;items&quot;: [ # The List of Comments for this Post.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700149 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800150 &quot;author&quot;: { # The author of this Comment.
151 &quot;displayName&quot;: &quot;A String&quot;, # The display name.
152 &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
153 &quot;image&quot;: { # The creator&#x27;s avatar.
154 &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
155 },
156 &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
157 },
158 &quot;blog&quot;: { # Data about the blog containing this comment.
159 &quot;id&quot;: &quot;A String&quot;, # The identifier of the blog containing this comment.
160 },
161 &quot;content&quot;: &quot;A String&quot;, # The actual content of the comment. May include HTML markup.
162 &quot;id&quot;: &quot;A String&quot;, # The identifier for this resource.
163 &quot;inReplyTo&quot;: { # Data about the comment this is in reply to.
164 &quot;id&quot;: &quot;A String&quot;, # The identified of the parent of this comment.
165 },
166 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entry. Always blogger#comment.
167 &quot;post&quot;: { # Data about the post containing this comment.
168 &quot;id&quot;: &quot;A String&quot;, # The identifier of the post containing this comment.
169 },
170 &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was published.
171 &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
172 &quot;status&quot;: &quot;A String&quot;, # The status of the comment (only populated for admin users).
173 &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was last updated.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700174 },
175 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800176 &quot;selfLink&quot;: &quot;A String&quot;, # The URL of the comments on this post.
177 &quot;totalItems&quot;: &quot;A String&quot;, # The count of comments on this post.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800178 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800179 &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
180 &quot;status&quot;: &quot;A String&quot;, # Status of the post. Only set for admin-level requests.
181 &quot;title&quot;: &quot;A String&quot;, # The title of the Post.
182 &quot;titleLink&quot;: &quot;A String&quot;, # The title link URL, similar to atom&#x27;s related link.
183 &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this Post was last updated.
184 &quot;url&quot;: &quot;A String&quot;, # The URL where this Post is displayed.
185 },
186 &quot;post_user_info&quot;: { # Information about a User for the Post.
187 &quot;blogId&quot;: &quot;A String&quot;, # ID of the Blog that the post resource belongs to.
188 &quot;hasEditAccess&quot;: True or False, # True if the user has Author level access to the post.
189 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#postPerUserInfo.
190 &quot;postId&quot;: &quot;A String&quot;, # ID of the Post resource.
191 &quot;userId&quot;: &quot;A String&quot;, # ID of the User.
192 },
193}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400194</div>
195
196<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800197 <code class="details" id="list">list(userId, blogId, endDate=None, fetchBodies=None, labels=None, maxResults=None, orderBy=None, pageToken=None, startDate=None, status=None, view=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700198 <pre>Lists post and user info pairs.
John Asmuth614db982014-04-24 15:46:26 -0400199
200Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700201 userId: string, A parameter (required)
202 blogId: string, A parameter (required)
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800203 endDate: string, A parameter
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800204 fetchBodies: boolean, A parameter
205 labels: string, A parameter
206 maxResults: integer, A parameter
207 orderBy: string, A parameter
208 Allowed values
209 ORDER_BY_UNSPECIFIED -
210 PUBLISHED -
211 UPDATED -
212 pageToken: string, A parameter
213 startDate: string, A parameter
214 status: string, A parameter (repeated)
215 Allowed values
216 LIVE -
217 DRAFT -
218 SCHEDULED -
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800219 view: string, A parameter
220 Allowed values
221 VIEW_TYPE_UNSPECIFIED -
222 READER -
223 AUTHOR -
224 ADMIN -
Dan O'Mearadd494642020-05-01 07:42:23 -0700225 x__xgafv: string, V1 error format.
John Asmuth614db982014-04-24 15:46:26 -0400226 Allowed values
Dan O'Mearadd494642020-05-01 07:42:23 -0700227 1 - v1 error format
228 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400229
230Returns:
231 An object of the form:
232
233 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800234 &quot;items&quot;: [ # The list of Posts with User information for the post, for this Blog.
235 {
236 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#postUserInfo.
237 &quot;post&quot;: { # The Post resource.
238 &quot;author&quot;: { # The author of this Post.
239 &quot;displayName&quot;: &quot;A String&quot;, # The display name.
240 &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
241 &quot;image&quot;: { # The creator&#x27;s avatar.
242 &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
243 },
244 &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800245 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800246 &quot;blog&quot;: { # Data about the blog containing this Post.
247 &quot;id&quot;: &quot;A String&quot;, # The identifier of the Blog that contains this Post.
248 },
249 &quot;content&quot;: &quot;A String&quot;, # The content of the Post. May contain HTML markup.
250 &quot;customMetaData&quot;: &quot;A String&quot;, # The JSON meta-data for the Post.
251 &quot;etag&quot;: &quot;A String&quot;, # Etag of the resource.
252 &quot;id&quot;: &quot;A String&quot;, # The identifier of this Post.
253 &quot;images&quot;: [ # Display image for the Post.
254 {
255 &quot;url&quot;: &quot;A String&quot;,
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800256 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800257 ],
258 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#post.
259 &quot;labels&quot;: [ # The list of labels this Post was tagged with.
260 &quot;A String&quot;,
261 ],
262 &quot;location&quot;: { # The location for geotagged posts.
263 &quot;lat&quot;: 3.14, # Location&#x27;s latitude.
264 &quot;lng&quot;: 3.14, # Location&#x27;s longitude.
265 &quot;name&quot;: &quot;A String&quot;, # Location name.
266 &quot;span&quot;: &quot;A String&quot;, # Location&#x27;s viewport span. Can be used when rendering a map preview.
267 },
268 &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this Post was published.
269 &quot;readerComments&quot;: &quot;A String&quot;, # Comment control and display setting for readers of this post.
270 &quot;replies&quot;: { # The container of comments on this Post.
271 &quot;items&quot;: [ # The List of Comments for this Post.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700272 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800273 &quot;author&quot;: { # The author of this Comment.
274 &quot;displayName&quot;: &quot;A String&quot;, # The display name.
275 &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
276 &quot;image&quot;: { # The creator&#x27;s avatar.
277 &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
278 },
279 &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
280 },
281 &quot;blog&quot;: { # Data about the blog containing this comment.
282 &quot;id&quot;: &quot;A String&quot;, # The identifier of the blog containing this comment.
283 },
284 &quot;content&quot;: &quot;A String&quot;, # The actual content of the comment. May include HTML markup.
285 &quot;id&quot;: &quot;A String&quot;, # The identifier for this resource.
286 &quot;inReplyTo&quot;: { # Data about the comment this is in reply to.
287 &quot;id&quot;: &quot;A String&quot;, # The identified of the parent of this comment.
288 },
289 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entry. Always blogger#comment.
290 &quot;post&quot;: { # Data about the post containing this comment.
291 &quot;id&quot;: &quot;A String&quot;, # The identifier of the post containing this comment.
292 },
293 &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was published.
294 &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
295 &quot;status&quot;: &quot;A String&quot;, # The status of the comment (only populated for admin users).
296 &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was last updated.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700297 },
298 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800299 &quot;selfLink&quot;: &quot;A String&quot;, # The URL of the comments on this post.
300 &quot;totalItems&quot;: &quot;A String&quot;, # The count of comments on this post.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800301 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800302 &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
303 &quot;status&quot;: &quot;A String&quot;, # Status of the post. Only set for admin-level requests.
304 &quot;title&quot;: &quot;A String&quot;, # The title of the Post.
305 &quot;titleLink&quot;: &quot;A String&quot;, # The title link URL, similar to atom&#x27;s related link.
306 &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this Post was last updated.
307 &quot;url&quot;: &quot;A String&quot;, # The URL where this Post is displayed.
John Asmuth614db982014-04-24 15:46:26 -0400308 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800309 &quot;post_user_info&quot;: { # Information about a User for the Post.
310 &quot;blogId&quot;: &quot;A String&quot;, # ID of the Blog that the post resource belongs to.
311 &quot;hasEditAccess&quot;: True or False, # True if the user has Author level access to the post.
312 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#postPerUserInfo.
313 &quot;postId&quot;: &quot;A String&quot;, # ID of the Post resource.
314 &quot;userId&quot;: &quot;A String&quot;, # ID of the User.
315 },
316 },
317 ],
318 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#postList.
319 &quot;nextPageToken&quot;: &quot;A String&quot;, # Pagination token to fetch the next page, if one exists.
320}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400321</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 -0700332 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400333 page. Returns None if there are no more items in the collection.
334 </pre>
335</div>
336
337</body></html>