SuperChatEvents

Um recurso superChatEvent representa uma mensagem do Super Chat comprada por um fã durante uma transmissão ao vivo do YouTube. No chat ao vivo do YouTube, os Super Chats se destacam de outras mensagens de duas maneiras:

  • Os Super Chats são destacados com uma cor.
  • Os Super Chats ficam fixados no ticker por um período definido.

A cor do Super Chat, o período em que ele fica fixado no mostrador e o comprimento máximo da mensagem são determinados pelo montante da compra. Acesse a Central de Ajuda do YouTube para saber mais sobre os Super Chats.

Métodos

A API oferece suporte aos seguintes métodos para recursos superChatEvents:

list
Lista os eventos do Super Chat das transmissões ao vivo de um canal nos últimos 30 dias. Faça um teste agora.

Representação de recurso

A estrutura JSON a seguir mostra o formato de um 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
    }
  }
}

Propriedades

A tabela a seguir define as propriedades que aparecem neste recurso:

Propriedades
kind string
Identifica o tipo de recurso da API. O valor será youtube#superChatEvent.
etag etag
O Etag desse recurso.
id string
O ID que o YouTube atribui para identificar exclusivamente o evento do Super Chat.
snippet object
O objeto snippet contém detalhes básicos sobre o evento do Super Chat.
snippet.channelId string
O ID do canal do YouTube que identifica o canal que transmitiu a transmissão ao vivo associada ao evento do Super Chat.
snippet.supporterDetails object
Detalhes sobre o canal do apoiador.
snippet.supporterDetails.channelId string
O ID do canal do YouTube do apoiador.
snippet.supporterDetails.channelUrl string
O URL do canal do apoiador.
snippet.supporterDetails.displayName string
O nome de exibição do canal do apoiador.
snippet.supporterDetails.profileImageUrl string
O URL do avatar do canal do apoiador.
snippet.commentText string
O conteúdo de texto do comentário do apoiador.
snippet.createdAt datetime
A data e a hora em que o Super Chat foi comprado. O valor é especificado no formato ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
snippet.amountMicros unsigned long
O montante da compra, em micros da moeda de compra. Por exemplo, se o montante da compra for de um dólar, o valor da propriedade snippet.amountMicros será 1000000.
snippet.currency string
A moeda em que a compra foi feita. O valor é um código de moeda ISO 4217.
snippet.displayString string
Uma string, como $1.00, que mostra o montante da compra e a moeda. A string de exibição é formatada com base nas convenções do idioma especificado pelo parâmetro de solicitação hl. Por padrão, as strings de exibição são formatadas em inglês. Por exemplo, por padrão, uma string é formatada como $1.00 em vez de $1,00.
snippet.messageType unsigned integer
O nível da mensagem paga. Quando um recurso liveChatMessage identifica uma mensagem do Super Chat, a propriedade snippet.superChatDetails.tier contém esse valor.

O nível é baseado no valor gasto para comprar a mensagem. Ele também determina a cor usada para destacar a mensagem na interface do chat ao vivo, o comprimento máximo da mensagem e o tempo em que a mensagem é fixada no ticker.

Os níveis do Super Chat estão documentados na Central de Ajuda do YouTube. Consulte a seção expansível sobre detalhes da compra do Super Chat. Nessa lista, o nível com o menor montante da compra é o nível 1, o próximo valor mais baixo é o nível 2 e assim por diante.
snippet.isSuperStickerEvent boolean
Indica se o recurso é um Super Sticker, que é um tipo específico de mensagem do Super Chat que tem uma imagem associada. Se o valor desse campo for true, o campo superStickerMetadata vai conter informações que podem ser usadas para mostrar a imagem.
snippet.superStickerMetadata object
Detalhes sobre o Super Sticker. Esse objeto só é retornado se o valor do campo snippet.isSuperStickerEvent for true.
snippet.superStickerMetadata.stickerId string
Um ID exclusivo que identifica a imagem do sticker. A imagem só é mostrada como parte da mensagem do Super Sticker quando os usuários visualizam a janela de chat no YouTube. No entanto, o URL da imagem não está disponível pela API. Para referência, você pode encontrar quais IDs de sticker estão relacionados a quais Super Stickers neste arquivo CSV.
snippet.superStickerMetadata.altText string
Uma string de texto que descreve o sticker. O campo snippet.superStickerMetadata.language identifica o idioma do texto. Ao chamar o método superChatEvents.list, defina o valor de parâmetro hl para o idioma desejado do texto.
snippet.superStickerMetadata.language string
O idioma do valor da propriedade snippet.superStickerMetadata.altText. Se o Super Sticker também mostrar algum texto, ele também estará nesse idioma.