Comments: list
Stay organized with collections
Save and categorize content based on your preferences.
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
Parameter name |
Value |
Description |
Required parameters |
blogId |
string |
The ID of the blog to fetch comments from.
|
postId |
string |
The ID of the post to fetch comments from.
|
Optional parameters |
endDate |
datetime |
Latest date of comment to fetch, a date-time with RFC 3339 formatting.
|
fetchBodies |
boolean |
Whether the body content of the comments is included.
|
maxResults |
unsigned integer |
Maximum number of comments to include in the result.
|
pageToken |
string |
Continuation token if request is paged.
|
startDate |
datetime |
Earliest date of comment to fetch, a date-time with RFC 3339 formatting.
|
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-08 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-08-08 UTC."],[[["\u003cp\u003eRetrieves a list of comments for a specific blog post, requiring authorization only for private blogs.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering of comments by date, content inclusion, maximum results, and status (live, pending, spam, emptied).\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination to retrieve large sets of comments using \u003ccode\u003enextPageToken\u003c/code\u003e and \u003ccode\u003eprevPageToken\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eProvides response data including comment details, author information, and pagination tokens in JSON format.\u003c/p\u003e\n"],["\u003cp\u003eOffers code examples in Java for utilizing the API to fetch and display comments.\u003c/p\u003e\n"]]],[],null,["Retrieves the list of [comments](/blogger/docs/3.0/reference/comments) for a [post](/blogger/docs/3.0/reference/posts).\n[Try it now](#try-it) or [see an example](#examples).\n\n[Authorization](/blogger/docs/3.0/using#auth) 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.\n\nRequest\n\nHTTP request \n\n```\nGET https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId/comments\n```\n\nParameters\n\n| Parameter name | Value | Description |\n|----------------|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Required parameters** |||\n| `blogId` | `string` | The ID of the blog to fetch comments from. |\n| `postId` | `string` | The ID of the post to fetch comments from. |\n| **Optional parameters** |||\n| `endDate` | `datetime` | Latest date of comment to fetch, a date-time with RFC 3339 formatting. |\n| `fetchBodies` | `boolean` | Whether the body content of the comments is included. |\n| `maxResults` | `unsigned integer` | Maximum number of comments to include in the result. |\n| `pageToken` | `string` | Continuation token if request is paged. |\n| `startDate` | `datetime` | Earliest date of comment to fetch, a date-time with RFC 3339 formatting. |\n| `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 |\n| `view` | `string` | Acceptable values are: - \"`ADMIN`\": Admin level detail - \"`AUTHOR`\": Author level detail - \"`READER`\": Admin level detail |\n\nRequest body\n\nDo not supply a request body with this method.\n\nResponse\n\nIf successful, this method returns a response body with the following structure:\n\n```objective-c\n{\n \"kind\": \"blogger#commentList\",\n \"nextPageToken\": string,\n \"prevPageToken\": string,\n \"items\": [\n comments Resource\n ]\n}\n```\n\n| Property name | Value | Description | Notes |\n|-----------------|----------|-------------------------------------------------------------|-------|\n| `kind` | `string` | The kind of this entry. Always `blogger#commentList`. | |\n| `nextPageToken` | `string` | Pagination token to fetch the next page, if one exists. | |\n| `prevPageToken` | `string` | Pagination token to fetch the previous page, if one exists. | |\n| `items[]` | `list` | The list of comments resources for the specified post. | |\n\nExamples\n\n**Note:** The code examples available for this method do not represent all supported programming languages (see the [client libraries page](/blogger/docs/3.0/libraries) for a list of supported languages). \n\nJava\n\nUses the [Java client library](http://code.google.com/p/google-api-java-client/) \n\n```java\n// The BlogId for the http://buzz.blogger.com/ blog.\nString BUZZ_BLOG_ID = \"2399953\";\n\n// The PostId for a buzz post with comments.\nString BUZZ_POST_ID = \"5310628572012276714\";\n\n// Configure the Java API Client for Installed Native App\nHttpTransport HTTP_TRANSPORT = new NetHttpTransport();\nJsonFactory JSON_FACTORY = new JacksonFactory();\n\n// Configure the Installed App OAuth2 flow.\nCredential credential = OAuth2Native.authorize(HTTP_TRANSPORT,\n\tJSON_FACTORY, new LocalServerReceiver(),\n\tArrays.asList(BloggerScopes.BLOGGER));\n\n// Construct the Blogger API access facade object.\nBlogger blogger = Blogger.builder(HTTP_TRANSPORT, JSON_FACTORY)\n\t.setApplicationName(\"Blogger-CommentsList-Snippet/1.0\")\n\t.setHttpRequestInitializer(credential).build();\n\n// The request action.\nList commentsListAction = blogger.comments().list(BUZZ_BLOG_ID, BUZZ_POST_ID);\n\n// Restrict the result content to just the data we need.\ncommentsListAction.setFields(\"items(author/displayName,content),nextPageToken\");\n\n// This step sends the request to the server.\nCommentList comments = commentsListAction.execute();\n\n// Now we can navigate the response.\nwhile(comments.getItems() != null && !comments.getItems().isEmpty()){\n\tfor(Comment comment : comments.getItems()) {\n\t\tSystem.out.println(comment.getAuthor().getDisplayName()+\": \"+comment.getContent());\n\t}\n\n\t// Pagination logic\n\tString pageToken = comments.getNextPageToken();\n\tif(pageToken == null) {\n\t\tbreak;\n\t}\n\tSystem.out.println(\"-- Next page of comments\");\n\tcommentsListAction.setPageToken(pageToken);\n\tcomments = commentsListAction.execute();\n}\n```\n\nTry it!\n\n\nUse the APIs Explorer below to call this method on live data and see the response."]]