Method: files.list

Liste les fichiers de l'utilisateur.

Cette méthode accepte le paramètre q, qui est une requête de recherche combinant un ou plusieurs termes de recherche. Pour en savoir plus, consultez le guide Rechercher des fichiers et des dossiers.

Requête HTTP

GET https://www.googleapis.com/drive/v3/files

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
corpora

string

Corps des éléments (fichiers/documents) auxquels s'applique la requête. Les corps acceptés sont "user", "domain", "drive" et "allDrives". Pour plus d'efficacité, privilégiez "user" ou "drive" à "allDrives". Par défaut, la valeur de "corpora" est "user". Toutefois, cela peut varier en fonction du filtre défini via le paramètre "q".
corpus
(deprecated)

enum (Corpus)

Obsolète: source des fichiers à lister. Utilisez plutôt "corpora".
driveId

string

ID du Drive partagé à rechercher.
includeItemsFromAllDrives

boolean

Indique si les éléments de Mon Drive et des Drive partagés doivent être inclus dans les résultats.
includeTeamDriveItems
(deprecated)

boolean

Obsolète: utilisez includeItemsFromAllDrives à la place.
orderBy

string

Liste de clés de tri séparées par une virgule. Les clés valides sont les suivantes:

  • createdTime: date de création du fichier.
  • folder: ID du dossier. Ce champ est trié par ordre alphabétique.
  • modifiedByMeTime: date et heure de la dernière modification du fichier par l'utilisateur.
  • modifiedTime: date de la dernière modification du fichier par n'importe quel utilisateur.
  • name: nom du fichier. Ce champ est trié par ordre alphabétique (1, 12, 2, 22, etc.).
  • name_natural: nom du fichier. Ce champ est trié selon l'ordre naturel (1, 2, 12, 22, etc.).
  • quotaBytesUsed: nombre d'octets de quota de stockage utilisés par le fichier.
  • recency: code temporel le plus récent des champs de date et d'heure du fichier.
  • sharedWithMeTime: date et heure de partage du fichier avec l'utilisateur, le cas échéant.
  • starred: indique si l'utilisateur a ajouté une étoile au fichier.
  • viewedByMeTime: date et heure de la dernière consultation du fichier par l'utilisateur.

Par défaut, chaque clé est triée par ordre croissant, mais vous pouvez inverser l'ordre avec le modificateur "desc". Exemple d'utilisation: ?orderBy=folder,modifiedTime desc,name.
pageSize

integer

Nombre maximal de fichiers à renvoyer par page. Il est possible que des pages de résultats partielles ou vides s'affichent avant la fin de la liste des fichiers.
pageToken

string

Jeton permettant de poursuivre 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.
q

string

Requête permettant de filtrer les résultats des fichiers. Consultez le guide "Rechercher des fichiers et des dossiers" pour connaître la syntaxe compatible.
spaces

string

Liste des espaces à interroger dans les corpus, séparés par une virgule. Les valeurs acceptées sont "drive" et "appDataFolder".
supportsAllDrives

boolean

Indique si l'application à l'origine de la requête est compatible avec Mon Drive et les Drive partagés.
supportsTeamDrives
(deprecated)

boolean

Obsolète: utilisez supportsAllDrives à la place.
teamDriveId
(deprecated)

string

Obsolète: utilisez driveId à la place.
includePermissionsForView

string

Spécifie les autorisations de la vue supplémentaire à inclure dans la réponse. Seule la valeur "published" est acceptée.
includeLabels

string

Liste d'ID de libellés séparés par une virgule, à inclure dans la partie labelInfo de la réponse.

Corps de la requête

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

Corps de la réponse

Liste de fichiers.

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

Représentation JSON 
{
  "nextPageToken": string,
  "kind": string,
  "incompleteSearch": boolean,
  "files": [
    {
      object (File)
    }
  ]
}
Champs
nextPageToken

string

Jeton de page pour la page de fichiers suivante. Il est absent si la fin de la liste des fichiers a été 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.
kind

string

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

object (File)

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

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.appdata
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.meet.readonly
  • https://www.googleapis.com/auth/drive.metadata
  • https://www.googleapis.com/auth/drive.metadata.readonly
  • https://www.googleapis.com/auth/drive.photos.readonly
  • https://www.googleapis.com/auth/drive.readonly

Certains champs d'application sont soumis à des restrictions et nécessitent une évaluation de sécurité pour que votre application puisse les utiliser. Pour en savoir plus, consultez le guide d'autorisation.

Corpus

Enums
user Fichiers appartenant à l'utilisateur ou partagés avec lui
domain Fichiers partagés avec le domaine de l'utilisateur.