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

必須。入力専用。generatedUriPattern の生成元となるユーザー指定の URI パターン。
type

enum (Type)

ターゲット サイトのタイプ（サイトを含めるか除外するかなど）。
exactMatch

boolean

変更不可。false に設定すると、providedUriPattern を含むアドレスのすべてのページを含む uri_pattern が生成されます。true に設定すると、providedUriPattern と完全に一致する URI パターンが生成されます。providedUriPattern が特定のパターンである場合は、特定のページと完全に一致する URI パターンが生成されます。providedUriPattern は常に正規化され、検索エンジンで使用される URI パターンが生成されます。
generatedUriPattern

string

出力専用。これは、providedUriPattern に基づいてシステムで生成されます。
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 です。
VERIFIED サイトの所有権が確認されました。
UNVERIFIED サイトの所有権の確認が保留中であるか、確認に失敗しました。
EXEMPTED 確認が免除されているサイト（すべてのユーザーに公開されているウェブサイトなど）。

IndexingStatus

ターゲット サイトのインデックス登録ステータスの列挙型。

列挙型
INDEXING_STATUS_UNSPECIFIED デフォルトは SUCCEEDED です。
PENDING ターゲット サイトは更新キューに登録され、インデックス パイプラインによって取得されます。
FAILED ターゲット サイトのインデックス登録に失敗します。
SUCCEEDED ターゲット サイトがインデックスに登録されている。
DELETING 以前にインデックス登録されたターゲット サイトは、削除対象としてマークされています。これは移行状態です。インデックス登録解除が成功した場合はターゲット サイトが削除され、インデックス登録解除が失敗した場合は状態が 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.
}
Fields
共用体フィールド 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 を更新します。