Page Summary
-
This method retrieves a list of comments for a specific post on a blog.
-
Authorization is required for private blogs, but not for public ones.
-
The request uses a GET method with required
blogIdandpostIdparameters and several optional parameters for filtering and pagination. -
The response includes a list of comment resources and tokens for pagination.
Retrieves the list of comments for a post . Try it now or see an example .
Authorization is required if the comments are on a blog that is private. If the comments are on a blog that is public, then this method can be called without authorization.
Request
HTTP request
GET https://www.googleapis.com/blogger/v3/blogs/ blogId /posts/ postId /comments
Parameters
blogId
string
postId
string
endDate
datetime
fetchBodies
boolean
maxResults
unsigned integer
pageToken
string
startDate
datetime
status
string
Acceptable values are:
- "
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
view
string
Acceptable values are:
- "
ADMIN": Admin level detail - "
AUTHOR": Author level detail - "
READER": Admin level detail
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response body with the following structure:
{ "kind" : "blogger#commentList" , "nextPageToken" : string , "prevPageToken" : string , "items" : [ comments Resource ] }
| Property name | Value | Description | Notes |
|---|---|---|---|
kind
|
string
|
The kind of this entry. Always blogger#commentList
. |
|
nextPageToken
|
string
|
Pagination token to fetch the next page, if one exists. | |
prevPageToken
|
string
|
Pagination token to fetch the previous page, if one exists. | |
items[]
|
list
|
The list of comments resources for the specified post. |
Examples
Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).
Java
Uses the Java client library
// The BlogId for the http://buzz.blogger.com/ blog .
String BUZZ_BLOG_ID = "2399953" ;
// The PostId for a buzz post with comments.
String BUZZ_POST_ID = "5310628572012276714" ;
// Configure the Java API Client for Installed Native App
HttpTransport HTTP_TRANSPORT = new NetHttpTransport();
JsonFactory JSON_FACTORY = new JacksonFactory();
// Configure the Installed App OAuth2 flow.
Credential credential = OAuth2Native.authorize(HTTP_TRANSPORT,
JSON_FACTORY, new LocalServerReceiver(),
Arrays.asList(BloggerScopes. BLOGGER ));
// Construct the Blogger API access facade object.
Blogger blogger = Blogger.builder(HTTP_TRANSPORT, JSON_FACTORY)
.setApplicationName( "Blogger-CommentsList-Snippet/1.0" )
.setHttpRequestInitializer(credential).build();
// The request action.
List commentsListAction = blogger.comments().list(BUZZ_BLOG_ID, BUZZ_POST_ID);
// Restrict the result content to just the data we need.
commentsListAction.setFields( "items(author/displayName,content),nextPageToken" );
// This step sends the request to the server.
CommentList comments = commentsListAction.execute();
// Now we can navigate the response.
while (comments.getItems() != null && !comments.getItems().isEmpty()){
for (Comment comment : comments.getItems()) {
System. out .println(comment.getAuthor().getDisplayName()+ ": " +comment.getContent());
}
// Pagination logic
String pageToken = comments.getNextPageToken();
if (pageToken == null ) {
break ;
}
System. out .println( "-- Next page of comments" );
commentsListAction.setPageToken(pageToken);
comments = commentsListAction.execute();
}
Try it!
Use the APIs Explorer below to call this method on live data and see the response.
