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, der eine Suchanfrage mit einem oder mehreren Suchbegriffen enthält.

Mit dieser Methode werden standardmäßig alle Dateien zurückgegeben, einschließlich der Dateien im Papierkorb. Wenn Sie nicht möchten, dass sich Dateien im Papierkorb in der Liste befinden, verwenden Sie den Anfrageparameter 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

Inhalte von Elementen (Dateien oder Dokumente), auf die sich die Abfrage bezieht. Folgende Körper werden unterstützt:

  • user
  • domain
  • drive
  • allDrives

Aus Effizienzgründen sollten Sie user oder drive gegenüber allDrives bevorzugen. 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)

Veraltet: Die Quelle der aufzulistenden Dateien. Verwenden Sie stattdessen corpora.
driveId

string

ID der geteilten Ablage, die durchsucht werden soll.
includeItemsFromAllDrives

boolean

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

boolean

Verworfen: Verwenden Sie stattdessen includeItemsFromAllDrives.
orderBy

string

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

  • createdTime: Wann die Datei erstellt wurde.
  • folder: Die Ordner-ID. Dieses Feld wird alphabetisch sortiert.
  • modifiedByMeTime: Der Zeitpunkt, zu dem die Datei zuletzt vom Nutzer geändert wurde.
  • modifiedTime: Der Zeitpunkt, zu dem die Datei zuletzt von jemandem geändert wurde.
  • name: Der Name der Datei. Dieses Feld wird alphabetisch sortiert, also 1, 12, 2, 22.
  • name_natural: Der Name der Datei. Dieses Feld wird mit natürlicher Sortierung sortiert, also 1, 2, 12, 22.
  • quotaBytesUsed: Die Anzahl der vom Speicherplatzkontingent verwendeten Byte für die Datei.
  • recency: Der letzte Zeitstempel aus den Datums- und Uhrzeitfeldern der Datei.
  • sharedWithMeTime: Gibt an, wann die Datei für den Nutzer freigegeben wurde, sofern zutreffend.
  • starred: Gibt an, ob der Nutzer die Datei mit einem Sternchen markiert hat.
  • viewedByMeTime: Der Zeitpunkt, zu dem die Datei zuletzt vom Nutzer aufgerufen wurde.

Die Sortierung erfolgt standardmäßig aufsteigend, kann aber mit dem Modifikator desc umgekehrt werden. Beispiel für die Verwendung: ?orderBy=folder,modifiedTime desc,name.
pageSize

integer

Die maximale Anzahl von Dateien, die pro Seite zurückgegeben werden sollen. Auch bevor das Ende der Dateiliste erreicht ist, können teilweise oder leere Ergebnisseiten auftreten.
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 Dateien und Ordner 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

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

boolean

Verworfen: Verwenden Sie stattdessen supportsAllDrives.
teamDriveId
(deprecated)

string

Verworfen: 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 mit IDs von Labels, die im labelInfo-Teil der Antwort enthalten sein sollen.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Eine Liste von Dateien.

Wenn der Vorgang erfolgreich abgeschlossen wurde, 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 es sollte eine zusätzliche Seite mit Ergebnissen abgerufen werden.
nextPageToken

string

Das Seitentoken für die nächste Seite mit Dateien. Dieser Parameter ist nicht vorhanden, wenn das Ende der Dateiliste erreicht wurde. Wenn das Token aus irgendeinem Grund abgelehnt wird, sollte es verworfen und die Paginierung mit der ersten Ergebnisseite neu gestartet werden. Das Seitentoken ist in der Regel mehrere Stunden lang gültig. Wenn jedoch neue Artikel hinzugefügt oder entfernt werden, können sich die erwarteten Ergebnisse ändern.
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.