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

Devolve a lista de sites de destino com o respetivo estado de validação de domínio. Atualmente, só é possível chamar este método na loja de dados com o estado BASIC_SITE_SEARCH.

Pedido HTTP

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

O URL usa a sintaxe de transcodificação de gRPC.

Parâmetros de caminho

Parâmetros
siteSearchEngine

string

Obrigatório. O recurso do motor de pesquisa do site no qual obtemos todo o estado de validação do domínio. projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine.

Parâmetros de consulta

Parâmetros
pageSize

integer

Tamanho da página solicitado. O servidor pode devolver menos itens do que o pedido. Se não for especificado, o servidor escolhe uma predefinição adequada. O valor máximo é 1000. Os valores superiores a 1000 são convertidos para 1000.

Se este campo for negativo, é devolvido um erro INVALID_ARGUMENT.
pageToken

string

Um token de página, recebido de uma chamada siteSearchEngine.fetchDomainVerificationStatus anterior. Faculte este valor para obter a página seguinte.

Quando paginar, todos os outros parâmetros fornecidos a siteSearchEngine.fetchDomainVerificationStatus têm de corresponder à chamada que forneceu o token da página.

Corpo do pedido

O corpo do pedido tem de estar vazio.

Corpo da resposta

Mensagem de resposta para o método SiteSearchEngineService.FetchDomainVerificationStatus.

Se for bem-sucedido, o corpo da resposta contém dados com a seguinte estrutura:

Representação JSON 
{
  "targetSites": [
    {
      object (TargetSite)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Campos
targetSites[]

object (TargetSite)

Lista de TargetSites que contêm o estado de validação do site.
nextPageToken

string

Um token que pode ser enviado como pageToken para obter a página seguinte. Se este campo for omitido, não existem páginas subsequentes.
totalSize

integer

O número total de itens que correspondem ao pedido. Este campo é sempre preenchido na resposta.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso siteSearchEngine:

  • discoveryengine.siteSearchEngines.fetchDomainVerificationStatus

Para mais informações, consulte a documentação do IAM.