Questa pagina è stata tradotta dall'API Cloud Translation.

CommentThreads: list

Restituisce un elenco di thread 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/commentThreads

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à `commentThread` della risorsa che la risposta dell'API includerà. Il seguente elenco contiene i nomi `part` che puoi includere nel valore del parametro: `id` `replies` `snippet`
Filtri (specifica esattamente uno dei seguenti parametri)
`allThreadsRelatedToChannelId`	`string` Il parametro `allThreadsRelatedToChannelId` indica all'API di restituire tutti i thread di commenti associati al canale specificato. La risposta può includere commenti sul canale o sui video del canale.
`channelId`	`string` Il parametro `channelId` indica all'API di restituire i thread di commenti contenenti commenti sul canale specificato. La risposta non includerà i commenti lasciati sui video caricati dal canale.
`id`	`string` Il parametro `id` specifica un elenco separato da virgole di ID thread di commenti per le risorse che devono essere recuperate.
`videoId`	`string` Il parametro `videoId` indica all'API di restituire i thread di commenti associati all'ID video specificato.
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`.
`moderationStatus`	`string` Questo parametro può essere utilizzato solo in una richiesta autorizzata appropriata. Imposta questo parametro per limitare i thread di commenti restituiti a un determinato stato di moderazione. Nota: questo parametro non è supportato per l'utilizzo in combinazione con il parametro `id`. Il valore predefinito è `published`. I valori accettabili sono: `heldForReview` - Recupera i thread dei commenti in attesa di revisione da parte di un moderatore. Un thread di commenti può essere incluso nella risposta se il commento di primo livello o almeno una delle risposte a quel commento sono in attesa di revisione. `likelySpam`: recupera i thread di commenti classificati come potenzialmente spam. È possibile includere nella risposta un thread di commenti se è probabile che si tratti di un commento di primo livello o di almeno una delle risposte a quel commento. `published`: recupera i thread dei commenti pubblicati. Questo è il valore predefinito. Un thread di commenti può essere incluso nella risposta se è stato pubblicato il suo commento di primo livello.
`order`	`string` Il parametro `order` specifica l'ordine in cui la risposta API deve elencare i thread di commenti. I valori validi sono: `time`: i thread di commenti sono ordinati per tempo. Questo è il comportamento predefinito. `relevance`: i thread dei commenti sono ordinati in base alla pertinenza. Nota: questo parametro non è supportato per l'utilizzo in combinazione con il parametro `id`.
`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`.
`searchTerms`	`string` Il parametro `searchTerms` indica all'API di limitare la risposta dell'API in modo che contenga solo i commenti che contengono i termini di ricerca specificati. Nota: questo parametro non è supportato per l'utilizzo in combinazione con il parametro `id`.
`textFormat`	`string` Imposta il valore di questo parametro su `html` o `plainText` per indicare all'API di restituire i commenti lasciati dagli utenti in formato html o in 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#commentThreadListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    commentThread 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#commentThreadListResponse`.
`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 thread 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+.
`badRequest (400)`	`processingFailure`	Il server API non è riuscito a elaborare la richiesta. Anche se può trattarsi di un errore temporaneo, di solito indica che l'input della richiesta non è valido. Controlla la struttura della risorsa `commentThread` nel corpo della richiesta per assicurarti che sia valida.
`forbidden (403)`	`commentsDisabled`	Il video identificato dal parametro `videoId` ha disattivato i commenti.
`forbidden (403)`	`forbidden`	Impossibile recuperare uno o più thread di commenti richiesti a causa di autorizzazioni insufficienti. La richiesta potrebbe non essere autorizzata correttamente.
`notFound (404)`	`channelNotFound`	Impossibile trovare il canale identificato dal parametro `channelId` o `allThreadsRelatedToChannelId`.
`notFound (404)`	`commentThreadNotFound`	Impossibile trovare uno o più thread di commenti specificati. Controlla i valori del parametro `id` della richiesta per assicurarti che sia corretto.
`notFound (404)`	`videoNotFound`	Impossibile trovare il video identificato dal parametro `videoId`.

Prova.

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