此页面由 Cloud Translation API 翻译。

Sponsors: list

注意：此方法自 2020 年 3 月 31 日起已弃用。我们已将其替换为 members.list 方法。您可以在 YouTube Data API 文档中查看有关该方法的信息。

从 2020 年 9 月 30 日起，sponsors.list 方法将不再受支持。 API 客户端应更新对 sponsors.list 方法的调用，以改用 members.list 方法。

列出频道的成员（以前称为“赞助商”）。该 API 请求必须由频道所有者授权。

常见使用场景

请求

HTTP 请求

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

授权

此请求需要获得以下至少一个范围的授权（详细了解身份验证和授权）。

范围
`https://www.googleapis.com/auth/youtube`
`https://www.googleapis.com/auth/youtube.force-ssl`
`https://www.googleapis.com/auth/youtube.readonly`

参数

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

参数
必需参数
`part`	`string` `part` 参数用于指定 API 响应将包含的 `sponsor` 资源部分。支持的值为 `id` 和 `snippet`。
可选参数
`filter`	`string` `filter` 参数用于指定要返回的渠道赞助商广告。默认值为 `newest`。可接受的值为： `all` - 返回从最新到最早的所有赞助者。 `newest` - 返回最近赞助者的一页内容。使用 `nextPageToken` 发出的后续请求会在注册新订阅者时检索这些订阅者。
`maxResults`	`unsigned integer` `maxResults` 参数用于指定结果集中应返回的最大项数。可接受的值包括`0`到`50`（含 0 和 5000）。默认值为 `5`。
`pageToken`	`string` `pageToken` 参数用于标识结果集中应返回的特定网页。在 API 响应中，`nextPageToken` 和 `prevPageToken` 属性用于标识可检索的其他页面。

请求正文

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

响应

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

{
  "kind": "youtube#sponsorListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    sponsor resource
  ]
}

属性

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

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

错误

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

错误类型	错误详情	说明
`forbidden (403)`	`insufficientPermissions`	您没有查看频道赞助商所需的权限。
`invalidValue (400)`	`invalidValueInRequest`	请求包含无效值。
`invalidValue (400)`	`sponsorshipNotEnabledForChannelId`	频道未启用赞助功能。

试试看！

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