Returns a list of comments that match the API request parameters.
Quota impact: A call to this method has a quota cost of 1 unit.
Insert or delete comments that appear in a document margin. Bubbles in the margin indicate where someone has left a comment. Practice with comments and other collaboration features in Word by downloading this Collaborate in Word learning guide. Because even famous people love famous people.
Common use cases
Request
HTTP request
Parameters
The following table lists the parameters that this query supports. All of the parameters listed are query parameters.
Parameters | ||
---|---|---|
Required parameters | ||
part | string The part parameter specifies a comma-separated list of one or more comment resource properties that the API response will include.The following list contains the part names that you can include in the parameter value:
| |
Filters (specify exactly one of the following parameters) | ||
id | string The id parameter specifies a comma-separated list of comment IDs for the resources that are being retrieved. In a comment resource, the id property specifies the comment's ID. | |
parentId | string The parentId parameter specifies the ID of the comment for which replies should be retrieved. Note: YouTube currently supports replies only for top-level comments. However, replies to replies may be supported in the future. | |
Optional parameters | ||
maxResults | unsigned integer The maxResults parameter specifies the maximum number of items that should be returned in the result set.Note: This parameter is not supported for use in conjunction with the id parameter. Acceptable values are 1 to 100 , inclusive. The default value is 20 . | |
pageToken | string The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page of the result that can be retrieved.Note: This parameter is not supported for use in conjunction with the id parameter. | |
textFormat | string This parameter indicates whether the API should return comments formatted as HTML or as plain text. The default value is html .Acceptable values are:
|
Request body
Do not provide a request body when calling this method.
Response
If successful, this method returns a response body with the following structure:
Properties
The following table defines the properties that appear in this resource:
Properties | |
---|---|
kind | string Identifies the API resource's type. The value will be youtube#commentListResponse . |
etag | etag The Etag of this resource. |
nextPageToken | string The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. |
pageInfo | object The pageInfo object encapsulates paging information for the result set. |
pageInfo.totalResults | integer The total number of results in the result set. |
pageInfo.resultsPerPage | integer The number of results included in the API response. |
items[] | list A list of comments that match the request criteria. |
Errors
The following table identifies error messages that the API could return in response to a call to this method. Please see the error message documentation for more detail.
Error type | Error detail | Description |
---|---|---|
badRequest (400) | operationNotSupported | The id filter is only compatible with comments based on Google+. |
forbidden (403) | forbidden | One or more of the requested comments cannot be retrieved due to insufficient permissions. The request might not be properly authorized. |
notFound (404) | commentNotFound | One or more of the specified comments cannot be found. Check the values of the request's id and parentId parameters to ensure that they are correct. |
Try it!
Use the APIs Explorer to call this API and see the API request and response.
A reader asks about these three words:
I was wondering about the differences between comment, suggestion, and feedback. They often seem to be used interchangeably. I would like to know how to use each word appropriately in different contexts.
Here are the relevant definitions of these words in the context of social media:
commentnoun: a remark or criticism on or upon anything.
suggestionnoun: an idea or thought suggested, a proposal.
feedbacknoun: information about the result of a process, experiment, etc.
The word comment has the broadest application because a comment can contain a suggestion or provide feedback.
The comments that follow the posts on this site provide examples of all three terms.
Comment
Carnival – The word derives from a phrase meaning “the putting away of flesh”… as in the fasting from meat as Christians [according to traditional dogma] are supposed to do during Lent. It became an event of feasting and revelry because it’s the last chance for the next 6 weeks to indulge in that delicious pot roast, steak dinner, or other self-gratifications.
The reader has added information relating to a post about words derived from a Latin word meaning flesh. This kind of comment enriches the site by expanding the post in a relevant manner.
Suggestion
Could you also clarify and explain the origins of “chalk it up”. I’ve also seen “chock it up” which I assume is an error. I’ve also heard “chop it up” in the same context.
This reader, in commenting on the post about chock-full, has made a suggestion for a future post. Such suggestions keep me supplied with topics.
Feedback
I think your spelling of “cockeyeed” is incorrect. I think it is spelled cockeyed. (minus one “e”)
Feedback can be positive or negative. Comments that express agreement or appreciation let writers know they’re on the right track with their intended audience. Comments that point out errors or ambiguity enable the writer to improve a published post.
NOTE: I like to receive feedback that points out typographical errors by way of email, rather than in the open comments section—and not just to minimize my embarrassment. When the error has been corrected in the post, the comment remains as a distraction to future readers.
The figurative use of feedback derives from a technical term relating to electronics:
feedbacknoun: The return of a fraction of the output signal from one stage of a circuit, amplifier, etc., to the input of the same or a preceding stage, “positive feedback” tending to increase the amplification; “negative feedback” tending to decrease the amplification. Also, a signal so returned.
I’ll take this opportunity to thank my readers for all three—comments, suggestions, and feedback. They are and have been of tremendous benefit to me, as a blogger and as a student of English.
Comment And Graphic Sites
Related post:
Comment Etiquette
Want to improve your English in five minutes a day? Get a subscription and start receiving our writing tips and exercises daily!
Keep learning! Browse the Vocabulary category, check our popular posts, or choose a related post below:
Comments Synonyms
Stop making those embarrassing mistakes! Subscribe to Daily Writing Tips today!
Report Card Comments
- You will improve your English in only 5 minutes per day, guaranteed!
- Subscribers get access to our archives with 800+ interactive exercises!
- You'll also get three bonus ebooks completely free!