Method: comments.list

Liste les commentaires associés à un fichier.

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

Permet d'inclure ou non les commentaires supprimés. Les commentaires supprimés n'incluent pas le contenu original.
pageSize

integer

Nombre maximal de commentaires à renvoyer par page.
pageToken

string

Jeton permettant de poursuivre une requête de liste précédente sur la page suivante. Doit être défini sur la valeur de "nextPageToken". de la réponse précédente.
startModifiedTime

string

La valeur minimale de "modifyTime" pour les commentaires du résultat (date-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 ajoutés à 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 
{
  "kind": string,
  "comments": [
    {
      object (Comment)
    }
  ],
  "nextPageToken": string
}
Champs
kind

string

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

object (Comment)

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

string

Jeton de la page de commentaires suivante. Il ne s'affiche pas si la fin de la liste des commentaires est atteinte. Si le jeton est refusé pour une raison quelconque, il doit être supprimé 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 de nouveaux éléments sont ajoutés ou supprimés, les résultats attendus peuvent différer.

Champs d'application 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 champs d'application sont restreints et nécessitent une évaluation de sécurité pour que votre application puisse les utiliser. Pour en savoir plus, consultez le Guide relatif aux autorisations.