LiveChatMessages: list

Elenca i messaggi della chat dal vivo relativi a una chat specifica.

Quando effettui la prima richiesta di recupero dei messaggi di chat, l'API restituisce una parte o tutta la cronologia chat, a seconda della sua durata. I messaggi nella risposta vengono ordinati dal meno recente al più recente.

• Il nextPageToken nella risposta fornisce un token che, nella richiesta successiva, identificherà il successivo insieme di risultati che il client API deve recuperare.
• La proprietà pollingIntervalMillis indica il tempo di attesa del client API prima di richiedere risultati aggiuntivi.

Quando richiedi risultati aggiuntivi, imposti il parametro pageToken sul valore nextPageToken e il server API restituisce messaggi di chat aggiuntivi, se disponibili. Ancora una volta, all'interno di quel set di risultati, i messaggi vengono ordinati dal meno recente al più recente.

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 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 saranno 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 supportata dal sito web di YouTube. Ad esempio, in inglese la valuta verrebbe visualizzata come $1.50, mentre in francese sarebbe 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 accettati sono compresi tra 200 e 2000. Il valore predefinito è 500.
pageToken	string Il parametro pageToken identifica una pagina specifica da restituire del set di risultati. In una risposta dell'API, la proprietà nextPageToken identifica altre pagine che è possibile recuperare.
profileImageSize	unsigned integer Il parametro profileImageSize consente di specificare le dimensioni delle immagini del profilo utente che devono essere restituite nel set di risultati. Le immagini sono quadrate. Il valore predefinito è 88, il che significa che le immagini saranno 88 x 88 px. I valori accettati sono compresi tra 16 e 720 inclusi.

Corpo della richiesta

Non fornire il corpo della richiesta quando chiami questo metodo.

Risposta

Se l'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
  ]
}

Proprietà

La tabella seguente definisce le proprietà 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 eseguire nuovamente il polling per i nuovi messaggi della chat live.
offlineAt	datetime La data e l'ora in cui il live streaming sottostante è stato 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 live. 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 ulteriori dettagli, consulta la documentazione relativa ai messaggi di errore.

Tipo di errore	Dettagli errore	Descrizione
forbidden (403)	forbidden	Non hai le autorizzazioni necessarie per recuperare i messaggi per la chat live specificata.
forbidden (403)	liveChatDisabled	La chat live non è attivata per la trasmissione specificata.
forbidden (403)	liveChatEnded	La chat live specificata non è più attiva.
notFound (404)	liveChatNotFound	Impossibile trovare la chat live che stai tentando di recuperare. Verifica che il valore del parametro liveChatId della richiesta sia corretto.
rateLimitExceeded	rateLimitExceeded	La richiesta è stata inviata troppo rapidamente dopo la richiesta precedente. Questo errore si verifica quando le richieste API per recuperare i messaggi vengono inviate più spesso delle frequenze di aggiornamento di YouTube, sprecando inutilmente larghezza di banda.

Prova.

Usa APIs Explorer per chiamare questa API e visualizzare la richiesta e la risposta dell'API.