Comments: list

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

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 comment 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:
  • id
  • snippet
Filtres (spécifier 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 en cours de récupération. 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:Actuellement, YouTube n'accepte que les réponses aux commentaires de premier niveau. Toutefois, il est possible que les réponses aux questions soient acceptées ultérieurement.
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.
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.
textFormat string
Ce paramètre indique si l'API doit renvoyer des commentaires au format HTML ou en texte brut. La valeur par défaut est html.

Les valeurs autorisé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
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 commentaires correspondant 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+.
forbidden (403) forbidden Impossible de récupérer un ou plusieurs des commentaires demandés, car les autorisations sont insuffisantes. Il est possible que la demande ne soit pas autorisée correctement.
notFound (404) commentNotFound Impossible de trouver un ou plusieurs commentaires spécifiés. Vérifiez que les valeurs des paramètres id et parentId de la requête sont correctes.

Essayer

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