Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c9b6cec70b2162b98d836f8100bc039f19fe23cb / . / docs / dyn / blogger_v3.pages.html
blob: f8560b38b7c731ffd3f05be712f8a7701d86fab7 [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.pages.html">pages</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(blogId, pageId)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]79<p class="firstline">Delete a page by ID.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]80<p class="toc_element">
81 <code><a href="#get">get(blogId, pageId, view=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]82<p class="firstline">Gets one blog page by ID.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]83<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]84 <code><a href="#insert">insert(blogId, body, isDraft=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]85<p class="firstline">Add a page.</p>
86<p class="toc_element">
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]87 <code><a href="#list">list(blogId, status=None, pageToken=None, maxResults=None, fetchBodies=None, view=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]88<p class="firstline">Retrieves the pages for a blog, optionally including non-LIVE statuses.</p>
89<p class="toc_element">
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]93 <code><a href="#patch">patch(blogId, pageId, body, revert=None, publish=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]94<p class="firstline">Update a page. This method supports patch semantics.</p>
95<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]96 <code><a href="#publish">publish(blogId, pageId)</a></code></p>
97<p class="firstline">Publishes a draft page.</p>
98<p class="toc_element">
99 <code><a href="#revert">revert(blogId, pageId)</a></code></p>
100<p class="firstline">Revert a published or scheduled page to draft state.</p>
101<p class="toc_element">
102 <code><a href="#update">update(blogId, pageId, body, revert=None, publish=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]103<p class="firstline">Update a page.</p>
104<h3>Method Details</h3>
105<div class="method">
106 <code class="details" id="delete">delete(blogId, pageId)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]107 <pre>Delete a page by ID.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]108
109Args:
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]110 blogId: string, The ID of the Blog. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]111 pageId: string, The ID of the Page. (required)
112</pre>
113</div>
114
115<div class="method">
116 <code class="details" id="get">get(blogId, pageId, view=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]117 <pre>Gets one blog page by ID.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]118
119Args:
120 blogId: string, ID of the blog containing the page. (required)
121 pageId: string, The ID of the page to get. (required)
122 view: string, A parameter
123 Allowed values
124 ADMIN - Admin level detail
125 AUTHOR - Author level detail
126 READER - Reader level detail
127
128Returns:
129 An object of the form:
130
131 {
132 "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
133 "content": "A String", # The body content of this Page, in HTML.
134 "kind": "blogger#page", # The kind of this entity. Always blogger#page
135 "author": { # The author of this Page.
136 "url": "A String", # The URL of the Page creator's Profile page.
137 "image": { # The page author's avatar.
138 "url": "A String", # The page author's avatar URL.
139 },
140 "displayName": "A String", # The display name.
141 "id": "A String", # The identifier of the Page creator.
142 },
143 "url": "A String", # The URL that this Page is displayed at.
144 "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
145 "updated": "A String", # RFC 3339 date-time when this Page was last updated.
146 "blog": { # Data about the blog containing this Page.
147 "id": "A String", # The identifier of the blog containing this page.
148 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]149 "etag": "A String", # Etag of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]150 "published": "A String", # RFC 3339 date-time when this Page was published.
151 "id": "A String", # The identifier for this resource.
152 "selfLink": "A String", # The API REST URL to fetch this resource from.
153 }</pre>
154</div>
155
156<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]157 <code class="details" id="insert">insert(blogId, body, isDraft=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]158 <pre>Add a page.
159
160Args:
161 blogId: string, ID of the blog to add the page to. (required)
162 body: object, The request body. (required)
163 The object takes the form of:
164
165{
166 "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
167 "content": "A String", # The body content of this Page, in HTML.
168 "kind": "blogger#page", # The kind of this entity. Always blogger#page
169 "author": { # The author of this Page.
170 "url": "A String", # The URL of the Page creator's Profile page.
171 "image": { # The page author's avatar.
172 "url": "A String", # The page author's avatar URL.
173 },
174 "displayName": "A String", # The display name.
175 "id": "A String", # The identifier of the Page creator.
176 },
177 "url": "A String", # The URL that this Page is displayed at.
178 "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
179 "updated": "A String", # RFC 3339 date-time when this Page was last updated.
180 "blog": { # Data about the blog containing this Page.
181 "id": "A String", # The identifier of the blog containing this page.
182 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]183 "etag": "A String", # Etag of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]184 "published": "A String", # RFC 3339 date-time when this Page was published.
185 "id": "A String", # The identifier for this resource.
186 "selfLink": "A String", # The API REST URL to fetch this resource from.
187 }
188
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]189 isDraft: boolean, Whether to create the page as a draft (default: false).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]190
191Returns:
192 An object of the form:
193
194 {
195 "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
196 "content": "A String", # The body content of this Page, in HTML.
197 "kind": "blogger#page", # The kind of this entity. Always blogger#page
198 "author": { # The author of this Page.
199 "url": "A String", # The URL of the Page creator's Profile page.
200 "image": { # The page author's avatar.
201 "url": "A String", # The page author's avatar URL.
202 },
203 "displayName": "A String", # The display name.
204 "id": "A String", # The identifier of the Page creator.
205 },
206 "url": "A String", # The URL that this Page is displayed at.
207 "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
208 "updated": "A String", # RFC 3339 date-time when this Page was last updated.
209 "blog": { # Data about the blog containing this Page.
210 "id": "A String", # The identifier of the blog containing this page.
211 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]212 "etag": "A String", # Etag of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]213 "published": "A String", # RFC 3339 date-time when this Page was published.
214 "id": "A String", # The identifier for this resource.
215 "selfLink": "A String", # The API REST URL to fetch this resource from.
216 }</pre>
217</div>
218
219<div class="method">
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]220 <code class="details" id="list">list(blogId, status=None, pageToken=None, maxResults=None, fetchBodies=None, view=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]221 <pre>Retrieves the pages for a blog, optionally including non-LIVE statuses.
222
223Args:
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]224 blogId: string, ID of the blog to fetch Pages from. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]225 status: string, A parameter (repeated)
226 Allowed values
227 draft - Draft (unpublished) Pages
228 live - Pages that are publicly visible
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]229 pageToken: string, Continuation token if the request is paged.
230 maxResults: integer, Maximum number of Pages to fetch.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]231 fetchBodies: boolean, Whether to retrieve the Page bodies.
232 view: string, Access level with which to view the returned result. Note that some fields require elevated access.
233 Allowed values
234 ADMIN - Admin level detail
235 AUTHOR - Author level detail
236 READER - Reader level detail
237
238Returns:
239 An object of the form:
240
241 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]242 "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]243 "items": [ # The list of Pages for a Blog.
244 {
245 "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
246 "content": "A String", # The body content of this Page, in HTML.
247 "kind": "blogger#page", # The kind of this entity. Always blogger#page
248 "author": { # The author of this Page.
249 "url": "A String", # The URL of the Page creator's Profile page.
250 "image": { # The page author's avatar.
251 "url": "A String", # The page author's avatar URL.
252 },
253 "displayName": "A String", # The display name.
254 "id": "A String", # The identifier of the Page creator.
255 },
256 "url": "A String", # The URL that this Page is displayed at.
257 "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
258 "updated": "A String", # RFC 3339 date-time when this Page was last updated.
259 "blog": { # Data about the blog containing this Page.
260 "id": "A String", # The identifier of the blog containing this page.
261 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]262 "etag": "A String", # Etag of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]263 "published": "A String", # RFC 3339 date-time when this Page was published.
264 "id": "A String", # The identifier for this resource.
265 "selfLink": "A String", # The API REST URL to fetch this resource from.
266 },
267 ],
268 "kind": "blogger#pageList", # The kind of this entity. Always blogger#pageList
269 }</pre>
270</div>
271
272<div class="method">
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]273 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
274 <pre>Retrieves the next page of results.
275
276Args:
277 previous_request: The request for the previous page. (required)
278 previous_response: The response from the request for the previous page. (required)
279
280Returns:
281 A request object that you can call 'execute()' on to request the next
282 page. Returns None if there are no more items in the collection.
283 </pre>
284</div>
285
286<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]287 <code class="details" id="patch">patch(blogId, pageId, body, revert=None, publish=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]288 <pre>Update a page. This method supports patch semantics.
289
290Args:
291 blogId: string, The ID of the Blog. (required)
292 pageId: string, The ID of the Page. (required)
293 body: object, The request body. (required)
294 The object takes the form of:
295
296{
297 "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
298 "content": "A String", # The body content of this Page, in HTML.
299 "kind": "blogger#page", # The kind of this entity. Always blogger#page
300 "author": { # The author of this Page.
301 "url": "A String", # The URL of the Page creator's Profile page.
302 "image": { # The page author's avatar.
303 "url": "A String", # The page author's avatar URL.
304 },
305 "displayName": "A String", # The display name.
306 "id": "A String", # The identifier of the Page creator.
307 },
308 "url": "A String", # The URL that this Page is displayed at.
309 "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
310 "updated": "A String", # RFC 3339 date-time when this Page was last updated.
311 "blog": { # Data about the blog containing this Page.
312 "id": "A String", # The identifier of the blog containing this page.
313 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]314 "etag": "A String", # Etag of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]315 "published": "A String", # RFC 3339 date-time when this Page was published.
316 "id": "A String", # The identifier for this resource.
317 "selfLink": "A String", # The API REST URL to fetch this resource from.
318 }
319
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]320 revert: boolean, Whether a revert action should be performed when the page is updated (default: false).
321 publish: boolean, Whether a publish action should be performed when the page is updated (default: false).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]322
323Returns:
324 An object of the form:
325
326 {
327 "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
328 "content": "A String", # The body content of this Page, in HTML.
329 "kind": "blogger#page", # The kind of this entity. Always blogger#page
330 "author": { # The author of this Page.
331 "url": "A String", # The URL of the Page creator's Profile page.
332 "image": { # The page author's avatar.
333 "url": "A String", # The page author's avatar URL.
334 },
335 "displayName": "A String", # The display name.
336 "id": "A String", # The identifier of the Page creator.
337 },
338 "url": "A String", # The URL that this Page is displayed at.
339 "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
340 "updated": "A String", # RFC 3339 date-time when this Page was last updated.
341 "blog": { # Data about the blog containing this Page.
342 "id": "A String", # The identifier of the blog containing this page.
343 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]344 "etag": "A String", # Etag of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]345 "published": "A String", # RFC 3339 date-time when this Page was published.
346 "id": "A String", # The identifier for this resource.
347 "selfLink": "A String", # The API REST URL to fetch this resource from.
348 }</pre>
349</div>
350
351<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]352 <code class="details" id="publish">publish(blogId, pageId)</code>
353 <pre>Publishes a draft page.
354
355Args:
356 blogId: string, The ID of the blog. (required)
357 pageId: string, The ID of the page. (required)
358
359Returns:
360 An object of the form:
361
362 {
363 "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
364 "content": "A String", # The body content of this Page, in HTML.
365 "kind": "blogger#page", # The kind of this entity. Always blogger#page
366 "author": { # The author of this Page.
367 "url": "A String", # The URL of the Page creator's Profile page.
368 "image": { # The page author's avatar.
369 "url": "A String", # The page author's avatar URL.
370 },
371 "displayName": "A String", # The display name.
372 "id": "A String", # The identifier of the Page creator.
373 },
374 "url": "A String", # The URL that this Page is displayed at.
375 "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
376 "updated": "A String", # RFC 3339 date-time when this Page was last updated.
377 "blog": { # Data about the blog containing this Page.
378 "id": "A String", # The identifier of the blog containing this page.
379 },
380 "etag": "A String", # Etag of the resource.
381 "published": "A String", # RFC 3339 date-time when this Page was published.
382 "id": "A String", # The identifier for this resource.
383 "selfLink": "A String", # The API REST URL to fetch this resource from.
384 }</pre>
385</div>
386
387<div class="method">
388 <code class="details" id="revert">revert(blogId, pageId)</code>
389 <pre>Revert a published or scheduled page to draft state.
390
391Args:
392 blogId: string, The ID of the blog. (required)
393 pageId: string, The ID of the page. (required)
394
395Returns:
396 An object of the form:
397
398 {
399 "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
400 "content": "A String", # The body content of this Page, in HTML.
401 "kind": "blogger#page", # The kind of this entity. Always blogger#page
402 "author": { # The author of this Page.
403 "url": "A String", # The URL of the Page creator's Profile page.
404 "image": { # The page author's avatar.
405 "url": "A String", # The page author's avatar URL.
406 },
407 "displayName": "A String", # The display name.
408 "id": "A String", # The identifier of the Page creator.
409 },
410 "url": "A String", # The URL that this Page is displayed at.
411 "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
412 "updated": "A String", # RFC 3339 date-time when this Page was last updated.
413 "blog": { # Data about the blog containing this Page.
414 "id": "A String", # The identifier of the blog containing this page.
415 },
416 "etag": "A String", # Etag of the resource.
417 "published": "A String", # RFC 3339 date-time when this Page was published.
418 "id": "A String", # The identifier for this resource.
419 "selfLink": "A String", # The API REST URL to fetch this resource from.
420 }</pre>
421</div>
422
423<div class="method">
424 <code class="details" id="update">update(blogId, pageId, body, revert=None, publish=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]425 <pre>Update a page.
426
427Args:
428 blogId: string, The ID of the Blog. (required)
429 pageId: string, The ID of the Page. (required)
430 body: object, The request body. (required)
431 The object takes the form of:
432
433{
434 "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
435 "content": "A String", # The body content of this Page, in HTML.
436 "kind": "blogger#page", # The kind of this entity. Always blogger#page
437 "author": { # The author of this Page.
438 "url": "A String", # The URL of the Page creator's Profile page.
439 "image": { # The page author's avatar.
440 "url": "A String", # The page author's avatar URL.
441 },
442 "displayName": "A String", # The display name.
443 "id": "A String", # The identifier of the Page creator.
444 },
445 "url": "A String", # The URL that this Page is displayed at.
446 "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
447 "updated": "A String", # RFC 3339 date-time when this Page was last updated.
448 "blog": { # Data about the blog containing this Page.
449 "id": "A String", # The identifier of the blog containing this page.
450 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]451 "etag": "A String", # Etag of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]452 "published": "A String", # RFC 3339 date-time when this Page was published.
453 "id": "A String", # The identifier for this resource.
454 "selfLink": "A String", # The API REST URL to fetch this resource from.
455 }
456
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]457 revert: boolean, Whether a revert action should be performed when the page is updated (default: false).
458 publish: boolean, Whether a publish action should be performed when the page is updated (default: false).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]459
460Returns:
461 An object of the form:
462
463 {
464 "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
465 "content": "A String", # The body content of this Page, in HTML.
466 "kind": "blogger#page", # The kind of this entity. Always blogger#page
467 "author": { # The author of this Page.
468 "url": "A String", # The URL of the Page creator's Profile page.
469 "image": { # The page author's avatar.
470 "url": "A String", # The page author's avatar URL.
471 },
472 "displayName": "A String", # The display name.
473 "id": "A String", # The identifier of the Page creator.
474 },
475 "url": "A String", # The URL that this Page is displayed at.
476 "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
477 "updated": "A String", # RFC 3339 date-time when this Page was last updated.
478 "blog": { # Data about the blog containing this Page.
479 "id": "A String", # The identifier of the blog containing this page.
480 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]481 "etag": "A String", # Etag of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]482 "published": "A String", # RFC 3339 date-time when this Page was published.
483 "id": "A String", # The identifier for this resource.
484 "selfLink": "A String", # The API REST URL to fetch this resource from.
485 }</pre>
486</div>
487
488</body></html>