Renvoie une liste de fils de commentaires qui correspondent aux paramètres de requête de l'API.
Impact du quota:un appel à cette méthode a un coût de quota de 1 unité.
Cas d'utilisation courants
Demande
Requête HTTP :
GET https://www.googleapis.com/youtube/v3/commentThreads
Paramètres
Le tableau suivant répertorie les paramètres compatibles avec cette requête. Tous les paramètres listés sont des paramètres de requête.
Paramètres | ||
---|---|---|
Réglages obligatoires | ||
part |
string Le paramètre part spécifie une liste d'une ou de plusieurs propriétés de ressources commentThread que la réponse de l'API devra séparer par une virgule.La liste suivante contient les noms part que vous pouvez inclure dans la valeur du paramètre:
|
|
Filtres (spécifier exactement l'un des paramètres suivants) | ||
allThreadsRelatedToChannelId |
string Le paramètre allThreadsRelatedToChannelId indique à l'API de renvoyer tous les fils de commentaires associés à la chaîne spécifiée. La réponse peut inclure des commentaires sur la chaîne ou sur ses vidéos. |
|
channelId |
string Le paramètre channelId indique à l'API de renvoyer les fils de commentaires contenant des commentaires sur la chaîne spécifiée. (La réponse ne s'applique pas aux commentaires laissés sur les vidéos mises en ligne par la chaîne.) |
|
id |
string Le paramètre id spécifie une liste d'ID de fils de commentaires séparés par des virgules pour les ressources qui doivent être récupérées. |
|
videoId |
string Le paramètre videoId indique à l'API de renvoyer les fils de commentaires associés à l'ID vidéo spécifié. |
|
Paramètres facultatifs | ||
maxResults |
unsigned integer Le paramètre maxResults spécifie le nombre maximal d'éléments qui doivent être renvoyés dans l'ensemble de résultats.Remarque:Ce paramètre ne peut pas être utilisé conjointement avec le paramètre id . Les valeurs autorisées vont de 1 à 100 , inclus. La valeur par défaut est 20 . |
|
moderationStatus |
string Ce paramètre ne peut être utilisé que dans une requête correctement autorisée. Définissez ce paramètre pour limiter les fils de commentaires renvoyés à un état de modération particulier. Remarque:Ce paramètre ne peut pas être utilisé avec le paramètre id . La valeur par défaut est published .Les valeurs autorisées sont les suivantes :
|
|
order |
string Le paramètre order spécifie l'ordre dans lequel la réponse de l'API doit répertorier les fils de commentaires. Les valeurs valides sont les suivantes:
id .
|
|
pageToken |
string Le paramètre pageToken identifie une page spécifique de l'ensemble de résultats à renvoyer. Dans une réponse d'API, la propriété nextPageToken identifie la page suivante du résultat pouvant être récupérée.Remarque : Ce paramètre ne peut pas être utilisé conjointement avec le paramètre id . |
|
searchTerms |
string Le paramètre searchTerms indique à l'API de limiter la réponse de l'API afin qu'elle ne contienne que des commentaires contenant les termes de recherche spécifiés.Remarque:Ce paramètre n'est pas compatible avec le paramètre id . |
|
textFormat |
string Définissez la valeur de ce paramètre sur html ou plainText pour indiquer à l'API de renvoyer les commentaires laissés par les utilisateurs au format HTML ou en texte brut. La valeur par défaut est html .Les valeurs autorisées sont les suivantes :
|
Corps de la requête
Ne fournissez pas de corps de requête lorsque vous appelez cette méthode.
Réponse
Si la requête aboutit, cette méthode renvoie un corps de réponse présentant la structure suivante :
{ "kind": "youtube#commentThreadListResponse", "etag": etag, "nextPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ commentThread Resource ] }
Propriétés
Le tableau suivant définit les propriétés qui apparaissent dans cette ressource:
Propriétés | |
---|---|
kind |
string Identifie le type de ressource de l'API. La valeur sera youtube#commentThreadListResponse . |
etag |
etag ETag de cette ressource. |
nextPageToken |
string Jeton pouvant être utilisé comme valeur du paramètre pageToken pour extraire la page suivante de l'ensemble de résultats. |
pageInfo |
object L'objet pageInfo encapsule les informations de pagination pour l'ensemble de résultats. |
pageInfo.totalResults |
integer Nombre total de résultats dans l'ensemble de résultats. |
pageInfo.resultsPerPage |
integer Nombre de résultats inclus dans la réponse de l'API. |
items[] |
list Liste de fils de commentaires qui correspondent aux critères de la requête. |
Erreurs
Le tableau suivant identifie les messages d'erreur que l'API pourrait renvoyer en réponse à un appel à cette méthode. Veuillez consulter la documentation sur les messages d'erreur pour en savoir plus.
Type d'erreur | Détails de l'erreur | Description |
---|---|---|
badRequest (400) |
operationNotSupported |
Le filtre d'ID est uniquement compatible avec les commentaires basés sur Google+. |
badRequest (400) |
processingFailure |
Le serveur d'API n'a pas pu traiter la requête. Bien qu'il s'agisse d'une erreur temporaire, cela indique généralement que l'entrée de la requête n'est pas valide. Vérifiez la structure de la ressource commentThread dans le corps de la requête pour vous assurer qu'elle est valide. |
forbidden (403) |
commentsDisabled |
Les commentaires de la vidéo identifiée par le paramètre videoId ont désactivé les commentaires. |
forbidden (403) |
forbidden |
Impossible de récupérer un ou plusieurs fils de commentaires demandés en raison d'autorisations insuffisantes. Il est possible que la demande ne soit pas autorisée correctement. |
notFound (404) |
channelNotFound |
La chaîne identifiée par le paramètre channelId ou allThreadsRelatedToChannelId est introuvable. |
notFound (404) |
commentThreadNotFound |
Impossible de trouver un ou plusieurs fils de commentaires spécifiés. Vérifiez que les valeurs du paramètre id de la requête sont correctes. |
notFound (404) |
videoNotFound |
La vidéo identifiée par le paramètre videoId est introuvable. |
Essayer
Utilisez APIs Explorer pour appeler cette API et afficher la requête API et la réponse.