返回与 API 请求参数匹配的组列表。例如,您可以检索已通过身份验证的用户拥有的所有群组,也可以按唯一 ID 检索一个或多个群组。
请求
HTTP 请求
GET https://youtubeanalytics.googleapis.com/v2/groups
授权
此请求需要获得以下至少一个范围的授权(详细了解身份验证和授权)。
权限范围 | |
---|---|
https://www.googleapis.com/auth/yt-analytics.readonly | 查看有关您的 YouTube 内容的 YouTube 数据分析报告。通过此范围,您可以访问用户活动指标,例如观看次数和评分计数。 |
https://www.googleapis.com/auth/yt-analytics-monetary.readonly | 查看 YouTube 分析工具为您的 YouTube 内容出具的财务报告。通过此范围,您可以访问用户活动指标,以及估算收入和广告效果指标。 |
https://www.googleapis.com/auth/youtube | 管理您的 YouTube 帐号。在 YouTube Analytics API 中,频道所有者使用此范围管理 YouTube 数据分析组和组项。 |
https://www.googleapis.com/auth/youtubepartner | 在 YouTube 上查看和管理 YouTube 资产和相关内容。在 YouTube Analytics API 中,内容所有者使用此范围管理 YouTube 数据分析组和组项。 |
参数
下表列出了此查询支持的参数。列出的所有参数都是查询参数。
参数 | ||
---|---|---|
过滤器(请准确指定以下参数之一) | ||
id |
string id 参数用于指定所检索资源的 YouTube 群组 ID 的列表(以英文逗号分隔)。每个群组都必须归经过身份验证的用户所有。在 group 资源中,id 属性用于指定该群组的 YouTube 群组 ID。请注意,如果您没有为 id 参数指定值,则必须将 mine 参数设置为 true 。 |
|
mine |
boolean 此参数只能在正确的授权请求中使用。将此参数的值设置为 true ,以检索经过身份验证的用户拥有的所有群组。 |
|
可选参数 | ||
onBehalfOfContentOwner |
string 此参数只能在正确的授权请求中使用。注意:此参数专供拥有和管理许多不同 YouTube 频道的 YouTube 内容合作伙伴使用。 onBehalfOfContentOwner 参数表示请求的授权凭据用于标识代表参数值中指定的内容所有者执行操作的 YouTube 用户。内容所有者只需进行一次身份验证,即可访问自己所有的视频和频道数据,而无需为每个频道提供身份验证凭据。用户通过身份验证时使用的帐号必须与指定的 YouTube 内容所有者相关联。 |
|
pageToken |
string pageToken 参数用于标识结果集中应返回的特定网页。在 API 响应中,nextPageToken 属性用于标识可检索的下一页。 |
请求正文
调用此方法时请勿提供请求正文。
响应
如果成功,此方法将返回采用以下结构的响应正文:
{ "kind": "youtube#groupListResponse", "etag": etag, "items": [ group Resource ], "nextPageToken": string }
属性
下表定义了此资源中显示的属性:
属性 | |
---|---|
kind |
string 标识 API 资源类型。值为 youtube#groupListResponse 。 |
etag |
etag 此资源的 Etag。 |
items[] |
list 与 API 请求参数匹配的群组列表。列表中的每一项表示 group 资源。 |
nextPageToken |
string 可用作 pageToken 参数值以检索结果集中的下一页的令牌。 |
错误
该 API 不会定义此 API 方法所独有的任何错误消息。不过,此方法仍会返回错误消息文档中列出的常规 API 错误。
试试看!
使用 APIs Explorer 调用此 API,并查看 API 请求和响应。