SuperChatEvents

superChatEvent 资源表示粉丝在 YouTube 直播期间购买的超级留言消息。在 YouTube 实时聊天中，超级留言以两种方式脱颖而出：

  • 超级留言以颜色突出显示。
  • 超级留言会在置顶栏中固定一段时间。

超级留言的颜色、在置顶栏中固定的时长以及消息的最大长度均由购买金额决定。如需详细了解超级留言，请访问 YouTube 帮助中心。

方法

对于 superChatEvents 资源，该 API 支持以下方法：

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
购买金额，以购买币种的微单位表示。例如，如果购买金额是 1 美元，则 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 获取图片网址。您可以在此 CSV 文件中找到哪些贴纸 ID 与哪些超级贴纸相关联，仅供参考。
snippet.superStickerMetadata.altText string
描述贴纸的文本字符串。snippet.superStickerMetadata.language 字段用于标识文本的语言。调用 superChatEvents.list 方法时，将 hl 参数值设置为文本的所需语言。
snippet.superStickerMetadata.language string
snippet.superStickerMetadata.altText 属性值的语言。如果超级贴纸还显示了任何文字，则说明该文字也以此语言显示。