blob: e335c970954a29ee5cc96345999c4bed238a3dfd [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070084 <code><a href="#list">list(userId, blogId, pageToken=None, startDate=None, labels=None, maxResults=None, status=None, orderBy=None, endDate=None, view=None, fetchBodies=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 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700113 &quot;post&quot;: { # The Post resource.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700114 &quot;content&quot;: &quot;A String&quot;, # The content of the Post. May contain HTML markup.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700115 &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700116 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#post.
Bu Sun Kim65020912020-05-20 12:08:20 -0700117 &quot;author&quot;: { # The author of this Post.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700118 &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700119 &quot;displayName&quot;: &quot;A String&quot;, # The display name.
Bu Sun Kim65020912020-05-20 12:08:20 -0700120 &quot;image&quot;: { # The creator&#x27;s avatar.
121 &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
122 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700123 &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400124 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700125 &quot;title&quot;: &quot;A String&quot;, # The title of the Post.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700126 &quot;labels&quot;: [ # The list of labels this Post was tagged with.
127 &quot;A String&quot;,
128 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700129 &quot;titleLink&quot;: &quot;A String&quot;, # The title link URL, similar to atom&#x27;s related link.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700130 &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this Post was last updated.
131 &quot;location&quot;: { # The location for geotagged posts.
132 &quot;lat&quot;: 3.14, # Location&#x27;s latitude.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700133 &quot;lng&quot;: 3.14, # Location&#x27;s longitude.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700134 &quot;span&quot;: &quot;A String&quot;, # Location&#x27;s viewport span. Can be used when rendering a map preview.
135 &quot;name&quot;: &quot;A String&quot;, # Location name.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700136 },
137 &quot;customMetaData&quot;: &quot;A String&quot;, # The JSON meta-data for the Post.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700138 &quot;url&quot;: &quot;A String&quot;, # The URL where this Post is displayed.
139 &quot;readerComments&quot;: &quot;A String&quot;, # Comment control and display setting for readers of this post.
140 &quot;status&quot;: &quot;A String&quot;, # Status of the post. Only set for admin-level requests.
141 &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this Post was published.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700142 &quot;blog&quot;: { # Data about the blog containing this Post.
143 &quot;id&quot;: &quot;A String&quot;, # The identifier of the Blog that contains this Post.
144 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700145 &quot;etag&quot;: &quot;A String&quot;, # Etag of the resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700146 &quot;replies&quot;: { # The container of comments on this Post.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700147 &quot;items&quot;: [ # The List of Comments for this Post.
148 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700149 &quot;author&quot;: { # The author of this Comment.
150 &quot;displayName&quot;: &quot;A String&quot;, # The display name.
151 &quot;image&quot;: { # The creator&#x27;s avatar.
152 &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
153 },
154 &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
155 &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
156 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700157 &quot;inReplyTo&quot;: { # Data about the comment this is in reply to.
158 &quot;id&quot;: &quot;A String&quot;, # The identified of the parent of this comment.
159 },
160 &quot;content&quot;: &quot;A String&quot;, # The actual content of the comment. May include HTML markup.
161 &quot;post&quot;: { # Data about the post containing this comment.
162 &quot;id&quot;: &quot;A String&quot;, # The identifier of the post containing this comment.
163 },
164 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entry. Always blogger#comment.
165 &quot;blog&quot;: { # Data about the blog containing this comment.
166 &quot;id&quot;: &quot;A String&quot;, # The identifier of the blog containing this comment.
167 },
168 &quot;id&quot;: &quot;A String&quot;, # The identifier for this resource.
169 &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was published.
170 &quot;status&quot;: &quot;A String&quot;, # The status of the comment (only populated for admin users).
171 &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
172 &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was last updated.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700173 },
174 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700175 &quot;totalItems&quot;: &quot;A String&quot;, # The count of comments on this post.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700176 &quot;selfLink&quot;: &quot;A String&quot;, # The URL of the comments on this post.
177 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700178 &quot;images&quot;: [ # Display image for the Post.
179 {
180 &quot;url&quot;: &quot;A String&quot;,
181 },
182 ],
183 &quot;id&quot;: &quot;A String&quot;, # The identifier of this Post.
John Asmuth614db982014-04-24 15:46:26 -0400184 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700185 &quot;post_user_info&quot;: { # Information about a User for the Post.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700186 &quot;blogId&quot;: &quot;A String&quot;, # ID of the Blog that the post resource belongs to.
187 &quot;hasEditAccess&quot;: True or False, # True if the user has Author level access to the post.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700188 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#postPerUserInfo.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700189 &quot;userId&quot;: &quot;A String&quot;, # ID of the User.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700190 &quot;postId&quot;: &quot;A String&quot;, # ID of the Post resource.
John Asmuth614db982014-04-24 15:46:26 -0400191 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700192 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#postUserInfo.
John Asmuth614db982014-04-24 15:46:26 -0400193 }</pre>
194</div>
195
196<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700197 <code class="details" id="list">list(userId, blogId, pageToken=None, startDate=None, labels=None, maxResults=None, status=None, orderBy=None, endDate=None, view=None, fetchBodies=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)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700203 pageToken: string, A parameter
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700204 startDate: string, A parameter
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700205 labels: string, A parameter
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700206 maxResults: integer, A parameter
207 status: string, A parameter (repeated)
208 Allowed values
209 LIVE -
210 DRAFT -
211 SCHEDULED -
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700212 orderBy: string, A parameter
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700213 Allowed values
214 ORDER_BY_UNSPECIFIED -
215 PUBLISHED -
216 UPDATED -
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700217 endDate: string, A parameter
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700218 view: string, A parameter
219 Allowed values
220 VIEW_TYPE_UNSPECIFIED -
221 READER -
222 AUTHOR -
223 ADMIN -
224 fetchBodies: boolean, A parameter
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 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700234 &quot;items&quot;: [ # The list of Posts with User information for the post, for this Blog.
John Asmuth614db982014-04-24 15:46:26 -0400235 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700236 &quot;post&quot;: { # The Post resource.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700237 &quot;content&quot;: &quot;A String&quot;, # The content of the Post. May contain HTML markup.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700238 &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700239 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#post.
Bu Sun Kim65020912020-05-20 12:08:20 -0700240 &quot;author&quot;: { # The author of this Post.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700241 &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700242 &quot;displayName&quot;: &quot;A String&quot;, # The display name.
Bu Sun Kim65020912020-05-20 12:08:20 -0700243 &quot;image&quot;: { # The creator&#x27;s avatar.
244 &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
245 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700246 &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400247 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700248 &quot;title&quot;: &quot;A String&quot;, # The title of the Post.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700249 &quot;labels&quot;: [ # The list of labels this Post was tagged with.
250 &quot;A String&quot;,
251 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700252 &quot;titleLink&quot;: &quot;A String&quot;, # The title link URL, similar to atom&#x27;s related link.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700253 &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this Post was last updated.
254 &quot;location&quot;: { # The location for geotagged posts.
255 &quot;lat&quot;: 3.14, # Location&#x27;s latitude.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700256 &quot;lng&quot;: 3.14, # Location&#x27;s longitude.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700257 &quot;span&quot;: &quot;A String&quot;, # Location&#x27;s viewport span. Can be used when rendering a map preview.
258 &quot;name&quot;: &quot;A String&quot;, # Location name.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700259 },
260 &quot;customMetaData&quot;: &quot;A String&quot;, # The JSON meta-data for the Post.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700261 &quot;url&quot;: &quot;A String&quot;, # The URL where this Post is displayed.
262 &quot;readerComments&quot;: &quot;A String&quot;, # Comment control and display setting for readers of this post.
263 &quot;status&quot;: &quot;A String&quot;, # Status of the post. Only set for admin-level requests.
264 &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this Post was published.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700265 &quot;blog&quot;: { # Data about the blog containing this Post.
266 &quot;id&quot;: &quot;A String&quot;, # The identifier of the Blog that contains this Post.
267 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700268 &quot;etag&quot;: &quot;A String&quot;, # Etag of the resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700269 &quot;replies&quot;: { # The container of comments on this Post.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700270 &quot;items&quot;: [ # The List of Comments for this Post.
271 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700272 &quot;author&quot;: { # The author of this Comment.
273 &quot;displayName&quot;: &quot;A String&quot;, # The display name.
274 &quot;image&quot;: { # The creator&#x27;s avatar.
275 &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
276 },
277 &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
278 &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
279 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700280 &quot;inReplyTo&quot;: { # Data about the comment this is in reply to.
281 &quot;id&quot;: &quot;A String&quot;, # The identified of the parent of this comment.
282 },
283 &quot;content&quot;: &quot;A String&quot;, # The actual content of the comment. May include HTML markup.
284 &quot;post&quot;: { # Data about the post containing this comment.
285 &quot;id&quot;: &quot;A String&quot;, # The identifier of the post containing this comment.
286 },
287 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entry. Always blogger#comment.
288 &quot;blog&quot;: { # Data about the blog containing this comment.
289 &quot;id&quot;: &quot;A String&quot;, # The identifier of the blog containing this comment.
290 },
291 &quot;id&quot;: &quot;A String&quot;, # The identifier for this resource.
292 &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was published.
293 &quot;status&quot;: &quot;A String&quot;, # The status of the comment (only populated for admin users).
294 &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
295 &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was last updated.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700296 },
297 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700298 &quot;totalItems&quot;: &quot;A String&quot;, # The count of comments on this post.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700299 &quot;selfLink&quot;: &quot;A String&quot;, # The URL of the comments on this post.
300 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700301 &quot;images&quot;: [ # Display image for the Post.
302 {
303 &quot;url&quot;: &quot;A String&quot;,
304 },
305 ],
306 &quot;id&quot;: &quot;A String&quot;, # The identifier of this Post.
John Asmuth614db982014-04-24 15:46:26 -0400307 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700308 &quot;post_user_info&quot;: { # Information about a User for the Post.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700309 &quot;blogId&quot;: &quot;A String&quot;, # ID of the Blog that the post resource belongs to.
310 &quot;hasEditAccess&quot;: True or False, # True if the user has Author level access to the post.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700311 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#postPerUserInfo.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700312 &quot;userId&quot;: &quot;A String&quot;, # ID of the User.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700313 &quot;postId&quot;: &quot;A String&quot;, # ID of the Post resource.
John Asmuth614db982014-04-24 15:46:26 -0400314 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700315 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#postUserInfo.
John Asmuth614db982014-04-24 15:46:26 -0400316 },
317 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700318 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#postList.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700319 &quot;nextPageToken&quot;: &quot;A String&quot;, # Pagination token to fetch the next page, if one exists.
John Asmuth614db982014-04-24 15:46:26 -0400320 }</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 -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>