Method: files.list

Affiche la liste des fichiers de l'utilisateur. Pour en savoir plus, consultez la page Rechercher des fichiers et des dossiers.

Cette méthode accepte le paramètre q, qui est une requête de recherche combinant un ou plusieurs termes de recherche.

Par défaut, cette méthode renvoie tous les fichiers, y compris ceux qui ont été placés dans la corbeille. Si vous ne souhaitez pas que les fichiers placés dans la corbeille apparaissent dans la liste, utilisez le paramètre de requête trashed=false pour les supprimer des résultats.

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

Spécifie une collection d'éléments (fichiers ou documents) auxquels la requête s'applique. Les éléments compatibles incluent les suivants :

  • user
  • domain
  • drive
  • allDrives

Pour plus d'efficacité, préférez user ou drive à allDrives. Par défaut, le corpus est défini sur user. Toutefois, cela peut changer en fonction du filtre défini via le paramètre q. Pour en savoir plus, consultez la section Organisation des fichiers.
corpus
(deprecated)

enum (Corpus)

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

string

ID du Drive partagé dans lequel effectuer la recherche.
includeItemsFromAllDrives

boolean

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

boolean

Obsolète : utilisez plutôt includeItemsFromAllDrives.
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. Évitez d'utiliser cette clé pour les requêtes sur de grandes collections d'éléments, car cela peut entraîner des délais d'attente ou d'autres problèmes. Pour le tri temporel sur de grandes collections d'éléments, utilisez plutôt modifiedTime desc.
  • folder : ID du dossier. Ce champ est trié par ordre alphabétique.
  • modifiedByMeTime : date 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).
  • name_natural : nom du fichier. Ce champ est trié par ordre naturel (1, 2, 12, 22).
  • quotaBytesUsed : nombre d'octets de quota de stockage utilisés par le fichier.
  • recency : horodatage le plus récent des champs de date et d'heure du fichier.
  • sharedWithMeTime : date à laquelle le fichier a été partagé avec l'utilisateur, le cas échéant.
  • starred : indique si l'utilisateur a activé le suivi du fichier.
  • viewedByMeTime : date à laquelle le fichier a été consulté pour la dernière fois par l'utilisateur.

Chaque clé est triée par ordre croissant par défaut, mais peut être inversée avec le modificateur desc. Exemple d'utilisation : ?orderBy=folder,modifiedTime desc,name.
pageSize

integer

Nombre maximal de fichiers à renvoyer par page. Les pages peuvent être partielles ou vides avant même d'atteindre la fin de la liste de fichiers.

Si aucune valeur n'est spécifiée, 100 fichiers au maximum sont renvoyés pour les Drive partagés, et la liste complète des fichiers pour les Drive non partagés.

La valeur maximale est 100. Les valeurs supérieures à 100 sont remplacées par 100.
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. Pour connaître la syntaxe compatible, consultez la page Rechercher des fichiers et des dossiers.
spaces

string

Liste des espaces à interroger dans les corpus, séparés par une virgule. Les valeurs acceptées sont drive et appDataFolder. Pour en savoir plus, consultez la section Organisation des fichiers.
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 plutôt supportsAllDrives.
teamDriveId
(deprecated)

string

Obsolète : utilisez plutôt driveId.
includePermissionsForView

string

Spécifie les autorisations de vue supplémentaires à inclure dans la réponse. Seule l'option 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 
{
  "files": [
    {
      object (File)
    }
  ],
  "nextPageToken": string,
  "kind": string,
  "incompleteSearch": boolean
}
Champs
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 récupérée.
nextPageToken

string

Jeton de page pour la page de fichiers suivante. Ce jeton est absent si la fin de la liste de fichiers a été atteinte. Si le jeton est rejeté 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 différer.
kind

string

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

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.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 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 d'autorisation.

Corpus

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