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 和 10000）。默认值为 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 请求和响应。