Method: comments.list

Affiche la liste des commentaires d'un fichier. Pour en savoir plus, consultez Gérer les commentaires et les réponses.

Obligatoire : le paramètre fields doit être défini. Pour renvoyer les champs exacts dont vous avez besoin, consultez la section Renvoyer des champs spécifiques.

Requête HTTP

GET https://www.googleapis.com/drive/v3/files/{fileId}/comments

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
fileId

string

ID du fichier.

Paramètres de requête

Paramètres
includeDeleted

boolean

Indique s'il faut inclure les commentaires supprimés. Les commentaires supprimés n'incluent pas leur contenu d'origine.
pageSize

integer

Nombre maximal de commentaires à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur.

Si aucune valeur n'est spécifiée, 20 commentaires au maximum sont renvoyés.

La valeur maximale est 100. Les valeurs supérieures sont réduites à 100.
pageToken

string

Jeton permettant de continuer une requête de liste précédente sur la page suivante. Cette valeur doit être définie sur la valeur de "nextPageToken" de la réponse précédente.
startModifiedTime

string

Valeur minimale de "modifiedTime" pour les commentaires de résultat (date et heure RFC 3339).

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Liste des commentaires d'un fichier.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "comments": [
    {
      object (Comment)
    }
  ],
  "kind": string,
  "nextPageToken": string
}
Champs
comments[]

object (Comment)

Liste des commentaires. Si nextPageToken est renseigné, cette liste peut être incomplète et une page de résultats supplémentaire doit être extraite.
kind

string

Identifie le type de ressource. Valeur : chaîne fixe "drive#commentList".
nextPageToken

string

Jeton de page pour la page de commentaires suivante. Ce paramètre est absent si la fin de la liste de commentaires a été atteinte. Si le jeton est refusé pour quelque raison que ce soit, il doit être ignoré et la pagination doit être redémarrée à partir de la première page de résultats. Le jeton de page est généralement valide pendant plusieurs heures. Toutefois, si des éléments sont ajoutés ou supprimés, les résultats attendus peuvent être différents.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.meet.readonly
  • https://www.googleapis.com/auth/drive.readonly

Certains niveaux d'accès sont limités et nécessitent une évaluation de sécurité pour que votre application puisse les utiliser. Pour en savoir plus, consultez le guide sur l'autorisation.