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

Ensembles d'éléments (fichiers/documents) auxquels s'applique la requête. Les corps compatibles sont default, domain, drive et allDrives. Pour plus d'efficacité, privilégiez default ou drive à allDrives.

corpus
(deprecated)

enum (Corpus)

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

driveId

string

ID du Drive partagé à rechercher.

includeItemsFromAllDrives

boolean

Indique si les éléments Mon Drive et les éléments 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 d'afficher des pages de résultats partielles ou vides avant même d'atteindre 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: dernière fois que le fichier a été modifié par un utilisateur.
  • 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.
  • sharedWithMeDate: date à laquelle le fichier a été partagé avec l'utilisateur, le cas échéant.
  • starred : indique si l'utilisateur a ajouté une étoile au fichier.
  • title: titre du fichier Ce champ est trié par ordre alphabétique (1, 12, 2, 22, etc.).
  • title_natural: titre du fichier Ce champ est trié selon l'ordre naturel (1, 2, 12, 22, etc.).

Par défaut, chaque clé trie dans l’ordre croissant, mais peut être inversée avec la fonction « desc » modificateur. Exemple d'utilisation : ?orderBy=folder,modifiedDate desc,title.

Notez qu'une limite s'applique actuellement aux 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 la recherche de 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 supportsAllDrives à la place.

teamDriveId
(deprecated)

string

Obsolète: utilisez plutôt driveId.

includePermissionsForView

string

Spécifie les autorisations de la vue supplémentaire à 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
{
  "nextPageToken": string,
  "kind": string,
  "etag": string,
  "selfLink": string,
  "incompleteSearch": boolean,
  "nextLink": string,
  "items": [
    {
      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.

kind

string

Cette valeur est toujours drive#fileList.

etag

string

ETag de la liste.

items[]

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

Corpus

Enums
DEFAULT Éléments auxquels l'utilisateur a accédé.
DOMAIN Éléments partagés avec le domaine de l'utilisateur.