You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
429 lines
17 KiB
429 lines
17 KiB
<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</a> . <a href="blogger_v3.comments.html">comments</a></h1>
|
|
<h2>Instance Methods</h2>
|
|
<p class="toc_element">
|
|
<code><a href="#approve">approve(blogId, postId, commentId)</a></code></p>
|
|
<p class="firstline">Marks a comment as not spam.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#delete">delete(blogId, postId, commentId)</a></code></p>
|
|
<p class="firstline">Delete a comment by ID.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#get">get(blogId, postId, commentId, view=None)</a></code></p>
|
|
<p class="firstline">Gets one comment by ID.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#list">list(blogId, postId, status=None, startDate=None, fetchBodies=None, endDate=None, pageToken=None, maxResults=None, view=None)</a></code></p>
|
|
<p class="firstline">Retrieves the comments for a post, possibly filtered.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#listByBlog">listByBlog(blogId, status=None, startDate=None, endDate=None, pageToken=None, maxResults=None, fetchBodies=None)</a></code></p>
|
|
<p class="firstline">Retrieves the comments for a blog, across all posts, possibly filtered.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#listByBlog_next">listByBlog_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="#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="#markAsSpam">markAsSpam(blogId, postId, commentId)</a></code></p>
|
|
<p class="firstline">Marks a comment as spam.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#removeContent">removeContent(blogId, postId, commentId)</a></code></p>
|
|
<p class="firstline">Removes the content of a comment.</p>
|
|
<h3>Method Details</h3>
|
|
<div class="method">
|
|
<code class="details" id="approve">approve(blogId, postId, commentId)</code>
|
|
<pre>Marks a comment as not spam.
|
|
|
|
Args:
|
|
blogId: string, The ID of the Blog. (required)
|
|
postId: string, The ID of the Post. (required)
|
|
commentId: string, The ID of the comment to mark as not spam. (required)
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{
|
|
"status": "A String", # The status of the comment (only populated for admin users)
|
|
"content": "A String", # The actual content of the comment. May include HTML markup.
|
|
"kind": "blogger#comment", # The kind of this entry. Always blogger#comment
|
|
"inReplyTo": { # Data about the comment this is in reply to.
|
|
"id": "A String", # The identified of the parent of this comment.
|
|
},
|
|
"author": { # The author of this Comment.
|
|
"url": "A String", # The URL of the Comment creator's Profile page.
|
|
"image": { # The comment creator's avatar.
|
|
"url": "A String", # The comment creator's avatar URL.
|
|
},
|
|
"displayName": "A String", # The display name.
|
|
"id": "A String", # The identifier of the Comment 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.
|
|
},
|
|
"id": "A String", # The identifier for this resource.
|
|
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="delete">delete(blogId, postId, commentId)</code>
|
|
<pre>Delete a comment by ID.
|
|
|
|
Args:
|
|
blogId: string, The ID of the Blog. (required)
|
|
postId: string, The ID of the Post. (required)
|
|
commentId: string, The ID of the comment to delete. (required)
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="get">get(blogId, postId, commentId, view=None)</code>
|
|
<pre>Gets one comment by ID.
|
|
|
|
Args:
|
|
blogId: string, ID of the blog to containing the comment. (required)
|
|
postId: string, ID of the post to fetch posts from. (required)
|
|
commentId: string, The ID of the comment to get. (required)
|
|
view: string, Access level for the requested comment (default: READER). Note that some comments will require elevated permissions, for example comments where the parent posts which is in a draft state, or comments that are pending moderation.
|
|
Allowed values
|
|
ADMIN - Admin level detail
|
|
AUTHOR - Author level detail
|
|
READER - Admin level detail
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{
|
|
"status": "A String", # The status of the comment (only populated for admin users)
|
|
"content": "A String", # The actual content of the comment. May include HTML markup.
|
|
"kind": "blogger#comment", # The kind of this entry. Always blogger#comment
|
|
"inReplyTo": { # Data about the comment this is in reply to.
|
|
"id": "A String", # The identified of the parent of this comment.
|
|
},
|
|
"author": { # The author of this Comment.
|
|
"url": "A String", # The URL of the Comment creator's Profile page.
|
|
"image": { # The comment creator's avatar.
|
|
"url": "A String", # The comment creator's avatar URL.
|
|
},
|
|
"displayName": "A String", # The display name.
|
|
"id": "A String", # The identifier of the Comment 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.
|
|
},
|
|
"id": "A String", # The identifier for this resource.
|
|
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="list">list(blogId, postId, status=None, startDate=None, fetchBodies=None, endDate=None, pageToken=None, maxResults=None, view=None)</code>
|
|
<pre>Retrieves the comments for a post, possibly filtered.
|
|
|
|
Args:
|
|
blogId: string, ID of the blog to fetch comments from. (required)
|
|
postId: string, ID of the post to fetch posts from. (required)
|
|
status: string, A parameter (repeated)
|
|
Allowed values
|
|
emptied - Comments that have had their content removed
|
|
live - Comments that are publicly visible
|
|
pending - Comments that are awaiting administrator approval
|
|
spam - Comments marked as spam by the administrator
|
|
startDate: string, Earliest date of comment to fetch, a date-time with RFC 3339 formatting.
|
|
fetchBodies: boolean, Whether the body content of the comments is included.
|
|
endDate: string, Latest date of comment to fetch, a date-time with RFC 3339 formatting.
|
|
pageToken: string, Continuation token if request is paged.
|
|
maxResults: integer, Maximum number of comments to include in the result.
|
|
view: string, Access level with which to view the returned result. Note that some fields require elevated access.
|
|
Allowed values
|
|
ADMIN - Admin level detail
|
|
AUTHOR - Author level detail
|
|
READER - Reader level detail
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{
|
|
"nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
|
|
"items": [ # The List of Comments for a Post.
|
|
{
|
|
"status": "A String", # The status of the comment (only populated for admin users)
|
|
"content": "A String", # The actual content of the comment. May include HTML markup.
|
|
"kind": "blogger#comment", # The kind of this entry. Always blogger#comment
|
|
"inReplyTo": { # Data about the comment this is in reply to.
|
|
"id": "A String", # The identified of the parent of this comment.
|
|
},
|
|
"author": { # The author of this Comment.
|
|
"url": "A String", # The URL of the Comment creator's Profile page.
|
|
"image": { # The comment creator's avatar.
|
|
"url": "A String", # The comment creator's avatar URL.
|
|
},
|
|
"displayName": "A String", # The display name.
|
|
"id": "A String", # The identifier of the Comment 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.
|
|
},
|
|
"id": "A String", # The identifier for this resource.
|
|
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
|
},
|
|
],
|
|
"kind": "blogger#commentList", # The kind of this entry. Always blogger#commentList
|
|
"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="listByBlog">listByBlog(blogId, status=None, startDate=None, endDate=None, pageToken=None, maxResults=None, fetchBodies=None)</code>
|
|
<pre>Retrieves the comments for a blog, across all posts, possibly filtered.
|
|
|
|
Args:
|
|
blogId: string, ID of the blog to fetch comments from. (required)
|
|
status: string, A parameter (repeated)
|
|
Allowed values
|
|
emptied - Comments that have had their content removed
|
|
live - Comments that are publicly visible
|
|
pending - Comments that are awaiting administrator approval
|
|
spam - Comments marked as spam by the administrator
|
|
startDate: string, Earliest date of comment to fetch, a date-time with RFC 3339 formatting.
|
|
endDate: string, Latest date of comment to fetch, a date-time with RFC 3339 formatting.
|
|
pageToken: string, Continuation token if request is paged.
|
|
maxResults: integer, Maximum number of comments to include in the result.
|
|
fetchBodies: boolean, Whether the body content of the comments is included.
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{
|
|
"nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
|
|
"items": [ # The List of Comments for a Post.
|
|
{
|
|
"status": "A String", # The status of the comment (only populated for admin users)
|
|
"content": "A String", # The actual content of the comment. May include HTML markup.
|
|
"kind": "blogger#comment", # The kind of this entry. Always blogger#comment
|
|
"inReplyTo": { # Data about the comment this is in reply to.
|
|
"id": "A String", # The identified of the parent of this comment.
|
|
},
|
|
"author": { # The author of this Comment.
|
|
"url": "A String", # The URL of the Comment creator's Profile page.
|
|
"image": { # The comment creator's avatar.
|
|
"url": "A String", # The comment creator's avatar URL.
|
|
},
|
|
"displayName": "A String", # The display name.
|
|
"id": "A String", # The identifier of the Comment 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.
|
|
},
|
|
"id": "A String", # The identifier for this resource.
|
|
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
|
},
|
|
],
|
|
"kind": "blogger#commentList", # The kind of this entry. Always blogger#commentList
|
|
"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="listByBlog_next">listByBlog_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="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="markAsSpam">markAsSpam(blogId, postId, commentId)</code>
|
|
<pre>Marks a comment as spam.
|
|
|
|
Args:
|
|
blogId: string, The ID of the Blog. (required)
|
|
postId: string, The ID of the Post. (required)
|
|
commentId: string, The ID of the comment to mark as spam. (required)
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{
|
|
"status": "A String", # The status of the comment (only populated for admin users)
|
|
"content": "A String", # The actual content of the comment. May include HTML markup.
|
|
"kind": "blogger#comment", # The kind of this entry. Always blogger#comment
|
|
"inReplyTo": { # Data about the comment this is in reply to.
|
|
"id": "A String", # The identified of the parent of this comment.
|
|
},
|
|
"author": { # The author of this Comment.
|
|
"url": "A String", # The URL of the Comment creator's Profile page.
|
|
"image": { # The comment creator's avatar.
|
|
"url": "A String", # The comment creator's avatar URL.
|
|
},
|
|
"displayName": "A String", # The display name.
|
|
"id": "A String", # The identifier of the Comment 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.
|
|
},
|
|
"id": "A String", # The identifier for this resource.
|
|
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="removeContent">removeContent(blogId, postId, commentId)</code>
|
|
<pre>Removes the content of a comment.
|
|
|
|
Args:
|
|
blogId: string, The ID of the Blog. (required)
|
|
postId: string, The ID of the Post. (required)
|
|
commentId: string, The ID of the comment to delete content from. (required)
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{
|
|
"status": "A String", # The status of the comment (only populated for admin users)
|
|
"content": "A String", # The actual content of the comment. May include HTML markup.
|
|
"kind": "blogger#comment", # The kind of this entry. Always blogger#comment
|
|
"inReplyTo": { # Data about the comment this is in reply to.
|
|
"id": "A String", # The identified of the parent of this comment.
|
|
},
|
|
"author": { # The author of this Comment.
|
|
"url": "A String", # The URL of the Comment creator's Profile page.
|
|
"image": { # The comment creator's avatar.
|
|
"url": "A String", # The comment creator's avatar URL.
|
|
},
|
|
"displayName": "A String", # The display name.
|
|
"id": "A String", # The identifier of the Comment 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.
|
|
},
|
|
"id": "A String", # The identifier for this resource.
|
|
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
|
}</pre>
|
|
</div>
|
|
|
|
</body></html> |