Comments: list

返回与 API 请求参数匹配的注释列表。

配额影响:调用此方法的配额费用为 1 个单位。

常见使用场景

请求

HTTP 请求

GET https://www.googleapis.com/youtube/v3/comments

参数

下表列出了此查询支持的参数。列出的所有参数都是查询参数。

参数
必需参数
part string
part 参数用于指定 API 响应将包含的一个或多个 comment 资源属性的英文逗号分隔列表。

以下列表包含您可以在参数值中包含的 part 名称:
  • id
  • snippet
过滤器(请准确指定以下参数之一)
id string
id 参数指定要检索的资源的注释 ID 列表(以英文逗号分隔)。在 comment 资源中,id 属性用于指定评论的 ID。
parentId string
parentId 参数用于指定要检索回复的评论的 ID。

注意:YouTube 目前仅支持为顶级评论回复评论。不过,我们日后可能会支持回复。
可选参数
maxResults unsigned integer
maxResults 参数用于指定应在结果集中返回的项数上限。

注意:此参数不支持与 id 参数结合使用。可接受的值包括1100(含 0 和 5000)。默认值为 20
pageToken string
pageToken 参数用于标识结果集中应返回的特定网页。在 API 响应中,nextPageToken 属性用于标识可检索的结果的下一页。

注意:此参数不支持与 id 参数结合使用。
textFormat string
此参数用于指示 API 是应返回采用 HTML 格式还是纯文本格式的评论。默认值为 html

可接受的值为:
  • html - 以 HTML 格式返回注释。这是默认值。
  • plainText - 以纯文本格式返回注释。

请求正文

调用此方法时请勿提供请求正文。

响应

如果成功,此方法将返回采用以下结构的响应正文:

{
  "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 为响应对此方法的调用可能返回的错误消息。如需了解详情,请参阅错误消息文档。

错误类型 错误详情 说明
badRequest (400) operationNotSupported ID 过滤器仅适用于基于 Google+ 的评论。
forbidden (403) forbidden 由于权限不足,无法检索请求的一条或多条评论。该请求可能未正确授权。
notFound (404) commentNotFound 找不到指定的一条或多条评论。请检查请求的 idparentId 参数的值,以确保其正确无误。

试试看!

使用 APIs Explorer 调用此 API,并查看 API 请求和响应。