Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f7b648f5281e17dfee86fe8eb048d5ff0a19ca81 / . / docs / dyn / blogger_v3.blogs.html
blob: 179db957686117a6dc03d0f81d4022ecf100632a [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -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.blogs.html">blogs</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(blogId, maxPosts=None)</a></code></p>
79<p class="firstline">Gets one blog by id.</p>
80<p class="toc_element">
81 <code><a href="#getByUrl">getByUrl(url=None)</a></code></p>
82<p class="firstline">Retrieve a Blog by URL.</p>
83<p class="toc_element">
84 <code><a href="#listByUser">listByUser(userId)</a></code></p>
85<p class="firstline">Retrieves a list of blogs, possibly filtered.</p>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="get">get(blogId, maxPosts=None)</code>
89 <pre>Gets one blog by id.
90
91Args:
92 blogId: string, The ID of the blog to get. (required)
93 maxPosts: integer, Maximum number of posts to pull back with the blog.
94
95Returns:
96 An object of the form:
97
98 {
99 "kind": "blogger#blog", # The kind of this entry. Always blogger#blog
100 "description": "A String", # The description of this blog. This is displayed underneath the title.
101 "locale": { # The locale this Blog is set to.
102 "country": "A String", # The country this blog's locale is set to.
103 "variant": "A String", # The language variant this blog is authored in.
104 "language": "A String", # The language this blog is authored in.
105 },
106 "posts": { # The container of posts in this blog.
107 "totalItems": 42, # The count of posts in this blog.
108 "items": [ # The List of Posts for this Blog.
109 {
110 "content": "A String", # The content of the Post. May contain HTML markup.
111 "kind": "blogger#post", # The kind of this entity. Always blogger#post
112 "author": { # The author of this Post.
113 "url": "A String", # The URL of the Post creator's Profile page.
114 "image": { # The Post author's avatar.
115 "url": "A String", # The Post author's avatar URL.
116 },
117 "displayName": "A String", # The display name.
118 "id": "A String", # The identifier of the Post creator.
119 },
120 "replies": { # The container of comments on this Post.
121 "totalItems": "A String", # The count of comments on this post.
122 "items": [ # The List of Comments for this Post.
123 {
124 "content": "A String", # The actual content of the comment. May include HTML markup.
125 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
126 "inReplyTo": { # Data about the comment this is in reply to.
127 "id": "A String", # The identified of the parent of this comment.
128 },
129 "author": { # The author of this Comment.
130 "url": "A String", # The URL of the Comment creator's Profile page.
131 "image": { # The comment creator's avatar.
132 "url": "A String", # The comment creator's avatar URL.
133 },
134 "displayName": "A String", # The display name.
135 "id": "A String", # The identifier of the Comment creator.
136 },
137 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
138 "blog": { # Data about the blog containing this comment.
139 "id": "A String", # The identifier of the blog containing this comment.
140 },
141 "published": "A String", # RFC 3339 date-time when this comment was published.
142 "post": { # Data about the post containing this comment.
143 "id": "A String", # The identifier of the post containing this comment.
144 },
145 "id": "A String", # The identifier for this resource.
146 "selfLink": "A String", # The API REST URL to fetch this resource from.
147 },
148 ],
149 "selfLink": "A String", # The URL of the comments on this post.
150 },
151 "labels": [ # The list of labels this Post was tagged with.
152 "A String",
153 ],
154 "customMetaData": "A String", # The JSON meta-data for the Post.
155 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
156 "blog": { # Data about the blog containing this Post.
157 "id": "A String", # The identifier of the Blog that contains this Post.
158 },
159 "url": "A String", # The URL where this Post is displayed.
160 "location": { # The location for geotagged posts.
161 "lat": 3.14, # Location's latitude.
162 "lng": 3.14, # Location's longitude.
163 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
164 "name": "A String", # Location name.
165 },
166 "published": "A String", # RFC 3339 date-time when this Post was published.
167 "title": "A String", # The title of the Post.
168 "id": "A String", # The identifier of this Post.
169 "selfLink": "A String", # The API REST URL to fetch this resource from.
170 },
171 ],
172 "selfLink": "A String", # The URL of the container for posts in this blog.
173 },
174 "customMetaData": "A String", # The JSON custom meta-data for the Blog
175 "updated": "A String", # RFC 3339 date-time when this blog was last updated.
176 "pages": { # The container of pages in this blog.
177 "totalItems": 42, # The count of pages in this blog.
178 "selfLink": "A String", # The URL of the container for pages in this blog.
179 },
180 "url": "A String", # The URL where this blog is published.
181 "published": "A String", # RFC 3339 date-time when this blog was published.
182 "id": "A String", # The identifier for this resource.
183 "selfLink": "A String", # The API REST URL to fetch this resource from.
184 "name": "A String", # The name of this blog. This is displayed as the title.
185 }</pre>
186</div>
187
188<div class="method">
189 <code class="details" id="getByUrl">getByUrl(url=None)</code>
190 <pre>Retrieve a Blog by URL.
191
192Args:
193 url: string, The URL of the blog to retrieve.
194
195Returns:
196 An object of the form:
197
198 {
199 "kind": "blogger#blog", # The kind of this entry. Always blogger#blog
200 "description": "A String", # The description of this blog. This is displayed underneath the title.
201 "locale": { # The locale this Blog is set to.
202 "country": "A String", # The country this blog's locale is set to.
203 "variant": "A String", # The language variant this blog is authored in.
204 "language": "A String", # The language this blog is authored in.
205 },
206 "posts": { # The container of posts in this blog.
207 "totalItems": 42, # The count of posts in this blog.
208 "items": [ # The List of Posts for this Blog.
209 {
210 "content": "A String", # The content of the Post. May contain HTML markup.
211 "kind": "blogger#post", # The kind of this entity. Always blogger#post
212 "author": { # The author of this Post.
213 "url": "A String", # The URL of the Post creator's Profile page.
214 "image": { # The Post author's avatar.
215 "url": "A String", # The Post author's avatar URL.
216 },
217 "displayName": "A String", # The display name.
218 "id": "A String", # The identifier of the Post creator.
219 },
220 "replies": { # The container of comments on this Post.
221 "totalItems": "A String", # The count of comments on this post.
222 "items": [ # The List of Comments for this Post.
223 {
224 "content": "A String", # The actual content of the comment. May include HTML markup.
225 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
226 "inReplyTo": { # Data about the comment this is in reply to.
227 "id": "A String", # The identified of the parent of this comment.
228 },
229 "author": { # The author of this Comment.
230 "url": "A String", # The URL of the Comment creator's Profile page.
231 "image": { # The comment creator's avatar.
232 "url": "A String", # The comment creator's avatar URL.
233 },
234 "displayName": "A String", # The display name.
235 "id": "A String", # The identifier of the Comment creator.
236 },
237 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
238 "blog": { # Data about the blog containing this comment.
239 "id": "A String", # The identifier of the blog containing this comment.
240 },
241 "published": "A String", # RFC 3339 date-time when this comment was published.
242 "post": { # Data about the post containing this comment.
243 "id": "A String", # The identifier of the post containing this comment.
244 },
245 "id": "A String", # The identifier for this resource.
246 "selfLink": "A String", # The API REST URL to fetch this resource from.
247 },
248 ],
249 "selfLink": "A String", # The URL of the comments on this post.
250 },
251 "labels": [ # The list of labels this Post was tagged with.
252 "A String",
253 ],
254 "customMetaData": "A String", # The JSON meta-data for the Post.
255 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
256 "blog": { # Data about the blog containing this Post.
257 "id": "A String", # The identifier of the Blog that contains this Post.
258 },
259 "url": "A String", # The URL where this Post is displayed.
260 "location": { # The location for geotagged posts.
261 "lat": 3.14, # Location's latitude.
262 "lng": 3.14, # Location's longitude.
263 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
264 "name": "A String", # Location name.
265 },
266 "published": "A String", # RFC 3339 date-time when this Post was published.
267 "title": "A String", # The title of the Post.
268 "id": "A String", # The identifier of this Post.
269 "selfLink": "A String", # The API REST URL to fetch this resource from.
270 },
271 ],
272 "selfLink": "A String", # The URL of the container for posts in this blog.
273 },
274 "customMetaData": "A String", # The JSON custom meta-data for the Blog
275 "updated": "A String", # RFC 3339 date-time when this blog was last updated.
276 "pages": { # The container of pages in this blog.
277 "totalItems": 42, # The count of pages in this blog.
278 "selfLink": "A String", # The URL of the container for pages in this blog.
279 },
280 "url": "A String", # The URL where this blog is published.
281 "published": "A String", # RFC 3339 date-time when this blog was published.
282 "id": "A String", # The identifier for this resource.
283 "selfLink": "A String", # The API REST URL to fetch this resource from.
284 "name": "A String", # The name of this blog. This is displayed as the title.
285 }</pre>
286</div>
287
288<div class="method">
289 <code class="details" id="listByUser">listByUser(userId)</code>
290 <pre>Retrieves a list of blogs, possibly filtered.
291
292Args:
293 userId: string, ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. (required)
294
295Returns:
296 An object of the form:
297
298 {
299 "items": [ # The list of Blogs this user has Authorship or Admin rights over.
300 {
301 "kind": "blogger#blog", # The kind of this entry. Always blogger#blog
302 "description": "A String", # The description of this blog. This is displayed underneath the title.
303 "locale": { # The locale this Blog is set to.
304 "country": "A String", # The country this blog's locale is set to.
305 "variant": "A String", # The language variant this blog is authored in.
306 "language": "A String", # The language this blog is authored in.
307 },
308 "posts": { # The container of posts in this blog.
309 "totalItems": 42, # The count of posts in this blog.
310 "items": [ # The List of Posts for this Blog.
311 {
312 "content": "A String", # The content of the Post. May contain HTML markup.
313 "kind": "blogger#post", # The kind of this entity. Always blogger#post
314 "author": { # The author of this Post.
315 "url": "A String", # The URL of the Post creator's Profile page.
316 "image": { # The Post author's avatar.
317 "url": "A String", # The Post author's avatar URL.
318 },
319 "displayName": "A String", # The display name.
320 "id": "A String", # The identifier of the Post creator.
321 },
322 "replies": { # The container of comments on this Post.
323 "totalItems": "A String", # The count of comments on this post.
324 "items": [ # The List of Comments for this Post.
325 {
326 "content": "A String", # The actual content of the comment. May include HTML markup.
327 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
328 "inReplyTo": { # Data about the comment this is in reply to.
329 "id": "A String", # The identified of the parent of this comment.
330 },
331 "author": { # The author of this Comment.
332 "url": "A String", # The URL of the Comment creator's Profile page.
333 "image": { # The comment creator's avatar.
334 "url": "A String", # The comment creator's avatar URL.
335 },
336 "displayName": "A String", # The display name.
337 "id": "A String", # The identifier of the Comment creator.
338 },
339 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
340 "blog": { # Data about the blog containing this comment.
341 "id": "A String", # The identifier of the blog containing this comment.
342 },
343 "published": "A String", # RFC 3339 date-time when this comment was published.
344 "post": { # Data about the post containing this comment.
345 "id": "A String", # The identifier of the post containing this comment.
346 },
347 "id": "A String", # The identifier for this resource.
348 "selfLink": "A String", # The API REST URL to fetch this resource from.
349 },
350 ],
351 "selfLink": "A String", # The URL of the comments on this post.
352 },
353 "labels": [ # The list of labels this Post was tagged with.
354 "A String",
355 ],
356 "customMetaData": "A String", # The JSON meta-data for the Post.
357 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
358 "blog": { # Data about the blog containing this Post.
359 "id": "A String", # The identifier of the Blog that contains this Post.
360 },
361 "url": "A String", # The URL where this Post is displayed.
362 "location": { # The location for geotagged posts.
363 "lat": 3.14, # Location's latitude.
364 "lng": 3.14, # Location's longitude.
365 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
366 "name": "A String", # Location name.
367 },
368 "published": "A String", # RFC 3339 date-time when this Post was published.
369 "title": "A String", # The title of the Post.
370 "id": "A String", # The identifier of this Post.
371 "selfLink": "A String", # The API REST URL to fetch this resource from.
372 },
373 ],
374 "selfLink": "A String", # The URL of the container for posts in this blog.
375 },
376 "customMetaData": "A String", # The JSON custom meta-data for the Blog
377 "updated": "A String", # RFC 3339 date-time when this blog was last updated.
378 "pages": { # The container of pages in this blog.
379 "totalItems": 42, # The count of pages in this blog.
380 "selfLink": "A String", # The URL of the container for pages in this blog.
381 },
382 "url": "A String", # The URL where this blog is published.
383 "published": "A String", # RFC 3339 date-time when this blog was published.
384 "id": "A String", # The identifier for this resource.
385 "selfLink": "A String", # The API REST URL to fetch this resource from.
386 "name": "A String", # The name of this blog. This is displayed as the title.
387 },
388 ],
389 "kind": "blogger#blogList", # The kind of this entity. Always blogger#blogList
390 }</pre>
391</div>
392
393</body></html>