SuperChatEvents

A 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
交易额，以购买币种的微单位表示。例如，如果交易额为 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属性值的语言。如果超级贴纸还显示任何文本，则该文本也采用这种语言。