Se usó la API de Cloud Translation para traducir esta página.

SuperChatEvents

Un recurso superChatEvent representa un mensaje de Súper chat que un fan compró durante una transmisión en vivo de YouTube. En la transmisión del chat en vivo de YouTube, los Súper chats se destacan entre los demás mensajes de las siguientes dos maneras:

Los Súper chats se destacan con un color.
Los Súper chats permanecen fijos en el visor por un período determinado.

El importe de la compra determina el color del Súper chat, el período de tiempo que permanece fijo en el visor y la longitud máxima del mensaje. 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: Enumera los eventos de Súper chat de las transmisiones en vivo de un canal en los últimos 30 días. Pruébala ahora.

Representación de recursos

En la siguiente estructura JSON, se 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` La 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` El ID del canal de YouTube que identifica el canal que transmite la transmisión en vivo asociada con el evento de Súper chat
`snippet.supporterDetails`	`object` Detalles sobre el canal del colaborador
`snippet.supporterDetails.channelId`	`string` El ID del canal de YouTube del colaborador
`snippet.supporterDetails.channelUrl`	`string` La URL del canal del colaborador.
`snippet.supporterDetails.displayName`	`string` El nombre visible del canal del colaborador.
`snippet.supporterDetails.profileImageUrl`	`string` URL de avatar del canal del seguidor.
`snippet.commentText`	`string` El contenido de texto del comentario de la persona que lo apoya
`snippet.createdAt`	`datetime` Fecha y 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 micros 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 string de visualización se formatea según las convenciones del idioma especificado en el parámetro de solicitud `hl`. De forma predeterminada, las strings de visualización tienen el mismo formato que en inglés. Por ejemplo, de forma predeterminada, una string tiene el formato `$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 Super Chat, la propiedad `snippet.superChatDetails.tier` contiene este valor. El nivel se basa en la cantidad de dinero gastado para comprar el mensaje. También determina el color que se usará para destacar el mensaje en la IU del chat en vivo, la longitud máxima del mensaje y la cantidad de tiempo que el mensaje permanecerá fijo en el visor. 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 menor importe de compra es el 1, el siguiente importe más bajo es el 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` 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ías 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. A modo de referencia, en este archivo CSV puedes encontrar los IDs de calcomanías relacionados con las Súper calcomanías.
`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` El idioma del valor de la propiedad `snippet.superStickerMetadata.altText`. Si la Súper calcomanía también muestra texto, este también está en ese idioma.