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 |
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 |
Nicht mehr unterstützt: Die Quelle der Dateien, die aufgelistet werden sollen. Verwenden Sie stattdessen „corpora“. |
driveId |
ID der geteilten Ablage, in der gesucht werden soll. |
includeItemsFromAllDrives |
Ob sowohl Elemente aus „Meine Ablage“ als auch aus geteilten Ablagen in den Ergebnissen berücksichtigt werden sollen. |
includeTeamDriveItems |
Verworfen. Verwenden Sie stattdessen |
orderBy |
Eine durch Kommas getrennte Liste von Sortierschlüsseln. Gültige Schlüssel sind:
Die Sortierung erfolgt standardmäßig in aufsteigender Reihenfolge, kann aber mit dem Modifikator „desc“ umgekehrt werden. Beispiel: |
pageSize |
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 |
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 |
Eine Abfrage zum Filtern der Dateiergebnisse. Informationen zur unterstützten Syntax finden Sie im Leitfaden „Nach Dateien und Ordnern suchen“. |
spaces |
Eine durch Kommas getrennte Liste der Gruppenbereiche, die in den Corpora abgefragt werden sollen. Unterstützte Werte sind „drive“ und „appDataFolder“. |
supportsAllDrives |
Ob die anfragende Anwendung sowohl „Meine Ablage“ als auch geteilte Ablagen unterstützt. |
supportsTeamDrives |
Verworfen. Verwenden Sie stattdessen |
teamDriveId |
Verworfen. Verwenden Sie stattdessen |
includePermissionsForView |
Gibt an, welche Berechtigungen der zusätzlichen Ansicht in der Antwort enthalten sein sollen. Nur „veröffentlicht“ wird unterstützt. |
includeLabels |
Eine durch Kommas getrennte Liste von Label-IDs, die in den Teil |
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 ( |
Felder | |
---|---|
nextPageToken |
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 |
Gibt an, um welche Art von Ressource es sich handelt. Wert: der feste String |
incompleteSearch |
Gibt an, ob die Suche unvollständig war. Wenn diese Option aktiviert ist, fehlen möglicherweise einige Suchergebnisse, da nicht in allen Dokumenten gesucht wurde. Das kann passieren, wenn Sie mit dem Korpus „allDrives“ in mehreren Laufwerken suchen, aber nicht in allen Korpora. In diesem Fall wird empfohlen, die Suchanfrage einzugrenzen, indem ein anderer Korpus wie „user“ oder „drive“ ausgewählt wird. |
files[] |
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. |