SuperChatEvents: list

チャンネルのライブ配信の過去 30 日間の Super Chat イベントを一覧表示します。

一般的なユースケース

リクエスト

HTTP リクエスト

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

認可

このリクエストは、少なくとも次のうち 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 レスポンスに含める superChatEvent リソース パーツを指定します。サポートされている値は id と snippet です。
オプション パラメータ
hl string
hl パラメータは、snippet.displayString プロパティの値をフォーマットするように API サーバーに指示します。これは、特定の言語の規則に従って Super Chat の購入金額と通貨を示します。パラメータ値には、i18nLanguages.list メソッドから返されるリストに含まれる言語コードを指定する必要があります。デフォルト値は en です。つまり、デフォルトの動作では、表示する文字列は英語で使用されるような書式設定になります。たとえば、文字列のデフォルト形式は $1,00 ではなく $1.00 です。
maxResults unsigned integer
maxResults パラメータは、結果セットで返されるアイテムの最大数を指定します。有効な値は 1～50 です。デフォルト値は 5 です。
pageToken string
pageToken パラメータは、結果セットの特定のページを返します。API レスポンスでは、nextPageToken プロパティと prevPageToken プロパティは取得可能な他のページを示します。

リクエスト本文

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

レスポンス

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

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

プロパティ

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

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

エラー

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

エラーのタイプ エラーの詳細 説明
forbidden (403) insufficientPermissions リクエストは適切に認証されていないため、Super Chat イベントを取得できません。

試してみよう:

APIs Explorer を使用してこの API を呼び出し、API のリクエストとレスポンスを確認します。