Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / blogger_v2.blogs.html
blob: 533f70f44f4b46a6d5c4da4c4e2cf489af715e28 [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[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
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]75<h1><a href="blogger_v2.html">Blogger API v3</a> . <a href="blogger_v2.blogs.html">blogs</a></h1>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#get">get(blogId, x__xgafv=None)</a></code></p>
79<p class="firstline">Gets a blog by id.</p>
80<p class="toc_element">
81 <code><a href="#list">list(userId, x__xgafv=None)</a></code></p>
82<p class="firstline">Lists blogs by user id, possibly filtered.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]83<h3>Method Details</h3>
84<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]85 <code class="details" id="get">get(blogId, x__xgafv=None)</code>
86 <pre>Gets a blog by id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]87
88Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]89 blogId: string, A parameter (required)
90 x__xgafv: string, V1 error format.
91 Allowed values
92 1 - v1 error format
93 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]94
95Returns:
96 An object of the form:
97
98 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]99 "status": "A String", # The status of the blog.
100 "updated": "A String", # RFC 3339 date-time when this blog was last updated.
101 "name": "A String", # The name of this blog. This is displayed as the title.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]102 "locale": { # The locale this Blog is set to.
103 "country": "A String", # The country this blog's locale is set to.
104 "variant": "A String", # The language variant this blog is authored in.
105 "language": "A String", # The language this blog is authored in.
106 },
107 "posts": { # The container of posts in this blog.
108 "totalItems": 42, # The count of posts in this blog.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]109 "items": [ # The List of Posts for this Blog.
110 {
111 "status": "A String", # Status of the post. Only set for admin-level requests.
112 "blog": { # Data about the blog containing this Post.
113 "id": "A String", # The identifier of the Blog that contains this Post.
114 },
115 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
116 "titleLink": "A String", # The title link URL, similar to atom's related link.
117 "author": { # The author of this Post.
118 "url": "A String", # The URL of the creator's Profile page.
119 "image": { # The creator's avatar.
120 "url": "A String", # The creator's avatar URL.
121 },
122 "displayName": "A String", # The display name.
123 "id": "A String", # The identifier of the creator.
124 },
125 "url": "A String", # The URL where this Post is displayed.
126 "readerComments": "A String", # Comment control and display setting for readers of this post.
127 "labels": [ # The list of labels this Post was tagged with.
128 "A String",
129 ],
130 "replies": { # The container of comments on this Post.
131 "totalItems": "A String", # The count of comments on this post.
132 "items": [ # The List of Comments for this Post.
133 {
134 "status": "A String", # The status of the comment (only populated for admin users).
135 "inReplyTo": { # Data about the comment this is in reply to.
136 "id": "A String", # The identified of the parent of this comment.
137 },
138 "kind": "A String", # The kind of this entry. Always blogger#comment.
139 "author": { # The author of this Comment.
140 "url": "A String", # The URL of the creator's Profile page.
141 "image": { # The creator's avatar.
142 "url": "A String", # The creator's avatar URL.
143 },
144 "displayName": "A String", # The display name.
145 "id": "A String", # The identifier of the creator.
146 },
147 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
148 "blog": { # Data about the blog containing this comment.
149 "id": "A String", # The identifier of the blog containing this comment.
150 },
151 "published": "A String", # RFC 3339 date-time when this comment was published.
152 "post": { # Data about the post containing this comment.
153 "id": "A String", # The identifier of the post containing this comment.
154 },
155 "content": "A String", # The actual content of the comment. May include HTML markup.
156 "id": "A String", # The identifier for this resource.
157 "selfLink": "A String", # The API REST URL to fetch this resource from.
158 },
159 ],
160 "selfLink": "A String", # The URL of the comments on this post.
161 },
162 "customMetaData": "A String", # The JSON meta-data for the Post.
163 "kind": "A String", # The kind of this entity. Always blogger#post.
164 "content": "A String", # The content of the Post. May contain HTML markup.
165 "etag": "A String", # Etag of the resource.
166 "location": { # The location for geotagged posts.
167 "lat": 3.14, # Location's latitude.
168 "lng": 3.14, # Location's longitude.
169 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
170 "name": "A String", # Location name.
171 },
172 "published": "A String", # RFC 3339 date-time when this Post was published.
173 "images": [ # Display image for the Post.
174 {
175 "url": "A String",
176 },
177 ],
178 "title": "A String", # The title of the Post.
179 "id": "A String", # The identifier of this Post.
180 "selfLink": "A String", # The API REST URL to fetch this resource from.
181 },
182 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]183 "selfLink": "A String", # The URL of the container for posts in this blog.
184 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]185 "customMetaData": "A String", # The JSON custom meta-data for the Blog.
186 "kind": "A String", # The kind of this entry. Always blogger#blog.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]187 "id": "A String", # The identifier for this resource.
188 "url": "A String", # The URL where this blog is published.
189 "published": "A String", # RFC 3339 date-time when this blog was published.
190 "pages": { # The container of pages in this blog.
191 "totalItems": 42, # The count of pages in this blog.
192 "selfLink": "A String", # The URL of the container for pages in this blog.
193 },
194 "selfLink": "A String", # The API REST URL to fetch this resource from.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]195 "description": "A String", # The description of this blog. This is displayed underneath the title.
196 }</pre>
197</div>
198
199<div class="method">
200 <code class="details" id="list">list(userId, x__xgafv=None)</code>
201 <pre>Lists blogs by user id, possibly filtered.
202
203Args:
204 userId: string, A parameter (required)
205 x__xgafv: string, V1 error format.
206 Allowed values
207 1 - v1 error format
208 2 - v2 error format
209
210Returns:
211 An object of the form:
212
213 {
214 "items": [ # The list of Blogs this user has Authorship or Admin rights over.
215 {
216 "status": "A String", # The status of the blog.
217 "updated": "A String", # RFC 3339 date-time when this blog was last updated.
218 "name": "A String", # The name of this blog. This is displayed as the title.
219 "locale": { # The locale this Blog is set to.
220 "country": "A String", # The country this blog's locale is set to.
221 "variant": "A String", # The language variant this blog is authored in.
222 "language": "A String", # The language this blog is authored in.
223 },
224 "posts": { # The container of posts in this blog.
225 "totalItems": 42, # The count of posts in this blog.
226 "items": [ # The List of Posts for this Blog.
227 {
228 "status": "A String", # Status of the post. Only set for admin-level requests.
229 "blog": { # Data about the blog containing this Post.
230 "id": "A String", # The identifier of the Blog that contains this Post.
231 },
232 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
233 "titleLink": "A String", # The title link URL, similar to atom's related link.
234 "author": { # The author of this Post.
235 "url": "A String", # The URL of the creator's Profile page.
236 "image": { # The creator's avatar.
237 "url": "A String", # The creator's avatar URL.
238 },
239 "displayName": "A String", # The display name.
240 "id": "A String", # The identifier of the creator.
241 },
242 "url": "A String", # The URL where this Post is displayed.
243 "readerComments": "A String", # Comment control and display setting for readers of this post.
244 "labels": [ # The list of labels this Post was tagged with.
245 "A String",
246 ],
247 "replies": { # The container of comments on this Post.
248 "totalItems": "A String", # The count of comments on this post.
249 "items": [ # The List of Comments for this Post.
250 {
251 "status": "A String", # The status of the comment (only populated for admin users).
252 "inReplyTo": { # Data about the comment this is in reply to.
253 "id": "A String", # The identified of the parent of this comment.
254 },
255 "kind": "A String", # The kind of this entry. Always blogger#comment.
256 "author": { # The author of this Comment.
257 "url": "A String", # The URL of the creator's Profile page.
258 "image": { # The creator's avatar.
259 "url": "A String", # The creator's avatar URL.
260 },
261 "displayName": "A String", # The display name.
262 "id": "A String", # The identifier of the creator.
263 },
264 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
265 "blog": { # Data about the blog containing this comment.
266 "id": "A String", # The identifier of the blog containing this comment.
267 },
268 "published": "A String", # RFC 3339 date-time when this comment was published.
269 "post": { # Data about the post containing this comment.
270 "id": "A String", # The identifier of the post containing this comment.
271 },
272 "content": "A String", # The actual content of the comment. May include HTML markup.
273 "id": "A String", # The identifier for this resource.
274 "selfLink": "A String", # The API REST URL to fetch this resource from.
275 },
276 ],
277 "selfLink": "A String", # The URL of the comments on this post.
278 },
279 "customMetaData": "A String", # The JSON meta-data for the Post.
280 "kind": "A String", # The kind of this entity. Always blogger#post.
281 "content": "A String", # The content of the Post. May contain HTML markup.
282 "etag": "A String", # Etag of the resource.
283 "location": { # The location for geotagged posts.
284 "lat": 3.14, # Location's latitude.
285 "lng": 3.14, # Location's longitude.
286 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
287 "name": "A String", # Location name.
288 },
289 "published": "A String", # RFC 3339 date-time when this Post was published.
290 "images": [ # Display image for the Post.
291 {
292 "url": "A String",
293 },
294 ],
295 "title": "A String", # The title of the Post.
296 "id": "A String", # The identifier of this Post.
297 "selfLink": "A String", # The API REST URL to fetch this resource from.
298 },
299 ],
300 "selfLink": "A String", # The URL of the container for posts in this blog.
301 },
302 "customMetaData": "A String", # The JSON custom meta-data for the Blog.
303 "kind": "A String", # The kind of this entry. Always blogger#blog.
304 "id": "A String", # The identifier for this resource.
305 "url": "A String", # The URL where this blog is published.
306 "published": "A String", # RFC 3339 date-time when this blog was published.
307 "pages": { # The container of pages in this blog.
308 "totalItems": 42, # The count of pages in this blog.
309 "selfLink": "A String", # The URL of the container for pages in this blog.
310 },
311 "selfLink": "A String", # The API REST URL to fetch this resource from.
312 "description": "A String", # The description of this blog. This is displayed underneath the title.
313 },
314 ],
315 "kind": "A String", # The kind of this entity. Always blogger#blogList.
316 "blogUserInfos": [ # Admin level list of blog per-user information.
317 {
318 "blog": { # The Blog resource.
319 "status": "A String", # The status of the blog.
320 "updated": "A String", # RFC 3339 date-time when this blog was last updated.
321 "name": "A String", # The name of this blog. This is displayed as the title.
322 "locale": { # The locale this Blog is set to.
323 "country": "A String", # The country this blog's locale is set to.
324 "variant": "A String", # The language variant this blog is authored in.
325 "language": "A String", # The language this blog is authored in.
326 },
327 "posts": { # The container of posts in this blog.
328 "totalItems": 42, # The count of posts in this blog.
329 "items": [ # The List of Posts for this Blog.
330 {
331 "status": "A String", # Status of the post. Only set for admin-level requests.
332 "blog": { # Data about the blog containing this Post.
333 "id": "A String", # The identifier of the Blog that contains this Post.
334 },
335 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
336 "titleLink": "A String", # The title link URL, similar to atom's related link.
337 "author": { # The author of this Post.
338 "url": "A String", # The URL of the creator's Profile page.
339 "image": { # The creator's avatar.
340 "url": "A String", # The creator's avatar URL.
341 },
342 "displayName": "A String", # The display name.
343 "id": "A String", # The identifier of the creator.
344 },
345 "url": "A String", # The URL where this Post is displayed.
346 "readerComments": "A String", # Comment control and display setting for readers of this post.
347 "labels": [ # The list of labels this Post was tagged with.
348 "A String",
349 ],
350 "replies": { # The container of comments on this Post.
351 "totalItems": "A String", # The count of comments on this post.
352 "items": [ # The List of Comments for this Post.
353 {
354 "status": "A String", # The status of the comment (only populated for admin users).
355 "inReplyTo": { # Data about the comment this is in reply to.
356 "id": "A String", # The identified of the parent of this comment.
357 },
358 "kind": "A String", # The kind of this entry. Always blogger#comment.
359 "author": { # The author of this Comment.
360 "url": "A String", # The URL of the creator's Profile page.
361 "image": { # The creator's avatar.
362 "url": "A String", # The creator's avatar URL.
363 },
364 "displayName": "A String", # The display name.
365 "id": "A String", # The identifier of the creator.
366 },
367 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
368 "blog": { # Data about the blog containing this comment.
369 "id": "A String", # The identifier of the blog containing this comment.
370 },
371 "published": "A String", # RFC 3339 date-time when this comment was published.
372 "post": { # Data about the post containing this comment.
373 "id": "A String", # The identifier of the post containing this comment.
374 },
375 "content": "A String", # The actual content of the comment. May include HTML markup.
376 "id": "A String", # The identifier for this resource.
377 "selfLink": "A String", # The API REST URL to fetch this resource from.
378 },
379 ],
380 "selfLink": "A String", # The URL of the comments on this post.
381 },
382 "customMetaData": "A String", # The JSON meta-data for the Post.
383 "kind": "A String", # The kind of this entity. Always blogger#post.
384 "content": "A String", # The content of the Post. May contain HTML markup.
385 "etag": "A String", # Etag of the resource.
386 "location": { # The location for geotagged posts.
387 "lat": 3.14, # Location's latitude.
388 "lng": 3.14, # Location's longitude.
389 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
390 "name": "A String", # Location name.
391 },
392 "published": "A String", # RFC 3339 date-time when this Post was published.
393 "images": [ # Display image for the Post.
394 {
395 "url": "A String",
396 },
397 ],
398 "title": "A String", # The title of the Post.
399 "id": "A String", # The identifier of this Post.
400 "selfLink": "A String", # The API REST URL to fetch this resource from.
401 },
402 ],
403 "selfLink": "A String", # The URL of the container for posts in this blog.
404 },
405 "customMetaData": "A String", # The JSON custom meta-data for the Blog.
406 "kind": "A String", # The kind of this entry. Always blogger#blog.
407 "id": "A String", # The identifier for this resource.
408 "url": "A String", # The URL where this blog is published.
409 "published": "A String", # RFC 3339 date-time when this blog was published.
410 "pages": { # The container of pages in this blog.
411 "totalItems": 42, # The count of pages in this blog.
412 "selfLink": "A String", # The URL of the container for pages in this blog.
413 },
414 "selfLink": "A String", # The API REST URL to fetch this resource from.
415 "description": "A String", # The description of this blog. This is displayed underneath the title.
416 },
417 "kind": "A String", # The kind of this entity. Always blogger#blogUserInfo.
418 "blog_user_info": { # Information about a User for the Blog.
419 "hasAdminAccess": True or False, # True if the user has Admin level access to the blog.
420 "kind": "A String", # The kind of this entity. Always blogger#blogPerUserInfo.
421 "userId": "A String", # ID of the User.
422 "role": "A String", # Access permissions that the user has for the blog (ADMIN, AUTHOR, or
423 # READER).
424 "photosAlbumKey": "A String", # The Photo Album Key for the user when adding photos to the blog.
425 "blogId": "A String", # ID of the Blog resource.
426 },
427 },
428 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]429 }</pre>
430</div>
431
432</body></html>