Comments: list

Renvoie une liste 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/comments

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 de une ou plusieurs propriétés de ressource comment 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
  • snippet
Filtres (spécifiez exactement l'un des paramètres suivants)
id string
Le paramètre id spécifie une liste d'ID de commentaires séparés par une virgule pour les ressources récupérées. Dans une ressource comment, la propriété id spécifie l'ID du commentaire.
parentId string
Le paramètre parentId spécifie l'ID du commentaire pour lequel les réponses doivent être récupérées.

Remarque : YouTube n'accepte actuellement les réponses que pour les commentaires de premier niveau. Toutefois, les réponses aux réponses pourront être acceptées à l'avenir.
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é conjointement avec le paramètre id. Les valeurs acceptées sont comprises entre 1 et 100 inclus. La valeur par défaut est 20.
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é conjointement avec le paramètre id.
textFormat string
Ce paramètre indique si l'API doit renvoyer les commentaires au format HTML ou en texte brut. La valeur par défaut est html.

Les valeurs acceptées sont les suivantes :
  • 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#commentListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    comment 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#commentListResponse.
etag etag
L'Etag de cette ressource.
nextPageToken string
Le 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
Le nombre total de résultats dans l'ensemble de résultats.
pageInfo.resultsPerPage integer
Le nombre de résultats inclus dans la réponse de l'API.
items[] list
Liste des 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 d'ID n'est compatible qu'avec les commentaires basés sur Google+.
forbidden (403) forbidden Un ou plusieurs des commentaires demandés ne peuvent pas être récupérés en raison d'autorisations insuffisantes. Il est possible que la requête ne soit pas correctement autorisée.
notFound (404) commentNotFound Un ou plusieurs des commentaires spécifiés sont introuvables. Vérifiez les valeurs des paramètres id et parentId de la requête pour vous assurer qu'elles sont correctes.

Essayer

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