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
Этаг этого ресурса.
id string
Идентификатор, который YouTube присваивает для уникальной идентификации мероприятия Суперчата.
snippet object
Объект snippet содержит основные сведения о событии Суперчата.
snippet. channelId string
Идентификатор канала YouTube, который идентифицирует канал, транслирующий прямую трансляцию, связанную с событием Суперчата.
snippet. supporterDetails object
Подробности о канале сторонника.
snippet.supporterDetails. channelId string
Идентификатор канала YouTube сторонника.
snippet.supporterDetails. channelUrl string
URL-адрес канала сторонника.
snippet.supporterDetails. displayName string
Отображаемое название канала сторонника.
snippet.supporterDetails. profileImageUrl string
URL-адрес аватара канала сторонника.
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
Уникальный идентификатор, идентифицирующий изображение стикера. Обратите внимание, что изображение отображается как часть сообщения суперстикера только тогда, когда пользователи просматривают окно чата на YouTube. Однако URL-адрес изображения недоступен через API. Исключительно для справки: в этом CSV-файле вы можете найти идентификаторы стикеров, к которым относятся суперстикеры.
snippet.superStickerMetadata. altText string
Текстовая строка, описывающая стикер. Поле snippet.superStickerMetadata.language определяет язык текста. При вызове метода superChatEvents.list установите значение параметра hl на желаемый язык текста.
snippet.superStickerMetadata. language string
Язык значения свойства snippet.superStickerMetadata.altText . Если суперстикер также отображает какой-либо текст, этот текст также написан на этом языке.