SuperChatEvents

superChatEvent リソースは、YouTube ライブ配信中に視聴者が購入した Super Chat メッセージを表します。YouTube のライブチャット ストリームでは、Super Chat は次の 2 つの方法で他のメッセージと区別されます。

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

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

メソッド

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
YouTube が Super Chat イベントを一意に識別するために割り当てる 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 Sticker は、関連付けられた画像を持つ特定のタイプの Super Chat メッセージです。このフィールドの値が true の場合、superStickerMetadata フィールドには画像の表示に使用できる情報が含まれます。
snippet.superStickerMetadata object
Super Sticker に関する詳細。このオブジェクトは、snippet.isSuperStickerEvent フィールドの値が true の場合にのみ返されます。
snippet.superStickerMetadata.stickerId string
ステッカー画像を識別する一意の ID。画像は、ユーザーが YouTube でチャット ウィンドウを表示したときにのみ、Super Sticker メッセージの一部として表示されます。ただし、画像 URL は API では使用できません。参考までに、この CSV ファイルで、どのステッカー ID がどの Super Sticker に関連しているかを確認できます。
snippet.superStickerMetadata.altText string
ステッカーを説明するテキスト文字列。snippet.superStickerMetadata.language フィールドは、テキストの言語を識別します。superChatEvents.list メソッドを呼び出すときは、hl パラメータの値をテキストの目的の言語に設定します。
snippet.superStickerMetadata.language string
snippet.superStickerMetadata.altText プロパティの値の言語。Super Sticker にテキストも表示される場合、そのテキストもこの言語で表示されます。