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

Risorse richieste:

Richiesta HTTP

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

Parametri

Nella tabella seguente sono elencati i parametri supportati dalla query. Tutti i parametri elencati sono parametri di ricerca.

Parametri
Parametri obbligatori
part string
Il parametro part specifica un elenco separato da virgole di una o più proprietà comment della risorsa che la risposta dell'API includerà.

Il seguente elenco contiene i nomi part che puoi includere nel valore del parametro:
  • id
  • snippet
Filtri (specifica esattamente uno dei seguenti parametri)
id string
Il parametro id specifica un elenco separato da virgole di ID commento per le risorse che vengono 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 recuperare le risposte.

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

Nota: questo parametro non è supportato per l'utilizzo in combinazione con il parametro id. I valori accettabili sono compresi tra 1 e 100 compresi. Il valore predefinito è 20.
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 la pagina successiva del risultato che è possibile recuperare.

Nota: questo parametro non è supportato per l'utilizzo 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 accettabili sono:
  • html: restituisce i commenti in formato HTML. Questo è il valore predefinito.
  • plainText: restituisce i commenti in formato testo normale.

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#commentListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    comment 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#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 maggiori dettagli, consulta la documentazione sui messaggi di errore.

Tipo di errore Dettagli errore Descrizione
badRequest (400) operationNotSupported Il filtro ID è compatibile solo con i commenti basati su Google+.
forbidden (403) forbidden Impossibile recuperare uno o più dei commenti richiesti a causa di autorizzazioni insufficienti. La richiesta potrebbe non essere autorizzata correttamente.
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.