SuperChatEvents

Un recurso superChatEvent representa un mensaje de Súper chat que compró un fan durante una transmisión en vivo de YouTube. En el chat en vivo de YouTube, los Súper chats se destacan de otras formas:

  • Los Súper chats se destacan con un color.
  • Los Súper chats permanecen fijados en el ticker durante un período determinado.

El color del Súper chat, el período durante el que permanece fijado en el ticker y la longitud máxima del mensaje se determinan según el importe de la compra. Consulta el Centro de ayuda de YouTube para obtener más información sobre los Súper chats.

Métodos

La API admite los siguientes métodos para los recursos superChatEvents:

list
Muestra los eventos de Súper chat de las transmisiones en vivo de un canal de los últimos 30 días. Pruébala ahora.

Representación de recursos

La siguiente estructura JSON muestra el formato de un recurso 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
    }
  }
}

Propiedades

La siguiente tabla define las propiedades que aparecen en este recurso:

Propiedades
kind string
Identifica el tipo de recurso de la API. El valor será youtube#superChatEvent.
etag etag
Es el Etag de este recurso.
id string
Es el ID que YouTube asigna para identificar de forma única el evento de Súper chat.
snippet object
El objeto snippet contiene detalles básicos sobre el evento de Súper chat.
snippet.channelId string
Es el ID del canal de YouTube que identifica el canal que transmitió la transmisión en vivo asociada con el evento de Súper chat.
snippet.supporterDetails object
Son los detalles sobre el canal del usuario que envió el Súper chat.
snippet.supporterDetails.channelId string
Es el ID del canal de YouTube del usuario que envió el Súper chat.
snippet.supporterDetails.channelUrl string
Es la URL del canal del usuario que envió el Súper chat.
snippet.supporterDetails.displayName string
Es el nombre visible del canal del usuario que envió el Súper chat.
snippet.supporterDetails.profileImageUrl string
Es la URL del avatar del canal del usuario que envió el Súper chat.
snippet.commentText string
Es el contenido de texto del comentario del usuario que envió el Súper chat.
snippet.createdAt datetime
Es la fecha y la hora en que se compró el Súper chat. El valor se especifica en formato ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
snippet.amountMicros unsigned long
Es el importe de la compra, en micro unidades de la moneda de compra. Por ejemplo, si el importe de la compra es de un dólar, el valor de la propiedad snippet.amountMicros es 1000000.
snippet.currency string
Es la moneda en la que se realizó la compra. El valor es un código de moneda ISO 4217.
snippet.displayString string
Es una cadena, como $1.00, que muestra el importe de la compra y la moneda. La cadena visible se formatea según las convenciones del idioma especificado por el parámetro de solicitud hl. De forma predeterminada, las cadenas visibles se formatean como lo harían en inglés. Por ejemplo, de forma predeterminada, una cadena se formatea como $1.00 en lugar de $1,00.
snippet.messageType unsigned integer
Es el nivel del mensaje pagado. Ten en cuenta que, cuando un recurso liveChatMessage identifica un mensaje de Súper chat, la propiedad snippet.superChatDetails.tier contiene este valor.

El nivel se basa en la cantidad de dinero que se gastó para comprar el mensaje. También determina el color que se usa para destacar el mensaje en la IU del chat en vivo, la longitud máxima del mensaje y el tiempo que el mensaje permanece fijado en el ticker.

Los niveles de Súper chat se documentan en el Centro de ayuda de YouTube. (Consulta la sección expandible sobre los detalles de compra de Súper chat). En esa lista, el nivel con el importe de la compra más bajo es el nivel 1, el siguiente importe de la compra más bajo es el nivel 2, y así sucesivamente.
snippet.isSuperStickerEvent boolean
Indica si el recurso es una Súper calcomanía, que es un tipo particular de mensaje de Súper chat que tiene una imagen asociada. Si el valor de este campo es true, el campo superStickerMetadata contendrá información que se puede usar para mostrar la imagen.
snippet.superStickerMetadata object
Son los detalles sobre la Súper calcomanía. Este objeto solo se muestra si el valor del campo snippet.isSuperStickerEvent es true.
snippet.superStickerMetadata.stickerId string
Es un ID único que identifica la imagen de la calcomanía. Ten en cuenta que la imagen solo se muestra como parte del mensaje de Súper calcomanía cuando los usuarios ven la ventana de chat en YouTube. Sin embargo, la URL de la imagen no está disponible a través de la API. Solo como referencia, puedes encontrar qué IDs de calcomanías se relacionan con qué Súper calcomanías en este archivo CSV.
snippet.superStickerMetadata.altText string
Es una cadena de texto que describe la calcomanía. El campo snippet.superStickerMetadata.language identifica el idioma del texto. Cuando llames al método superChatEvents.list, establece el valor del parámetro hl en el idioma deseado para el texto.
snippet.superStickerMetadata.language string
Es el idioma del valor de la propiedad snippet.superStickerMetadata.altText. Si la Súper calcomanía también muestra algún texto, ese texto también está en este idioma.