このページは Cloud Translation API によって翻訳されました。

Sponsors: list

注: この方法は 2020 年 3 月 31 日をもって非推奨になりました。members.list メソッドに置き換えられました。そのメソッドの詳細については、YouTube Data API のドキュメントをご覧ください。

sponsors.list メソッドは、2020 年 9 月 30 日をもってサポートが終了します。API クライアントは、代わりに sponsors.list メソッドの呼び出しを更新して、members.list メソッドを使用する必要があります。

チャンネルのメンバー（旧称「スポンサー」）を一覧表示します。API リクエストはチャンネル所有者の承認が必要です。

一般的なユースケース

リクエスト

HTTP リクエスト

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

承認

このリクエストは、少なくとも次のうち 1 つのスコープでの承認が必要です（認証と承認の詳細をご確認ください）。

範囲
`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` - 最新のスポンサーの 1 ページを返します。その後の `nextPageToken` を使用したリクエストは、登録時に新しい定期購入者を取得します。
`maxResults`	`unsigned integer` `maxResults` パラメータでは、結果セットで返される商品アイテムの最大数を指定します。有効な値は `0`～`50`（指定した値を含む）です。デフォルト値は `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 のリクエストとレスポンスを確認します。