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 d'é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, les corpus sont définis sur "utilisateur". Cependant, il peut changer en fonction du filtre défini via le paramètre "q".

corpus
(deprecated)

enum (Corpus)

Obsolète: source des fichiers à répertorier. Utilisez plutôt des "corpors".

driveId

string

ID du Drive partagé à rechercher.

includeItemsFromAllDrives

boolean

Indique si les éléments Mon Drive et Drive partagés 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 "createTime", "folder", "ModifiedByMeTime", "ModifiedTime", "name", "name_natural", "quotaBytesUsed", "recency", "sharedWithMeTime", "starred" et "viewedByMeTime". Le tri sur chaque touche est effectué par défaut dans l'ordre croissant, mais il est possible d'annuler l'opération à l'aide du modificateur "desc". Exemple d'utilisation: ?orderBy=folder,ModifiedTime desc,name.

pageSize

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'avoir atteint la fin de la liste des fichiers.

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.

q

string

Requête permettant de filtrer les résultats du fichier. Consultez le guide "Rechercher des fichiers et des dossiers" pour connaître la syntaxe prise en charge.

spaces

string

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

supportsAllDrives

boolean

Indique si l'application à l'origine de la demande 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émentaire à inclure dans la réponse. Seul l'état "Publié" est accepté.

includeLabels

string

Liste des ID des étiquettes à inclure dans la partie labelInfo de la réponse, séparés par une virgule.

Corps de la requête

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

Corps de la réponse

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

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

Corpus

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