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

Resource: TargetSite

Situs target untuk SiteSearchEngine.

Representasi 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)
  }
}
Kolom
name

string

Hanya output. Nama resource yang sepenuhnya memenuhi syarat dari situs target. projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine/targetSites/{targetSite} target_site_id dibuat oleh sistem.

providedUriPattern

string

Wajib. Hanya input. Pola URI yang disediakan pengguna dari mana generatedUriPattern dibuat.

type

enum (Type)

Jenis situs target, misalnya, apakah situs akan disertakan atau dikecualikan.

exactMatch

boolean

Tidak dapat diubah. Jika disetel ke false, uri_pattern akan dibuat untuk menyertakan semua halaman yang alamatnya berisi providedUriPattern. Jika disetel ke benar (true), uri_pattern akan dibuat agar cocok persis dengan providedUriPattern atau hanya halaman tertentu jika providedUriPattern adalah halaman tertentu. providedUriPattern selalu dinormalisasi untuk membuat pola URI yang akan digunakan oleh mesin telusur.

generatedUriPattern

string

Hanya output. Ini dibuat oleh sistem berdasarkan providedUriPattern.

rootDomainUri

string

Hanya output. Domain root dari providedUriPattern.

siteVerificationInfo

object (SiteVerificationInfo)

Hanya output. Status verifikasi kepemilikan dan validitas situs.

indexingStatus

enum (IndexingStatus)

Hanya output. Status pengindeksan.

updateTime

string (Timestamp format)

Hanya output. Waktu terakhir situs target diperbarui.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

failureReason

object (FailureReason)

Hanya output. Alasan kegagalan.

Jenis

Kemungkinan jenis situs target.

Enum
TYPE_UNSPECIFIED Nilai ini tidak digunakan. Dalam hal ini, perilaku server ditetapkan secara default ke Type.INCLUDE.
INCLUDE Sertakan situs target.
EXCLUDE Mengecualikan situs target.

SiteVerificationInfo

Informasi verifikasi untuk situs target dalam penelusuran situs lanjutan.

Representasi JSON
{
  "siteVerificationState": enum (SiteVerificationState),
  "verifyTime": string
}
Kolom
siteVerificationState

enum (SiteVerificationState)

Status verifikasi situs yang menunjukkan kepemilikan dan validitas.

verifyTime

string (Timestamp format)

Waktu verifikasi situs terbaru.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

SiteVerificationState

Status verifikasi situs.

Enum
SITE_VERIFICATION_STATE_UNSPECIFIED Nilai defaultnya adalah VERIFIED.
VERIFIED Kepemilikan situs telah diverifikasi.
UNVERIFIED Kepemilikan situs menunggu verifikasi atau verifikasi gagal.
EXEMPTED Situs yang dikecualikan dari verifikasi, misalnya, situs publik yang terbuka untuk semua orang.

IndexingStatus

Enumerasi status pengindeksan situs target.

Enum
INDEXING_STATUS_UNSPECIFIED Nilai defaultnya adalah SUCCEEDED.
PENDING Situs target berada dalam antrean pembaruan dan akan diambil oleh pipeline pengindeksan.
FAILED Situs target gagal diindeks.
SUCCEEDED Situs target telah diindeks.
DELETING Situs target yang sebelumnya diindeks telah ditandai untuk dihapus. Ini adalah status transisi yang akan menghasilkan: 1. situs target dihapus jika penghapusan pengindeksan berhasil; 2. status kembali ke BERHASIL jika penghapusan pengindeksan gagal.
CANCELLABLE Perubahan situs target tertunda, tetapi dapat dibatalkan.
CANCELLED Perubahan situs target dibatalkan.

FailureReason

Alasan kegagalan pengindeksan penelusuran situs.

Representasi JSON
{

  // Union field failure can be only one of the following:
  "quotaFailure": {
    object (QuotaFailure)
  }
  // End of list of possible types for union field failure.
}
Kolom
Kolom union failure. Alasan kegagalan. failure hanya ada berupa salah satu diantara berikut:
quotaFailure

object (QuotaFailure)

Gagal karena kuota tidak mencukupi.

QuotaFailure

Gagal karena kuota tidak mencukupi.

Representasi JSON
{
  "totalRequiredQuota": string
}
Kolom
totalRequiredQuota

string (int64 format)

Jumlah ini adalah perkiraan jumlah total kuota yang dibutuhkan project ini untuk menyelesaikan pengindeksan dengan berhasil.

Metode

batchCreate

Membuat TargetSite dalam batch.

create

Membuat TargetSite.

delete

Menghapus TargetSite.

get

Mendapatkan TargetSite.

list

Mendapatkan daftar TargetSite.

patch

Memperbarui TargetSite.