Una risorsa liveChatMessage
rappresenta un messaggio di una chat dal vivo di YouTube. La risorsa può contenere dettagli su diversi tipi di messaggi, tra cui un SMS appena pubblicato o un evento di finanziamento dei fan.
La funzionalità di chat live è abilitata per impostazione predefinita per le trasmissioni live ed è disponibile mentre è attivo l'evento dal vivo. Al termine dell'evento, la chat live non sarà più disponibile.
Metodi
L'API supporta i seguenti metodi per le risorse liveChatMessages
:
- list
- Elenca i messaggi della chat live relativi a una chat specifica. Prova subito.
- inserisci
- Aggiunge un messaggio o un sondaggio a una chat live. Prova subito.
- transizione
- Esegui la transizione dello stato di un messaggio live. Prova subito.
- elimina
- Elimina un messaggio di chat. La richiesta API deve essere autorizzata dal proprietario del canale o da un moderatore della chat live. Prova subito.
Rappresentazione della risorsa
La seguente struttura JSON mostra il formato di una risorsa liveChatMessages
:
{ "kind": "youtube#liveChatMessage", "etag": etag, "id": string, "snippet": { "type": string, "liveChatId": string, "authorChannelId": string, "publishedAt": datetime, "hasDisplayContent": boolean, "displayMessage": string, "fanFundingEventDetails": { "amountMicros": unsigned long, "currency": string, "amountDisplayString": string, "userComment": string }, "textMessageDetails": { "messageText": string }, "messageDeletedDetails": { "deletedMessageId": string }, "userBannedDetails": { "bannedUserDetails": { "channelId": string, "channelUrl": string, "displayName": string, "profileImageUrl": string }, "banType": string, "banDurationSeconds": unsigned long }, "memberMilestoneChatDetails": { "userComment": string, "memberMonth": unsigned integer, "memberLevelName": string }, "newSponsorDetails": { "memberLevelName": string, "isUpgrade": bool }, "superChatDetails": { "amountMicros": unsigned long, "currency": string, "amountDisplayString": string, "userComment": string, "tier": unsigned integer }, "superStickerDetails": { "superStickerMetadata": { "stickerId": string, "altText": string, "language": string }, "amountMicros": unsigned long, "currency": string, "amountDisplayString": string, "tier": unsigned integer }, "pollDetails": { "metadata": { "options": { "optionText": string, "questionText": string, }, "status": enum }, }, "membershipGiftingDetails": { "giftMembershipsCount": integer, "giftMembershipsLevelName": string }, "giftMembershipReceivedDetails": { "memberLevelName": string, "gifterChannelId": string, "associatedMembershipGiftingMessageId": string }, }, "authorDetails": { "channelId": string, "channelUrl": string, "displayName": string, "profileImageUrl": string, "isVerified": boolean, "isChatOwner": boolean, "isChatSponsor": boolean, "isChatModerator": boolean }, }
Proprietà
La tabella seguente definisce le proprietà visualizzate in questa risorsa:
Proprietà | |
---|---|
kind |
string Identifica il tipo di risorsa API. Il valore sarà youtube#liveChatMessage . |
etag |
etag L'Etag di questa risorsa. |
id |
string L'ID assegnato da YouTube per identificare in modo univoco il messaggio. |
snippet |
object L'oggetto snippet contiene i dettagli principali del messaggio di chat. |
snippet.type |
string Il tipo di messaggio. Questa proprietà è sempre presente e il suo valore determina quali campi sono presenti nella risorsa. I valori validi per questa proprietà sono:
|
snippet.liveChatId |
string L'ID che identifica in modo univoco la chat live a cui è associato il messaggio. L'ID chat live associato a una trasmissione viene restituito nella proprietà snippet.liveChatId della risorsa liveBroadcast . |
snippet.authorChannelId |
string L'ID dell'utente che ha creato il messaggio. Questo campo viene compilato solo per i seguenti tipi di messaggi:
|
snippet.publishedAt |
datetime La data e l'ora di pubblicazione originale del messaggio. Il valore è specificato nel formato ISO 8601 ( YYYY-MM-DDThh:mm:ss.sZ ). |
snippet.hasDisplayContent |
boolean Indica se il messaggio ha contenuti visibili che devono essere mostrati agli utenti. |
snippet.displayMessage |
string Contiene una stringa che viene mostrata agli utenti. Questo campo non è presente se il tipo di messaggio è chatEndedEvent o tombstone . |
snippet.fanFundingEventDetails |
object Nota: questo oggetto e le relative proprietà secondarie sono stati deprecati. A partire dal 28 febbraio 2017, le risorse di liveChatMessage non restituiranno più dettagli relativi agli eventi di Finanziamenti dei fan.Questo oggetto contiene dettagli sull'evento di finanziamento. È presente solo se il tipo di messaggio è fanFundingEvent . |
snippet.fanFundingEventDetails.amountMicros |
unsigned long Nota: questa proprietà è stata ritirata. L'importo del fondo. |
snippet.fanFundingEventDetails.currency |
string Nota: questa proprietà è stata ritirata. La valuta in cui è stato effettuato il fondo. |
snippet.fanFundingEventDetails.amountDisplayString |
string Nota: questa proprietà è stata ritirata. Una stringa visualizzata che mostra all'utente l'importo e la valuta del fondo. |
snippet.fanFundingEventDetails.userComment |
string Nota: questa proprietà è stata ritirata. Il commento aggiunto dall'utente a questo evento di finanziamento dei fan. |
snippet.textMessageDetails |
object Questo oggetto contiene dettagli sull'SMS. È presente solo se il tipo di messaggio è textMessageEvent . |
snippet.textMessageDetails.messageText |
string Il messaggio dell'utente. |
snippet.messageDeletedDetails |
object Questo oggetto contiene dettagli su un messaggio eliminato da un moderatore della chat o dal proprietario del canale della trasmissione live. È presente solo se il tipo di messaggio è messageDeletedEvent . |
snippet.messageDeletedDetails.deletedMessageId |
string L'ID che identifica in modo univoco il messaggio eliminato. Il valore è uguale al valore della proprietà id del messaggio di testo originale. Ad esempio, se un textMessageEvent ha il valore della proprietà id 123 e il messaggio viene successivamente eliminato, il valore snippet.messageDeletedDetails.deletedMessageId per quel messaggio sarà 123 .Se memorizzi nella cache i messaggi di chat dopo averli recuperati, utilizza il valore di questa proprietà per identificare il messaggio che non deve più essere visualizzato. |
snippet.userBannedDetails |
object Questo oggetto contiene dettagli su un utente che è stato escluso dalla chat. Contiene anche dettagli sull'esclusione stessa. Gli utenti possono essere esclusi da una chat in modo definitivo o temporaneo. |
snippet.userBannedDetails.bannedUserDetails |
object Questo oggetto contiene informazioni sull'utente escluso. |
snippet.userBannedDetails.bannedUserDetails.channelId |
string L'ID canale YouTube dell'utente escluso. |
snippet.userBannedDetails.bannedUserDetails.channelUrl |
string L'URL del canale YouTube dell'utente escluso. |
snippet.userBannedDetails.bannedUserDetails.displayName |
string Il nome visualizzato del canale YouTube dell'utente escluso. |
snippet.userBannedDetails.bannedUserDetails.profileImageUrl |
string L'avatar del canale YouTube dell'utente escluso. |
snippet.userBannedDetails.banType |
string Il tipo di esclusione. I valori validi per questa proprietà sono:
|
snippet.userBannedDetails.banDurationSeconds |
unsigned long La durata dell'esclusione. Questa proprietà è presente solo se il valore della proprietà snippet.userBannedDetails.banType è temporary . |
snippet.memberMilestoneChatDetails |
object Questo oggetto contiene dettagli su un evento traguardo membro. È presente solo se il tipo di messaggio è memberMilestoneChatEvent . |
snippet.memberMilestoneChatDetails.userComment |
string Il commento aggiunto dall'abbonato a questo messaggio di fedeltà al canale. Questo campo è vuoto per i messaggi senza commento del membro. |
snippet.memberMilestoneChatDetails.memberMonth |
unsigned integer Il numero totale di mesi (arrotondati) in cui lo spettatore è abbonato al canale che gli ha permesso di raggiungere questo traguardo. Si tratta dello stesso numero di mesi mostrato agli utenti di YouTube. |
snippet.memberMilestoneChatDetails.memberLevelName |
string Il nome del livello a cui lo spettatore è membro. I nomi dei livelli sono definiti dal canale YouTube che offre l'abbonamento. In alcune situazioni questo campo non viene compilato. |
snippet.newSponsorDetails |
object Questo oggetto contiene dettagli sull'evento Annuncio dei nuovi membri. Viene impostato solo se il tipo è newSponsorEvent . "Membro" è il termine per "sponsor".
|
snippet.newSponsorDetails.memberLevelName |
string Il nome del livello a cui lo spettatore è membro. I nomi dei livelli sono definiti dal canale YouTube che offre l'abbonamento. In alcuni casi, questo campo non viene compilato. |
snippet.newSponsorDetails.isUpgrade |
bool Indica se lo spettatore ha appena eseguito l'upgrade da un livello inferiore. Per gli spettatori che non erano abbonati al momento dell'acquisto, il valore del campo è false .
|
snippet.superChatDetails |
object Questo oggetto contiene dettagli su un evento Superchat. È presente solo se il tipo di messaggio è superChatEvent . |
snippet.superChatDetails.amountMicros |
unsigned long Importo di acquisto, in micro della valuta di acquisto. Ad esempio, se l'importo di acquisto è un dollaro, il valore della proprietà snippet.amountMicros sarà 1000000 . |
snippet.superChatDetails.currency |
string La valuta in cui è stato effettuato l'acquisto. Il valore è un codice valuta ISO 4217. |
snippet.superChatDetails.amountDisplayString |
string Una stringa, ad esempio $1.00 , che contiene l'importo di acquisto e la valuta. La stringa deve essere mostrata all'utente. |
snippet.superChatDetails.userComment |
string Il commento aggiunto dall'utente a questo evento Superchat. |
snippet.superChatDetails.tier |
unsigned integer Il livello per il messaggio a pagamento. Tieni presente che in una risorsa superChatEvent , la proprietà snippet.messageType contiene questo valore.Il livello si basa sull'importo speso per acquistare il messaggio. Determina inoltre il colore usato per evidenziare il messaggio nell'interfaccia utente della chat live, la lunghezza massima del messaggio e il periodo di tempo durante il quale 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 sui dettagli per l'acquisto di messaggi Superchat. Nell'elenco, il livello con l'importo di acquisto più basso è il livello 1, l'importo più basso successivo è il livello 2 e così via. |
snippet.superStickerDetails |
object Questo oggetto contiene dettagli su un evento Super Sticker. È presente solo se il tipo di messaggio è superStickerEvent . |
snippet.superStickerDetails.superStickerMetadata |
object Dettagli sul Super Sticker. |
snippet.superStickerDetails.superStickerMetadata.stickerId |
string Un ID univoco che identifica l'immagine dell'adesivo. Tieni presente che l'immagine viene visualizzata solo nel messaggio Super Sticker quando gli utenti visualizzano la finestra della chat su YouTube. Tuttavia, l'URL dell'immagine non è disponibile se si utilizza l'API. Solo come riferimento, puoi trovare gli ID Sticker correlati ai Super Sticker in questo file CSV. |
snippet.superStickerDetails.superStickerMetadata.altText |
string Una stringa di testo che descrive l'adesivo. Il campo snippet.superStickerDetails.superStickerMetadata.language identifica la lingua del testo. Quando chiami il metodo liveChatMessages.list , imposta il valore del parametro hl sulla lingua scelta per il testo. |
snippet.superStickerDetails.superStickerMetadata.language |
string La lingua del valore della proprietà snippet.superStickerDetails.superStickerMetadata.altText . |
snippet.superStickerDetails.amountMicros |
unsigned long Importo di acquisto, in micro della valuta di acquisto. Ad esempio, se l'importo di acquisto è un dollaro, il valore della proprietà snippet.amountMicros sarà 1000000 . |
snippet.superStickerDetails.currency |
string La valuta in cui è stato effettuato l'acquisto. Il valore è un codice valuta ISO 4217. |
snippet.superStickerDetails.amountDisplayString |
string Una stringa, ad esempio $1.00 , che contiene l'importo di acquisto e la valuta. La stringa deve essere mostrata all'utente. |
snippet.superStickerDetails.tier |
unsigned integer Il livello per il messaggio a pagamento. Tieni presente che in una risorsa superChatEvent , la proprietà snippet.messageType contiene questo valore.Il livello si basa sull'importo speso per acquistare il messaggio. Determina inoltre il colore usato per evidenziare il messaggio nell'interfaccia utente della chat live, la lunghezza massima del messaggio e il periodo di tempo durante il quale il messaggio rimane fissato nel riquadro di aggiornamento. I livelli di Superchat, che comprendono anche i Super Sticker, sono documentati nel Centro assistenza YouTube. Consulta la sezione espandibile sui dettagli per l'acquisto di messaggi Superchat. Nell'elenco, il livello con l'importo di acquisto più basso è il livello 1, l'importo inferiore successivo è il livello 2 e così via. |
snippet.pollDetails |
object Questo oggetto contiene dettagli su un evento sondaggio. È presente solo se il tipo di messaggio è pollEvent . |
snippet.pollDetails.metadata |
object Dettagli sull'evento sondaggio. |
snippet.pollDetails.metadata.options |
object Le opzioni disponibili nel sondaggio dal vivo. |
snippet.pollDetails.metadata.options.optionText |
string Il testo dell'opzione Sondaggio dal vivo. |
snippet.pollDetails.metadata.options.questionText |
string Il testo della domanda del sondaggio dal vivo. |
snippet.pollDetails.metadata.status |
enum Lo stato dell'evento con sondaggio dal vivo. I valori validi per questa proprietà sono:
|
snippet.membershipGiftingDetails |
object Questo oggetto contiene dettagli su un evento Regala un abbonamento. È presente solo se message type è membershipGiftingEvent . |
snippet.membershipGiftingDetails.giftMembershipsCount |
integer Il numero di abbonamenti regalo acquistati dall'utente. |
snippet.membershipGiftingDetails.giftMembershipsLevelName |
string Il nome del livello degli abbonamenti regalo acquistati dall'utente. I nomi dei livelli sono definiti dal canale YouTube che offre l'abbonamento. In alcuni casi, questo campo non viene compilato. |
snippet.giftMembershipReceivedDetails |
object Questo oggetto contiene dettagli su un evento Abbonamento regalo ricevuto. È presente solo se message type è giftMembershipReceivedEvent . |
snippet.giftMembershipReceivedDetails.memberLevelName |
string Il nome del livello a cui lo spettatore è membro. Questo valore corrisponde a snippet.membershipGiftingDetails.giftMembershipsLevelName del messaggio associato relativo alla funzionalità Regala un abbonamento. I nomi dei livelli sono definiti dal canale YouTube che offre l'abbonamento. In alcuni casi, questo campo non viene compilato. |
snippet.giftMembershipReceivedDetails.gifterChannelId |
string L'ID dell'utente che ha effettuato l'acquisto della funzionalità Regala un abbonamento. Questo valore corrisponde a snippet.authorChannelId del messaggio associato relativo alla funzionalità Regala un abbonamento. |
snippet.giftMembershipReceivedDetails.associatedMembershipGiftingMessageId |
string L'ID del messaggio relativo a Regala un abbonamento correlato a questo abbonamento regalo. Questo ID farà sempre riferimento a un messaggio il cui type è membershipGiftingEvent . |
authorDetails |
object L'oggetto authorDetails contiene ulteriori dettagli sull'utente che ha pubblicato questo messaggio. |
authorDetails.channelId |
string L'ID canale YouTube dell'autore. |
authorDetails.channelUrl |
string L'URL del canale YouTube dell'autore. |
authorDetails.displayName |
string Il nome visualizzato del canale YouTube dell'autore. |
authorDetails.profileImageUrl |
string L'URL dell'avatar del canale YouTube dell'autore. |
authorDetails.isVerified |
boolean Questo valore indica se l'identità dell'autore è stata verificata da YouTube. |
authorDetails.isChatOwner |
boolean Questo valore indica se l'autore è il proprietario della chat live. |
authorDetails.isChatSponsor |
boolean Questo valore indica se l'autore è uno sponsor della chat live. |
authorDetails.isChatModerator |
boolean Questo valore indica se l'autore è un moderatore della chat live. |