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_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, isDraft=None)</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, pageToken=None, maxResults=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="#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"> 93 <code><a href="#patch">patch(blogId, pageId, body, revert=None, publish=None)</a></code></p> 94 <p class="firstline">Update a page. This method supports patch semantics.</p> 95 <p class="toc_element"> 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> 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> 107 <pre>Delete a page by ID. 108 109 Args: 110 blogId: string, The ID of the Blog. (required) 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> 117 <pre>Gets one blog page by ID. 118 119 Args: 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 128 Returns: 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 }, 149 "etag": "A String", # Etag of the resource. 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"> 157 <code class="details" id="insert">insert(blogId, body, isDraft=None)</code> 158 <pre>Add a page. 159 160 Args: 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 }, 183 "etag": "A String", # Etag of the resource. 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 189 isDraft: boolean, Whether to create the page as a draft (default: false). 190 191 Returns: 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 }, 212 "etag": "A String", # Etag of the resource. 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"> 220 <code class="details" id="list">list(blogId, status=None, pageToken=None, maxResults=None, fetchBodies=None, view=None)</code> 221 <pre>Retrieves the pages for a blog, optionally including non-LIVE statuses. 222 223 Args: 224 blogId: string, ID of the blog to fetch Pages from. (required) 225 status: string, A parameter (repeated) 226 Allowed values 227 draft - Draft (unpublished) Pages 228 live - Pages that are publicly visible 229 pageToken: string, Continuation token if the request is paged. 230 maxResults: integer, Maximum number of Pages to fetch. 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 238 Returns: 239 An object of the form: 240 241 { 242 "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists. 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 }, 262 "etag": "A String", # Etag of the resource. 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 "etag": "A String", # Etag of the response. 270 }</pre> 271 </div> 272 273 <div class="method"> 274 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 275 <pre>Retrieves the next page of results. 276 277 Args: 278 previous_request: The request for the previous page. (required) 279 previous_response: The response from the request for the previous page. (required) 280 281 Returns: 282 A request object that you can call 'execute()' on to request the next 283 page. Returns None if there are no more items in the collection. 284 </pre> 285 </div> 286 287 <div class="method"> 288 <code class="details" id="patch">patch(blogId, pageId, body, revert=None, publish=None)</code> 289 <pre>Update a page. This method supports patch semantics. 290 291 Args: 292 blogId: string, The ID of the Blog. (required) 293 pageId: string, The ID of the Page. (required) 294 body: object, The request body. (required) 295 The object takes the form of: 296 297 { 298 "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT). 299 "content": "A String", # The body content of this Page, in HTML. 300 "kind": "blogger#page", # The kind of this entity. Always blogger#page 301 "author": { # The author of this Page. 302 "url": "A String", # The URL of the Page creator's Profile page. 303 "image": { # The page author's avatar. 304 "url": "A String", # The page author's avatar URL. 305 }, 306 "displayName": "A String", # The display name. 307 "id": "A String", # The identifier of the Page creator. 308 }, 309 "url": "A String", # The URL that this Page is displayed at. 310 "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface. 311 "updated": "A String", # RFC 3339 date-time when this Page was last updated. 312 "blog": { # Data about the blog containing this Page. 313 "id": "A String", # The identifier of the blog containing this page. 314 }, 315 "etag": "A String", # Etag of the resource. 316 "published": "A String", # RFC 3339 date-time when this Page was published. 317 "id": "A String", # The identifier for this resource. 318 "selfLink": "A String", # The API REST URL to fetch this resource from. 319 } 320 321 revert: boolean, Whether a revert action should be performed when the page is updated (default: false). 322 publish: boolean, Whether a publish action should be performed when the page is updated (default: false). 323 324 Returns: 325 An object of the form: 326 327 { 328 "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT). 329 "content": "A String", # The body content of this Page, in HTML. 330 "kind": "blogger#page", # The kind of this entity. Always blogger#page 331 "author": { # The author of this Page. 332 "url": "A String", # The URL of the Page creator's Profile page. 333 "image": { # The page author's avatar. 334 "url": "A String", # The page author's avatar URL. 335 }, 336 "displayName": "A String", # The display name. 337 "id": "A String", # The identifier of the Page creator. 338 }, 339 "url": "A String", # The URL that this Page is displayed at. 340 "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface. 341 "updated": "A String", # RFC 3339 date-time when this Page was last updated. 342 "blog": { # Data about the blog containing this Page. 343 "id": "A String", # The identifier of the blog containing this page. 344 }, 345 "etag": "A String", # Etag of the resource. 346 "published": "A String", # RFC 3339 date-time when this Page was published. 347 "id": "A String", # The identifier for this resource. 348 "selfLink": "A String", # The API REST URL to fetch this resource from. 349 }</pre> 350 </div> 351 352 <div class="method"> 353 <code class="details" id="publish">publish(blogId, pageId)</code> 354 <pre>Publishes a draft page. 355 356 Args: 357 blogId: string, The ID of the blog. (required) 358 pageId: string, The ID of the page. (required) 359 360 Returns: 361 An object of the form: 362 363 { 364 "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT). 365 "content": "A String", # The body content of this Page, in HTML. 366 "kind": "blogger#page", # The kind of this entity. Always blogger#page 367 "author": { # The author of this Page. 368 "url": "A String", # The URL of the Page creator's Profile page. 369 "image": { # The page author's avatar. 370 "url": "A String", # The page author's avatar URL. 371 }, 372 "displayName": "A String", # The display name. 373 "id": "A String", # The identifier of the Page creator. 374 }, 375 "url": "A String", # The URL that this Page is displayed at. 376 "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface. 377 "updated": "A String", # RFC 3339 date-time when this Page was last updated. 378 "blog": { # Data about the blog containing this Page. 379 "id": "A String", # The identifier of the blog containing this page. 380 }, 381 "etag": "A String", # Etag of the resource. 382 "published": "A String", # RFC 3339 date-time when this Page was published. 383 "id": "A String", # The identifier for this resource. 384 "selfLink": "A String", # The API REST URL to fetch this resource from. 385 }</pre> 386 </div> 387 388 <div class="method"> 389 <code class="details" id="revert">revert(blogId, pageId)</code> 390 <pre>Revert a published or scheduled page to draft state. 391 392 Args: 393 blogId: string, The ID of the blog. (required) 394 pageId: string, The ID of the page. (required) 395 396 Returns: 397 An object of the form: 398 399 { 400 "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT). 401 "content": "A String", # The body content of this Page, in HTML. 402 "kind": "blogger#page", # The kind of this entity. Always blogger#page 403 "author": { # The author of this Page. 404 "url": "A String", # The URL of the Page creator's Profile page. 405 "image": { # The page author's avatar. 406 "url": "A String", # The page author's avatar URL. 407 }, 408 "displayName": "A String", # The display name. 409 "id": "A String", # The identifier of the Page creator. 410 }, 411 "url": "A String", # The URL that this Page is displayed at. 412 "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface. 413 "updated": "A String", # RFC 3339 date-time when this Page was last updated. 414 "blog": { # Data about the blog containing this Page. 415 "id": "A String", # The identifier of the blog containing this page. 416 }, 417 "etag": "A String", # Etag of the resource. 418 "published": "A String", # RFC 3339 date-time when this Page was published. 419 "id": "A String", # The identifier for this resource. 420 "selfLink": "A String", # The API REST URL to fetch this resource from. 421 }</pre> 422 </div> 423 424 <div class="method"> 425 <code class="details" id="update">update(blogId, pageId, body, revert=None, publish=None)</code> 426 <pre>Update a page. 427 428 Args: 429 blogId: string, The ID of the Blog. (required) 430 pageId: string, The ID of the Page. (required) 431 body: object, The request body. (required) 432 The object takes the form of: 433 434 { 435 "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT). 436 "content": "A String", # The body content of this Page, in HTML. 437 "kind": "blogger#page", # The kind of this entity. Always blogger#page 438 "author": { # The author of this Page. 439 "url": "A String", # The URL of the Page creator's Profile page. 440 "image": { # The page author's avatar. 441 "url": "A String", # The page author's avatar URL. 442 }, 443 "displayName": "A String", # The display name. 444 "id": "A String", # The identifier of the Page creator. 445 }, 446 "url": "A String", # The URL that this Page is displayed at. 447 "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface. 448 "updated": "A String", # RFC 3339 date-time when this Page was last updated. 449 "blog": { # Data about the blog containing this Page. 450 "id": "A String", # The identifier of the blog containing this page. 451 }, 452 "etag": "A String", # Etag of the resource. 453 "published": "A String", # RFC 3339 date-time when this Page was published. 454 "id": "A String", # The identifier for this resource. 455 "selfLink": "A String", # The API REST URL to fetch this resource from. 456 } 457 458 revert: boolean, Whether a revert action should be performed when the page is updated (default: false). 459 publish: boolean, Whether a publish action should be performed when the page is updated (default: false). 460 461 Returns: 462 An object of the form: 463 464 { 465 "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT). 466 "content": "A String", # The body content of this Page, in HTML. 467 "kind": "blogger#page", # The kind of this entity. Always blogger#page 468 "author": { # The author of this Page. 469 "url": "A String", # The URL of the Page creator's Profile page. 470 "image": { # The page author's avatar. 471 "url": "A String", # The page author's avatar URL. 472 }, 473 "displayName": "A String", # The display name. 474 "id": "A String", # The identifier of the Page creator. 475 }, 476 "url": "A String", # The URL that this Page is displayed at. 477 "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface. 478 "updated": "A String", # RFC 3339 date-time when this Page was last updated. 479 "blog": { # Data about the blog containing this Page. 480 "id": "A String", # The identifier of the blog containing this page. 481 }, 482 "etag": "A String", # Etag of the resource. 483 "published": "A String", # RFC 3339 date-time when this Page was published. 484 "id": "A String", # The identifier for this resource. 485 "selfLink": "A String", # The API REST URL to fetch this resource from. 486 }</pre> 487 </div> 488 489 </body></html>
