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

Gets a list of TargetSites.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent site search engine resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine.

If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

Query parameters

Parameters
pageSize

integer

Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000.

If this field is negative, an INVALID_ARGUMENT error is returned.
pageToken

string

A page token, received from a previous targetSites.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to targetSites.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ListTargetSitesResponse.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.targetSites.list

For more information, see the IAM documentation.