Comments: list
Stay organized with collections
Save and categorize content based on your preferences.
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.
Common use cases
Request
HTTP request
GET https://www.googleapis.com/youtube/v3/comments
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:
html
– Returns the comments in HTML format. This is the default value.
plainText
– Returns the comments in plain text format.
|
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:
{
"kind": "youtube#commentListResponse",
"etag":
etag
,
"nextPageToken":
string
,
"pageInfo": {
"totalResults":
integer
,
"resultsPerPage":
integer
},
"items": [
comment Resource
]
}
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
|
Try it!
Use the
APIs Explorer
to call this API and see the API request and 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 2022-11-04 UTC.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"Missing the information I need"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"Too complicated / too many steps"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"Out of date"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"Samples / code issue"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]