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，涵蓋位址包含所提供 UriPattern 的所有網頁。如果設為 true，系統會產生 uri_pattern，盡量與 providedUriPattern 完全相符，如果 providedUriPattern 是特定網頁，則只會產生該網頁的 uri_pattern。系統一律會將 providedUriPattern 正規化，產生搜尋引擎使用的 URI 模式。
generatedUriPattern

string

僅供輸出。這是系統根據提供的 UriPattern 生成的內容。
rootDomainUri

string

僅供輸出。providedUriPattern 的根網域。
siteVerificationInfo

object (SiteVerificationInfo)

僅供輸出。網站擁有權和有效性驗證狀態。
indexingStatus

enum (IndexingStatus)

僅供輸出。索引狀態。
updateTime

string (Timestamp format)

僅供輸出。目標網站的上次更新時間。

使用 RFC 3339，產生的輸出內容一律會經過 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 標準化，並使用 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 網站擁有權驗證完成。
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。