Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 8ed1dcdf85556905681146bf5fcadf6540a508e9 / . / docs / dyn / blogger_v3.posts.html
blob: f38d3d9ec0fb2ab7098fc5330c68f0f2c88735ee [file] [log] [blame]
<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.posts.html">posts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(blogId, postId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a post by blog id and post id.</p>
<p class="toc_element">
<code><a href="#get">get(blogId, postId, maxComments=None, fetchImages=None, fetchBody=None, x__xgafv=None, view=None)</a></code></p>
<p class="firstline">Gets a post by blog id and post id</p>
<p class="toc_element">
<code><a href="#getByPath">getByPath(blogId, path, x__xgafv=None, maxComments=None, view=None)</a></code></p>
<p class="firstline">Gets a post by path.</p>
<p class="toc_element">
<code><a href="#insert">insert(blogId, body=None, isDraft=None, fetchBody=None, x__xgafv=None, fetchImages=None)</a></code></p>
<p class="firstline">Inserts a post.</p>
<p class="toc_element">
<code><a href="#list">list(blogId, orderBy=None, startDate=None, endDate=None, labels=None, x__xgafv=None, fetchImages=None, pageToken=None, status=None, maxResults=None, fetchBodies=None, view=None)</a></code></p>
<p class="firstline">Lists posts.</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, postId, body=None, x__xgafv=None, publish=None, fetchImages=None, revert=None, fetchBody=None, maxComments=None)</a></code></p>
<p class="firstline">Patches a post.</p>
<p class="toc_element">
<code><a href="#publish">publish(blogId, postId, publishDate=None, x__xgafv=None)</a></code></p>
<p class="firstline">Publishes a post.</p>
<p class="toc_element">
<code><a href="#revert">revert(blogId, postId, x__xgafv=None)</a></code></p>
<p class="firstline">Reverts a published or scheduled post to draft state.</p>
<p class="toc_element">
<code><a href="#search">search(blogId, q, orderBy=None, x__xgafv=None, fetchBodies=None)</a></code></p>
<p class="firstline">Searches for posts matching given query terms in the specified blog.</p>
<p class="toc_element">
<code><a href="#update">update(blogId, postId, body=None, x__xgafv=None, publish=None, fetchImages=None, revert=None, fetchBody=None, maxComments=None)</a></code></p>
<p class="firstline">Updates a post by blog id and post id.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(blogId, postId, x__xgafv=None)</code>
<pre>Deletes a post by blog id and post id.
Args:
blogId: string, A parameter (required)
postId: 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, postId, maxComments=None, fetchImages=None, fetchBody=None, x__xgafv=None, view=None)</code>
<pre>Gets a post by blog id and post id
Args:
blogId: string, A parameter (required)
postId: string, A parameter (required)
maxComments: integer, A parameter
fetchImages: boolean, A parameter
fetchBody: boolean, A parameter
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
view: string, A parameter
Returns:
An object of the form:
{
"status": "A String", # Status of the post. Only set for admin-level requests.
"blog": { # Data about the blog containing this Post.
"id": "A String", # The identifier of the Blog that contains this Post.
},
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
"titleLink": "A String", # The title link URL, similar to atom's related link.
"author": { # The author of this Post.
"url": "A String", # The URL of the creator's Profile page.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
},
"title": "A String", # The title of the Post.
"replies": { # The container of comments on this Post.
"totalItems": "A String", # The count of comments on this post.
"items": [ # The List of Comments for this Post.
{
"status": "A String", # The status of the comment (only populated for admin users).
"inReplyTo": { # Data about the comment this is in reply to.
"id": "A String", # The identified of the parent of this comment.
},
"kind": "A String", # The kind of this entry. Always blogger#comment.
"author": { # The author of this Comment.
"url": "A String", # The URL of the creator's Profile page.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
},
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
"blog": { # Data about the blog containing this comment.
"id": "A String", # The identifier of the blog containing this comment.
},
"published": "A String", # RFC 3339 date-time when this comment was published.
"post": { # Data about the post containing this comment.
"id": "A String", # The identifier of the post containing this comment.
},
"content": "A String", # The actual content of the comment. May include HTML markup.
"id": "A String", # The identifier for this resource.
"selfLink": "A String", # The API REST URL to fetch this resource from.
},
],
"selfLink": "A String", # The URL of the comments on this post.
},
"readerComments": "A String", # Comment control and display setting for readers of this post.
"labels": [ # The list of labels this Post was tagged with.
"A String",
],
"customMetaData": "A String", # The JSON meta-data for the Post.
"kind": "A String", # The kind of this entity. Always blogger#post.
"content": "A String", # The content of the Post. May contain HTML markup.
"url": "A String", # The URL where this Post is displayed.
"etag": "A String", # Etag of the resource.
"location": { # The location for geotagged posts.
"lat": 3.14, # Location's latitude.
"lng": 3.14, # Location's longitude.
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
"name": "A String", # Location name.
},
"published": "A String", # RFC 3339 date-time when this Post was published.
"images": [ # Display image for the Post.
{
"url": "A String",
},
],
"id": "A String", # The identifier of this Post.
"selfLink": "A String", # The API REST URL to fetch this resource from.
}</pre>
</div>
<div class="method">
<code class="details" id="getByPath">getByPath(blogId, path, x__xgafv=None, maxComments=None, view=None)</code>
<pre>Gets a post by path.
Args:
blogId: string, A parameter (required)
path: string, A parameter (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
maxComments: integer, A parameter
view: string, A parameter
Returns:
An object of the form:
{
"status": "A String", # Status of the post. Only set for admin-level requests.
"blog": { # Data about the blog containing this Post.
"id": "A String", # The identifier of the Blog that contains this Post.
},
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
"titleLink": "A String", # The title link URL, similar to atom's related link.
"author": { # The author of this Post.
"url": "A String", # The URL of the creator's Profile page.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
},
"title": "A String", # The title of the Post.
"replies": { # The container of comments on this Post.
"totalItems": "A String", # The count of comments on this post.
"items": [ # The List of Comments for this Post.
{
"status": "A String", # The status of the comment (only populated for admin users).
"inReplyTo": { # Data about the comment this is in reply to.
"id": "A String", # The identified of the parent of this comment.
},
"kind": "A String", # The kind of this entry. Always blogger#comment.
"author": { # The author of this Comment.
"url": "A String", # The URL of the creator's Profile page.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
},
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
"blog": { # Data about the blog containing this comment.
"id": "A String", # The identifier of the blog containing this comment.
},
"published": "A String", # RFC 3339 date-time when this comment was published.
"post": { # Data about the post containing this comment.
"id": "A String", # The identifier of the post containing this comment.
},
"content": "A String", # The actual content of the comment. May include HTML markup.
"id": "A String", # The identifier for this resource.
"selfLink": "A String", # The API REST URL to fetch this resource from.
},
],
"selfLink": "A String", # The URL of the comments on this post.
},
"readerComments": "A String", # Comment control and display setting for readers of this post.
"labels": [ # The list of labels this Post was tagged with.
"A String",
],
"customMetaData": "A String", # The JSON meta-data for the Post.
"kind": "A String", # The kind of this entity. Always blogger#post.
"content": "A String", # The content of the Post. May contain HTML markup.
"url": "A String", # The URL where this Post is displayed.
"etag": "A String", # Etag of the resource.
"location": { # The location for geotagged posts.
"lat": 3.14, # Location's latitude.
"lng": 3.14, # Location's longitude.
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
"name": "A String", # Location name.
},
"published": "A String", # RFC 3339 date-time when this Post was published.
"images": [ # Display image for the Post.
{
"url": "A String",
},
],
"id": "A String", # The identifier of this Post.
"selfLink": "A String", # The API REST URL to fetch this resource from.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(blogId, body=None, isDraft=None, fetchBody=None, x__xgafv=None, fetchImages=None)</code>
<pre>Inserts a post.
Args:
blogId: string, A parameter (required)
body: object, The request body.
The object takes the form of:
{
"status": "A String", # Status of the post. Only set for admin-level requests.
"blog": { # Data about the blog containing this Post.
"id": "A String", # The identifier of the Blog that contains this Post.
},
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
"titleLink": "A String", # The title link URL, similar to atom's related link.
"author": { # The author of this Post.
"url": "A String", # The URL of the creator's Profile page.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
},
"title": "A String", # The title of the Post.
"replies": { # The container of comments on this Post.
"totalItems": "A String", # The count of comments on this post.
"items": [ # The List of Comments for this Post.
{
"status": "A String", # The status of the comment (only populated for admin users).
"inReplyTo": { # Data about the comment this is in reply to.
"id": "A String", # The identified of the parent of this comment.
},
"kind": "A String", # The kind of this entry. Always blogger#comment.
"author": { # The author of this Comment.
"url": "A String", # The URL of the creator's Profile page.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
},
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
"blog": { # Data about the blog containing this comment.
"id": "A String", # The identifier of the blog containing this comment.
},
"published": "A String", # RFC 3339 date-time when this comment was published.
"post": { # Data about the post containing this comment.
"id": "A String", # The identifier of the post containing this comment.
},
"content": "A String", # The actual content of the comment. May include HTML markup.
"id": "A String", # The identifier for this resource.
"selfLink": "A String", # The API REST URL to fetch this resource from.
},
],
"selfLink": "A String", # The URL of the comments on this post.
},
"readerComments": "A String", # Comment control and display setting for readers of this post.
"labels": [ # The list of labels this Post was tagged with.
"A String",
],
"customMetaData": "A String", # The JSON meta-data for the Post.
"kind": "A String", # The kind of this entity. Always blogger#post.
"content": "A String", # The content of the Post. May contain HTML markup.
"url": "A String", # The URL where this Post is displayed.
"etag": "A String", # Etag of the resource.
"location": { # The location for geotagged posts.
"lat": 3.14, # Location's latitude.
"lng": 3.14, # Location's longitude.
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
"name": "A String", # Location name.
},
"published": "A String", # RFC 3339 date-time when this Post was published.
"images": [ # Display image for the Post.
{
"url": "A String",
},
],
"id": "A String", # The identifier of this Post.
"selfLink": "A String", # The API REST URL to fetch this resource from.
}
isDraft: boolean, A parameter
fetchBody: boolean, A parameter
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
fetchImages: boolean, A parameter
Returns:
An object of the form:
{
"status": "A String", # Status of the post. Only set for admin-level requests.
"blog": { # Data about the blog containing this Post.
"id": "A String", # The identifier of the Blog that contains this Post.
},
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
"titleLink": "A String", # The title link URL, similar to atom's related link.
"author": { # The author of this Post.
"url": "A String", # The URL of the creator's Profile page.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
},
"title": "A String", # The title of the Post.
"replies": { # The container of comments on this Post.
"totalItems": "A String", # The count of comments on this post.
"items": [ # The List of Comments for this Post.
{
"status": "A String", # The status of the comment (only populated for admin users).
"inReplyTo": { # Data about the comment this is in reply to.
"id": "A String", # The identified of the parent of this comment.
},
"kind": "A String", # The kind of this entry. Always blogger#comment.
"author": { # The author of this Comment.
"url": "A String", # The URL of the creator's Profile page.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
},
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
"blog": { # Data about the blog containing this comment.
"id": "A String", # The identifier of the blog containing this comment.
},
"published": "A String", # RFC 3339 date-time when this comment was published.
"post": { # Data about the post containing this comment.
"id": "A String", # The identifier of the post containing this comment.
},
"content": "A String", # The actual content of the comment. May include HTML markup.
"id": "A String", # The identifier for this resource.
"selfLink": "A String", # The API REST URL to fetch this resource from.
},
],
"selfLink": "A String", # The URL of the comments on this post.
},
"readerComments": "A String", # Comment control and display setting for readers of this post.
"labels": [ # The list of labels this Post was tagged with.
"A String",
],
"customMetaData": "A String", # The JSON meta-data for the Post.
"kind": "A String", # The kind of this entity. Always blogger#post.
"content": "A String", # The content of the Post. May contain HTML markup.
"url": "A String", # The URL where this Post is displayed.
"etag": "A String", # Etag of the resource.
"location": { # The location for geotagged posts.
"lat": 3.14, # Location's latitude.
"lng": 3.14, # Location's longitude.
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
"name": "A String", # Location name.
},
"published": "A String", # RFC 3339 date-time when this Post was published.
"images": [ # Display image for the Post.
{
"url": "A String",
},
],
"id": "A String", # The identifier of this Post.
"selfLink": "A String", # The API REST URL to fetch this resource from.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(blogId, orderBy=None, startDate=None, endDate=None, labels=None, x__xgafv=None, fetchImages=None, pageToken=None, status=None, maxResults=None, fetchBodies=None, view=None)</code>
<pre>Lists posts.
Args:
blogId: string, A parameter (required)
orderBy: string, A parameter
startDate: string, A parameter
endDate: string, A parameter
labels: string, A parameter
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
fetchImages: boolean, A parameter
pageToken: string, A parameter
status: string, A parameter (repeated)
maxResults: integer, A parameter
fetchBodies: boolean, A parameter
view: string, A parameter
Returns:
An object of the form:
{
"nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
"items": [ # The list of Posts for this Blog.
{
"status": "A String", # Status of the post. Only set for admin-level requests.
"blog": { # Data about the blog containing this Post.
"id": "A String", # The identifier of the Blog that contains this Post.
},
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
"titleLink": "A String", # The title link URL, similar to atom's related link.
"author": { # The author of this Post.
"url": "A String", # The URL of the creator's Profile page.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
},
"title": "A String", # The title of the Post.
"replies": { # The container of comments on this Post.
"totalItems": "A String", # The count of comments on this post.
"items": [ # The List of Comments for this Post.
{
"status": "A String", # The status of the comment (only populated for admin users).
"inReplyTo": { # Data about the comment this is in reply to.
"id": "A String", # The identified of the parent of this comment.
},
"kind": "A String", # The kind of this entry. Always blogger#comment.
"author": { # The author of this Comment.
"url": "A String", # The URL of the creator's Profile page.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
},
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
"blog": { # Data about the blog containing this comment.
"id": "A String", # The identifier of the blog containing this comment.
},
"published": "A String", # RFC 3339 date-time when this comment was published.
"post": { # Data about the post containing this comment.
"id": "A String", # The identifier of the post containing this comment.
},
"content": "A String", # The actual content of the comment. May include HTML markup.
"id": "A String", # The identifier for this resource.
"selfLink": "A String", # The API REST URL to fetch this resource from.
},
],
"selfLink": "A String", # The URL of the comments on this post.
},
"readerComments": "A String", # Comment control and display setting for readers of this post.
"labels": [ # The list of labels this Post was tagged with.
"A String",
],
"customMetaData": "A String", # The JSON meta-data for the Post.
"kind": "A String", # The kind of this entity. Always blogger#post.
"content": "A String", # The content of the Post. May contain HTML markup.
"url": "A String", # The URL where this Post is displayed.
"etag": "A String", # Etag of the resource.
"location": { # The location for geotagged posts.
"lat": 3.14, # Location's latitude.
"lng": 3.14, # Location's longitude.
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
"name": "A String", # Location name.
},
"published": "A String", # RFC 3339 date-time when this Post was published.
"images": [ # Display image for the Post.
{
"url": "A String",
},
],
"id": "A String", # The identifier of this Post.
"selfLink": "A String", # The API REST URL to fetch this resource from.
},
],
"kind": "A String", # The kind of this entity. Always blogger#postList.
"etag": "A String", # Etag of the response.
"prevPageToken": "A String", # Pagination token to fetch the previous 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, postId, body=None, x__xgafv=None, publish=None, fetchImages=None, revert=None, fetchBody=None, maxComments=None)</code>
<pre>Patches a post.
Args:
blogId: string, A parameter (required)
postId: string, A parameter (required)
body: object, The request body.
The object takes the form of:
{
"status": "A String", # Status of the post. Only set for admin-level requests.
"blog": { # Data about the blog containing this Post.
"id": "A String", # The identifier of the Blog that contains this Post.
},
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
"titleLink": "A String", # The title link URL, similar to atom's related link.
"author": { # The author of this Post.
"url": "A String", # The URL of the creator's Profile page.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
},
"title": "A String", # The title of the Post.
"replies": { # The container of comments on this Post.
"totalItems": "A String", # The count of comments on this post.
"items": [ # The List of Comments for this Post.
{
"status": "A String", # The status of the comment (only populated for admin users).
"inReplyTo": { # Data about the comment this is in reply to.
"id": "A String", # The identified of the parent of this comment.
},
"kind": "A String", # The kind of this entry. Always blogger#comment.
"author": { # The author of this Comment.
"url": "A String", # The URL of the creator's Profile page.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
},
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
"blog": { # Data about the blog containing this comment.
"id": "A String", # The identifier of the blog containing this comment.
},
"published": "A String", # RFC 3339 date-time when this comment was published.
"post": { # Data about the post containing this comment.
"id": "A String", # The identifier of the post containing this comment.
},
"content": "A String", # The actual content of the comment. May include HTML markup.
"id": "A String", # The identifier for this resource.
"selfLink": "A String", # The API REST URL to fetch this resource from.
},
],
"selfLink": "A String", # The URL of the comments on this post.
},
"readerComments": "A String", # Comment control and display setting for readers of this post.
"labels": [ # The list of labels this Post was tagged with.
"A String",
],
"customMetaData": "A String", # The JSON meta-data for the Post.
"kind": "A String", # The kind of this entity. Always blogger#post.
"content": "A String", # The content of the Post. May contain HTML markup.
"url": "A String", # The URL where this Post is displayed.
"etag": "A String", # Etag of the resource.
"location": { # The location for geotagged posts.
"lat": 3.14, # Location's latitude.
"lng": 3.14, # Location's longitude.
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
"name": "A String", # Location name.
},
"published": "A String", # RFC 3339 date-time when this Post was published.
"images": [ # Display image for the Post.
{
"url": "A String",
},
],
"id": "A String", # The identifier of this Post.
"selfLink": "A String", # The API REST URL to fetch this resource from.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
publish: boolean, A parameter
fetchImages: boolean, A parameter
revert: boolean, A parameter
fetchBody: boolean, A parameter
maxComments: integer, A parameter
Returns:
An object of the form:
{
"status": "A String", # Status of the post. Only set for admin-level requests.
"blog": { # Data about the blog containing this Post.
"id": "A String", # The identifier of the Blog that contains this Post.
},
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
"titleLink": "A String", # The title link URL, similar to atom's related link.
"author": { # The author of this Post.
"url": "A String", # The URL of the creator's Profile page.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
},
"title": "A String", # The title of the Post.
"replies": { # The container of comments on this Post.
"totalItems": "A String", # The count of comments on this post.
"items": [ # The List of Comments for this Post.
{
"status": "A String", # The status of the comment (only populated for admin users).
"inReplyTo": { # Data about the comment this is in reply to.
"id": "A String", # The identified of the parent of this comment.
},
"kind": "A String", # The kind of this entry. Always blogger#comment.
"author": { # The author of this Comment.
"url": "A String", # The URL of the creator's Profile page.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
},
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
"blog": { # Data about the blog containing this comment.
"id": "A String", # The identifier of the blog containing this comment.
},
"published": "A String", # RFC 3339 date-time when this comment was published.
"post": { # Data about the post containing this comment.
"id": "A String", # The identifier of the post containing this comment.
},
"content": "A String", # The actual content of the comment. May include HTML markup.
"id": "A String", # The identifier for this resource.
"selfLink": "A String", # The API REST URL to fetch this resource from.
},
],
"selfLink": "A String", # The URL of the comments on this post.
},
"readerComments": "A String", # Comment control and display setting for readers of this post.
"labels": [ # The list of labels this Post was tagged with.
"A String",
],
"customMetaData": "A String", # The JSON meta-data for the Post.
"kind": "A String", # The kind of this entity. Always blogger#post.
"content": "A String", # The content of the Post. May contain HTML markup.
"url": "A String", # The URL where this Post is displayed.
"etag": "A String", # Etag of the resource.
"location": { # The location for geotagged posts.
"lat": 3.14, # Location's latitude.
"lng": 3.14, # Location's longitude.
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
"name": "A String", # Location name.
},
"published": "A String", # RFC 3339 date-time when this Post was published.
"images": [ # Display image for the Post.
{
"url": "A String",
},
],
"id": "A String", # The identifier of this Post.
"selfLink": "A String", # The API REST URL to fetch this resource from.
}</pre>
</div>
<div class="method">
<code class="details" id="publish">publish(blogId, postId, publishDate=None, x__xgafv=None)</code>
<pre>Publishes a post.
Args:
blogId: string, A parameter (required)
postId: string, A parameter (required)
publishDate: string, A parameter
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"status": "A String", # Status of the post. Only set for admin-level requests.
"blog": { # Data about the blog containing this Post.
"id": "A String", # The identifier of the Blog that contains this Post.
},
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
"titleLink": "A String", # The title link URL, similar to atom's related link.
"author": { # The author of this Post.
"url": "A String", # The URL of the creator's Profile page.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
},
"title": "A String", # The title of the Post.
"replies": { # The container of comments on this Post.
"totalItems": "A String", # The count of comments on this post.
"items": [ # The List of Comments for this Post.
{
"status": "A String", # The status of the comment (only populated for admin users).
"inReplyTo": { # Data about the comment this is in reply to.
"id": "A String", # The identified of the parent of this comment.
},
"kind": "A String", # The kind of this entry. Always blogger#comment.
"author": { # The author of this Comment.
"url": "A String", # The URL of the creator's Profile page.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
},
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
"blog": { # Data about the blog containing this comment.
"id": "A String", # The identifier of the blog containing this comment.
},
"published": "A String", # RFC 3339 date-time when this comment was published.
"post": { # Data about the post containing this comment.
"id": "A String", # The identifier of the post containing this comment.
},
"content": "A String", # The actual content of the comment. May include HTML markup.
"id": "A String", # The identifier for this resource.
"selfLink": "A String", # The API REST URL to fetch this resource from.
},
],
"selfLink": "A String", # The URL of the comments on this post.
},
"readerComments": "A String", # Comment control and display setting for readers of this post.
"labels": [ # The list of labels this Post was tagged with.
"A String",
],
"customMetaData": "A String", # The JSON meta-data for the Post.
"kind": "A String", # The kind of this entity. Always blogger#post.
"content": "A String", # The content of the Post. May contain HTML markup.
"url": "A String", # The URL where this Post is displayed.
"etag": "A String", # Etag of the resource.
"location": { # The location for geotagged posts.
"lat": 3.14, # Location's latitude.
"lng": 3.14, # Location's longitude.
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
"name": "A String", # Location name.
},
"published": "A String", # RFC 3339 date-time when this Post was published.
"images": [ # Display image for the Post.
{
"url": "A String",
},
],
"id": "A String", # The identifier of this Post.
"selfLink": "A String", # The API REST URL to fetch this resource from.
}</pre>
</div>
<div class="method">
<code class="details" id="revert">revert(blogId, postId, x__xgafv=None)</code>
<pre>Reverts a published or scheduled post to draft state.
Args:
blogId: string, A parameter (required)
postId: 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:
{
"status": "A String", # Status of the post. Only set for admin-level requests.
"blog": { # Data about the blog containing this Post.
"id": "A String", # The identifier of the Blog that contains this Post.
},
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
"titleLink": "A String", # The title link URL, similar to atom's related link.
"author": { # The author of this Post.
"url": "A String", # The URL of the creator's Profile page.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
},
"title": "A String", # The title of the Post.
"replies": { # The container of comments on this Post.
"totalItems": "A String", # The count of comments on this post.
"items": [ # The List of Comments for this Post.
{
"status": "A String", # The status of the comment (only populated for admin users).
"inReplyTo": { # Data about the comment this is in reply to.
"id": "A String", # The identified of the parent of this comment.
},
"kind": "A String", # The kind of this entry. Always blogger#comment.
"author": { # The author of this Comment.
"url": "A String", # The URL of the creator's Profile page.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
},
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
"blog": { # Data about the blog containing this comment.
"id": "A String", # The identifier of the blog containing this comment.
},
"published": "A String", # RFC 3339 date-time when this comment was published.
"post": { # Data about the post containing this comment.
"id": "A String", # The identifier of the post containing this comment.
},
"content": "A String", # The actual content of the comment. May include HTML markup.
"id": "A String", # The identifier for this resource.
"selfLink": "A String", # The API REST URL to fetch this resource from.
},
],
"selfLink": "A String", # The URL of the comments on this post.
},
"readerComments": "A String", # Comment control and display setting for readers of this post.
"labels": [ # The list of labels this Post was tagged with.
"A String",
],
"customMetaData": "A String", # The JSON meta-data for the Post.
"kind": "A String", # The kind of this entity. Always blogger#post.
"content": "A String", # The content of the Post. May contain HTML markup.
"url": "A String", # The URL where this Post is displayed.
"etag": "A String", # Etag of the resource.
"location": { # The location for geotagged posts.
"lat": 3.14, # Location's latitude.
"lng": 3.14, # Location's longitude.
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
"name": "A String", # Location name.
},
"published": "A String", # RFC 3339 date-time when this Post was published.
"images": [ # Display image for the Post.
{
"url": "A String",
},
],
"id": "A String", # The identifier of this Post.
"selfLink": "A String", # The API REST URL to fetch this resource from.
}</pre>
</div>
<div class="method">
<code class="details" id="search">search(blogId, q, orderBy=None, x__xgafv=None, fetchBodies=None)</code>
<pre>Searches for posts matching given query terms in the specified blog.
Args:
blogId: string, A parameter (required)
q: string, A parameter (required)
orderBy: string, A parameter
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
fetchBodies: boolean, A parameter
Returns:
An object of the form:
{
"nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
"items": [ # The list of Posts for this Blog.
{
"status": "A String", # Status of the post. Only set for admin-level requests.
"blog": { # Data about the blog containing this Post.
"id": "A String", # The identifier of the Blog that contains this Post.
},
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
"titleLink": "A String", # The title link URL, similar to atom's related link.
"author": { # The author of this Post.
"url": "A String", # The URL of the creator's Profile page.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
},
"title": "A String", # The title of the Post.
"replies": { # The container of comments on this Post.
"totalItems": "A String", # The count of comments on this post.
"items": [ # The List of Comments for this Post.
{
"status": "A String", # The status of the comment (only populated for admin users).
"inReplyTo": { # Data about the comment this is in reply to.
"id": "A String", # The identified of the parent of this comment.
},
"kind": "A String", # The kind of this entry. Always blogger#comment.
"author": { # The author of this Comment.
"url": "A String", # The URL of the creator's Profile page.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
},
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
"blog": { # Data about the blog containing this comment.
"id": "A String", # The identifier of the blog containing this comment.
},
"published": "A String", # RFC 3339 date-time when this comment was published.
"post": { # Data about the post containing this comment.
"id": "A String", # The identifier of the post containing this comment.
},
"content": "A String", # The actual content of the comment. May include HTML markup.
"id": "A String", # The identifier for this resource.
"selfLink": "A String", # The API REST URL to fetch this resource from.
},
],
"selfLink": "A String", # The URL of the comments on this post.
},
"readerComments": "A String", # Comment control and display setting for readers of this post.
"labels": [ # The list of labels this Post was tagged with.
"A String",
],
"customMetaData": "A String", # The JSON meta-data for the Post.
"kind": "A String", # The kind of this entity. Always blogger#post.
"content": "A String", # The content of the Post. May contain HTML markup.
"url": "A String", # The URL where this Post is displayed.
"etag": "A String", # Etag of the resource.
"location": { # The location for geotagged posts.
"lat": 3.14, # Location's latitude.
"lng": 3.14, # Location's longitude.
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
"name": "A String", # Location name.
},
"published": "A String", # RFC 3339 date-time when this Post was published.
"images": [ # Display image for the Post.
{
"url": "A String",
},
],
"id": "A String", # The identifier of this Post.
"selfLink": "A String", # The API REST URL to fetch this resource from.
},
],
"kind": "A String", # The kind of this entity. Always blogger#postList.
"etag": "A String", # Etag of the response.
"prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(blogId, postId, body=None, x__xgafv=None, publish=None, fetchImages=None, revert=None, fetchBody=None, maxComments=None)</code>
<pre>Updates a post by blog id and post id.
Args:
blogId: string, A parameter (required)
postId: string, A parameter (required)
body: object, The request body.
The object takes the form of:
{
"status": "A String", # Status of the post. Only set for admin-level requests.
"blog": { # Data about the blog containing this Post.
"id": "A String", # The identifier of the Blog that contains this Post.
},
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
"titleLink": "A String", # The title link URL, similar to atom's related link.
"author": { # The author of this Post.
"url": "A String", # The URL of the creator's Profile page.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
},
"title": "A String", # The title of the Post.
"replies": { # The container of comments on this Post.
"totalItems": "A String", # The count of comments on this post.
"items": [ # The List of Comments for this Post.
{
"status": "A String", # The status of the comment (only populated for admin users).
"inReplyTo": { # Data about the comment this is in reply to.
"id": "A String", # The identified of the parent of this comment.
},
"kind": "A String", # The kind of this entry. Always blogger#comment.
"author": { # The author of this Comment.
"url": "A String", # The URL of the creator's Profile page.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
},
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
"blog": { # Data about the blog containing this comment.
"id": "A String", # The identifier of the blog containing this comment.
},
"published": "A String", # RFC 3339 date-time when this comment was published.
"post": { # Data about the post containing this comment.
"id": "A String", # The identifier of the post containing this comment.
},
"content": "A String", # The actual content of the comment. May include HTML markup.
"id": "A String", # The identifier for this resource.
"selfLink": "A String", # The API REST URL to fetch this resource from.
},
],
"selfLink": "A String", # The URL of the comments on this post.
},
"readerComments": "A String", # Comment control and display setting for readers of this post.
"labels": [ # The list of labels this Post was tagged with.
"A String",
],
"customMetaData": "A String", # The JSON meta-data for the Post.
"kind": "A String", # The kind of this entity. Always blogger#post.
"content": "A String", # The content of the Post. May contain HTML markup.
"url": "A String", # The URL where this Post is displayed.
"etag": "A String", # Etag of the resource.
"location": { # The location for geotagged posts.
"lat": 3.14, # Location's latitude.
"lng": 3.14, # Location's longitude.
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
"name": "A String", # Location name.
},
"published": "A String", # RFC 3339 date-time when this Post was published.
"images": [ # Display image for the Post.
{
"url": "A String",
},
],
"id": "A String", # The identifier of this Post.
"selfLink": "A String", # The API REST URL to fetch this resource from.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
publish: boolean, A parameter
fetchImages: boolean, A parameter
revert: boolean, A parameter
fetchBody: boolean, A parameter
maxComments: integer, A parameter
Returns:
An object of the form:
{
"status": "A String", # Status of the post. Only set for admin-level requests.
"blog": { # Data about the blog containing this Post.
"id": "A String", # The identifier of the Blog that contains this Post.
},
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
"titleLink": "A String", # The title link URL, similar to atom's related link.
"author": { # The author of this Post.
"url": "A String", # The URL of the creator's Profile page.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
},
"title": "A String", # The title of the Post.
"replies": { # The container of comments on this Post.
"totalItems": "A String", # The count of comments on this post.
"items": [ # The List of Comments for this Post.
{
"status": "A String", # The status of the comment (only populated for admin users).
"inReplyTo": { # Data about the comment this is in reply to.
"id": "A String", # The identified of the parent of this comment.
},
"kind": "A String", # The kind of this entry. Always blogger#comment.
"author": { # The author of this Comment.
"url": "A String", # The URL of the creator's Profile page.
"image": { # The creator's avatar.
"url": "A String", # The creator's avatar URL.
},
"displayName": "A String", # The display name.
"id": "A String", # The identifier of the creator.
},
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
"blog": { # Data about the blog containing this comment.
"id": "A String", # The identifier of the blog containing this comment.
},
"published": "A String", # RFC 3339 date-time when this comment was published.
"post": { # Data about the post containing this comment.
"id": "A String", # The identifier of the post containing this comment.
},
"content": "A String", # The actual content of the comment. May include HTML markup.
"id": "A String", # The identifier for this resource.
"selfLink": "A String", # The API REST URL to fetch this resource from.
},
],
"selfLink": "A String", # The URL of the comments on this post.
},
"readerComments": "A String", # Comment control and display setting for readers of this post.
"labels": [ # The list of labels this Post was tagged with.
"A String",
],
"customMetaData": "A String", # The JSON meta-data for the Post.
"kind": "A String", # The kind of this entity. Always blogger#post.
"content": "A String", # The content of the Post. May contain HTML markup.
"url": "A String", # The URL where this Post is displayed.
"etag": "A String", # Etag of the resource.
"location": { # The location for geotagged posts.
"lat": 3.14, # Location's latitude.
"lng": 3.14, # Location's longitude.
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
"name": "A String", # Location name.
},
"published": "A String", # RFC 3339 date-time when this Post was published.
"images": [ # Display image for the Post.
{
"url": "A String",
},
],
"id": "A String", # The identifier of this Post.
"selfLink": "A String", # The API REST URL to fetch this resource from.
}</pre>
</div>
</body></html>