531 lines
23 KiB
HTML
531 lines
23 KiB
HTML
<html><body>
|
|
<style>
|
|
|
|
body, h1, h2, h3, div, span, p, pre, a {
|
|
margin: 0;
|
|
padding: 0;
|
|
border: 0;
|
|
font-weight: inherit;
|
|
font-style: inherit;
|
|
font-size: 100%;
|
|
font-family: inherit;
|
|
vertical-align: baseline;
|
|
}
|
|
|
|
body {
|
|
font-size: 13px;
|
|
padding: 1em;
|
|
}
|
|
|
|
h1 {
|
|
font-size: 26px;
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
h2 {
|
|
font-size: 24px;
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
h3 {
|
|
font-size: 20px;
|
|
margin-bottom: 1em;
|
|
margin-top: 1em;
|
|
}
|
|
|
|
pre, code {
|
|
line-height: 1.5;
|
|
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
|
|
}
|
|
|
|
pre {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
h1, h2, h3, p {
|
|
font-family: Arial, sans serif;
|
|
}
|
|
|
|
h1, h2, h3 {
|
|
border-bottom: solid #CCC 1px;
|
|
}
|
|
|
|
.toc_element {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
.firstline {
|
|
margin-left: 2 em;
|
|
}
|
|
|
|
.method {
|
|
margin-top: 1em;
|
|
border: solid 1px #CCC;
|
|
padding: 1em;
|
|
background: #EEE;
|
|
}
|
|
|
|
.details {
|
|
font-weight: bold;
|
|
font-size: 14px;
|
|
}
|
|
|
|
</style>
|
|
|
|
<h1><a href="blogger_v3.html">Blogger API v3</a> . <a href="blogger_v3.pages.html">pages</a></h1>
|
|
<h2>Instance Methods</h2>
|
|
<p class="toc_element">
|
|
<code><a href="#close">close()</a></code></p>
|
|
<p class="firstline">Close httplib2 connections.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#delete">delete(blogId, pageId, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Deletes a page by blog id and page id.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#get">get(blogId, pageId, view=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Gets a page by blog id and page id.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#insert">insert(blogId, body=None, isDraft=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Inserts a page.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#list">list(blogId, fetchBodies=None, maxResults=None, pageToken=None, status=None, view=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Lists pages.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
|
<p class="firstline">Retrieves the next page of results.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#patch">patch(blogId, pageId, body=None, publish=None, revert=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Patches a page.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#publish">publish(blogId, pageId, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Publishes a page.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#revert">revert(blogId, pageId, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Reverts a published or scheduled page to draft state.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#update">update(blogId, pageId, body=None, publish=None, revert=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Updates a page by blog id and page id.</p>
|
|
<h3>Method Details</h3>
|
|
<div class="method">
|
|
<code class="details" id="close">close()</code>
|
|
<pre>Close httplib2 connections.</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="delete">delete(blogId, pageId, x__xgafv=None)</code>
|
|
<pre>Deletes a page by blog id and page id.
|
|
|
|
Args:
|
|
blogId: string, A parameter (required)
|
|
pageId: string, A parameter (required)
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="get">get(blogId, pageId, view=None, x__xgafv=None)</code>
|
|
<pre>Gets a page by blog id and page id.
|
|
|
|
Args:
|
|
blogId: string, A parameter (required)
|
|
pageId: string, A parameter (required)
|
|
view: string, A parameter
|
|
Allowed values
|
|
VIEW_TYPE_UNSPECIFIED -
|
|
READER -
|
|
AUTHOR -
|
|
ADMIN -
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{
|
|
"author": { # The author of this Page.
|
|
"displayName": "A String", # The display name.
|
|
"id": "A String", # The identifier of the creator.
|
|
"image": { # The creator's avatar.
|
|
"url": "A String", # The creator's avatar URL.
|
|
},
|
|
"url": "A String", # The URL of the creator's Profile page.
|
|
},
|
|
"blog": { # Data about the blog containing this Page.
|
|
"id": "A String", # The identifier of the blog containing this page.
|
|
},
|
|
"content": "A String", # The body content of this Page, in HTML.
|
|
"etag": "A String", # Etag of the resource.
|
|
"id": "A String", # The identifier for this resource.
|
|
"kind": "A String", # The kind of this entity. Always blogger#page.
|
|
"published": "A String", # RFC 3339 date-time when this Page was published.
|
|
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
|
"status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
|
|
"title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
|
|
"updated": "A String", # RFC 3339 date-time when this Page was last updated.
|
|
"url": "A String", # The URL that this Page is displayed at.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="insert">insert(blogId, body=None, isDraft=None, x__xgafv=None)</code>
|
|
<pre>Inserts a page.
|
|
|
|
Args:
|
|
blogId: string, A parameter (required)
|
|
body: object, The request body.
|
|
The object takes the form of:
|
|
|
|
{
|
|
"author": { # The author of this Page.
|
|
"displayName": "A String", # The display name.
|
|
"id": "A String", # The identifier of the creator.
|
|
"image": { # The creator's avatar.
|
|
"url": "A String", # The creator's avatar URL.
|
|
},
|
|
"url": "A String", # The URL of the creator's Profile page.
|
|
},
|
|
"blog": { # Data about the blog containing this Page.
|
|
"id": "A String", # The identifier of the blog containing this page.
|
|
},
|
|
"content": "A String", # The body content of this Page, in HTML.
|
|
"etag": "A String", # Etag of the resource.
|
|
"id": "A String", # The identifier for this resource.
|
|
"kind": "A String", # The kind of this entity. Always blogger#page.
|
|
"published": "A String", # RFC 3339 date-time when this Page was published.
|
|
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
|
"status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
|
|
"title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
|
|
"updated": "A String", # RFC 3339 date-time when this Page was last updated.
|
|
"url": "A String", # The URL that this Page is displayed at.
|
|
}
|
|
|
|
isDraft: boolean, A parameter
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{
|
|
"author": { # The author of this Page.
|
|
"displayName": "A String", # The display name.
|
|
"id": "A String", # The identifier of the creator.
|
|
"image": { # The creator's avatar.
|
|
"url": "A String", # The creator's avatar URL.
|
|
},
|
|
"url": "A String", # The URL of the creator's Profile page.
|
|
},
|
|
"blog": { # Data about the blog containing this Page.
|
|
"id": "A String", # The identifier of the blog containing this page.
|
|
},
|
|
"content": "A String", # The body content of this Page, in HTML.
|
|
"etag": "A String", # Etag of the resource.
|
|
"id": "A String", # The identifier for this resource.
|
|
"kind": "A String", # The kind of this entity. Always blogger#page.
|
|
"published": "A String", # RFC 3339 date-time when this Page was published.
|
|
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
|
"status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
|
|
"title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
|
|
"updated": "A String", # RFC 3339 date-time when this Page was last updated.
|
|
"url": "A String", # The URL that this Page is displayed at.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="list">list(blogId, fetchBodies=None, maxResults=None, pageToken=None, status=None, view=None, x__xgafv=None)</code>
|
|
<pre>Lists pages.
|
|
|
|
Args:
|
|
blogId: string, A parameter (required)
|
|
fetchBodies: boolean, A parameter
|
|
maxResults: integer, A parameter
|
|
pageToken: string, A parameter
|
|
status: string, A parameter (repeated)
|
|
Allowed values
|
|
LIVE -
|
|
DRAFT -
|
|
view: string, A parameter
|
|
Allowed values
|
|
VIEW_TYPE_UNSPECIFIED -
|
|
READER -
|
|
AUTHOR -
|
|
ADMIN -
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{
|
|
"etag": "A String", # Etag of the response.
|
|
"items": [ # The list of Pages for a Blog.
|
|
{
|
|
"author": { # The author of this Page.
|
|
"displayName": "A String", # The display name.
|
|
"id": "A String", # The identifier of the creator.
|
|
"image": { # The creator's avatar.
|
|
"url": "A String", # The creator's avatar URL.
|
|
},
|
|
"url": "A String", # The URL of the creator's Profile page.
|
|
},
|
|
"blog": { # Data about the blog containing this Page.
|
|
"id": "A String", # The identifier of the blog containing this page.
|
|
},
|
|
"content": "A String", # The body content of this Page, in HTML.
|
|
"etag": "A String", # Etag of the resource.
|
|
"id": "A String", # The identifier for this resource.
|
|
"kind": "A String", # The kind of this entity. Always blogger#page.
|
|
"published": "A String", # RFC 3339 date-time when this Page was published.
|
|
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
|
"status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
|
|
"title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
|
|
"updated": "A String", # RFC 3339 date-time when this Page was last updated.
|
|
"url": "A String", # The URL that this Page is displayed at.
|
|
},
|
|
],
|
|
"kind": "A String", # The kind of this entity. Always blogger#pageList.
|
|
"nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
|
|
<pre>Retrieves the next page of results.
|
|
|
|
Args:
|
|
previous_request: The request for the previous page. (required)
|
|
previous_response: The response from the request for the previous page. (required)
|
|
|
|
Returns:
|
|
A request object that you can call 'execute()' on to request the next
|
|
page. Returns None if there are no more items in the collection.
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="patch">patch(blogId, pageId, body=None, publish=None, revert=None, x__xgafv=None)</code>
|
|
<pre>Patches a page.
|
|
|
|
Args:
|
|
blogId: string, A parameter (required)
|
|
pageId: string, A parameter (required)
|
|
body: object, The request body.
|
|
The object takes the form of:
|
|
|
|
{
|
|
"author": { # The author of this Page.
|
|
"displayName": "A String", # The display name.
|
|
"id": "A String", # The identifier of the creator.
|
|
"image": { # The creator's avatar.
|
|
"url": "A String", # The creator's avatar URL.
|
|
},
|
|
"url": "A String", # The URL of the creator's Profile page.
|
|
},
|
|
"blog": { # Data about the blog containing this Page.
|
|
"id": "A String", # The identifier of the blog containing this page.
|
|
},
|
|
"content": "A String", # The body content of this Page, in HTML.
|
|
"etag": "A String", # Etag of the resource.
|
|
"id": "A String", # The identifier for this resource.
|
|
"kind": "A String", # The kind of this entity. Always blogger#page.
|
|
"published": "A String", # RFC 3339 date-time when this Page was published.
|
|
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
|
"status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
|
|
"title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
|
|
"updated": "A String", # RFC 3339 date-time when this Page was last updated.
|
|
"url": "A String", # The URL that this Page is displayed at.
|
|
}
|
|
|
|
publish: boolean, A parameter
|
|
revert: boolean, A parameter
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{
|
|
"author": { # The author of this Page.
|
|
"displayName": "A String", # The display name.
|
|
"id": "A String", # The identifier of the creator.
|
|
"image": { # The creator's avatar.
|
|
"url": "A String", # The creator's avatar URL.
|
|
},
|
|
"url": "A String", # The URL of the creator's Profile page.
|
|
},
|
|
"blog": { # Data about the blog containing this Page.
|
|
"id": "A String", # The identifier of the blog containing this page.
|
|
},
|
|
"content": "A String", # The body content of this Page, in HTML.
|
|
"etag": "A String", # Etag of the resource.
|
|
"id": "A String", # The identifier for this resource.
|
|
"kind": "A String", # The kind of this entity. Always blogger#page.
|
|
"published": "A String", # RFC 3339 date-time when this Page was published.
|
|
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
|
"status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
|
|
"title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
|
|
"updated": "A String", # RFC 3339 date-time when this Page was last updated.
|
|
"url": "A String", # The URL that this Page is displayed at.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="publish">publish(blogId, pageId, x__xgafv=None)</code>
|
|
<pre>Publishes a page.
|
|
|
|
Args:
|
|
blogId: string, A parameter (required)
|
|
pageId: string, A parameter (required)
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{
|
|
"author": { # The author of this Page.
|
|
"displayName": "A String", # The display name.
|
|
"id": "A String", # The identifier of the creator.
|
|
"image": { # The creator's avatar.
|
|
"url": "A String", # The creator's avatar URL.
|
|
},
|
|
"url": "A String", # The URL of the creator's Profile page.
|
|
},
|
|
"blog": { # Data about the blog containing this Page.
|
|
"id": "A String", # The identifier of the blog containing this page.
|
|
},
|
|
"content": "A String", # The body content of this Page, in HTML.
|
|
"etag": "A String", # Etag of the resource.
|
|
"id": "A String", # The identifier for this resource.
|
|
"kind": "A String", # The kind of this entity. Always blogger#page.
|
|
"published": "A String", # RFC 3339 date-time when this Page was published.
|
|
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
|
"status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
|
|
"title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
|
|
"updated": "A String", # RFC 3339 date-time when this Page was last updated.
|
|
"url": "A String", # The URL that this Page is displayed at.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="revert">revert(blogId, pageId, x__xgafv=None)</code>
|
|
<pre>Reverts a published or scheduled page to draft state.
|
|
|
|
Args:
|
|
blogId: string, A parameter (required)
|
|
pageId: string, A parameter (required)
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{
|
|
"author": { # The author of this Page.
|
|
"displayName": "A String", # The display name.
|
|
"id": "A String", # The identifier of the creator.
|
|
"image": { # The creator's avatar.
|
|
"url": "A String", # The creator's avatar URL.
|
|
},
|
|
"url": "A String", # The URL of the creator's Profile page.
|
|
},
|
|
"blog": { # Data about the blog containing this Page.
|
|
"id": "A String", # The identifier of the blog containing this page.
|
|
},
|
|
"content": "A String", # The body content of this Page, in HTML.
|
|
"etag": "A String", # Etag of the resource.
|
|
"id": "A String", # The identifier for this resource.
|
|
"kind": "A String", # The kind of this entity. Always blogger#page.
|
|
"published": "A String", # RFC 3339 date-time when this Page was published.
|
|
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
|
"status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
|
|
"title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
|
|
"updated": "A String", # RFC 3339 date-time when this Page was last updated.
|
|
"url": "A String", # The URL that this Page is displayed at.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="update">update(blogId, pageId, body=None, publish=None, revert=None, x__xgafv=None)</code>
|
|
<pre>Updates a page by blog id and page id.
|
|
|
|
Args:
|
|
blogId: string, A parameter (required)
|
|
pageId: string, A parameter (required)
|
|
body: object, The request body.
|
|
The object takes the form of:
|
|
|
|
{
|
|
"author": { # The author of this Page.
|
|
"displayName": "A String", # The display name.
|
|
"id": "A String", # The identifier of the creator.
|
|
"image": { # The creator's avatar.
|
|
"url": "A String", # The creator's avatar URL.
|
|
},
|
|
"url": "A String", # The URL of the creator's Profile page.
|
|
},
|
|
"blog": { # Data about the blog containing this Page.
|
|
"id": "A String", # The identifier of the blog containing this page.
|
|
},
|
|
"content": "A String", # The body content of this Page, in HTML.
|
|
"etag": "A String", # Etag of the resource.
|
|
"id": "A String", # The identifier for this resource.
|
|
"kind": "A String", # The kind of this entity. Always blogger#page.
|
|
"published": "A String", # RFC 3339 date-time when this Page was published.
|
|
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
|
"status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
|
|
"title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
|
|
"updated": "A String", # RFC 3339 date-time when this Page was last updated.
|
|
"url": "A String", # The URL that this Page is displayed at.
|
|
}
|
|
|
|
publish: boolean, A parameter
|
|
revert: boolean, A parameter
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{
|
|
"author": { # The author of this Page.
|
|
"displayName": "A String", # The display name.
|
|
"id": "A String", # The identifier of the creator.
|
|
"image": { # The creator's avatar.
|
|
"url": "A String", # The creator's avatar URL.
|
|
},
|
|
"url": "A String", # The URL of the creator's Profile page.
|
|
},
|
|
"blog": { # Data about the blog containing this Page.
|
|
"id": "A String", # The identifier of the blog containing this page.
|
|
},
|
|
"content": "A String", # The body content of this Page, in HTML.
|
|
"etag": "A String", # Etag of the resource.
|
|
"id": "A String", # The identifier for this resource.
|
|
"kind": "A String", # The kind of this entity. Always blogger#page.
|
|
"published": "A String", # RFC 3339 date-time when this Page was published.
|
|
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
|
"status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
|
|
"title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
|
|
"updated": "A String", # RFC 3339 date-time when this Page was last updated.
|
|
"url": "A String", # The URL that this Page is displayed at.
|
|
}</pre>
|
|
</div>
|
|
|
|
</body></html> |