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