SuperChatEvents

Una risorsa superChatEvent rappresenta un messaggio Superchat acquistato da un fan durante un live streaming di YouTube. Nello stream della chat live di YouTube, i messaggi Superchat si distinguono dagli altri in due modi:

  • I messaggi Super Chat sono evidenziati con un colore.
  • I messaggi Super Chat rimangono fissati nel riquadro di aggiornamento per un determinato periodo di tempo.

Il colore del Super Chat, il periodo di tempo in cui rimane fissato nel riquadro di aggiornamento e la lunghezza massima del messaggio sono tutti determinati dall'importo di acquisto. Consulta il Centro assistenza YouTube per scoprire di più sui Super Chat.

Metodi

L'API supporta i seguenti metodi per le risorse superChatEvents:

list
Elenca gli eventi Superchat dei live streaming di un canale negli ultimi 30 giorni. Prova subito.

Rappresentazione delle risorse

La seguente struttura JSON mostra il formato di una risorsa 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
    }
  }
}

Proprietà

La tabella seguente definisce le proprietà che appaiono in questa risorsa:

Proprietà
kind string
Identifica il tipo di risorsa API. Il valore sarà youtube#superChatEvent.
etag etag
L'Etag di questa risorsa.
id string
L'ID che YouTube assegna per identificare in modo univoco l'evento Super Chat.
snippet object
L'oggetto snippet contiene i dettagli di base sull'evento Super Chat.
snippet.channelId string
L'ID canale YouTube che identifica il canale che ha trasmesso il live streaming associato all'evento Super Chat.
snippet.supporterDetails object
Dettagli sul canale del sostenitore.
snippet.supporterDetails.channelId string
L'ID canale YouTube del sostenitore.
snippet.supporterDetails.channelUrl string
L'URL del canale del sostenitore.
snippet.supporterDetails.displayName string
Il nome visualizzato del canale del sostenitore.
snippet.supporterDetails.profileImageUrl string
L'URL dell'avatar del canale del sostenitore.
snippet.commentText string
Il contenuto testuale del commento del sostenitore.
snippet.createdAt datetime
La data e l'ora in cui è stato acquistato il messaggio Super Chat. Il valore è specificato nel formato ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
snippet.amountMicros unsigned long
L'importo di acquisto, in micro della valuta di acquisto. Ad esempio, se l'importo dell'acquisto è di un dollaro, il valore della proprietà snippet.amountMicros è 1000000.
snippet.currency string
La valuta in cui è stato effettuato l'acquisto. Il valore è un codice valuta ISO 4217.
snippet.displayString string
Una stringa, ad esempio $1.00, che mostra l'importo di acquisto e la valuta. La stringa di visualizzazione è formattata in base alle convenzioni della lingua specificata dal parametro della richiesta hl. Per impostazione predefinita, le stringhe di visualizzazione vengono formattate come in inglese. Ad esempio, per impostazione predefinita, una stringa viene formattata come $1.00 anziché $1,00.
snippet.messageType unsigned integer
Il livello del messaggio a pagamento. Tieni presente che quando una risorsa liveChatMessage identifica un messaggio Superchat, la proprietà snippet.superChatDetails.tier contiene questo valore.

Il livello si basa sull'importo speso per acquistare il messaggio. Determina anche il colore utilizzato per evidenziare il messaggio nell'interfaccia utente della chat live, la lunghezza massima del messaggio e il periodo di tempo in cui il messaggio viene fissato nel ticker.

I livelli di Superchat sono documentati nel Centro assistenza YouTube. (Consulta la sezione espandibile sui dettagli dell'acquisto di Super Chat.) In questo elenco, il livello con l'importo di acquisto più basso è il livello 1, l'importo successivo più basso è il livello 2 e così via.
snippet.isSuperStickerEvent boolean
Indica se la risorsa è un Super Sticker, ovvero un tipo particolare di messaggio Superchat con un'immagine associata. Se il valore di questo campo è true, il campo superStickerMetadata conterrà informazioni che possono essere utilizzate per visualizzare l'immagine.
snippet.superStickerMetadata object
Dettagli sul Super Sticker. Questo oggetto viene restituito solo se il valore del campo snippet.isSuperStickerEvent è true.
snippet.superStickerMetadata.stickerId string
Un ID univoco che identifica l'immagine dello sticker. Tieni presente che l'immagine viene visualizzata solo come parte del messaggio Super Sticker quando gli utenti visualizzano la finestra della chat su YouTube. Tuttavia, l'URL dell'immagine non è disponibile tramite l'API. Solo a titolo di riferimento, puoi trovare gli ID degli sticker che si riferiscono ai Super Sticker in questo file CSV.
snippet.superStickerMetadata.altText string
Una stringa di testo che descrive lo sticker. Il campo snippet.superStickerMetadata.language identifica la lingua del testo. Quando chiami il metodo superChatEvents.list, imposta il valore parametro hl sulla lingua desiderata per il testo.
snippet.superStickerMetadata.language string
La lingua del valore della proprietà snippet.superStickerMetadata.altText. Se il Super Sticker mostra anche del testo, questo testo è anche in questa lingua.