このページは Cloud Translation API によって翻訳されました。

SuperChatEvents

superChatEvent リソースは、YouTube ライブ配信中にファンが購入した Super Chat メッセージを表します。YouTube チャットストリームでは、次の 2 つの方法で Super Chat を目立たせることができます。

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 の購入の詳細に関するセクションを展開すると確認できます）。このリストでは、購入額が最も少ない階層は Tier 1、次に低い金額は Tier 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 では使用できません。
`snippet.superStickerMetadata.altText`	`string` ステッカーを説明するテキスト文字列。`snippet.superStickerMetadata.language` フィールドは、テキストの言語を識別します。`superChatEvents.list` メソッドを呼び出すときは、テキストの hl パラメータ値を目的の言語に設定します。
`snippet.superStickerMetadata.language`	`string` `snippet.superStickerMetadata.altText` プロパティ値の言語。Super Sticker にもテキストが表示される場合は、そのテキストもこの言語で表示されます。