Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 614db98bf45b9da1f29c35a9d942536111e99d41 / . / docs / dyn / blogger_v3.postUserInfos.html
blob: 7b1d986b4c99c8445113a3efa28b547e47a17832 [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
75<h1><a href="blogger_v3.html">Blogger API</a> . <a href="blogger_v3.postUserInfos.html">postUserInfos</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(userId, blogId, postId, maxComments=None)</a></code></p>
79<p class="firstline">Gets one post and user info pair, by post id and user id. The post user info contains per-user information about the post, such as access rights, specific to the user.</p>
80<p class="toc_element">
81 <code><a href="#list">list(userId, blogId, orderBy=None, startDate=None, endDate=None, labels=None, pageToken=None, status=None, maxResults=None, fetchBodies=None, view=None)</a></code></p>
82<p class="firstline">Retrieves a list of post and post user info pairs, possibly filtered. The post user info contains per-user information about the post, such as access rights, specific to the user.</p>
83<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">
88 <code class="details" id="get">get(userId, blogId, postId, maxComments=None)</code>
89 <pre>Gets one post and user info pair, by post id and user id. The post user info contains per-user information about the post, such as access rights, specific to the user.
90
91Args:
92 userId: string, ID of the user for the per-user information to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. (required)
93 blogId: string, The ID of the blog. (required)
94 postId: string, The ID of the post to get. (required)
95 maxComments: integer, Maximum number of comments to pull back on a post.
96
97Returns:
98 An object of the form:
99
100 {
101 "kind": "blogger#postUserInfo", # The kind of this entity. Always blogger#postUserInfo
102 "post": { # The Post resource.
103 "status": "A String", # Status of the post. Only set for admin-level requests
104 "content": "A String", # The content of the Post. May contain HTML markup.
105 "kind": "blogger#post", # The kind of this entity. Always blogger#post
106 "titleLink": "A String", # The title link URL, similar to atom's related link.
107 "author": { # The author of this Post.
108 "url": "A String", # The URL of the Post creator's Profile page.
109 "image": { # The Post author's avatar.
110 "url": "A String", # The Post author's avatar URL.
111 },
112 "displayName": "A String", # The display name.
113 "id": "A String", # The identifier of the Post creator.
114 },
115 "replies": { # The container of comments on this Post.
116 "totalItems": "A String", # The count of comments on this post.
117 "items": [ # The List of Comments for this Post.
118 {
119 "status": "A String", # The status of the comment (only populated for admin users)
120 "content": "A String", # The actual content of the comment. May include HTML markup.
121 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
122 "inReplyTo": { # Data about the comment this is in reply to.
123 "id": "A String", # The identified of the parent of this comment.
124 },
125 "author": { # The author of this Comment.
126 "url": "A String", # The URL of the Comment creator's Profile page.
127 "image": { # The comment creator's avatar.
128 "url": "A String", # The comment creator's avatar URL.
129 },
130 "displayName": "A String", # The display name.
131 "id": "A String", # The identifier of the Comment creator.
132 },
133 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
134 "blog": { # Data about the blog containing this comment.
135 "id": "A String", # The identifier of the blog containing this comment.
136 },
137 "published": "A String", # RFC 3339 date-time when this comment was published.
138 "post": { # Data about the post containing this comment.
139 "id": "A String", # The identifier of the post containing this comment.
140 },
141 "id": "A String", # The identifier for this resource.
142 "selfLink": "A String", # The API REST URL to fetch this resource from.
143 },
144 ],
145 "selfLink": "A String", # The URL of the comments on this post.
146 },
147 "labels": [ # The list of labels this Post was tagged with.
148 "A String",
149 ],
150 "customMetaData": "A String", # The JSON meta-data for the Post.
151 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
152 "blog": { # Data about the blog containing this Post.
153 "id": "A String", # The identifier of the Blog that contains this Post.
154 },
155 "url": "A String", # The URL where this Post is displayed.
156 "location": { # The location for geotagged posts.
157 "lat": 3.14, # Location's latitude.
158 "lng": 3.14, # Location's longitude.
159 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
160 "name": "A String", # Location name.
161 },
162 "published": "A String", # RFC 3339 date-time when this Post was published.
163 "images": [ # Display image for the Post.
164 {
165 "url": "A String",
166 },
167 ],
168 "title": "A String", # The title of the Post.
169 "id": "A String", # The identifier of this Post.
170 "selfLink": "A String", # The API REST URL to fetch this resource from.
171 },
172 "post_user_info": { # Information about a User for the Post.
173 "kind": "blogger#postPerUserInfo", # The kind of this entity. Always blogger#postPerUserInfo
174 "postId": "A String", # ID of the Post resource.
175 "userId": "A String", # ID of the User.
176 "blogId": "A String", # ID of the Blog that the post resource belongs to.
177 "hasEditAccess": True or False, # True if the user has Author level access to the post.
178 },
179 }</pre>
180</div>
181
182<div class="method">
183 <code class="details" id="list">list(userId, blogId, orderBy=None, startDate=None, endDate=None, labels=None, pageToken=None, status=None, maxResults=None, fetchBodies=None, view=None)</code>
184 <pre>Retrieves a list of post and post user info pairs, possibly filtered. The post user info contains per-user information about the post, such as access rights, specific to the user.
185
186Args:
187 userId: string, ID of the user for the per-user information to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. (required)
188 blogId: string, ID of the blog to fetch posts from. (required)
189 orderBy: string, Sort order applied to search results. Default is published.
190 Allowed values
191 published - Order by the date the post was published
192 updated - Order by the date the post was last updated
193 startDate: string, Earliest post date to fetch, a date-time with RFC 3339 formatting.
194 endDate: string, Latest post date to fetch, a date-time with RFC 3339 formatting.
195 labels: string, Comma-separated list of labels to search for.
196 pageToken: string, Continuation token if the request is paged.
197 status: string, A parameter (repeated)
198 Allowed values
199 draft - Draft posts
200 live - Published posts
201 scheduled - Posts that are scheduled to publish in future.
202 maxResults: integer, Maximum number of posts to fetch.
203 fetchBodies: boolean, Whether the body content of posts is included. Default is false.
204 view: string, Access level with which to view the returned result. Note that some fields require elevated access.
205 Allowed values
206 ADMIN - Admin level detail
207 AUTHOR - Author level detail
208 READER - Reader level detail
209
210Returns:
211 An object of the form:
212
213 {
214 "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
215 "items": [ # The list of Posts with User information for the post, for this Blog.
216 {
217 "kind": "blogger#postUserInfo", # The kind of this entity. Always blogger#postUserInfo
218 "post": { # The Post resource.
219 "status": "A String", # Status of the post. Only set for admin-level requests
220 "content": "A String", # The content of the Post. May contain HTML markup.
221 "kind": "blogger#post", # The kind of this entity. Always blogger#post
222 "titleLink": "A String", # The title link URL, similar to atom's related link.
223 "author": { # The author of this Post.
224 "url": "A String", # The URL of the Post creator's Profile page.
225 "image": { # The Post author's avatar.
226 "url": "A String", # The Post author's avatar URL.
227 },
228 "displayName": "A String", # The display name.
229 "id": "A String", # The identifier of the Post creator.
230 },
231 "replies": { # The container of comments on this Post.
232 "totalItems": "A String", # The count of comments on this post.
233 "items": [ # The List of Comments for this Post.
234 {
235 "status": "A String", # The status of the comment (only populated for admin users)
236 "content": "A String", # The actual content of the comment. May include HTML markup.
237 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
238 "inReplyTo": { # Data about the comment this is in reply to.
239 "id": "A String", # The identified of the parent of this comment.
240 },
241 "author": { # The author of this Comment.
242 "url": "A String", # The URL of the Comment creator's Profile page.
243 "image": { # The comment creator's avatar.
244 "url": "A String", # The comment creator's avatar URL.
245 },
246 "displayName": "A String", # The display name.
247 "id": "A String", # The identifier of the Comment creator.
248 },
249 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
250 "blog": { # Data about the blog containing this comment.
251 "id": "A String", # The identifier of the blog containing this comment.
252 },
253 "published": "A String", # RFC 3339 date-time when this comment was published.
254 "post": { # Data about the post containing this comment.
255 "id": "A String", # The identifier of the post containing this comment.
256 },
257 "id": "A String", # The identifier for this resource.
258 "selfLink": "A String", # The API REST URL to fetch this resource from.
259 },
260 ],
261 "selfLink": "A String", # The URL of the comments on this post.
262 },
263 "labels": [ # The list of labels this Post was tagged with.
264 "A String",
265 ],
266 "customMetaData": "A String", # The JSON meta-data for the Post.
267 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
268 "blog": { # Data about the blog containing this Post.
269 "id": "A String", # The identifier of the Blog that contains this Post.
270 },
271 "url": "A String", # The URL where this Post is displayed.
272 "location": { # The location for geotagged posts.
273 "lat": 3.14, # Location's latitude.
274 "lng": 3.14, # Location's longitude.
275 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
276 "name": "A String", # Location name.
277 },
278 "published": "A String", # RFC 3339 date-time when this Post was published.
279 "images": [ # Display image for the Post.
280 {
281 "url": "A String",
282 },
283 ],
284 "title": "A String", # The title of the Post.
285 "id": "A String", # The identifier of this Post.
286 "selfLink": "A String", # The API REST URL to fetch this resource from.
287 },
288 "post_user_info": { # Information about a User for the Post.
289 "kind": "blogger#postPerUserInfo", # The kind of this entity. Always blogger#postPerUserInfo
290 "postId": "A String", # ID of the Post resource.
291 "userId": "A String", # ID of the User.
292 "blogId": "A String", # ID of the Blog that the post resource belongs to.
293 "hasEditAccess": True or False, # True if the user has Author level access to the post.
294 },
295 },
296 ],
297 "kind": "blogger#postUserInfosList", # The kind of this entity. Always blogger#postList
298 }</pre>
299</div>
300
301<div class="method">
302 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
303 <pre>Retrieves the next page of results.
304
305Args:
306 previous_request: The request for the previous page. (required)
307 previous_response: The response from the request for the previous page. (required)
308
309Returns:
310 A request object that you can call 'execute()' on to request the next
311 page. Returns None if there are no more items in the collection.
312 </pre>
313</div>
314
315</body></html>