SuperChatEvents

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

  • I messaggi Superchat vengono evidenziati con un colore.
  • I messaggi Superchat rimangono bloccati nel riquadro di aggiornamento per un determinato periodo di tempo.

Il colore del messaggio Superchat, il periodo di tempo durante il quale rimane nel riquadro di aggiornamento e la lunghezza massima del messaggio sono tutti determinati dall'importo dell'acquisto. Per scoprire di più su Superchat, consulta il Centro assistenza YouTube.

Metodi

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

list
Elencare 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à visualizzate 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 assegnato da YouTube per identificare in modo univoco l'evento Superchat.
snippet object
L'oggetto snippet contiene i dettagli di base sull'evento Superchat.
snippet.channelId string
L'ID canale YouTube che identifica il canale che trasmette il live streaming associato all'evento Superchat.
snippet.supporterDetails object
Dettagli sul canale del sostenitori.
snippet.supporterDetails.channelId string
L'ID del canale YouTube del sostenitore.
snippet.supporterDetails.channelUrl string
L'URL del canale del sostenitori.
snippet.supporterDetails.displayName string
Il nome visualizzato del canale del sostenitore.
snippet.supporterDetails.profileImageUrl string
L'URL dell'avatar del canale del sostenitori.
snippet.commentText string
I contenuti testuali del commento del sostenitori.
snippet.createdAt datetime
La data e l'ora in cui è stato acquistato il messaggio Superchat. 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 di 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, come $1.00, che mostra l'importo e la valuta dell'acquisto. La stringa di visualizzazione è formattata in base alle convenzioni per la lingua specificata dal parametro di 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é come $1,00.
snippet.messageType unsigned integer
Il livello per il 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 l'acquisto del messaggio. Determina inoltre il colore utilizzato per evidenziare il messaggio nell'interfaccia utente della chat dal vivo, la lunghezza massima del messaggio e la quantità di tempo in cui il messaggio viene messo in primo piano nel riquadro di aggiornamento.

I livelli di Superchat sono documentati nel Centro assistenza YouTube. Consulta la sezione espandibile dedicata ai dettagli dell'acquisto di messaggi Superchat. In questo elenco, il livello con l'importo di acquisto più basso è il livello 1, il livello più basso successivo è il livello 2 e così via.
snippet.isSuperStickerEvent boolean
Indica se la risorsa è un Super Sticker, ovvero un particolare tipo di messaggio Superchat a cui è associata un'immagine. 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 dell'adesivo. Tieni presente che l'immagine viene mostrata nel messaggio Super Sticker solo quando gli utenti visualizzano la finestra della chat su YouTube. Tuttavia, l'URL dell'immagine non è disponibile tramite l'API. Solo come riferimento, in questo file CSV puoi trovare gli ID dei adesivi e i Super Sticker.
snippet.superStickerMetadata.altText string
Una stringa di testo che descrive l'adesivo. Il campo snippet.superStickerMetadata.language identifica la lingua del testo. Quando chiami il metodo superChatEvents.list, imposta il valore del 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, anche il testo è in questa lingua.