blob: 94ce5e6628cb6c9345591892e8625b4a5c2c0321 [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">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <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 -040080<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070081 <code><a href="#list">list(userId, blogId, fetchBodies=None, view=None, pageToken=None, status=None, startDate=None, maxResults=None, labels=None, orderBy=None, endDate=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -070082<p class="firstline">Lists post and user info pairs.</p>
John Asmuth614db982014-04-24 15:46:26 -040083<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 -070088 <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 -040090
91Args:
Dan O'Mearadd494642020-05-01 07:42:23 -070092 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 -0400100
101Returns:
102 An object of the form:
103
104 {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700105 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#postUserInfo.
Bu Sun Kim65020912020-05-20 12:08:20 -0700106 &quot;post&quot;: { # The Post resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700107 &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
Bu Sun Kim65020912020-05-20 12:08:20 -0700108 &quot;author&quot;: { # The author of this Post.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700109 &quot;displayName&quot;: &quot;A String&quot;, # The display name.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700110 &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
Bu Sun Kim65020912020-05-20 12:08:20 -0700111 &quot;image&quot;: { # The creator&#x27;s avatar.
112 &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
113 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700114 &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400115 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700116 &quot;etag&quot;: &quot;A String&quot;, # Etag of the resource.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700117 &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this Post was published.
Bu Sun Kim65020912020-05-20 12:08:20 -0700118 &quot;images&quot;: [ # Display image for the Post.
John Asmuth614db982014-04-24 15:46:26 -0400119 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700120 &quot;url&quot;: &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400121 },
122 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700123 &quot;labels&quot;: [ # The list of labels this Post was tagged with.
124 &quot;A String&quot;,
125 ],
126 &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this Post was last updated.
127 &quot;location&quot;: { # The location for geotagged posts.
128 &quot;lat&quot;: 3.14, # Location&#x27;s latitude.
129 &quot;span&quot;: &quot;A String&quot;, # Location&#x27;s viewport span. Can be used when rendering a map preview.
130 &quot;name&quot;: &quot;A String&quot;, # Location name.
131 &quot;lng&quot;: 3.14, # Location&#x27;s longitude.
132 },
133 &quot;customMetaData&quot;: &quot;A String&quot;, # The JSON meta-data for the Post.
134 &quot;id&quot;: &quot;A String&quot;, # The identifier of this Post.
135 &quot;blog&quot;: { # Data about the blog containing this Post.
136 &quot;id&quot;: &quot;A String&quot;, # The identifier of the Blog that contains this Post.
137 },
138 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#post.
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;replies&quot;: { # The container of comments on this Post.
142 &quot;totalItems&quot;: &quot;A String&quot;, # The count of comments on this post.
143 &quot;items&quot;: [ # The List of Comments for this Post.
144 {
145 &quot;content&quot;: &quot;A String&quot;, # The actual content of the comment. May include HTML markup.
146 &quot;id&quot;: &quot;A String&quot;, # The identifier for this resource.
147 &quot;post&quot;: { # Data about the post containing this comment.
148 &quot;id&quot;: &quot;A String&quot;, # The identifier of the post containing this comment.
149 },
150 &quot;blog&quot;: { # Data about the blog containing this comment.
151 &quot;id&quot;: &quot;A String&quot;, # The identifier of the blog containing this comment.
152 },
153 &quot;status&quot;: &quot;A String&quot;, # The status of the comment (only populated for admin users).
154 &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
155 &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was last updated.
156 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entry. Always blogger#comment.
157 &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;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was published.
161 &quot;author&quot;: { # The author of this Comment.
162 &quot;displayName&quot;: &quot;A String&quot;, # The display name.
163 &quot;image&quot;: { # The creator&#x27;s avatar.
164 &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
165 },
166 &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
167 &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
168 },
169 },
170 ],
171 &quot;selfLink&quot;: &quot;A String&quot;, # The URL of the comments on this post.
172 },
173 &quot;title&quot;: &quot;A String&quot;, # The title of the Post.
174 &quot;url&quot;: &quot;A String&quot;, # The URL where this Post is displayed.
175 &quot;content&quot;: &quot;A String&quot;, # The content of the Post. May contain HTML markup.
176 &quot;titleLink&quot;: &quot;A String&quot;, # The title link URL, similar to atom&#x27;s related link.
John Asmuth614db982014-04-24 15:46:26 -0400177 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700178 &quot;post_user_info&quot;: { # Information about a User for the Post.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700179 &quot;postId&quot;: &quot;A String&quot;, # ID of the Post resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700180 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#postPerUserInfo.
181 &quot;blogId&quot;: &quot;A String&quot;, # ID of the Blog that the post resource belongs to.
182 &quot;hasEditAccess&quot;: True or False, # True if the user has Author level access to the post.
183 &quot;userId&quot;: &quot;A String&quot;, # ID of the User.
John Asmuth614db982014-04-24 15:46:26 -0400184 },
185 }</pre>
186</div>
187
188<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700189 <code class="details" id="list">list(userId, blogId, fetchBodies=None, view=None, pageToken=None, status=None, startDate=None, maxResults=None, labels=None, orderBy=None, endDate=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700190 <pre>Lists post and user info pairs.
John Asmuth614db982014-04-24 15:46:26 -0400191
192Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700193 userId: string, A parameter (required)
194 blogId: string, A parameter (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700195 fetchBodies: boolean, A parameter
Bu Sun Kim65020912020-05-20 12:08:20 -0700196 view: string, A parameter
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700197 pageToken: string, A parameter
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700198 status: string, A parameter (repeated)
199 startDate: string, A parameter
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700200 maxResults: integer, A parameter
201 labels: string, A parameter
202 orderBy: string, A parameter
203 endDate: string, A parameter
Dan O'Mearadd494642020-05-01 07:42:23 -0700204 x__xgafv: string, V1 error format.
John Asmuth614db982014-04-24 15:46:26 -0400205 Allowed values
Dan O'Mearadd494642020-05-01 07:42:23 -0700206 1 - v1 error format
207 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400208
209Returns:
210 An object of the form:
211
212 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700213 &quot;items&quot;: [ # The list of Posts with User information for the post, for this Blog.
John Asmuth614db982014-04-24 15:46:26 -0400214 {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700215 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#postUserInfo.
Bu Sun Kim65020912020-05-20 12:08:20 -0700216 &quot;post&quot;: { # The Post resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700217 &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
Bu Sun Kim65020912020-05-20 12:08:20 -0700218 &quot;author&quot;: { # The author of this Post.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700219 &quot;displayName&quot;: &quot;A String&quot;, # The display name.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700220 &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
Bu Sun Kim65020912020-05-20 12:08:20 -0700221 &quot;image&quot;: { # The creator&#x27;s avatar.
222 &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
223 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700224 &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400225 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700226 &quot;etag&quot;: &quot;A String&quot;, # Etag of the resource.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700227 &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this Post was published.
Bu Sun Kim65020912020-05-20 12:08:20 -0700228 &quot;images&quot;: [ # Display image for the Post.
John Asmuth614db982014-04-24 15:46:26 -0400229 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700230 &quot;url&quot;: &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400231 },
232 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700233 &quot;labels&quot;: [ # The list of labels this Post was tagged with.
234 &quot;A String&quot;,
235 ],
236 &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this Post was last updated.
237 &quot;location&quot;: { # The location for geotagged posts.
238 &quot;lat&quot;: 3.14, # Location&#x27;s latitude.
239 &quot;span&quot;: &quot;A String&quot;, # Location&#x27;s viewport span. Can be used when rendering a map preview.
240 &quot;name&quot;: &quot;A String&quot;, # Location name.
241 &quot;lng&quot;: 3.14, # Location&#x27;s longitude.
242 },
243 &quot;customMetaData&quot;: &quot;A String&quot;, # The JSON meta-data for the Post.
244 &quot;id&quot;: &quot;A String&quot;, # The identifier of this Post.
245 &quot;blog&quot;: { # Data about the blog containing this Post.
246 &quot;id&quot;: &quot;A String&quot;, # The identifier of the Blog that contains this Post.
247 },
248 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#post.
249 &quot;readerComments&quot;: &quot;A String&quot;, # Comment control and display setting for readers of this post.
250 &quot;status&quot;: &quot;A String&quot;, # Status of the post. Only set for admin-level requests.
251 &quot;replies&quot;: { # The container of comments on this Post.
252 &quot;totalItems&quot;: &quot;A String&quot;, # The count of comments on this post.
253 &quot;items&quot;: [ # The List of Comments for this Post.
254 {
255 &quot;content&quot;: &quot;A String&quot;, # The actual content of the comment. May include HTML markup.
256 &quot;id&quot;: &quot;A String&quot;, # The identifier for this resource.
257 &quot;post&quot;: { # Data about the post containing this comment.
258 &quot;id&quot;: &quot;A String&quot;, # The identifier of the post containing this comment.
259 },
260 &quot;blog&quot;: { # Data about the blog containing this comment.
261 &quot;id&quot;: &quot;A String&quot;, # The identifier of the blog containing this comment.
262 },
263 &quot;status&quot;: &quot;A String&quot;, # The status of the comment (only populated for admin users).
264 &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
265 &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was last updated.
266 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entry. Always blogger#comment.
267 &quot;inReplyTo&quot;: { # Data about the comment this is in reply to.
268 &quot;id&quot;: &quot;A String&quot;, # The identified of the parent of this comment.
269 },
270 &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was published.
271 &quot;author&quot;: { # The author of this Comment.
272 &quot;displayName&quot;: &quot;A String&quot;, # The display name.
273 &quot;image&quot;: { # The creator&#x27;s avatar.
274 &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
275 },
276 &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
277 &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
278 },
279 },
280 ],
281 &quot;selfLink&quot;: &quot;A String&quot;, # The URL of the comments on this post.
282 },
283 &quot;title&quot;: &quot;A String&quot;, # The title of the Post.
284 &quot;url&quot;: &quot;A String&quot;, # The URL where this Post is displayed.
285 &quot;content&quot;: &quot;A String&quot;, # The content of the Post. May contain HTML markup.
286 &quot;titleLink&quot;: &quot;A String&quot;, # The title link URL, similar to atom&#x27;s related link.
John Asmuth614db982014-04-24 15:46:26 -0400287 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700288 &quot;post_user_info&quot;: { # Information about a User for the Post.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700289 &quot;postId&quot;: &quot;A String&quot;, # ID of the Post resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700290 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#postPerUserInfo.
291 &quot;blogId&quot;: &quot;A String&quot;, # ID of the Blog that the post resource belongs to.
292 &quot;hasEditAccess&quot;: True or False, # True if the user has Author level access to the post.
293 &quot;userId&quot;: &quot;A String&quot;, # ID of the User.
John Asmuth614db982014-04-24 15:46:26 -0400294 },
295 },
296 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700297 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#postList.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700298 &quot;nextPageToken&quot;: &quot;A String&quot;, # Pagination token to fetch the next page, if one exists.
John Asmuth614db982014-04-24 15:46:26 -0400299 }</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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700311 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400312 page. Returns None if there are no more items in the collection.
313 </pre>
314</div>
315
316</body></html>