返回与 API 请求参数匹配的评论线程列表。
配额影响:调用此方法的配额费用为 1 个单位。
常见使用场景
请求
HTTP 请求
GET https://www.googleapis.com/youtube/v3/commentThreads
参数
下表列出了此查询支持的参数。列出的所有参数都是查询参数。
参数 | ||
---|---|---|
必需参数 | ||
part |
string part 参数用于指定 API 响应将包含的一个或多个 commentThread 资源属性的英文逗号分隔列表。以下列表包含您可以在参数值中包含的 part 名称:
|
|
过滤器(请准确指定以下参数之一) | ||
allThreadsRelatedToChannelId |
string allThreadsRelatedToChannelId 参数指示 API 返回与指定渠道关联的所有评论会话。回复中可能包含有关频道或频道中视频的评论。 |
|
channelId |
string channelId 参数会指示 API 返回包含对指定频道的评论的评论线程。(回复中不会包含对频道上传的视频发表的评论。) |
|
id |
string id 参数用于指定应该检索的资源的注释会话 ID 的逗号分隔列表。 |
|
videoId |
string videoId 参数用于指示 API 返回与指定视频 ID 相关联的评论会话。 |
|
可选参数 | ||
maxResults |
unsigned integer maxResults 参数用于指定应在结果集中返回的项数上限。注意:此参数不支持与 id 参数结合使用。可接受的值包括1 到100 (含 0 和 5000)。默认值为 20 。 |
|
moderationStatus |
string 此参数只能在正确的授权请求中使用。设置此参数可将返回的评论会话限制为特定的审核状态。 注意:此参数不支持与 id 参数结合使用。默认值为 published 。可接受的值为:
|
|
order |
string order 参数用于指定 API 响应列出评论线程的顺序。有效值为:
id 参数结合使用。 |
|
pageToken |
string pageToken 参数用于标识结果集中应返回的特定网页。在 API 响应中,nextPageToken 属性用于标识可检索的结果的下一页。注意:此参数不支持与 id 参数结合使用。 |
|
searchTerms |
string searchTerms 参数会指示 API 将 API 响应限制为仅包含包含指定搜索字词的评论。注意:此参数不支持与 id 参数结合使用。 |
|
textFormat |
string 请将此参数的值设为 html 或 plainText ,以指示 API 返回用户以 HTML 格式或纯文本形式发表的评论。默认值为 html 。可接受的值为:
|
请求正文
调用此方法时请勿提供请求正文。
响应
如果成功,此方法将返回采用以下结构的响应正文:
{ "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 |
找不到由 channelId 或 allThreadsRelatedToChannelId 参数标识的频道。 |
notFound (404) |
commentThreadNotFound |
找不到一个或多个指定的评论会话。请检查请求的 id 参数值,确保其正确无误。 |
notFound (404) |
videoNotFound |
找不到由 videoId 参数标识的视频。 |
试试看!
使用 APIs Explorer 调用此 API,并查看 API 请求和响应。