返回与 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 请求和响应。