LiveChatMessages: list

Elenca i messaggi chat live per una chat specifica.

Quando effettui la prima richiesta per recuperare i messaggi chat, l'API restituisce una parte o tutta la cronologia chat, a seconda della sua lunghezza. I messaggi nella risposta sono ordinati dal più vecchio al più recente.
  • Il nextPageToken nella risposta fornisce un token che, nella richiesta successiva, identificherà il set di risultati successivo che il client API deve recuperare.
  • La proprietà pollingIntervalMillis indica per quanto tempo il client API deve attendere prima di richiedere risultati aggiuntivi.
Quando richiedi risultati aggiuntivi, imposta il parametro pageToken sul valore nextPageToken e il server API restituisce altri messaggi chat, se disponibili. Anche in questo set di risultati, i messaggi sono ordinati dal più vecchio al più recente.

Impatto sulla quota: una chiamata a questo metodo ha un costo di quota di 5 unità.

Casi d'uso comuni

Richiesta

Richiesta HTTP

GET https://www.googleapis.com/youtube/v3/liveChat/messages

Parametri

La tabella seguente elenca i parametri supportati da questa query. Tutti i parametri elencati sono parametri di query.

Parametri
Parametri obbligatori
liveChatId string
Il parametro liveChatId specifica l'ID della chat di cui verranno restituiti i messaggi. L'ID della chat live 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 lingua dell'applicazione specifica supportata dal sito web di YouTube. Ad esempio, in inglese la valuta viene visualizzata come $1.50, mentre in francese 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 da restituire nel set di risultati. I valori accettabili sono compresi tra 200 e 2000, inclusi. Il valore predefinito è 500.

La richiesta iniziale effettuata senza un token di continuazione conterrà solo i messaggi più recenti. Questo valore potrebbe essere inferiore a maxResults, se fornito.

L'API non recupera i messaggi precedenti a quelli restituiti dalla richiesta iniziale effettuata senza un token di continuazione.
pageToken string
Il parametro pageToken identifica una pagina specifica nel set di risultati da restituire. In una risposta dell'API, la proprietà nextPageToken identifica altre pagine che potrebbero essere recuperate.
profileImageSize unsigned integer
Il parametro profileImageSize specifica le dimensioni delle immagini del profilo utente da restituire nel set di risultati. Le immagini sono quadrate. Il valore predefinito è 88, il che significa che le immagini saranno di 88 x 88 pixel. I valori accettabili sono compresi nell'intervallo da 16 a 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 della 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
  ],
  "activePollItem": liveChatMessage Resource
}

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#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
La quantità di tempo, in millisecondi, che il client deve attendere prima di eseguire di nuovo il polling per i nuovi messaggi chat live.
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 di paginazione 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. Ogni elemento nell'elenco è una risorsa liveChatMessage.
activePollItem object
I dati del sondaggio nel messaggio. Ogni sondaggio è una risorsa liveChatMessage con il tipo pollEvent, che rappresenta un sondaggio attivo. Può esserci un solo sondaggio per chat.

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 disponi delle autorizzazioni necessarie per recuperare i messaggi per la chat live specificata.
forbidden (403) liveChatDisabled La chat live non è abilitata per la trasmissione specificata.
forbidden (403) liveChatEnded La chat live specificata non è più in diretta.
notFound (404) liveChatNotFound Impossibile trovare la chat live che stai tentando di recuperare. Controlla il valore del parametro liveChatId della richiesta per assicurarti che sia corretto.
rateLimitExceeded rateLimitExceeded La richiesta è stata inviata troppo rapidamente dopo la precedente. Questo errore si verifica quando le richieste API per recuperare i messaggi vengono inviate più frequentemente rispetto alle frequenze di aggiornamento di YouTube, il che spreca inutilmente la larghezza di banda.

Prova

Utilizza APIs Explorer per chiamare questa API e visualizzare la richiesta API e la risposta.