SuperChatEvents: list

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

一般的なユースケース

リクエスト

HTTP リクエスト

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

承認

このリクエストは、少なくとも次のうち 1 つのスコープによる承認が必要です。認証と承認の詳細については、OAuth 2.0 認証の実装をご覧ください。

範囲
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 パラメータは、結果セットで返されるアイテムの最大数を指定します。有効な値は 1～50 です。デフォルト値は 5 です。
pageToken string
pageToken パラメータは、返される結果セット内の特定のページを識別します。API レスポンスの nextPageToken プロパティと prevPageToken プロパティには、取得可能な他のページが指定されています。

リクエスト本文

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

Response

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

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