REST Resource: projects.locations.collections.dataStores.siteSearchEngine.targetSites

资源：TargetSite

SiteSearchEngine 的目标网站。

JSON 表示法 
{
  "name": string,
  "providedUriPattern": string,
  "type": enum (Type),
  "exactMatch": boolean,
  "generatedUriPattern": string,
  "rootDomainUri": string,
  "siteVerificationInfo": {
    object (SiteVerificationInfo)
  },
  "indexingStatus": enum (IndexingStatus),
  "updateTime": string,
  "failureReason": {
    object (FailureReason)
  }
}
字段
name

string

仅限输出。目标网站的完全限定资源名称。projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine/targetSites/{targetSite} target_site_id 由系统生成。
providedUriPattern

string

必需。仅限输入。用户提供的 URI 模式，用于生成 generatedUriPattern。
type

enum (Type)

目标网站的类型，例如，网站是要包含还是排除。
exactMatch

boolean

不可变。如果设置为 false，则会生成一个 uri_pattern，以包含地址中包含 providedUriPattern 的所有网页。如果设置为 true，系统会生成一个 uri_pattern，尝试与 providedUriPattern 完全匹配，或者如果 providedUriPattern 是特定的，则仅与特定网页匹配。providedUriPattern 始终会进行标准化处理，以生成供搜索引擎使用的 URI 模式。
generatedUriPattern

string

仅限输出。这是根据 providedUriPattern 由系统生成的。
rootDomainUri

string

仅限输出。providedUriPattern 的根网域。
siteVerificationInfo

object (SiteVerificationInfo)

仅限输出。网站所有权和有效性验证状态。
indexingStatus

enum (IndexingStatus)

仅限输出。索引编制状态。
updateTime

string (Timestamp format)

仅限输出。目标网站的上次更新时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
failureReason

object (FailureReason)

仅限输出。失败原因。

类型

可能的目标网站类型。

枚举
TYPE_UNSPECIFIED 此值未使用。在这种情况下，服务器行为默认为 Type.INCLUDE。
INCLUDE 包含目标网站。
EXCLUDE 排除目标网站。

SiteVerificationInfo

高级网站搜索中目标网站的验证信息。

JSON 表示法 
{
  "siteVerificationState": enum (SiteVerificationState),
  "verifyTime": string
}
字段
siteVerificationState

enum (SiteVerificationState)

网站验证状态，用于指明所有权和有效性。
verifyTime

string (Timestamp format)

最新的网站验证时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

SiteVerificationState

网站验证状态。

枚举
SITE_VERIFICATION_STATE_UNSPECIFIED 默认值为 VERIFIED。
VERIFIED 网站所有权已通过验证。
UNVERIFIED 网站所有权正在等待验证或验证失败。
EXEMPTED 免于验证的网站，例如面向所有人开放的公共网站。

IndexingStatus

目标网站的索引编制状态枚举。

枚举
INDEXING_STATUS_UNSPECIFIED 默认值为 SUCCEEDED。
PENDING 目标网站位于更新队列中，并将由索引流水线拾取。
FAILED 目标网站无法编入索引。
SUCCEEDED 目标网站已被编入索引。
DELETING 之前已编入索引的目标网站已被标记为待删除。此状态表示正在转换，最终结果为：1. 如果取消编入索引成功，则删除目标网站；2. 如果取消编入索引失败，则状态恢复为 SUCCEEDED。
CANCELLABLE 目标网站更改正在等待处理，但可以取消。
CANCELLED 目标网站更改已取消。

FailureReason

网站搜索索引编制失败原因。

JSON 表示法 
{

  // Union field failure can be only one of the following:
  "quotaFailure": {
    object (QuotaFailure)
  }
  // End of list of possible types for union field failure.
}
字段
联合字段 failure。失败原因。failure 只能是下列其中一项：
quotaFailure

object (QuotaFailure)

由于配额不足，因此操作失败。

QuotaFailure

由于配额不足，因此操作失败。

JSON 表示法 
{
  "totalRequiredQuota": string
}
字段
totalRequiredQuota

string (int64 format)

此数字用于估算相应项目成功完成索引编制所需的总配额。

方法

batchCreate

 批量创建 TargetSite。

create

 创建 TargetSite。

delete

 删除 TargetSite。

get

 获取 TargetSite。

list

 获取 TargetSite 的列表。

patch

 更新 TargetSite。