Comments: list

Restituisce un elenco di commenti che corrispondono ai parametri della richiesta API.

Impatto della quota: una chiamata a questo metodo ha un costo della quota di 1 unità.

Casi d'uso comuni

Richiesta

Richiesta HTTP

GET https://www.googleapis.com/youtube/v3/comments

Parametri

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

Parametri
Parametri obbligatori
part string
Il parametro part specifica un elenco separato da virgole di una o più proprietà delle risorse comment che verranno incluse nella risposta dell'API.

Il seguente elenco contiene i part nomi che puoi includere nel valore del parametro:
  • id
  • snippet
Filtri (specificare esattamente uno dei seguenti parametri)
id string
Il parametro id specifica un elenco separato da virgole di ID commento per le risorse recuperate. In una risorsa comment, la proprietà id specifica l'ID del commento.
parentId string
Il parametro parentId specifica l'ID del commento per il quale devono essere recuperate le risposte.

Nota: YouTube al momento supporta le risposte solo per i commenti di primo livello. Tuttavia, le risposte alle risposte potrebbero essere supportate in futuro.
Parametri facoltativi
maxResults unsigned integer
Il parametro maxResults specifica il numero massimo di elementi da restituire nel set di risultati.

Nota: l'uso di questo parametro non è supportato in combinazione con il parametro id. I valori accettati sono compresi tra 1 e 100. Il valore predefinito è 20.
pageToken string
Il parametro pageToken identifica una pagina specifica da restituire del set di risultati. In una risposta dell'API, la proprietà nextPageToken identifica la pagina successiva del risultato recuperabile.

Nota: l'uso di questo parametro non è supportato in combinazione con il parametro id.
textFormat string
Questo parametro indica se l'API deve restituire commenti formattati come HTML o come testo normale. Il valore predefinito è html.

I valori accettati sono:
  • html: restituisce i commenti in formato HTML. Questo è il valore predefinito.
  • plainText: restituisce i commenti in formato di testo normale.

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#commentListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    comment 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#commentListResponse.
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.
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 commenti che corrispondono ai criteri della richiesta.

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
badRequest (400) operationNotSupported Il filtro ID è compatibile soltanto con i commenti basati su Google+.
forbidden (403) forbidden Impossibile recuperare uno o più commenti richiesti a causa di autorizzazioni insufficienti. La richiesta potrebbe non essere autorizzata in modo adeguato.
notFound (404) commentNotFound Impossibile trovare uno o più commenti specificati. Controlla i valori dei parametri id e parentId della richiesta per assicurarti che siano corretti.

Prova.

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