SuperChatEvents

Ресурс superChatEvent представляет собой сообщение в Суперчате, приобретенное фанатом во время YouTube Live. Сообщения Суперчата отличаются от обычных двумя особенностями:

  • Сообщения Суперчата выделяются цветом.
  • Сообщения Суперчата остаются закрепленными в бегущей строке в течение определенного времени.

Цвет сообщения, время его закрепления в тикете и максимальная длина зависят от суммы покупки. Подробнее о Суперчате написано в Справочном центре 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 присваивает событию Суперчата.
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. Если на суперстикере есть текст, он также будет на этом языке.