Quando effettui la tua prima richiesta di recupero dei messaggi della chat, l'API restituisce tutta la cronologia chat o tutta la cronologia, a seconda della durata della cronologia. I messaggi nella risposta sono ordinati dal meno recente al più recente.
- Il
nextPageToken
nella risposta fornisce un token che, nella richiesta successiva, identificherà l'insieme di risultati successivo che il client API dovrebbe recuperare. - La proprietà
pollingIntervalMillis
indica quanto tempo il client API deve attendere prima di richiedere risultati aggiuntivi.
pageToken
sul valore nextPageToken
e il server API restituisce ulteriori messaggi di chat, se disponibili. Anche in questo caso, i messaggi vengono ordinati dal meno recente al più recente.Casi d'uso comuni
Risorse richieste:
Richiesta HTTP
GET https://www.googleapis.com/youtube/v3/liveChat/messages
Parametri
Nella tabella seguente sono elencati i parametri supportati dalla query. Tutti i parametri elencati sono parametri di ricerca.
Parametri | ||
---|---|---|
Parametri obbligatori | ||
liveChatId |
string Il parametro liveChatId specifica l'ID della chat di cui verranno restituiti i messaggi. L'ID della chat dal vivo associato a una trasmissione viene restituito nella proprietà snippet.liveChatId della risorsa liveBroadcast . |
|
part |
string Il parametro part specifica le parti della risorsa liveChatMessage che verranno incluse nella risposta dell'API. I valori supportati sono id , snippet e authorDetails . |
|
Parametri facoltativi | ||
hl |
string Il parametro hl indica all'API di recuperare una stringa di visualizzazione della valuta localizzata per una specifica lingua dell'applicazione supportata dal sito web di YouTube. Ad esempio, in inglese la valuta viene mostrata come $1.50 , mentre in francese viene indicata come 1,50$ .Il valore del parametro deve essere un codice lingua incluso nell'elenco restituito dal metodo i18nLanguages.list . |
|
maxResults |
unsigned integer Il parametro maxResults specifica il numero massimo di messaggi che devono essere restituiti nel set di risultati. I valori accettabili sono compresi tra 200 e 2000 compresi. Il valore predefinito è 500 . |
|
pageToken |
string Il parametro pageToken identifica una pagina specifica nel set di risultati che deve essere restituita. In una risposta API, la proprietà nextPageToken identifica altre pagine che è possibile recuperare. |
|
profileImageSize |
unsigned integer Il parametro profileImageSize specifica le dimensioni delle immagini del profilo utente che devono essere restituite nel set di risultati. Le immagini sono quadrate. Il valore predefinito è 88 , ovvero le immagini saranno 88 x 88 px. I valori accettabili sono compresi nell'intervallo tra 16 e 720 inclusi. |
Corpo della richiesta
Non fornire un corpo della richiesta quando chiami questo metodo.
Risposta
In caso di esito positivo, questo metodo restituisce un corpo di risposta con la seguente struttura:
{ "kind": "youtube#liveChatMessageListResponse", "etag": etag, "nextPageToken": string, "pollingIntervalMillis": unsigned integer, "offlineAt": datetime, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ liveChatMessage Resource ] }
Proprietà
La tabella seguente definisce le proprietà che vengono visualizzate in questa risorsa:
Proprietà | |
---|---|
kind |
string Identifica il tipo di risorsa API. Il valore sarà youtube#liveChatMessageListResponse . |
etag |
etag L'Etag di questa risorsa. |
nextPageToken |
string Il token che può essere utilizzato come valore del parametro pageToken per recuperare la pagina successiva nel set di risultati. |
pollingIntervalMillis |
unsigned integer Il tempo, in millisecondi, che il client deve attendere prima di ripetere il polling per i nuovi messaggi della chat dal vivo. |
offlineAt |
datetime La data e l'ora in cui il live streaming sottostante è andato offline. Questa proprietà è presente solo se lo stream è già offline. Il valore è specificato nel formato ISO 8601 ( YYYY-MM-DDThh:mm:ss.sZ ). |
pageInfo |
object L'oggetto pageInfo incapsula le informazioni sul paging per il set di risultati. |
pageInfo.totalResults |
integer Il numero totale di risultati nel set di risultati. |
pageInfo.resultsPerPage |
integer Il numero di risultati inclusi nella risposta dell'API. |
items[] |
list Un elenco di messaggi della chat dal vivo. Ogni elemento nell'elenco è una risorsa liveChatMessage . |
Errori
La tabella seguente identifica i messaggi di errore che l'API potrebbe restituire in risposta a una chiamata a questo metodo. Per maggiori dettagli, consulta la documentazione sui messaggi di errore.
Tipo di errore | Dettagli errore | Descrizione |
---|---|---|
forbidden (403) |
forbidden |
Non hai le autorizzazioni necessarie per recuperare i messaggi per la chat dal vivo specificata. |
forbidden (403) |
liveChatDisabled |
La chat dal vivo non è abilitata per la trasmissione specificata. |
forbidden (403) |
liveChatEnded |
La chat dal vivo specificata non è più dal vivo. |
notFound (404) |
liveChatNotFound |
Impossibile trovare la chat dal vivo che stai cercando di recuperare. Controlla il valore del parametro liveChatId della richiesta per assicurarti che sia corretto. |
rateLimitExceeded |
rateLimitExceeded |
La richiesta è stata inviata troppo rapidamente dopo quella precedente. Questo errore si verifica quando le richieste API per recuperare i messaggi vengono inviate con maggiore frequenza rispetto alle frequenze di aggiornamento di YouTube, comportando inutilmente la larghezza di banda. |
Prova.
Usa APIs Explorer per chiamare questa API e visualizzare la richiesta e la risposta dell'API.