此页面由 Cloud Translation API 翻译。

CommentThreads: list

返回与 API 请求参数匹配的评论线程列表。

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

常见使用场景

请求

HTTP 请求

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

参数

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

参数
必需参数
`part`	`string` `part` 参数指定一个逗号分隔列表，其中包含 API 响应将包含的一个或多个 `commentThread` 资源属性。以下列表包含您可以包含在参数值中的 `part` 名称： `id` `replies` `snippet`
过滤条件（请仅指定以下参数之一）
`allThreadsRelatedToChannelId`	`string` `allThreadsRelatedToChannelId` 参数指示 API 返回与指定频道关联的所有评论会话。
`id`	`string` `id` 参数用于为应检索的资源指定评论会话 ID 列表（以英文逗号分隔）。
`videoId`	`string` `videoId` 参数指示 API 返回与指定视频 ID 相关联的评论会话。
可选参数
`maxResults`	`unsigned integer` `maxResults` 参数指定结果集中应返回的最大项数。注意：此参数不能与 `id` 参数结合使用。可接受的值包括`1`到`100`（含 0 和 10000）。默认值为 `20`。
`moderationStatus`	`string` 此参数只能在正确授权的请求中使用。设置此参数可将返回的评论会话串限制为特定的审核状态。注意：不支持将此参数与 `id` 参数结合使用。默认值为 `published`。可接受的值包括： `heldForReview` - 检索正在等待管理员审核的评论会话。如果顶级评论或对该评论的至少一个回复正在等待审核，该评论会话会包含在回复中。 `likelySpam` - 检索被归类为疑似垃圾内容的评论会话。如果顶级评论或对该评论的至少一个回复被认为可能是垃圾留言，该评论会话就会被添加到该回复中。 `published` - 检索已发布评论的会话串。此设置为默认值。如果评论会话的顶级评论已发布，则可将其添加到回复中。
`order`	`string` `order` 参数指定 API 响应列出评论线程的顺序。有效值包括： `time` - 评论会话会按时间排序。这是默认行为。 `relevance` - 评论会话按相关性排序。注意：不支持将此参数与 `id` 参数结合使用。
`pageToken`	`string` `pageToken` 参数用于标识结果集中应返回的特定网页。在 API 响应中，`nextPageToken` 属性用于标识可检索到的结果的下一页。注意：不支持将此参数与 `id` 参数结合使用。
`searchTerms`	`string` `searchTerms` 参数用于指示 API 将 API 响应限制为仅包含包含指定搜索字词的评论。注意：此参数不能与 `id` 参数结合使用。
`textFormat`	`string` 将此参数的值设置为 `html` 或 `plainText`，以指示 API 以 HTML 格式或纯文本形式返回用户留下的评论。默认值为 `html`。可接受的值包括： `html` - 以 HTML 格式返回注释。这是默认值。 `plainText` - 以纯文本格式返回注释。

请求正文

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

响应

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

{
  "kind": "youtube#commentThreadListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    commentThread Resource
  ]
}

属性

下表定义了此资源中显示的属性：

属性
`kind`	`string` 标识 API 资源的类型。其值为 `youtube#commentThreadListResponse`。
`etag`	`etag` 此资源的 Etag。
`nextPageToken`	`string` 可用作 `pageToken` 参数值的令牌，用于检索结果集中的下一页。
`pageInfo`	`object` `pageInfo` 对象可封装结果集的分页信息。
`pageInfo.totalResults`	`integer` 结果集中的结果总数。
`pageInfo.resultsPerPage`	`integer` API 响应中包含的结果数量。
`items[]`	`list` 符合请求条件的评论会话列表。

错误

下表列出了 API 在响应对此方法的调用时可能会返回的错误消息。如需了解详情，请参阅错误消息文档。

错误类型	错误详情	说明
`badRequest (400)`	`operationNotSupported`	使用“`id`”过滤器只能基于 Google+ 发表的评论。
`badRequest (400)`	`processingFailure`	API 服务器未能成功处理请求。虽然这可能是暂时性错误，但通常表示请求的输入无效。检查请求正文中 `commentThread` 资源的结构，确保其有效。
`forbidden (403)`	`commentsDisabled`	由 `videoId` 参数标识的视频已停用评论功能。
`forbidden (403)`	`forbidden`	由于权限不足，无法检索所请求的一个或多个评论会话。请求可能未获得适当授权。
`notFound (404)`	`channelNotFound`	找不到由 `allThreadsRelatedToChannelId` 参数标识的频道。
`notFound (404)`	`commentThreadNotFound`	找不到指定的一个或多个评论会话。检查请求的 `id` 参数的值，确保其正确无误。
`notFound (404)`	`videoNotFound`	找不到由 `videoId` 参数标识的视频。

试试看！

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