Method: projects.locations.collections.dataStores.branches.documents.list

Ruft eine Liste von Document ab.

HTTP-Anfrage

GET https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/documents

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Ressourcenname des übergeordneten Zweigs, z. B. projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}. Verwenden Sie default_branch als Zweig-ID, um Dokumente unter dem Standardzweig aufzulisten.

Wenn der Aufrufer keine Berechtigung hat, Documents unter dieser Niederlassung aufzulisten, wird unabhängig davon, ob diese Niederlassung vorhanden ist oder nicht, der Fehler PERMISSION_DENIED zurückgegeben.

Abfrageparameter

Parameter
pageSize

integer

Maximale Anzahl der zurückzugebenden Document. Wenn nicht angegeben, lautet die Standardeinstellung 100. Der maximal zulässige Wert beträgt 1.000. Werte über 1.000 werden auf 1.000 festgelegt.

Wenn dieses Feld negativ ist, wird ein INVALID_ARGUMENT-Fehler zurückgegeben.
pageToken

string

Ein Seitentoken ListDocumentsResponse.next_page_token, das von einem vorherigen DocumentService.ListDocuments-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für DocumentService.ListDocuments bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von ListDocumentsResponse.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource parent:

  • discoveryengine.documents.list

Weitere Informationen finden Sie in der IAM-Dokumentation.