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

返回目标网站列表及其域名验证状态。目前，此方法只能在具有 BASIC_SITE_SEARCH 状态的数据存储区下调用。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
siteSearchEngine

string

必需。我们从中获取所有域名验证状态的网站搜索引擎资源。projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine。

查询参数

参数
pageSize

integer

请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定，服务器将选择合适的默认值。最大值为 1,000；大于 1,000 的值将被强制转换为 1,000。

如果此字段为负数，系统会返回 INVALID_ARGUMENT 错误。
pageToken

string

从之前的 siteSearchEngine.fetchDomainVerificationStatus 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时，提供给 siteSearchEngine.fetchDomainVerificationStatus 的所有其他参数必须与提供页面令牌的调用匹配。

请求正文

请求正文必须为空。

响应正文

SiteSearchEngineService.FetchDomainVerificationStatus 方法的响应消息。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "targetSites": [
    {
      object (TargetSite)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
字段
targetSites[]

object (TargetSite)

包含网站验证状态的 TargetSite 列表。
nextPageToken

string

可作为 pageToken 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。
totalSize

integer

与请求匹配的商品总数。此字段始终会填充在响应中。

授权范围

需要以下 OAuth 范围之一：

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

如需了解详情，请参阅 Authentication Overview。

IAM 权限

需要拥有 siteSearchEngine 资源的以下 IAM 权限：

  • discoveryengine.siteSearchEngines.fetchDomainVerificationStatus

如需了解详情，请参阅 IAM 文档。