blob: 632050a9fbf9e25ed730501aa60c0c2f9f3a48ac [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 Kim65020912020-05-20 12:08:20 -070081 <code><a href="#list">list(userId, blogId, startDate=None, labels=None, endDate=None, orderBy=None, status=None, pageToken=None, maxResults=None, view=None, fetchBodies=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 Kim65020912020-05-20 12:08:20 -0700105 &quot;post&quot;: { # The Post resource.
106 &quot;customMetaData&quot;: &quot;A String&quot;, # The JSON meta-data for the Post.
107 &quot;replies&quot;: { # The container of comments on this Post.
108 &quot;items&quot;: [ # The List of Comments for this Post.
John Asmuth614db982014-04-24 15:46:26 -0400109 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700110 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entry. Always blogger#comment.
111 &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
112 &quot;id&quot;: &quot;A String&quot;, # The identifier for this resource.
113 &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was published.
114 &quot;blog&quot;: { # Data about the blog containing this comment.
115 &quot;id&quot;: &quot;A String&quot;, # The identifier of the blog containing this comment.
John Asmuth614db982014-04-24 15:46:26 -0400116 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700117 &quot;content&quot;: &quot;A String&quot;, # The actual content of the comment. May include HTML markup.
118 &quot;inReplyTo&quot;: { # Data about the comment this is in reply to.
119 &quot;id&quot;: &quot;A String&quot;, # The identified of the parent of this comment.
120 },
121 &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was last updated.
122 &quot;status&quot;: &quot;A String&quot;, # The status of the comment (only populated for admin users).
123 &quot;author&quot;: { # The author of this Comment.
124 &quot;image&quot;: { # The creator&#x27;s avatar.
125 &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
John Asmuth614db982014-04-24 15:46:26 -0400126 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700127 &quot;displayName&quot;: &quot;A String&quot;, # The display name.
128 &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
129 &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400130 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700131 &quot;post&quot;: { # Data about the post containing this comment.
132 &quot;id&quot;: &quot;A String&quot;, # The identifier of the post containing this comment.
John Asmuth614db982014-04-24 15:46:26 -0400133 },
John Asmuth614db982014-04-24 15:46:26 -0400134 },
135 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700136 &quot;selfLink&quot;: &quot;A String&quot;, # The URL of the comments on this post.
137 &quot;totalItems&quot;: &quot;A String&quot;, # The count of comments on this post.
John Asmuth614db982014-04-24 15:46:26 -0400138 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700139 &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
140 &quot;labels&quot;: [ # The list of labels this Post was tagged with.
141 &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400142 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700143 &quot;author&quot;: { # The author of this Post.
144 &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
145 &quot;image&quot;: { # The creator&#x27;s avatar.
146 &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
147 },
148 &quot;displayName&quot;: &quot;A String&quot;, # The display name.
149 &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
John Asmuth614db982014-04-24 15:46:26 -0400150 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700151 &quot;images&quot;: [ # Display image for the Post.
John Asmuth614db982014-04-24 15:46:26 -0400152 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700153 &quot;url&quot;: &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400154 },
155 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700156 &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this Post was published.
157 &quot;title&quot;: &quot;A String&quot;, # The title of the Post.
158 &quot;titleLink&quot;: &quot;A String&quot;, # The title link URL, similar to atom&#x27;s related link.
159 &quot;blog&quot;: { # Data about the blog containing this Post.
160 &quot;id&quot;: &quot;A String&quot;, # The identifier of the Blog that contains this Post.
161 },
162 &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this Post was last updated.
163 &quot;url&quot;: &quot;A String&quot;, # The URL where this Post is displayed.
164 &quot;content&quot;: &quot;A String&quot;, # The content of the Post. May contain HTML markup.
165 &quot;id&quot;: &quot;A String&quot;, # The identifier of this Post.
166 &quot;location&quot;: { # The location for geotagged posts.
167 &quot;name&quot;: &quot;A String&quot;, # Location name.
168 &quot;span&quot;: &quot;A String&quot;, # Location&#x27;s viewport span. Can be used when rendering a map preview.
169 &quot;lat&quot;: 3.14, # Location&#x27;s latitude.
170 &quot;lng&quot;: 3.14, # Location&#x27;s longitude.
171 },
172 &quot;status&quot;: &quot;A String&quot;, # Status of the post. Only set for admin-level requests.
173 &quot;readerComments&quot;: &quot;A String&quot;, # Comment control and display setting for readers of this post.
174 &quot;etag&quot;: &quot;A String&quot;, # Etag of the resource.
175 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#post.
John Asmuth614db982014-04-24 15:46:26 -0400176 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700177 &quot;post_user_info&quot;: { # Information about a User for the Post.
178 &quot;postId&quot;: &quot;A String&quot;, # ID of the Post resource.
179 &quot;hasEditAccess&quot;: True or False, # True if the user has Author level access to the post.
180 &quot;userId&quot;: &quot;A String&quot;, # ID of the User.
181 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#postPerUserInfo.
182 &quot;blogId&quot;: &quot;A String&quot;, # ID of the Blog that the post resource belongs to.
John Asmuth614db982014-04-24 15:46:26 -0400183 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700184 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#postUserInfo.
John Asmuth614db982014-04-24 15:46:26 -0400185 }</pre>
186</div>
187
188<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700189 <code class="details" id="list">list(userId, blogId, startDate=None, labels=None, endDate=None, orderBy=None, status=None, pageToken=None, maxResults=None, view=None, fetchBodies=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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700195 startDate: string, A parameter
Dan O'Mearadd494642020-05-01 07:42:23 -0700196 labels: string, A parameter
Bu Sun Kim65020912020-05-20 12:08:20 -0700197 endDate: string, A parameter
198 orderBy: string, A parameter
199 status: string, A parameter (repeated)
200 pageToken: string, A parameter
201 maxResults: integer, A parameter
202 view: string, A parameter
203 fetchBodies: boolean, 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;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#postList.
214 &quot;items&quot;: [ # The list of Posts with User information for the post, for this Blog.
John Asmuth614db982014-04-24 15:46:26 -0400215 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700216 &quot;post&quot;: { # The Post resource.
217 &quot;customMetaData&quot;: &quot;A String&quot;, # The JSON meta-data for the Post.
218 &quot;replies&quot;: { # The container of comments on this Post.
219 &quot;items&quot;: [ # The List of Comments for this Post.
John Asmuth614db982014-04-24 15:46:26 -0400220 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700221 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entry. Always blogger#comment.
222 &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
223 &quot;id&quot;: &quot;A String&quot;, # The identifier for this resource.
224 &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was published.
225 &quot;blog&quot;: { # Data about the blog containing this comment.
226 &quot;id&quot;: &quot;A String&quot;, # The identifier of the blog containing this comment.
John Asmuth614db982014-04-24 15:46:26 -0400227 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700228 &quot;content&quot;: &quot;A String&quot;, # The actual content of the comment. May include HTML markup.
229 &quot;inReplyTo&quot;: { # Data about the comment this is in reply to.
230 &quot;id&quot;: &quot;A String&quot;, # The identified of the parent of this comment.
231 },
232 &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was last updated.
233 &quot;status&quot;: &quot;A String&quot;, # The status of the comment (only populated for admin users).
234 &quot;author&quot;: { # The author of this Comment.
235 &quot;image&quot;: { # The creator&#x27;s avatar.
236 &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
John Asmuth614db982014-04-24 15:46:26 -0400237 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700238 &quot;displayName&quot;: &quot;A String&quot;, # The display name.
239 &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
240 &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400241 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700242 &quot;post&quot;: { # Data about the post containing this comment.
243 &quot;id&quot;: &quot;A String&quot;, # The identifier of the post containing this comment.
John Asmuth614db982014-04-24 15:46:26 -0400244 },
John Asmuth614db982014-04-24 15:46:26 -0400245 },
246 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700247 &quot;selfLink&quot;: &quot;A String&quot;, # The URL of the comments on this post.
248 &quot;totalItems&quot;: &quot;A String&quot;, # The count of comments on this post.
John Asmuth614db982014-04-24 15:46:26 -0400249 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700250 &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
251 &quot;labels&quot;: [ # The list of labels this Post was tagged with.
252 &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400253 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700254 &quot;author&quot;: { # The author of this Post.
255 &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
256 &quot;image&quot;: { # The creator&#x27;s avatar.
257 &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
258 },
259 &quot;displayName&quot;: &quot;A String&quot;, # The display name.
260 &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
John Asmuth614db982014-04-24 15:46:26 -0400261 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700262 &quot;images&quot;: [ # Display image for the Post.
John Asmuth614db982014-04-24 15:46:26 -0400263 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700264 &quot;url&quot;: &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400265 },
266 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700267 &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this Post was published.
268 &quot;title&quot;: &quot;A String&quot;, # The title of the Post.
269 &quot;titleLink&quot;: &quot;A String&quot;, # The title link URL, similar to atom&#x27;s related link.
270 &quot;blog&quot;: { # Data about the blog containing this Post.
271 &quot;id&quot;: &quot;A String&quot;, # The identifier of the Blog that contains this Post.
272 },
273 &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this Post was last updated.
274 &quot;url&quot;: &quot;A String&quot;, # The URL where this Post is displayed.
275 &quot;content&quot;: &quot;A String&quot;, # The content of the Post. May contain HTML markup.
276 &quot;id&quot;: &quot;A String&quot;, # The identifier of this Post.
277 &quot;location&quot;: { # The location for geotagged posts.
278 &quot;name&quot;: &quot;A String&quot;, # Location name.
279 &quot;span&quot;: &quot;A String&quot;, # Location&#x27;s viewport span. Can be used when rendering a map preview.
280 &quot;lat&quot;: 3.14, # Location&#x27;s latitude.
281 &quot;lng&quot;: 3.14, # Location&#x27;s longitude.
282 },
283 &quot;status&quot;: &quot;A String&quot;, # Status of the post. Only set for admin-level requests.
284 &quot;readerComments&quot;: &quot;A String&quot;, # Comment control and display setting for readers of this post.
285 &quot;etag&quot;: &quot;A String&quot;, # Etag of the resource.
286 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#post.
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.
289 &quot;postId&quot;: &quot;A String&quot;, # ID of the Post resource.
290 &quot;hasEditAccess&quot;: True or False, # True if the user has Author level access to the post.
291 &quot;userId&quot;: &quot;A String&quot;, # ID of the User.
292 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#postPerUserInfo.
293 &quot;blogId&quot;: &quot;A String&quot;, # ID of the Blog that the post resource belongs to.
John Asmuth614db982014-04-24 15:46:26 -0400294 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700295 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#postUserInfo.
John Asmuth614db982014-04-24 15:46:26 -0400296 },
297 ],
Bu Sun Kim65020912020-05-20 12:08:20 -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>