Method: projects.locations.collections.dataStores.siteSearchEngine.targetSites.list

Ruft eine Liste der TargetSite ab

HTTP-Anfrage

GET https://discoveryengine.googleapis.com/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/targetSites

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Ressourcenname der übergeordneten Suchmaschine für Websites, z. B. projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine.

Wenn der Aufrufer keine Berechtigung hat, TargetSites für diese Website-Suchmaschine aufzulisten, wird unabhängig davon, ob dieser Zweig vorhanden ist oder nicht, ein PERMISSION_DENIED-Fehler zurückgegeben.

Abfrageparameter

Parameter
pageSize

integer

Angeforderte Seitengröße. Der Server gibt möglicherweise weniger Elemente als angefordert zurück. Wenn kein Wert angegeben wurde, wählt der Server einen geeigneten Standardwert aus. Der Höchstwert liegt bei 1.000. Alle Werte darüber werden implizit in 1.000 umgewandelt.

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

string

Ein Seitentoken, das von einem vorherigen targetSites.list-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für targetSites.list bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

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

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.targetSites.list

Weitere Informationen finden Sie in der IAM-Dokumentation.