Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b1cc515b93bef725389ac86401366b6f7a98b0c8 / . / docs / dyn / blogger_v3.pages.html
blob: b14ffdc11176e1144aeeab55e59882d8d8fe2f99 [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>
79<p class="firstline">Delete a page by id.</p>
80<p class="toc_element">
81 <code><a href="#get">get(blogId, pageId, view=None)</a></code></p>
82<p class="firstline">Gets one blog page by id.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(blogId, body)</a></code></p>
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">
90 <code><a href="#patch">patch(blogId, pageId, body)</a></code></p>
91<p class="firstline">Update a page. This method supports patch semantics.</p>
92<p class="toc_element">
93 <code><a href="#update">update(blogId, pageId, body)</a></code></p>
94<p class="firstline">Update a page.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="delete">delete(blogId, pageId)</code>
98 <pre>Delete a page by id.
99
100Args:
101 blogId: string, The Id of the Blog. (required)
102 pageId: string, The ID of the Page. (required)
103</pre>
104</div>
105
106<div class="method">
107 <code class="details" id="get">get(blogId, pageId, view=None)</code>
108 <pre>Gets one blog page by id.
109
110Args:
111 blogId: string, ID of the blog containing the page. (required)
112 pageId: string, The ID of the page to get. (required)
113 view: string, A parameter
114 Allowed values
115 ADMIN - Admin level detail
116 AUTHOR - Author level detail
117 READER - Reader level detail
118
119Returns:
120 An object of the form:
121
122 {
123 "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
124 "content": "A String", # The body content of this Page, in HTML.
125 "kind": "blogger#page", # The kind of this entity. Always blogger#page
126 "author": { # The author of this Page.
127 "url": "A String", # The URL of the Page creator's Profile page.
128 "image": { # The page author's avatar.
129 "url": "A String", # The page author's avatar URL.
130 },
131 "displayName": "A String", # The display name.
132 "id": "A String", # The identifier of the Page creator.
133 },
134 "url": "A String", # The URL that this Page is displayed at.
135 "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
136 "updated": "A String", # RFC 3339 date-time when this Page was last updated.
137 "blog": { # Data about the blog containing this Page.
138 "id": "A String", # The identifier of the blog containing this page.
139 },
140 "published": "A String", # RFC 3339 date-time when this Page was published.
141 "id": "A String", # The identifier for this resource.
142 "selfLink": "A String", # The API REST URL to fetch this resource from.
143 }</pre>
144</div>
145
146<div class="method">
147 <code class="details" id="insert">insert(blogId, body)</code>
148 <pre>Add a page.
149
150Args:
151 blogId: string, ID of the blog to add the page to. (required)
152 body: object, The request body. (required)
153 The object takes the form of:
154
155{
156 "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
157 "content": "A String", # The body content of this Page, in HTML.
158 "kind": "blogger#page", # The kind of this entity. Always blogger#page
159 "author": { # The author of this Page.
160 "url": "A String", # The URL of the Page creator's Profile page.
161 "image": { # The page author's avatar.
162 "url": "A String", # The page author's avatar URL.
163 },
164 "displayName": "A String", # The display name.
165 "id": "A String", # The identifier of the Page creator.
166 },
167 "url": "A String", # The URL that this Page is displayed at.
168 "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
169 "updated": "A String", # RFC 3339 date-time when this Page was last updated.
170 "blog": { # Data about the blog containing this Page.
171 "id": "A String", # The identifier of the blog containing this page.
172 },
173 "published": "A String", # RFC 3339 date-time when this Page was published.
174 "id": "A String", # The identifier for this resource.
175 "selfLink": "A String", # The API REST URL to fetch this resource from.
176 }
177
178
179Returns:
180 An object of the form:
181
182 {
183 "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
184 "content": "A String", # The body content of this Page, in HTML.
185 "kind": "blogger#page", # The kind of this entity. Always blogger#page
186 "author": { # The author of this Page.
187 "url": "A String", # The URL of the Page creator's Profile page.
188 "image": { # The page author's avatar.
189 "url": "A String", # The page author's avatar URL.
190 },
191 "displayName": "A String", # The display name.
192 "id": "A String", # The identifier of the Page creator.
193 },
194 "url": "A String", # The URL that this Page is displayed at.
195 "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
196 "updated": "A String", # RFC 3339 date-time when this Page was last updated.
197 "blog": { # Data about the blog containing this Page.
198 "id": "A String", # The identifier of the blog containing this page.
199 },
200 "published": "A String", # RFC 3339 date-time when this Page was published.
201 "id": "A String", # The identifier for this resource.
202 "selfLink": "A String", # The API REST URL to fetch this resource from.
203 }</pre>
204</div>
205
206<div class="method">
207 <code class="details" id="list">list(blogId, status=None, fetchBodies=None, view=None)</code>
208 <pre>Retrieves the pages for a blog, optionally including non-LIVE statuses.
209
210Args:
211 blogId: string, ID of the blog to fetch pages from. (required)
212 status: string, A parameter (repeated)
213 Allowed values
214 draft - Draft (unpublished) Pages
215 live - Pages that are publicly visible
216 fetchBodies: boolean, Whether to retrieve the Page bodies.
217 view: string, Access level with which to view the returned result. Note that some fields require elevated access.
218 Allowed values
219 ADMIN - Admin level detail
220 AUTHOR - Author level detail
221 READER - Reader level detail
222
223Returns:
224 An object of the form:
225
226 {
227 "items": [ # The list of Pages for a Blog.
228 {
229 "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
230 "content": "A String", # The body content of this Page, in HTML.
231 "kind": "blogger#page", # The kind of this entity. Always blogger#page
232 "author": { # The author of this Page.
233 "url": "A String", # The URL of the Page creator's Profile page.
234 "image": { # The page author's avatar.
235 "url": "A String", # The page author's avatar URL.
236 },
237 "displayName": "A String", # The display name.
238 "id": "A String", # The identifier of the Page creator.
239 },
240 "url": "A String", # The URL that this Page is displayed at.
241 "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
242 "updated": "A String", # RFC 3339 date-time when this Page was last updated.
243 "blog": { # Data about the blog containing this Page.
244 "id": "A String", # The identifier of the blog containing this page.
245 },
246 "published": "A String", # RFC 3339 date-time when this Page was published.
247 "id": "A String", # The identifier for this resource.
248 "selfLink": "A String", # The API REST URL to fetch this resource from.
249 },
250 ],
251 "kind": "blogger#pageList", # The kind of this entity. Always blogger#pageList
252 }</pre>
253</div>
254
255<div class="method">
256 <code class="details" id="patch">patch(blogId, pageId, body)</code>
257 <pre>Update a page. This method supports patch semantics.
258
259Args:
260 blogId: string, The ID of the Blog. (required)
261 pageId: string, The ID of the Page. (required)
262 body: object, The request body. (required)
263 The object takes the form of:
264
265{
266 "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
267 "content": "A String", # The body content of this Page, in HTML.
268 "kind": "blogger#page", # The kind of this entity. Always blogger#page
269 "author": { # The author of this Page.
270 "url": "A String", # The URL of the Page creator's Profile page.
271 "image": { # The page author's avatar.
272 "url": "A String", # The page author's avatar URL.
273 },
274 "displayName": "A String", # The display name.
275 "id": "A String", # The identifier of the Page creator.
276 },
277 "url": "A String", # The URL that this Page is displayed at.
278 "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
279 "updated": "A String", # RFC 3339 date-time when this Page was last updated.
280 "blog": { # Data about the blog containing this Page.
281 "id": "A String", # The identifier of the blog containing this page.
282 },
283 "published": "A String", # RFC 3339 date-time when this Page was published.
284 "id": "A String", # The identifier for this resource.
285 "selfLink": "A String", # The API REST URL to fetch this resource from.
286 }
287
288
289Returns:
290 An object of the form:
291
292 {
293 "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
294 "content": "A String", # The body content of this Page, in HTML.
295 "kind": "blogger#page", # The kind of this entity. Always blogger#page
296 "author": { # The author of this Page.
297 "url": "A String", # The URL of the Page creator's Profile page.
298 "image": { # The page author's avatar.
299 "url": "A String", # The page author's avatar URL.
300 },
301 "displayName": "A String", # The display name.
302 "id": "A String", # The identifier of the Page creator.
303 },
304 "url": "A String", # The URL that this Page is displayed at.
305 "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
306 "updated": "A String", # RFC 3339 date-time when this Page was last updated.
307 "blog": { # Data about the blog containing this Page.
308 "id": "A String", # The identifier of the blog containing this page.
309 },
310 "published": "A String", # RFC 3339 date-time when this Page was published.
311 "id": "A String", # The identifier for this resource.
312 "selfLink": "A String", # The API REST URL to fetch this resource from.
313 }</pre>
314</div>
315
316<div class="method">
317 <code class="details" id="update">update(blogId, pageId, body)</code>
318 <pre>Update a page.
319
320Args:
321 blogId: string, The ID of the Blog. (required)
322 pageId: string, The ID of the Page. (required)
323 body: object, The request body. (required)
324 The object takes the form of:
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 },
344 "published": "A String", # RFC 3339 date-time when this Page was published.
345 "id": "A String", # The identifier for this resource.
346 "selfLink": "A String", # The API REST URL to fetch this resource from.
347 }
348
349
350Returns:
351 An object of the form:
352
353 {
354 "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
355 "content": "A String", # The body content of this Page, in HTML.
356 "kind": "blogger#page", # The kind of this entity. Always blogger#page
357 "author": { # The author of this Page.
358 "url": "A String", # The URL of the Page creator's Profile page.
359 "image": { # The page author's avatar.
360 "url": "A String", # The page author's avatar URL.
361 },
362 "displayName": "A String", # The display name.
363 "id": "A String", # The identifier of the Page creator.
364 },
365 "url": "A String", # The URL that this Page is displayed at.
366 "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
367 "updated": "A String", # RFC 3339 date-time when this Page was last updated.
368 "blog": { # Data about the blog containing this Page.
369 "id": "A String", # The identifier of the blog containing this page.
370 },
371 "published": "A String", # RFC 3339 date-time when this Page was published.
372 "id": "A String", # The identifier for this resource.
373 "selfLink": "A String", # The API REST URL to fetch this resource from.
374 }</pre>
375</div>
376
377</body></html>