Method: comments.list

Liste les commentaires d'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 leur contenu d'origine.

pageSize

integer

Nombre maximal de commentaires à renvoyer par page.

pageToken

string

Jeton permettant de poursuivre une demande de liste précédente sur la page suivante. Elle 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-heure RFC 3339).

Corps de la requête

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

Corps de la réponse

Une liste de commentaires sur 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 doit être extraite.

nextPageToken

string

Jeton de la page de commentaires suivante. Ce paramètre sera absent si la fin de la liste de commentaires a été atteinte. Si le jeton est refusé pour une raison quelconque, il doit être supprimé, et la pagination doit être relancé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 être différents.

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.readonly

Certains champs d'application 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 relatif aux autorisations.