SuperChatEvents

superChatEvent リソースは、YouTube ライブ配信中にファンが購入した Super Chat メッセージを表します。YouTube のチャット ストリームでは、Super Chat は次の 2 つの点で他のメッセージより目立ちます。

  • Super Chat は色でハイライト表示されます。
  • Super Chat はティッカー内に一定期間固定表示されます。

Super Chat の色、ティッカーに固定されている期間、メッセージの最大長はすべて、購入金額によって決まります。Super Chat について詳しくは、YouTube ヘルプセンターをご覧ください。

Methods

この API では、superChatEvents リソースについて次のメソッドがサポートされています。

list
過去 30 日間にチャンネルのライブ配信で行われた Super Chat イベントのリストを表示します。 今すぐ試す

リソース表現

次の JSON 構造は、superChatEvent リソースの形式を示しています。

{
  "kind": "youtube#superChatEvent",
  "etag": etag,
  "id": string,
  "snippet": {
    "channelId": string,
    "supporterDetails": {
      "channelId": string,
      "channelUrl": string,
      "displayName": string,
      "profileImageUrl": string
    },
    "commentText": string,
    "createdAt": datetime,
    "amountMicros": unsigned long,
    "currency": string,
    "displayString": string,
    "messageType": unsigned integer,
    "isSuperStickerEvent": boolean,
    "superStickerMetadata": {
      "stickerId": string,
      "altText": string,
      "language": string
    }
  }
}

プロパティ

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

プロパティ
kind string
API リソースのタイプを識別します。値は youtube#superChatEvent です。
etag etag
このリソースの Etag。
id string
Super Chat イベントを一意に識別するために YouTube が割り当てた ID。
snippet object
snippet オブジェクトには、Super Chat イベントに関する基本情報が格納されます。
snippet.channelId string
Super Chat イベントに関連付けられたライブ配信を配信するチャンネルを識別する YouTube チャンネル ID。
snippet.supporterDetails object
サポーターのチャンネルの詳細。
snippet.supporterDetails.channelId string
サポーターの YouTube チャンネル ID。
snippet.supporterDetails.channelUrl string
サポーターのチャンネルの URL。
snippet.supporterDetails.displayName string
サポーターのチャンネルの表示名。
snippet.supporterDetails.profileImageUrl string
サポーターのチャンネルのアバター URL。
snippet.commentText string
サポーターのコメントのテキスト コンテンツ。
snippet.createdAt datetime
Super Chat を購入した日時。値は ISO 8601（YYYY-MM-DDThh:mm:ss.sZ）形式で指定します。
snippet.amountMicros unsigned long
購入金額（購入通貨のマイクロ単位）。たとえば、購入金額が 1 ドルの場合、snippet.amountMicros プロパティ値は 1000000 です。
snippet.currency string
購入に使用された通貨。値は ISO 4217 の通貨コードです。
snippet.displayString string
購入金額と通貨を示す文字列（$1.00 など）。表示文字列は、hl リクエスト パラメータで指定された言語の規則に基づいて書式設定されます。デフォルトでは、表示文字列は英語と同じ形式になります。たとえば、デフォルトでは、文字列の形式は $1,00 ではなく $1.00 になります。
snippet.messageType unsigned integer
有料メッセージの階層。liveChatMessage リソースが Super Chat メッセージを識別する場合、snippet.superChatDetails.tier プロパティにはこの値が含まれます。

階層は、メッセージの購入金額に基づきます。また、チャット UI でメッセージを目立たせる色、メッセージの最大長、ティッカーでメッセージを固定する時間も決まります。

Super Chat の階層については、YouTube ヘルプセンターをご覧ください。（Super Chat の購入の詳細については、展開可能なセクションをご覧ください）。このリストで、購入金額が最も低い階層は階層 1、その次に低い階層は階層 2 のようになります。
snippet.isSuperStickerEvent boolean
リソースが Super Sticker（画像を含む特定の種類の Super Chat メッセージ）であるかどうかを示します。このフィールドの値が true の場合、superStickerMetadata フィールドには、画像の表示に使用できる情報が格納されます。
snippet.superStickerMetadata object
Super Sticker の詳細。このオブジェクトは、snippet.isSuperStickerEvent フィールドの値が true の場合にのみ返されます。
snippet.superStickerMetadata.stickerId string
ステッカー画像を識別する一意の ID。この画像は、ユーザーが YouTube でチャット ウィンドウを表示したときに Super Sticker メッセージの一部としてのみ表示されることに注意してください。ただし、API を介して画像の URL を取得することはできません。ご参考までに、どのステッカー ID とどの Super Stickers が関連しているかをこちらの CSV ファイルでご確認ください。
snippet.superStickerMetadata.altText string
ステッカーを説明するテキスト文字列。snippet.superStickerMetadata.language フィールドは、テキストの言語を指定します。superChatEvents.list メソッドを呼び出す際は、hl パラメータ値をテキストの言語に設定します。
snippet.superStickerMetadata.language string
snippet.superStickerMetadata.altText プロパティ値の言語。Super Sticker にテキストも表示される場合、そのテキストもこの言語で表示されます。