CommentThreads: list

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

Impatto sulla 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/commentThreads

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à della risorsa commentThread che la risposta dell'API includerà.

Il seguente elenco contiene i nomi delle 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.
id string
Il parametro id specifica un elenco separato da virgole di ID dei thread di commenti per le risorse da recuperare.
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 da restituire nel set di risultati.

Nota: questo parametro non è supportato per l'uso in combinazione con il parametro id. I valori accettabili sono compresi tra 1 e 100, inclusi. Il valore predefinito è 20.
moderationStatus string
Questo parametro può essere utilizzato solo in una richiesta autorizzata correttamente. Imposta questo parametro per limitare i thread di commenti restituiti a un determinato stato di moderazione.

Nota: questo parametro non è supportato per l'uso in combinazione con il parametro id. Il valore predefinito è published.

I valori accettabili sono:
  • heldForReview : recupera i thread di 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 è in attesa di revisione.
  • likelySpam : recupera i thread di commenti classificati come probabili spam. Un thread di commenti può essere incluso nella risposta se il commento di primo livello o almeno una delle risposte a quel commento è considerato probabile spam.
  • published : recupera i thread di commenti pubblicati. Questo è il valore predefinito. Un thread di commenti può essere incluso nella risposta se il commento di primo livello è stato pubblicato.
order string
Il parametro order specifica l'ordine in cui la risposta dell'API deve elencare i thread di commenti. I valori ammessi sono:
  • time : i thread di commenti sono ordinati per ora. Questo è il comportamento predefinito.
  • relevance : i thread di commenti sono ordinati per pertinenza.
Nota: questo parametro non è supportato per l'uso in combinazione con il parametro id.
pageToken string
Il parametro pageToken identifica una pagina specifica nel set di risultati da restituire. In una risposta dell'API, la proprietà nextPageToken identifica la pagina successiva del risultato che può essere recuperata.

Nota: Questo parametro non è supportato per l'uso 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 includono i termini di ricerca specificati.

Nota: questo parametro non è supportato per l'uso 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 di 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 della 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 appaiono 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 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 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 dei 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 correttamente la richiesta. Sebbene possa trattarsi di un errore temporaneo, in genere 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 I commenti sono disattivati per il video identificato dal parametro videoId.
forbidden (403) forbidden Non è possibile 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 allThreadsRelatedToChannelId.
notFound (404) commentThreadNotFound Impossibile trovare uno o più thread di commenti specificati. Controlla i valori del parametro id della richiesta per assicurarti che siano corretti.
notFound (404) videoNotFound Impossibile trovare il video identificato dal parametro videoId.

Prova

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