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

Recebe uma lista de TargetSites.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso do mecanismo de pesquisa do site pai, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine.

Se o autor da chamada não tiver permissão para listar TargetSites nesse mecanismo de pesquisa do site, independente de a ramificação existir ou não, um erro PERMISSION_DENIED será retornado.

Parâmetros de consulta

Parâmetros
pageSize

integer

Tamanho da página solicitada. O servidor pode retornar menos resultados do que o solicitado. Se não for especificado, o servidor escolherá um padrão apropriado. O valor máximo é 1.000. Valores maiores serão convertidos para 1.000.

Se esse campo for negativo, um erro INVALID_ARGUMENT será retornado.
pageToken

string

Um token de página recebido de uma chamada targetSites.list anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para targetSites.list precisam corresponder à chamada que forneceu o token da página.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de ListTargetSitesResponse.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • discoveryengine.targetSites.list

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