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 パラメータは、特定のプロパティ規則に従い、Super Chat の購入金額と通貨を示す snippet.displayString プロパティ値をフォーマットするよう API サーバーに指示します。パラメータ値は、i18nLanguages.list メソッドで返されるリストに含まれる言語コードである必要があります。デフォルト値は en です。この場合、デフォルトの動作では、ディスプレイ文字列は英語で使用されるように書式設定されます。たとえば、デフォルトでは、文字列の形式は $1,00 ではなく $1.00 です。
maxResults unsigned integer
maxResults パラメータでは、結果セットで返される商品アイテムの最大数を指定します。有効な値は 150(指定した値を含む)です。デフォルト値は 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 のリクエストとレスポンスを確認します。