- Requête HTTP
- Paramètres de requête
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- Corpus
- Essayer
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 |
Corps des éléments (fichiers/documents) auxquels la requête s'applique. Les corps compatibles sont "user", "domain", "drive" et "allDrives". Préférez l'utilisateur à "allDrive" pour plus d'efficacité. Par défaut, les corpus sont définis sur "user". Toutefois, cela peut changer en fonction du filtre défini via le paramètre "q". |
corpus |
Obsolète: source des fichiers à répertorier. Utilisez plutôt "corpora". |
driveId |
ID du Drive partagé dans lequel effectuer la recherche. |
includeItemsFromAllDrives |
Indique si les éléments Mon Drive et les Drive partagés doivent être inclus dans les résultats. |
includeTeamDriveItems |
Obsolète: utilisez plutôt |
orderBy |
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'. Par défaut, chaque clé est triée par ordre croissant, mais l'inverse peut être annulé avec le modificateur "desc". Exemple d'utilisation: ?orderBy=folder,ModifiedTime desc,name. |
pageSize |
Nombre maximal de fichiers à renvoyer par page. Des pages de résultats partielles ou vides sont possibles avant même la fin de la liste de fichiers. |
pageToken |
Jeton permettant de poursuivre une requête de liste précédente sur la page suivante. Il doit être défini sur la valeur de "nextPageToken" de la réponse précédente. |
q |
Requête de filtrage des résultats du fichier. Consultez le guide "Rechercher des fichiers et des dossiers" pour connaître la syntaxe à utiliser. |
spaces |
Liste d'espaces à interroger dans les corpus, séparés par une virgule. Les valeurs acceptées sont "drive" et "appDataFolder". |
supportsAllDrives |
Indique si l'application à l'origine de la demande est compatible avec Mon Drive et les Drive partagés. |
supportsTeamDrives |
Obsolète: utilisez plutôt |
teamDriveId |
Obsolète: utilisez plutôt |
includePermissionsForView |
Spécifie les autorisations supplémentaires de la vue à inclure dans la réponse. Seul "publié" est accepté. |
includeLabels |
Liste d'ID de libellés séparés par une virgule à inclure dans la partie |
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
Liste de fichiers.
Représentation JSON |
---|
{
"nextPageToken": string,
"kind": string,
"incompleteSearch": boolean,
"files": [
{
object ( |
Champs | |
---|---|
nextPageToken |
Jeton de page pour la page de fichiers suivante. Elle sera absente si la fin de la liste des fichiers est 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 |
Identifie le type de ressource de cette valeur. Valeur: chaîne fixe |
incompleteSearch |
Indique si le processus de recherche est incomplet. Si la valeur est "true", certains résultats de recherche peuvent être manquants, car tous les documents n'ont pas été recherchés. Cela peut se produire lorsque vous recherchez plusieurs lecteurs avec les corpus "allDrives", mais que ceux-ci n'ont pas pu être recherchés. Dans ce cas, nous recommandons aux clients d'affiner leur requête en choisissant un corpus différent, par exemple "utilisateur" ou "drive". |
files[] |
Liste de fichiers. Si nextPageToken est renseigné, cette liste peut être incomplète et une page supplémentaire de résultats doit être récupérée. |
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 sur les autorisations.
Corpus
Enums | |
---|---|
user |
Fichiers appartenant à l'utilisateur ou partagés avec celui-ci |
domain |
Fichiers partagés avec le domaine de l'utilisateur. |