Debian Codegraph @

docs/dyn/blogger_v2.blogs.html

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