Method: files.list

Listet die Dateien des Nutzers auf. Weitere Informationen finden Sie unter Nach Dateien und Ordnern suchen.

Diese Methode akzeptiert den Parameter q, eine Suchanfrage, die einen oder mehrere Suchbegriffe kombiniert.

Standardmäßig werden mit dieser Methode alle Dateien zurückgegeben, einschließlich der Dateien im Papierkorb. Wenn Sie nicht möchten, dass Dateien im Papierkorb in der Liste angezeigt werden, verwenden Sie den Suchparameter trashed=false, um sie aus den Ergebnissen zu entfernen.

HTTP-Anfrage

GET https://www.googleapis.com/drive/v3/files

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
corpora

string

Gibt eine Sammlung von Elementen (Dateien oder Dokumente) an, auf die sich die Abfrage bezieht. Unterstützte Elemente sind:

  • user
  • domain
  • drive
  • allDrives

Verwenden Sie aus Effizienzgründen user oder drive anstelle von allDrives. Standardmäßig ist „corpora“ auf user festgelegt. Dies kann sich jedoch je nach Filter ändern, der über den Parameter q festgelegt wurde. Weitere Informationen finden Sie unter Dateiorganisation.
corpus
(deprecated)

enum (Corpus)

Nicht mehr unterstützt: Die Quelle der aufzulistenden Dateien. Verwenden Sie stattdessen corpora.
driveId

string

ID der geteilten Ablage, in der gesucht werden soll.
includeItemsFromAllDrives

boolean

Gibt an, ob Elemente aus „Meine Ablage“ und aus geteilten Ablagen in die Ergebnisse aufgenommen werden sollen.
includeTeamDriveItems
(deprecated)

boolean

Nicht mehr unterstützt: Verwenden Sie stattdessen includeItemsFromAllDrives.
orderBy

string

Eine durch Kommas getrennte Liste von Sortierschlüsseln. Gültige Schlüssel sind:

  • createdTime: Zeitpunkt, zu dem die Datei erstellt wurde. Verwenden Sie diesen Schlüssel nicht für Abfragen in großen Elementesammlungen, da dies zu Zeitüberschreitungen oder anderen Problemen führen kann. Verwenden Sie für die zeitbezogene Sortierung in großen Elementesammlungen stattdessen modifiedTime desc.
  • folder: Die Ordner-ID. Dieses Feld wird alphabetisch sortiert.
  • modifiedByMeTime: Zeitpunkt, zu dem die Datei zuletzt vom Nutzer geändert wurde.
  • modifiedTime: Zeitpunkt, zu dem die Datei zuletzt von einer Person geändert wurde.
  • name: Der Name der Datei. Dieses Feld wird alphabetisch sortiert, z. B. 1, 12, 2, 22.
  • name_natural: Der Name der Datei. Dieses Feld wird natürlich sortiert, z. B. 1, 2, 12, 22.
  • quotaBytesUsed: Die Anzahl der Speicherkontingent-Byte, die von der Datei verwendet werden.
  • recency: Der letzte Zeitstempel aus den Datums- und Uhrzeitfeldern der Datei.
  • sharedWithMeTime: Zeitpunkt, zu dem die Datei für den Nutzer freigegeben wurde (falls zutreffend).
  • starred: Gibt an, ob der Nutzer die Datei mit einem Stern markiert hat.
  • viewedByMeTime: Zeitpunkt, zu dem die Datei zuletzt vom Nutzer angesehen wurde.

Standardmäßig wird nach jedem Schlüssel aufsteigend sortiert. Mit dem Modifikator desc kann die Sortierreihenfolge umgekehrt werden. Beispiel: ?orderBy=folder,modifiedTime desc,name.
pageSize

integer

Die maximale Anzahl der Dateien, die pro Seite zurückgegeben werden sollen. Seiten können auch vor dem Ende der Dateiliste unvollständig oder leer sein.

Wenn nicht angegeben, werden für geteilte Ablagen maximal 100 Dateien und für nicht freigegebene Ablagen die gesamte Liste der Dateien zurückgegeben.

Der Maximalwert ist 100. Werte über 100 werden auf 100 geändert.
pageToken

string

Das Token zum Fortsetzen einer vorherigen Listenanfrage auf der nächsten Seite. Dieser Wert sollte auf den Wert von nextPageToken aus der vorherigen Antwort festgelegt werden.
q

string

Eine Abfrage zum Filtern der Dateiergebnisse. Informationen zur unterstützten Syntax finden Sie unter Nach Dateien und Ordnern suchen.
spaces

string

Eine durch Kommas getrennte Liste von Bereichen, die in den Korpora abgefragt werden sollen. Unterstützte Werte sind drive und appDataFolder. Weitere Informationen finden Sie unter Dateiorganisation.
supportsAllDrives

boolean

Gibt an, ob die anfragende Anwendung sowohl „Meine Ablage“ als auch geteilte Ablagen unterstützt.
supportsTeamDrives
(deprecated)

boolean

Nicht mehr unterstützt: Verwenden Sie stattdessen supportsAllDrives.
teamDriveId
(deprecated)

string

Nicht mehr unterstützt: Verwenden Sie stattdessen driveId.
includePermissionsForView

string

Gibt an, welche Berechtigungen für zusätzliche Ansichten in die Antwort aufgenommen werden sollen. Nur published wird unterstützt.
includeLabels

string

Eine durch Kommas getrennte Liste der IDs von Labels, die in den Teil labelInfo der Antwort aufgenommen werden sollen.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Eine Liste von Dateien.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "files": [
    {
      object (File)
    }
  ],
  "nextPageToken": string,
  "kind": string,
  "incompleteSearch": boolean
}
Felder
files[]

object (File)

Die Liste der Dateien. Wenn nextPageToken ausgefüllt ist, ist diese Liste möglicherweise unvollständig und eine weitere Seite mit Ergebnissen sollte abgerufen werden.
nextPageToken

string

Das Seitentoken für die nächste Seite mit Dateien. Dieses Token ist nicht vorhanden, wenn das Ende der Dateiliste erreicht wurde. Wenn das Token aus irgendeinem Grund abgelehnt wird, sollte es verworfen werden und die Paginierung sollte ab der ersten Ergebnisseite neu gestartet werden. Das Seitentoken ist in der Regel mehrere Stunden gültig. Wenn jedoch neue Elemente hinzugefügt oder entfernt werden, können sich die erwarteten Ergebnisse unterscheiden.
kind

string

Kennzeichnet, welche Art von Ressource dies ist. Wert: der feste String "drive#fileList".

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • 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

Einige Bereiche sind eingeschränkt und erfordern eine Sicherheitsprüfung für Ihre App, damit sie verwendet werden können. Weitere Informationen finden Sie im Autorisierungsleitfaden.

Korpus

Enums
user Dateien, die dem Nutzer gehören oder für ihn freigegeben wurden.
domain Dateien, die für die Domain des Nutzers freigegeben wurden.