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

Obtém uma lista de TargetSites.

Pedido HTTP

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

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

Parâmetros de caminho

Parâmetros
parent

string

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

Se o autor da chamada não tiver autorização para listar TargetSites neste motor de pesquisa do site, independentemente de este ramo existir ou não, é devolvido um erro PERMISSION_DENIED.

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 targetSites.list anterior. Faculte este valor para obter a página seguinte.

Quando paginar, todos os outros parâmetros fornecidos a targetSites.list 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

Se for bem-sucedido, o corpo da resposta contém uma instância de ListTargetSitesResponse.

Â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 parent:

  • discoveryengine.targetSites.list

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