SuperChatEvents

superChatEvent 資源代表粉絲在 YouTube 直播期間購買的超級留言訊息。在 YouTube 直播聊天室中，超級留言會以兩種方式與其他訊息區隔：

• 超級留言會以顏色醒目顯示。
• 超級留言會在聊天室置頂顯示一段時間。

超級留言的顏色、在聊天室置頂顯示的時間長度，以及訊息長度上限，都取決於購買金額。如要進一步瞭解超級留言，請參閱 YouTube 說明中心。

方法

API 支援下列 superChatEvents 資源方法：

list

列出頻道過去 30 天直播的超級留言事件。 立即試用。

資源表示法

下列 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 指派的 ID，用於識別超級留言事件。
snippet	object snippet 物件包含超級留言活動的基本詳細資料。
snippet.channelId	string YouTube 頻道 ID，用於識別與超級留言事件相關聯的直播頻道。
snippet.supporterDetails	object 支持者頻道的詳細資料。
snippet.supporterDetails.channelId	string 支持者的 YouTube 頻道 ID。
snippet.supporterDetails.channelUrl	string 支持者頻道的網址。
snippet.supporterDetails.displayName	string 贊助者頻道的顯示名稱。
snippet.supporterDetails.profileImageUrl	string 支持者頻道的顯示圖片網址。
snippet.commentText	string 支持者留言的文字內容。
snippet.createdAt	datetime 購買超級留言的日期和時間。值以 ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) 格式指定。
snippet.amountMicros	unsigned long 購買金額，以購買幣別的百萬分之一為單位。舉例來說，如果購買金額為一美元，snippet.amountMicros 屬性值就是 1000000。
snippet.currency	string 購買時使用的幣別。值為 ISO 4217 貨幣代碼。
snippet.displayString	string 顯示購買金額和幣別的字串，例如 $1.00。顯示字串的格式會根據 hl 要求參數指定的語言慣例設定。根據預設，顯示字串的格式與英文相同。舉例來說，字串預設會格式化為 $1.00，而非 $1,00。
snippet.messageType	unsigned integer 付費訊息的等級。請注意，當 liveChatMessage 資源識別出超級留言訊息時，snippet.superChatDetails.tier 屬性會包含這個值。 等級是根據購買訊息所花費的金額而定。系統也會根據等級決定在聊天室使用者介面中醒目顯示訊息的顏色、訊息長度上限，以及訊息在跑馬燈中置頂的時間長度。 如要瞭解超級留言等級，請參閱 YouTube 說明中心。(請參閱超級留言購買詳細資料的展開式部分)。在該清單中，購買金額最低的級別為第 1 級，次低金額為第 2 級，依此類推。
snippet.isSuperStickerEvent	boolean 指出資源是否為超級貼圖，這是一種與圖片相關聯的特殊超級留言訊息。如果這個欄位的值為 true，superStickerMetadata 欄位就會包含可用於顯示圖片的資訊。
snippet.superStickerMetadata	object 超級貼圖的詳細資料。只有在 snippet.isSuperStickerEvent 欄位的值為 true 時，系統才會傳回這個物件。
snippet.superStickerMetadata.stickerId	string 可識別貼圖圖片的專屬 ID。請注意，使用者在 YouTube 聊天視窗中只會看到超級貼圖訊息，不會看到圖片。不過，您無法透過 API 取得圖片網址。如要瞭解貼圖 ID 與超級貼圖的對應關係，請參閱這份 CSV 檔案。
snippet.superStickerMetadata.altText	string 描述貼圖的文字字串。snippet.superStickerMetadata.language 欄位會識別文字的語言。呼叫 superChatEvents.list 方法時，請將 hl 參數值設為文字所需的語言。
snippet.superStickerMetadata.language	string snippet.superStickerMetadata.altText 屬性值的語言。如果超級貼圖也顯示任何文字，這些文字也會以這個語言呈現。