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 のリクエストとレスポンスを確認します。