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

Obtient une liste de TargetSite.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de ressource du moteur de recherche sur le site parent, par exemple projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine.

Si l'appelant n'est pas autorisé à lister les TargetSites sous ce moteur de recherche de site, qu'il existe ou non, une erreur PERMISSION_DENIED est renvoyée.

Paramètres de requête

Paramètres
pageSize

integer

Taille de la page demandée. Le serveur peut renvoyer un nombre d'éléments inférieur à celui demandé. Si aucune valeur n'est spécifiée, le serveur sélectionne une valeur par défaut appropriée. La valeur maximale est 1 000. Les valeurs supérieures sont réduites à 1 000.

Si ce champ est négatif, une erreur INVALID_ARGUMENT est renvoyée.
pageToken

string

Jeton de page reçu d'un appel targetSites.list précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à targetSites.list doivent correspondre à l'appel ayant fourni le jeton de page.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de ListTargetSitesResponse.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • discoveryengine.targetSites.list

Pour en savoir plus, consultez la documentation IAM.