Una risorsa liveChatMessage
rappresenta un messaggio di chat in 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 relativo ai finanziamenti dei fan.
La funzionalità di chat dal vivo è abilitata per impostazione predefinita per le trasmissioni dal vivo ed è disponibile quando l'evento dal vivo è attivo. Al termine dell'evento, la chat live non è più disponibile per quell'evento.
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.
- inserire
- Aggiunge un messaggio a una chat dal vivo. 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 delle risorse
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 }, "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 della chat dal vivo 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 in cui il messaggio è stato pubblicato in origine. Il valore è specificato nel formato ISO 8601 ( YYYY-MM-DDThh:mm:ss.sZ ). |
snippet.hasDisplayContent |
boolean Indica se il messaggio ha contenuti da mostrare agli utenti. |
snippet.displayMessage |
string Contiene una stringa 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, nelle risorse di liveChatMessage non verranno più restituiti dettagli per gli 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 i dettagli del messaggio. È presente solo se il tipo di messaggio è textMessageEvent . |
snippet.textMessageDetails.messageText |
string Il messaggio dell'utente. |
snippet.messageDeletedDetails |
object Questo oggetto contiene i dettagli su un messaggio eliminato da un moderatore della chat o dal proprietario del canale della trasmissione dal vivo. È presente solo se il tipo di messaggio è messageDeletedEvent . |
snippet.messageDeletedDetails.deletedMessageId |
string L'ID che identifica in modo univoco il messaggio eliminato. Il valore corrisponde al valore della proprietà id del messaggio di testo originale. Ad esempio, se textMessageEvent ha un valore della proprietà id pari a 123 e quel messaggio viene successivamente eliminato, il valore snippet.messageDeletedDetails.deletedMessageId per quel messaggio sarà 123 .Se memorizzi i messaggi di chat nella cache 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 i dettagli su un utente che è stato escluso dalla chat. Contiene anche i dettagli sull'esclusione. Gli utenti possono essere esclusi temporaneamente o definitivamente da una chat. |
snippet.userBannedDetails.bannedUserDetails |
object Questo oggetto contiene informazioni sull'utente escluso. |
snippet.userBannedDetails.bannedUserDetails.channelId |
string L'ID del 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 i dettagli di un evento fedeltà al canale. È 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 un commento da parte del membro. |
snippet.memberMilestoneChatDetails.memberMonth |
unsigned integer Il numero totale di mesi (arrotondato per eccesso) in cui lo spettatore è stato abbonato e ha ricevuto questo messaggio di fedeltà al canale. Si tratta dello stesso numero di mesi che viene mostrato agli utenti di YouTube. |
snippet.memberMilestoneChatDetails.memberLevelName |
string Il nome del livello a cui lo spettatore è abbonato. I nomi dei livelli sono definiti dal canale YouTube che offre l'abbonamento. In alcuni casi, questo campo non viene compilato. |
snippet.newSponsorDetails |
object Questo oggetto contiene i dettagli sull'evento Annuncio per i nuovi membri. Viene impostato solo se il tipo è newSponsorEvent . "Membro" è il termine di "sponsor".
|
snippet.newSponsorDetails.memberLevelName |
string Il nome del livello a cui lo spettatore è abbonato. 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 il visualizzatore 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 L'importo di acquisto, in micro della valuta di acquisto. Ad esempio, se l'importo di acquisto è un dollaro, il valore della proprietà snippet.amountMicros è 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, come $1.00 , che contiene l'importo e la valuta di acquisto. La stringa deve essere visualizzata dall'utente. |
snippet.superChatDetails.userComment |
string Il commento aggiunto dall'utente a questo evento di 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 l'acquisto del messaggio. Determina inoltre il colore utilizzato per evidenziare il messaggio nell'interfaccia utente della chat live, la lunghezza massima del messaggio e il tempo per cui il messaggio rimane 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, l'importo inferiore 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 mostrata all'interno del messaggio Super Sticker solo quando gli utenti visualizzano la finestra della chat su YouTube. Tuttavia, l'URL dell'immagine non è disponibile utilizzando l'API. Solo come riferimento, puoi trovare gli ID degli adesivi e dei 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 L'importo di acquisto, in micro della valuta di acquisto. Ad esempio, se l'importo di acquisto è un dollaro, il valore della proprietà snippet.amountMicros è 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, come $1.00 , che contiene l'importo e la valuta di acquisto. La stringa deve essere visualizzata dall'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 l'acquisto del messaggio. Determina inoltre il colore utilizzato per evidenziare il messaggio nell'interfaccia utente della chat live, la lunghezza massima del messaggio e il tempo per cui il messaggio rimane in primo piano nel riquadro di aggiornamento. I livelli di Superchat, che coprono anche i Super Sticker, 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, l'importo inferiore successivo è il livello 2 e così via. |
snippet.pollDetails |
object Questo oggetto contiene i dettagli di un evento sondaggio. È presente solo se il tipo di messaggio è pollEvent . |
snippet.pollDetails.metadata |
object Dettagli sull'evento del sondaggio. |
snippet.pollDetails.metadata.options |
object Le opzioni disponibili nel sondaggio dal vivo. |
snippet.pollDetails.metadata.options.optionText |
string Il testo dell'opzione del 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 relativi a un evento Abbonamento regalo ricevuto. È presente solo se message type è giftMembershipReceivedEvent . |
snippet.giftMembershipReceivedDetails.memberLevelName |
string Il nome del livello a cui lo spettatore è abbonato. Corrisponde al valore 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 di Regala un abbonamento. Corrisponde al valore snippet.authorChannelId del messaggio associato relativo alla funzionalità Regala un abbonamento. |
snippet.giftMembershipReceivedDetails.associatedMembershipGiftingMessageId |
string L'ID del messaggio relativo alla funzionalità Regala un abbonamento correlato all'abbonamento regalo in questione. 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 dal vivo. |