- 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 |
Ensembles d'éléments (fichiers/documents) auxquels la requête s'applique. Les corps pris en charge sont "user", "domain", "drive" et "allDrives". Pour plus d'efficacité, préférez "user" ou "drive" à "allDrives". Par défaut, les corpus est défini 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é à rechercher. |
includeItemsFromAllDrives |
Indique si les éléments Mon Drive et les éléments des 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', 'modifyByMeTime', 'ModifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred' et 'viewedByMeTime'. Par défaut, chaque clé est triée dans l'ordre croissant, mais elle peut être inversée avec le modificateur "desc". Exemple d'utilisation: ?orderBy=folder,ModifyTime desc,name. |
pageSize |
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. |
pageToken |
Jeton permettant de poursuivre une requête de liste précédente sur la page suivante. Doit être défini sur la valeur "nextPageToken" de la réponse précédente. |
q |
Requête permettant de filtrer les résultats du fichier. Pour connaître la syntaxe à utiliser, consultez le guide "Rechercher des fichiers et des dossiers". |
spaces |
Liste d'espaces séparés par une virgule à interroger dans les corpus. 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 de vue supplémentaires à inclure dans la réponse. Seul l'état "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
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 ( |
Champs | |
---|---|
nextPageToken |
Jeton de page pour la page de fichiers suivante. Ce champ est absent 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. 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 différer. |
kind |
Identifie le type de ressource. Valeur: chaîne fixe |
incompleteSearch |
Indique si le processus de recherche était incomplet. Si la valeur est "true", certains résultats de recherche peuvent être manquants, car tous les documents n'ont pas fait l'objet d'une recherche. Cela peut se produire lorsque vous effectuez une recherche dans plusieurs Drive avec les corpus "allDrives", mais que tous les corpus n'ont pas pu être recherchés. Dans ce cas, il est conseillé aux clients de restreindre leur requête en choisissant un autre corpus, tel que "user" ou "drive". |
files[] |
Liste des fichiers. Si nextPageToken est renseigné, cette liste peut être incomplète et une page de résultats supplémentaire devra ê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.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 relatif aux autorisations.
Corpus
Enums | |
---|---|
user |
Fichiers appartenant à l'utilisateur ou partagés avec celui-ci |
domain |
Fichiers partagés avec le domaine de l'utilisateur. |