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

Returns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
siteSearchEngine

string

Required. The site search engine resource under which we fetch all the domain verification status. projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine.

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 siteSearchEngine.fetchDomainVerificationStatus call. Provide this to retrieve the subsequent page.

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

Request body

The request body must be empty.

Response body

Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "targetSites": [
    {
      object (TargetSite)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Fields
targetSites[]

object (TargetSite)

List of TargetSites containing the site verification status.
nextPageToken

string

A token that can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
totalSize

integer

The total number of items matching the request. This will always be populated in the response.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the siteSearchEngine resource:

  • discoveryengine.siteSearchEngines.fetchDomainVerificationStatus

For more information, see the IAM documentation.