CommentThreads: list

Renvoie une liste de fils de commentaires correspondant aux paramètres de la requête API.

Impact sur le quota : un appel à cette méthode coûte 1 unité de quota.

Cas d'utilisation courants

Requête

Requête HTTP

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

Paramètres

Le tableau suivant répertorie les paramètres acceptés par cette requête. Tous les paramètres listés sont des paramètres de requête.

Paramètres
Paramètres obligatoires
part string
Le paramètre part spécifie une liste d'une ou de plusieurs propriétés de ressource commentThread séparées par une virgule que la réponse de l'API inclura.

La liste suivante contient les noms part que vous pouvez inclure dans la valeur du paramètre :
  • id
  • replies
  • snippet
Filtres (spécifiez exactement l'un des paramètres suivants)
allThreadsRelatedToChannelId string
Le paramètre allThreadsRelatedToChannelId demande à l'API de renvoyer tous les fils de commentaires associés à la chaîne spécifiée.
id string
Le paramètre id spécifie une liste d'ID de fils de commentaires séparés par une virgule pour les ressources à récupérer.
videoId string
Le paramètre videoId demande à 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 à renvoyer dans l'ensemble de résultats.

Remarque : Ce paramètre ne peut pas être utilisé avec le paramètre id. Les valeurs acceptées sont comprises entre 1 et 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.

Voici les valeurs possibles :
  • heldForReview : récupère les fils de commentaires en attente de modération. Un fil de commentaires peut être inclus dans la réponse si le commentaire de premier niveau ou au moins l'une des réponses à ce commentaire sont en attente de modération.
  • likelySpam : récupère les fils de commentaires classés comme spam potentiel. Un fil de commentaires peut être inclus dans la réponse si le commentaire de premier niveau ou au moins l'une des réponses à ce commentaire sont considérés comme spam potentiel.
  • published : récupère les fils de commentaires publiés. Il s'agit de la valeur par défaut. Un fil de commentaires peut être inclus dans la réponse si son commentaire de premier niveau a été publié.
order string
Le paramètre order spécifie l'ordre dans lequel la réponse de l'API doit lister les fils de commentaires. Voici les valeurs possibles :
  • time : les fils de commentaires sont classés par date. Il s'agit du comportement par défaut.
  • relevance : les fils de commentaires sont classés par pertinence.
Remarque : Ce paramètre ne peut pas être utilisé avec le paramètre id.
pageToken string
Le paramètre pageToken identifie une page spécifique de l'ensemble de résultats à renvoyer. Dans une réponse de l'API, la propriété nextPageToken identifie la page de résultats suivante qui peut être récupérée.

Remarque : Ce paramètre ne peut pas être utilisé avec le paramètre id.
searchTerms string
Le paramètre searchTerms demande à l'API de limiter la réponse de l'API aux commentaires contenant les termes de recherche spécifiés.

Remarque : Ce paramètre ne peut pas être utilisé avec le paramètre id.
textFormat string
Définissez la valeur de ce paramètre sur html ou plainText pour demander à 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.

Voici les valeurs possibles :
  • html : renvoie les commentaires au format HTML. Il s'agit de la valeur par défaut.
  • plainText : renvoie les commentaires au format texte brut.

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 qui peut être utilisé comme valeur du paramètre pageToken pour récupérer la page suivante dans 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 des fils de commentaires correspondant aux critères de la requête.

Erreurs

Le tableau suivant identifie les messages d'erreur que l'API peut renvoyer en réponse à un appel à cette méthode. Pour en savoir plus, consultez la documentation sur les messages d'erreur.

Type d'erreur Détails de l'erreur Description
badRequest (400) operationNotSupported Le filtre id n'est compatible qu'avec les commentaires basés sur Google+.
badRequest (400) processingFailure Le serveur d'API n'a pas réussi à traiter la requête. Bien qu'il puisse s'agir d'une erreur temporaire, elle 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 sont désactivés pour la vidéo identifiée par le paramètre videoId.
forbidden (403) forbidden Un ou plusieurs des fils de commentaires demandés ne peuvent pas être récupérés en raison d'autorisations insuffisantes. La requête n'est peut-être pas correctement autorisée.
notFound (404) channelNotFound La chaîne identifiée par le paramètre allThreadsRelatedToChannelId est introuvable.
notFound (404) commentThreadNotFound Un ou plusieurs des fils de commentaires spécifiés sont introuvables. Vérifiez les valeurs du paramètre id de la requête pour vous assurer qu'elles sont correctes.
notFound (404) videoNotFound La vidéo identifiée par le paramètre videoId est introuvable.

Essayer

Utilisez l'APIs Explorer pour appeler cette API et afficher la requête et la réponse de l'API.