FanFundingEvents: list

注: これはサポート終了のお知らせです。

視聴者ファンディング機能は非推奨となり、2017 年 2 月 28 日に提供が終了します。このサポート終了は、YouTube の新機能である Super Chat のリリースと同時に行われます。

チャンネルの視聴者ファンディング イベントを一覧表示します。API リクエストはチャンネル所有者の承認が必要です。

リクエスト

HTTP リクエスト

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

承認

このリクエストは、少なくとも次のうち 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 レスポンスに含める fanFundingEvent リソース部分を指定します。指定できる値は id および snippet です。
オプション パラメータ
hl string
hl パラメータは、特定の YouTube ウェブサイトでサポートされているアプリケーション言語のローカライズされた通貨表示文字列を取得するように API に指示します。たとえば、英語では、通貨は $1.50、フランス語では 1,50$ と表示されます。

パラメータ値は、i18nLanguages.list メソッドで返されるリストに含まれる言語コードでなければなりません。
maxResults unsigned integer
maxResults パラメータでは、結果セットで返される商品アイテムの最大数を指定します。有効な値は 0～50（指定した値を含む）です。デフォルト値は 5 です。
pageToken string
pageToken パラメータは、API サーバーが返すように要求された結果セット内の特定のページを識別します。API レスポンスでは、nextPageToken プロパティはリクエストの次のページを指定します。

リクエスト本文

このメソッドを呼び出す場合は、リクエストの本文を指定しないでください。

レスポンス

成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。

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

プロパティ

次の表は、このリソースで使用されているプロパティの定義を示したものです。

プロパティ
kind string
API リソースのタイプを識別します。値は youtube#fanFundingEventListResponse です。
etag etag
このリソースの Etag。
nextPageToken string
結果セットの次のページを取得するために pageToken パラメータの値として使用できるトークン。
pageInfo object
pageInfo オブジェクトは、結果セットのページ情報をカプセル化します。
pageInfo.totalResults integer
結果セット内の結果の合計数。
pageInfo.resultsPerPage integer
API レスポンスに含まれる結果の数。
items[] list
リクエスト条件に一致する視聴者ファンディング イベントのリスト。

エラー

次の表に、このメソッドの呼び出しに応じて API から返される可能性のあるエラー メッセージを示します。詳細については、エラー メッセージのドキュメントを参照してください。

エラーのタイプ エラーの詳細 説明
forbidden (403) insufficientPermissions チャンネルの視聴者ファンディング イベントを表示するのに必要な権限がありません。
invalidValue (400) fanFundingNotEnabledForChannelId チャンネルで視聴者ファンディングが有効になっていない。

実習

API Explorer を使用し、ライブ データに対してこのメソッドを呼び出して、API リクエストとレスポンスを確認してください。