Method: files.list

Listet die Dateien des Nutzers auf.

Für diese Methode ist der Parameter q zulässig. Dabei handelt es sich um eine Suchanfrage, die einen oder mehrere Suchbegriffe kombiniert. Weitere Informationen finden Sie im Hilfeartikel Nach Dateien und Ordnern suchen.

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/Dokumente), auf die die Abfrage angewendet wird. Unterstützte Entitäten sind „user“, „domain“, „drive“ und „allDrives“. Verwenden Sie aus Effizienzgründen „user“ oder „drive“ anstelle von „allDrives“. Standardmäßig ist „corpora“ auf „user“ festgelegt. Das kann sich jedoch je nach Filter ändern, der über den Parameter „q“ festgelegt wird.

corpus
(deprecated)

enum (Corpus)

Nicht mehr unterstützt: Die Quelle der Dateien, die aufgelistet werden sollen. Verwenden Sie stattdessen „corpora“.

driveId

string

ID der geteilten Ablage, in der gesucht werden soll.

includeItemsFromAllDrives

boolean

Ob sowohl Elemente aus „Meine Ablage“ als auch aus geteilten Ablagen in den Ergebnissen berücksichtigt 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: Das Datum und die Uhrzeit, zu dem 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: Das Datum, an 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 nach der natürlichen Sortierreihenfolge sortiert, also 1, 2, 12, 22.
  • quotaBytesUsed: Die Anzahl der Speicherkontingent-Byte, die von der Datei verwendet werden.
  • recency: Der aktuelle Zeitstempel aus den Datums-/Uhrzeitfeldern der Datei.
  • sharedWithMeTime: Wann die Datei für den Nutzer freigegeben wurde, sofern zutreffend.
  • starred: Gibt an, ob der Nutzer die Datei mit einem Stern markiert hat.
  • viewedByMeTime: Der Zeitpunkt, zu dem der Nutzer die Datei zuletzt aufgerufen hat.

Die Sortierung erfolgt standardmäßig in aufsteigender Reihenfolge, kann aber mit dem Modifikator „desc“ umgekehrt werden. Beispiel: ?orderBy=folder,modifiedTime desc,name.

pageSize

integer

Die maximale Anzahl von Dateien, die pro Seite zurückgegeben werden sollen. Teilweise oder leere Ergebnisseiten sind möglich, auch wenn das Ende der Dateiliste noch nicht erreicht wurde.

pageToken

string

Das Token, mit dem eine vorherige Listenanfrage auf der nächsten Seite fortgesetzt wird. Dieser sollte auf den Wert „nextPageToken“ aus der vorherigen Antwort festgelegt sein.

q

string

Eine Abfrage zum Filtern der Dateiergebnisse. Informationen zur unterstützten Syntax finden Sie im Leitfaden „Nach Dateien und Ordnern suchen“.

spaces

string

Eine durch Kommas getrennte Liste der Gruppenbereiche, die in den Corpora abgefragt werden sollen. Unterstützte Werte sind „drive“ und „appDataFolder“.

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 der zusätzlichen Ansicht in der Antwort enthalten sein sollen. Nur „veröffentlicht“ wird unterstützt.

includeLabels

string

Eine durch Kommas getrennte Liste von Label-IDs, 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
{
  "nextPageToken": string,
  "kind": string,
  "incompleteSearch": boolean,
  "files": [
    {
      object (File)
    }
  ]
}
Felder
nextPageToken

string

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

kind

string

Gibt an, um welche Art von Ressource es sich handelt. Wert: der feste String "drive#fileList".

files[]

object (File)

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

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, damit Ihre App sie verwenden kann. Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

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.