返回与 API 请求参数匹配的注释列表。
对配额的影响:调用此方法的配额费用为 1 个单位。
常见使用场景
请求
HTTP 请求
GET https://www.googleapis.com/youtube/v3/comments
参数
下表列出了此查询支持的参数。列出的所有参数都是查询参数。
参数 | ||
---|---|---|
必需参数 | ||
part |
string part 参数指定一个逗号分隔列表,其中包含 API 响应将包含的一个或多个 comment 资源属性。以下列表包含您可以包含在参数值中的 part 名称:
|
|
过滤条件(请仅指定以下参数之一) | ||
id |
string id 参数指定要检索的资源的评论 ID 列表(以英文逗号分隔)。在 comment 资源中,id 属性用于指定评论的 ID。 |
|
parentId |
string parentId 参数指定应检索其回复的评论的 ID。注意:YouTube 目前仅支持回复顶级评论。不过,我们以后可能会支持回复回复功能。 |
|
可选参数 | ||
maxResults |
unsigned integer maxResults 参数指定结果集中应返回的最大项数。注意:此参数不能与 id 参数结合使用。可接受的值包括1 到100 (含 0 和 10000)。默认值为 20 。 |
|
pageToken |
string pageToken 参数用于标识结果集中应返回的特定网页。在 API 响应中,nextPageToken 属性用于标识可检索到的结果的下一页。注意:不支持将此参数与 id 参数结合使用。 |
|
textFormat |
string 此参数指示 API 应返回 HTML 格式的注释还是纯文本格式的注释。默认值为 html 。可接受的值包括:
|
请求正文
调用此方法时,请勿提供请求正文。
响应
如果成功,此方法将返回采用以下结构的响应正文:
{
"kind": "youtube#commentListResponse",
"etag":etag ,
"nextPageToken":string ,
"pageInfo": {
"totalResults":integer ,
"resultsPerPage":integer
},
"items": [
comment Resource
]
}
属性
下表定义了此资源中显示的属性:
属性 | |
---|---|
kind |
string 标识 API 资源的类型。其值为 youtube#commentListResponse 。 |
etag |
etag 此资源的 Etag。 |
nextPageToken |
string 可用作 pageToken 参数值的令牌,用于检索结果集中的下一页。 |
pageInfo |
object pageInfo 对象可封装结果集的分页信息。 |
pageInfo.totalResults |
integer 结果集中的结果总数。 |
pageInfo.resultsPerPage |
integer API 响应中包含的结果数量。 |
items[] |
list 符合请求条件的评论列表。 |
错误
下表列出了 API 在响应对此方法的调用时可能会返回的错误消息。如需了解详情,请参阅错误消息文档。