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

Obtiene una lista de TargetSites.

Solicitud HTTP


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

Las URL usan la sintaxis de transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. Es el nombre del recurso del motor de búsqueda del sitio principal, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine.

Si el llamador no tiene permiso para enumerar los TargetSites en este motor de búsqueda del sitio, independientemente de si existe o no esta rama, se devuelve un error de PERMISSION_DENIED.

Parámetros de consulta

Parámetros
pageSize

integer

Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado. El valor máximo es 1,000; valores superiores a 1,000 se convertirán en 1,000.

Si este campo es negativo, se devuelve un error INVALID_ARGUMENT.
pageToken

string

Un token de página, recibido desde una llamada targetSites.list anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a targetSites.list deben coincidir con la llamada que proporcionó el token de la página.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de ListTargetSitesResponse.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • discoveryengine.targetSites.list

Para obtener más información, consulta la documentación de IAM.