Method: projects.locations.collections.dataStores.siteSearchEngine.fetchDomainVerificationStatus

Renvoie la liste des sites cibles avec leur état de validation du domaine. Cette méthode ne peut être appelée que pour un data store dont l'état est BASIC_SITE_SEARCH pour le moment.

Requête HTTP

GET https://discoveryengine.googleapis.com/v1/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:fetchDomainVerificationStatus

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
siteSearchEngine

string

Obligatoire. Ressource du moteur de recherche sur le site à partir de laquelle nous récupérons l'état de validation du domaine. projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine.

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 siteSearchEngine.fetchDomainVerificationStatus précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à siteSearchEngine.fetchDomainVerificationStatus 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

Message de réponse pour la méthode SiteSearchEngineService.FetchDomainVerificationStatus.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "targetSites": [
    {
      object (TargetSite)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Champs
targetSites[]

object (TargetSite)

Liste des TargetSites contenant l'état de validation du site.
nextPageToken

string

Jeton pouvant être envoyé en tant que pageToken pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.
totalSize

integer

Nombre total d'éléments correspondant à la requête. Cette information sera toujours fournie dans la réponse.

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 siteSearchEngine :

  • discoveryengine.siteSearchEngines.fetchDomainVerificationStatus

Pour en savoir plus, consultez la documentation IAM.