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/v2/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 default, domain, drive et allDrives. Préférez default ou drive à allDrives pour l'efficacité.
corpus
(deprecated)

enum (Corpus)

Obsolète : corps des éléments (fichiers/documents) auxquels s'applique la requête. Utilisez corpora à la place.
driveId

string

ID du Drive partagé dans lequel effectuer la recherche.
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 plutôt includeItemsFromAllDrives.
maxResults

integer

Nombre maximal de fichiers à renvoyer par page. Il est possible que les pages de résultats soient partielles ou vides avant même la fin de la liste des fichiers.
orderBy

string

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

  • createdDate : date de création du fichier.
  • folder : ID du dossier. Ce champ est trié par ordre alphabétique.
  • lastViewedByMeDate : date et heure de la dernière consultation du fichier par l'utilisateur.
  • modifiedByMeDate : date de la dernière modification du fichier par l'utilisateur.
  • modifiedDate : date et heure de la dernière modification du fichier par un utilisateur.
  • quotaBytesUsed : nombre d'octets du quota de stockage utilisés par le fichier.
  • recency : code temporel le plus récent des champs de date et d'heure du fichier.
  • sharedWithMeDate : 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.
  • title : titre du fichier. Ce champ est trié par ordre alphabétique (1, 12, 2, 22).
  • title_natural : titre du fichier. Ce champ est trié à l'aide de l'ordre de tri naturel (1, 2, 12, 22).

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,modifiedDate desc,title.

Notez qu'il existe actuellement une limite pour les utilisateurs disposant d'environ un million de fichiers, pour lesquels l'ordre de tri demandé est ignoré.
pageToken

string

Jeton de page pour les fichiers.
projection
(deprecated)

enum (Projection)

Obsolète : ce paramètre n'a aucune fonction.
q

string

Chaîne de requête pour rechercher des fichiers.
spaces

string

Liste des espaces à interroger, 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 plutôt supportsAllDrives.
teamDriveId
(deprecated)

string

Obsolète : utilisez plutôt driveId.
includePermissionsForView

string

Spécifie les autorisations de vues 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 
{
  "items": [
    {
      object (File)
    }
  ],
  "nextPageToken": string,
  "kind": string,
  "etag": string,
  "selfLink": string,
  "incompleteSearch": boolean,
  "nextLink": string
}
Champs
items[]

object (File)

Liste des fichiers. Si nextPageToken est renseigné, il est possible que cette liste soit incomplète et qu'une page de résultats supplémentaire doive être récupérée.
nextPageToken

string

Jeton de page pour la page de fichiers suivante. Ce champ 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.
kind

string

Cette valeur est toujours drive#fileList.
etag

string

ETag de la liste.

Champs d'application des autorisations

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

  • https://www.googleapis.com/auth/docs
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.appdata
  • https://www.googleapis.com/auth/drive.apps.readonly
  • 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 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
DEFAULT Éléments auxquels l'utilisateur a accédé.
DOMAIN Éléments partagés avec le domaine de l'utilisateur.