Schema

Definisi skema untuk sumber data.

Representasi JSON 
{
  "objectDefinitions": [
    {
      object (ObjectDefinition)
    }
  ],
  "operationIds": [
    string
  ]
}
Kolom
objectDefinitions[]

object (ObjectDefinition)

Daftar objek tingkat teratas untuk sumber data. Jumlah elemen maksimum adalah 10.
operationIds[]

string

ID Operasi yang Berjalan Lama (LLO) yang saat ini berjalan untuk skema ini. Setelah mengubah skema, tunggu hingga operasi selesai sebelum mengindeks konten tambahan.

ObjectDefinition

Definisi untuk objek dalam sumber data.

Representasi JSON 
{
  "name": string,
  "options": {
    object (ObjectOptions)
  },
  "propertyDefinitions": [
    {
      object (PropertyDefinition)
    }
  ]
}
Kolom
name

string

Nama objek, yang kemudian menentukan jenisnya. Permintaan pengindeksan item harus menetapkan kolom objectType sama dengan nilai ini. Misalnya, jika name adalah Document, permintaan pengindeksan untuk item jenis Dokumen harus menetapkan objectType sama dengan Document. Setiap definisi objek harus diberi nama secara unik di dalam skema. Nama harus diawali dengan huruf dan hanya berisi huruf (A-Z, a-z) atau angka (0-9). Panjang maksimum adalah 256 karakter.
options

object (ObjectOptions)

Opsi opsional spesifik per objek.
propertyDefinitions[]

object (PropertyDefinition)

Definisi properti untuk objek. Jumlah elemen maksimum adalah 1.000.

ObjectOptions

Opsi untuk objek.

Representasi JSON 
{
  "freshnessOptions": {
    object (ObjectOptions.FreshnessOptions)
  },
  "displayOptions": {
    object (ObjectDisplayOptions)
  },
  "suggestionFilteringOperators": [
    string
  ]
}
Kolom
freshnessOptions

object (ObjectOptions.FreshnessOptions)

Opsi keaktualan objek.
displayOptions

object (ObjectDisplayOptions)

Opsi yang menentukan bagaimana objek ditampilkan di halaman hasil Cloud Search.
suggestionFilteringOperators[]

string

Operator yang dapat digunakan untuk memfilter saran. Untuk query.suggest API, hanya operator yang disebutkan di sini yang akan diterima di FilterOptions. Hanya operator TEXT dan ENUM yang didukung.

CATATAN: "objecttype", "type" dan "mimetype" sudah didukung. Properti ini ditujukan untuk mengonfigurasi operator spesifik per skema.

Meskipun ini adalah array, hanya satu operator yang dapat ditentukan. Ini adalah array untuk ekstensibilitas di masa mendatang.

Pemetaan operator ke beberapa properti dalam objek yang sama tidak didukung. Jika operator mencakup berbagai jenis objek, opsi ini harus ditetapkan sekali untuk setiap definisi objek.

ObjectOptions.FreshnessOptions

Menunjukkan properti keaktualan yang akan digunakan saat menyesuaikan peringkat penelusuran untuk item. Tanggal yang lebih baru dan lebih baru menunjukkan kualitas yang lebih tinggi. Gunakan properti opsi keaktualan yang paling sesuai dengan data Anda. Untuk dokumen fileshare, waktu terakhir diubah adalah yang paling relevan. Untuk data acara kalender, waktu saat acara terjadi adalah indikator keaktualan yang lebih relevan. Dengan cara ini, acara kalender yang terjadi mendekati waktu kueri penelusuran dianggap berkualitas lebih tinggi dan diberi peringkat yang sesuai.

Representasi JSON 
{
  "freshnessProperty": string,
  "freshnessDuration": string
}
Kolom
freshnessProperty

string

Properti ini menunjukkan tingkat keaktualan objek dalam indeks. Jika ditetapkan, properti ini harus berupa properti tingkat teratas di dalam property definitions dan harus berupa timestamp type atau date type. Jika tidak, Indexing API akan menggunakan updateTime sebagai indikator keaktualan. Panjang maksimum adalah 256 karakter.

Jika properti digunakan untuk menghitung keaktualan, nilainya akan ditetapkan secara default ke 2 tahun dari waktu saat ini.
freshnessDuration

string (Duration format)

Durasi setelah objek akan dianggap tidak berlaku. Nilai defaultnya adalah 180 hari (dalam detik).

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".

ObjectDisplayOptions

Opsi tampilan untuk sebuah objek.

Representasi JSON 
{
  "objectDisplayLabel": string,
  "metalines": [
    {
      object (ObjectDisplayOptions.Metaline)
    }
  ]
}
Kolom
objectDisplayLabel

string

Label yang mudah digunakan untuk ditampilkan di hasil penelusuran guna menunjukkan jenis item. Ini adalah OPSIONAL; jika tidak diberikan, label objek tidak akan ditampilkan pada garis konteks hasil penelusuran. Panjang maksimum adalah 64 karakter.
metalines[]

object (ObjectDisplayOptions.Metaline)

Mendefinisikan properti yang ditampilkan di metaline hasil penelusuran. Nilai properti ditampilkan dalam urutan yang diberikan di sini. Jika properti memiliki beberapa nilai, semua nilai akan ditampilkan sebelum properti berikutnya. Oleh karena itu, sebaiknya tentukan properti tunggal sebelum properti berulang dalam daftar ini. Semua properti harus menetapkan isReturnable ke benar (true). Jumlah maksimum metaline adalah 3.

ObjectDisplayOptions.Metaline

Metaline adalah daftar properti yang ditampilkan bersama dengan hasil penelusuran untuk memberikan konteks.

Representasi JSON 
{
  "properties": [
    {
      object (ObjectDisplayOptions.DisplayedProperty)
    }
  ]
}
Kolom
properties[]

object (ObjectDisplayOptions.DisplayedProperty)

Daftar properti yang ditampilkan untuk metaline. Jumlah properti maksimum adalah 5.

ObjectDisplayOptions.DisplayedProperty

Referensi ke properti level teratas dalam objek yang harus ditampilkan di hasil penelusuran. Nilai properti yang dipilih akan ditampilkan dalam hasil penelusuran bersama dengan display label untuk properti tersebut jika ditentukan. Jika label tampilan tidak ditentukan, hanya nilai yang akan ditampilkan.

Representasi JSON 
{
  "propertyName": string
}
Kolom
propertyName

string

Nama properti tingkat teratas seperti yang ditentukan dalam definisi properti untuk objek. Jika namanya bukan properti yang ditentukan dalam skema, error akan muncul saat mencoba memperbarui skema.

PropertyDefinition

Definisi properti di dalam objek.

Representasi JSON 
{
  "name": string,
  "isReturnable": boolean,
  "isRepeatable": boolean,
  "isSortable": boolean,
  "isFacetable": boolean,
  "isSuggestable": boolean,
  "isWildcardSearchable": boolean,
  "displayOptions": {
    object (PropertyDisplayOptions)
  },

  // Union field property_options can be only one of the following:
  "integerPropertyOptions": {
    object (IntegerPropertyOptions)
  },
  "doublePropertyOptions": {
    object (DoublePropertyOptions)
  },
  "timestampPropertyOptions": {
    object (TimestampPropertyOptions)
  },
  "booleanPropertyOptions": {
    object (BooleanPropertyOptions)
  },
  "objectPropertyOptions": {
    object (ObjectPropertyOptions)
  },
  "enumPropertyOptions": {
    object (EnumPropertyOptions)
  },
  "datePropertyOptions": {
    object (DatePropertyOptions)
  },
  "textPropertyOptions": {
    object (TextPropertyOptions)
  },
  "htmlPropertyOptions": {
    object (HtmlPropertyOptions)
  }
  // End of list of possible types for union field property_options.
}
Kolom
name

string

Nama properti. Permintaan pengindeksan item yang dikirim ke Indexing API harus menetapkan property name yang sama dengan nilai ini. Misalnya, jika nama adalah subject_line, permintaan pengindeksan item dokumen dengan kolom subjek harus menetapkan name untuk kolom tersebut sama dengan subject_line. Gunakan nama sebagai ID untuk properti objek. Setelah terdaftar sebagai properti untuk sebuah objek, Anda tidak dapat menggunakan kembali nama ini untuk properti lain dalam objek tersebut. Nama harus diawali dengan huruf dan hanya berisi huruf (A-Z, a-z) atau angka (0-9). Panjang maksimum adalah 256 karakter.
isReturnable

boolean

Menunjukkan bahwa properti mengidentifikasi data yang harus ditampilkan dalam hasil penelusuran melalui Query API. Jika ditetapkan ke true, pengguna Query API dapat menggunakan kolom properti yang cocok dalam hasil. Namun, penyimpanan kolom memerlukan lebih banyak alokasi ruang dan menggunakan lebih banyak bandwidth untuk kueri penelusuran, yang memengaruhi performa pada set data besar. Tetapkan ke true di sini hanya jika kolom tersebut diperlukan untuk hasil penelusuran. Tidak boleh benar untuk properti yang jenisnya adalah objek.
isRepeatable

boolean

Menunjukkan bahwa beberapa nilai diizinkan untuk properti. Misalnya, dokumen hanya memiliki satu deskripsi, tetapi dapat memiliki beberapa komentar. Tidak boleh benar untuk properti yang jenisnya boolean. Jika ditetapkan ke salah (false), properti yang berisi lebih dari satu nilai akan menyebabkan permintaan pengindeksan item tersebut ditolak.
isSortable

boolean

Menunjukkan bahwa properti dapat digunakan untuk pengurutan. Tidak boleh benar untuk properti yang dapat diulang. Tidak boleh benar untuk properti yang jenisnya objek. IsReturnable harus benar untuk menetapkan opsi ini. Hanya didukung untuk properti boolean, tanggal, ganda, bilangan bulat, dan stempel waktu.
isFacetable

boolean

Menunjukkan bahwa properti dapat digunakan untuk menghasilkan faset. Tidak boleh benar untuk properti yang jenisnya objek. IsReturnable harus benar untuk menetapkan opsi ini. Hanya didukung untuk properti boolean, enum, bilangan bulat, dan teks.
isSuggestable

boolean

Menunjukkan bahwa properti dapat digunakan untuk menghasilkan saran kueri.
isWildcardSearchable

boolean

Menunjukkan bahwa pengguna dapat melakukan penelusuran karakter pengganti untuk properti ini. Hanya didukung untuk properti Teks. IsReturnable harus benar untuk menetapkan opsi ini. Dalam sumber data tertentu, maksimum 5 properti dapat ditandai sebagai isWildcardSearchable. Untuk mengetahui detail selengkapnya, lihat Menentukan properti objek
displayOptions

object (PropertyDisplayOptions)

Opsi yang menentukan cara properti ditampilkan di halaman hasil Cloud Search jika ditentukan untuk ditampilkan di display options objek.
Kolom union property_options. Opsi khusus jenis yang menentukan cara properti diindeks dan digunakan. Jika opsi harus menjadi opsi default untuk suatu jenis, kolom ini harus tetap ditetapkan ke salah satu jenis tersebut. Jika kolom ini tidak disetel, pembaruan skema akan ditolak. property_options hanya dapat berupa salah satu dari berikut:
integerPropertyOptions

object (IntegerPropertyOptions)
doublePropertyOptions

object (DoublePropertyOptions)
timestampPropertyOptions

object (TimestampPropertyOptions)
booleanPropertyOptions

object (BooleanPropertyOptions)
objectPropertyOptions

object (ObjectPropertyOptions)
enumPropertyOptions

object (EnumPropertyOptions)
datePropertyOptions

object (DatePropertyOptions)
textPropertyOptions

object (TextPropertyOptions)
htmlPropertyOptions

object (HtmlPropertyOptions)

IntegerPropertyOptions

Opsi untuk properti bilangan bulat.

Representasi JSON 
{
  "orderedRanking": enum (IntegerPropertyOptions.OrderedRanking),
  "minimumValue": string,
  "maximumValue": string,
  "operatorOptions": {
    object (IntegerPropertyOptions.IntegerOperatorOptions)
  },
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
Kolom
orderedRanking

enum (IntegerPropertyOptions.OrderedRanking)

Digunakan untuk menentukan peringkat yang diurutkan untuk bilangan bulat. Hanya dapat digunakan jika isRepeatable bernilai salah (false).
minimumValue

string (Int64Value format)

Nilai minimum properti. Nilai minimum dan maksimum untuk properti digunakan untuk menentukan peringkat hasil sesuai dengan ordered ranking. Permintaan pengindeksan dengan nilai yang kurang dari nilai minimum akan diterima dan diberi peringkat dengan bobot yang sama seperti item yang diindeks dengan nilai minimum.
maximumValue

string (Int64Value format)

Nilai maksimum properti. Nilai minimum dan maksimum untuk properti digunakan untuk menentukan peringkat hasil sesuai dengan ordered ranking. Permintaan pengindeksan dengan nilai yang lebih besar dari nilai maksimum akan diterima dan diberi peringkat dengan bobot yang sama seperti item yang diindeks dengan nilai maksimum.
operatorOptions

object (IntegerPropertyOptions.IntegerOperatorOptions)

Jika ditetapkan, menjelaskan cara penggunaan bilangan bulat sebagai operator penelusuran.
integerFacetingOptions

object (IntegerFacetingOptions)

Jika ditetapkan, menjelaskan opsi facet bilangan bulat untuk properti bilangan bulat yang diberikan. Properti bilangan bulat yang sesuai harus ditandai isFacetable.

IntegerPropertyOptions.OrderedRanking

Digunakan untuk menentukan bagaimana nilai bilangan bulat harus diberi peringkat relatif terhadap nilai lainnya. Bilangan bulat dengan peringkat yang lebih tinggi menunjukkan kepentingan yang lebih besar. Misalnya, dalam beberapa sumber data, prioritas yang lebih rendah menunjukkan kepentingan yang lebih tinggi, sementara prioritas yang lebih tinggi menunjukkan kepentingan yang lebih tinggi.

Enum
NO_ORDER Tidak ada urutan peringkat untuk properti. Hasil tidak disesuaikan dengan nilai properti ini.
ASCENDING Properti ini diberi peringkat dari atas ke bawah. Nilai yang lebih rendah menunjukkan peringkat yang lebih rendah.
DESCENDING Properti ini diberi peringkat dalam urutan menurun. Nilai yang lebih rendah menunjukkan peringkat yang lebih tinggi.

IntegerPropertyOptions.IntegerOperatorOptions

Digunakan untuk menyediakan operator penelusuran untuk properti bilangan bulat. Tindakan ini bersifat opsional. Operator query.search memungkinkan pengguna membatasi kueri untuk kolom tertentu yang relevan dengan jenis item yang ditelusuri.

Representasi JSON 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Kolom
operatorName

string

Menunjukkan nama operator yang diperlukan dalam kueri untuk mengisolasi properti bilangan bulat. Misalnya, jika operatorName adalah priority dan nama properti adalah priorityVal, kueri seperti priority:<value> hanya akan menampilkan hasil jika nilai properti bernama priorityVal cocok dengan <value>. Sebaliknya, penelusuran yang menggunakan &lt;value&gt; yang sama tanpa operator akan menampilkan semua item dengan &lt;value&gt; cocok dengan nilai properti String atau teks dalam kolom konten untuk item tersebut. Nama operator hanya boleh berisi huruf kecil (a-z). Panjang maksimum adalah 32 karakter.
lessThanOperatorName

string

Menunjukkan nama operator yang diperlukan dalam kueri untuk mengisolasi properti bilangan bulat menggunakan operator lebih kecil dari. Misalnya, jika lessThanOperatorName adalah prioritybottom dan nama properti adalah priorityVal, kueri seperti prioritypublikasi:<value> hanya akan menampilkan hasil jika nilai properti bernama priorityVal lebih kecil dari <value>. Nama operator hanya boleh berisi huruf kecil (a-z). Panjang maksimum adalah 32 karakter.
greaterThanOperatorName

string

Menunjukkan nama operator yang diperlukan dalam kueri untuk mengisolasi properti bilangan bulat menggunakan operator lebih besar-dari. Misalnya, jika moreThanOperatorName adalah priorityabove dan nama properti priorityVal, kueri seperti priorityabove:<value> hanya menampilkan hasil jika nilai properti bernama priorityVal lebih besar dari <value>. Nama operator hanya boleh berisi huruf kecil (a-z). Panjang maksimum adalah 32 karakter.

DoublePropertyOptions

Opsi untuk properti ganda.

Representasi JSON 
{
  "operatorOptions": {
    object (DoublePropertyOptions.DoubleOperatorOptions)
  }
}
Kolom
operatorOptions

object (DoublePropertyOptions.DoubleOperatorOptions)

Jika ditetapkan, menjelaskan cara penggunaan double sebagai operator penelusuran.

DoublePropertyOptions.DoubleOperatorOptions

Digunakan untuk menyediakan operator penelusuran pada properti ganda. Tindakan ini bersifat opsional. Operator query.search memungkinkan pengguna membatasi kueri untuk kolom tertentu yang relevan dengan jenis item yang ditelusuri.

Representasi JSON 
{
  "operatorName": string
}
Kolom
operatorName

string

Menunjukkan nama operator yang dibutuhkan dalam kueri untuk menggunakan properti ganda dalam pengurutan atau sebagai faset. Nama operator hanya boleh berisi huruf kecil (a-z). Panjang maksimum adalah 32 karakter.

TimestampPropertyOptions

Opsi untuk properti stempel waktu.

Representasi JSON 
{
  "operatorOptions": {
    object (TimestampPropertyOptions.TimestampOperatorOptions)
  }
}
Kolom
operatorOptions

object (TimestampPropertyOptions.TimestampOperatorOptions)

Jika ditetapkan, akan menjelaskan cara penggunaan stempel waktu sebagai operator penelusuran.

TimestampPropertyOptions.TimestampOperatorOptions

Digunakan untuk memberikan operator penelusuran untuk properti stempel waktu. Tindakan ini bersifat opsional. Operator query.search memungkinkan pengguna membatasi kueri untuk kolom tertentu yang relevan dengan jenis item yang ditelusuri.

Representasi JSON 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Kolom
operatorName

string

Menunjukkan nama operator yang diperlukan dalam kueri untuk mengisolasi properti stempel waktu. Misalnya, jika operatorName closedon dan nama properti adalah closeDate, kueri seperti closedon:<value> akan menampilkan hasil hanya jika nilai properti bernama closeDate cocok dengan <value>. Sebaliknya, penelusuran yang menggunakan &lt;value&gt; yang sama tanpa operator akan menampilkan semua item dengan &lt;value&gt; cocok dengan nilai properti String atau teks dalam kolom konten untuk item tersebut. Nama operator hanya boleh berisi huruf kecil (a-z). Panjang maksimum adalah 32 karakter.
lessThanOperatorName

string

Menunjukkan nama operator yang diperlukan dalam kueri untuk mengisolasi properti stempel waktu menggunakan operator lebih kecil dari. Misalnya, jika lessThanOperatorName closedbefore dan nama properti adalah closeDate, kueri seperti closedbefore:<value> hanya akan menampilkan hasil ketika nilai properti bernama closeDate lebih awal dari <value>. Nama operator hanya boleh berisi huruf kecil (a-z). Panjang maksimum adalah 32 karakter.
greaterThanOperatorName

string

Menunjukkan nama operator yang diperlukan dalam kueri untuk mengisolasi properti stempel waktu menggunakan operator lebih besar dari. Misalnya, jika moreThanOperatorName closedafter dan nama properti adalah closeDate, kueri seperti closedafter:<value> akan menampilkan hasil hanya ketika nilai properti bernama closeDate lebih lama dari <value>. Nama operator hanya boleh berisi huruf kecil (a-z). Panjang maksimum adalah 32 karakter.

BooleanPropertyOptions

Opsi untuk properti boolean.

Representasi JSON 
{
  "operatorOptions": {
    object (BooleanPropertyOptions.BooleanOperatorOptions)
  }
}
Kolom
operatorOptions

object (BooleanPropertyOptions.BooleanOperatorOptions)

Jika ditetapkan, menjelaskan bagaimana boolean harus digunakan sebagai operator penelusuran.

BooleanPropertyOptions.BooleanOperatorOptions

Digunakan untuk menyediakan operator penelusuran untuk properti boolean. Tindakan ini bersifat opsional. Operator query.search memungkinkan pengguna membatasi kueri untuk kolom tertentu yang relevan dengan jenis item yang ditelusuri.

Representasi JSON 
{
  "operatorName": string
}
Kolom
operatorName

string

Menunjukkan nama operator yang diperlukan dalam kueri untuk mengisolasi properti boolean. Misalnya, jika operatorName ditutup dan nama properti isClosed, kueri seperti closed:<value> hanya menampilkan hasil jika nilai properti bernama isClosed cocok dengan <value>. Sebaliknya, penelusuran yang menggunakan &lt;value&gt; yang sama tanpa operator akan menampilkan semua item dengan &lt;value&gt; cocok dengan nilai properti String atau teks dalam kolom konten untuk item tersebut. Nama operator hanya boleh berisi huruf kecil (a-z). Panjang maksimum adalah 32 karakter.

ObjectPropertyOptions

Opsi untuk properti objek.

Representasi JSON 
{
  "subobjectProperties": [
    {
      object (PropertyDefinition)
    }
  ]
}
Kolom
subobjectProperties[]

object (PropertyDefinition)

Properti sub-objek. Properti ini mewakili objek bertingkat. Misalnya, jika properti ini mewakili alamat pos, subobjectProperties mungkin diberi nama street, city, dan state. Jumlah elemen maksimum adalah 1.000.

EnumPropertyOptions

Opsi untuk properti enum, yang memungkinkan Anda menentukan rangkaian string yang dibatasi untuk mencocokkan kueri pengguna, menetapkan peringkat untuk nilai string tersebut, dan menentukan nama operator yang akan dipasangkan dengan string tersebut sehingga pengguna dapat mempersempit hasil hanya untuk item dengan nilai tertentu. Misalnya, untuk item dalam sistem pelacakan permintaan dengan informasi prioritas, Anda dapat menetapkan p0 sebagai nilai enum yang diizinkan dan mengaitkan enum ini dengan nama operator priority, sehingga pengguna penelusuran dapat menambahkan priority:p0 ke kueri mereka untuk membatasi kumpulan hasil hanya untuk item yang diindeks dengan nilai p0.

Representasi JSON 
{
  "possibleValues": [
    {
      object (EnumPropertyOptions.EnumValuePair)
    }
  ],
  "orderedRanking": enum (EnumPropertyOptions.OrderedRanking),
  "operatorOptions": {
    object (EnumPropertyOptions.EnumOperatorOptions)
  }
}
Kolom
possibleValues[]

object (EnumPropertyOptions.EnumValuePair)

Daftar nilai yang mungkin untuk properti enumerasi. Semua EnumValuePairs harus memberikan nilai string. Jika Anda menentukan nilai bilangan bulat untuk satu EnumValuePair, semua EnumValuePairs yang mungkin harus memberikan nilai bilangan bulat. Nilai string dan nilai bilangan bulat harus unik di atas semua nilai yang memungkinkan. Setelah ditetapkan, nilai yang mungkin tidak dapat dihapus atau diubah. Jika Anda memberikan peringkat yang diurutkan dan berpikir Anda dapat memasukkan nilai enum tambahan di masa mendatang, biarkan kesenjangan pada nilai bilangan bulat awal untuk memungkinkan penambahan nilai di antara nilai yang terdaftar sebelumnya. Jumlah elemen maksimum adalah 100.
orderedRanking

enum (EnumPropertyOptions.OrderedRanking)

Digunakan untuk menentukan peringkat yang diurutkan untuk enumerasi yang menentukan bagaimana nilai bilangan bulat yang diberikan dalam EnumValuePairs yang mungkin digunakan untuk menentukan peringkat hasil. Jika ditentukan, nilai bilangan bulat harus diberikan untuk semua kemungkinan nilai EnumValuePair yang diberikan untuk properti ini. Hanya dapat digunakan jika isRepeatable bernilai salah (false).
operatorOptions

object (EnumPropertyOptions.EnumOperatorOptions)

Jika ditetapkan, menjelaskan cara penggunaan enum sebagai operator penelusuran.

EnumPropertyOptions.EnumValuePair

Pasangan nilai enumerasi menentukan dua hal: nilai string yang diperlukan dan nilai bilangan bulat opsional. Nilai string menentukan istilah kueri yang diperlukan untuk mengambil item tersebut, seperti p0 untuk item prioritas. Nilai bilangan bulat menentukan peringkat nilai string tersebut relatif terhadap nilai lainnya yang dihitung untuk properti yang sama. Misalnya, Anda dapat mengaitkan p0 dengan 0 dan menentukan pasangan enum lainnya, seperti p1 dan 1. Anda harus menggunakan nilai bilangan bulat yang dikombinasikan dengan ordered ranking untuk menetapkan peringkat nilai tertentu secara relatif terhadap nilai terenumerasi lainnya untuk nama properti yang sama. Di sini, urutan peringkat DESCENDING untuk properti prioritas menghasilkan peningkatan peringkat untuk item yang diindeks dengan nilai p0 dibandingkan dengan item yang diindeks dengan nilai p1. Tanpa urutan peringkat yang ditentukan, nilai bilangan bulat tidak akan memengaruhi peringkat item.

Representasi JSON 
{
  "stringValue": string,
  "integerValue": integer
}
Kolom
stringValue

string

Nilai string EnumValuePair. Panjang maksimum adalah 32 karakter.
integerValue

integer

Nilai bilangan bulat EnumValuePair yang tidak boleh negatif. Opsional.

EnumPropertyOptions.OrderedRanking

Digunakan untuk menentukan arah peringkat untuk bilangan bulat EnumValuePair yang relatif terhadap nilai bilangan bulat EnumValuePair lainnya. Untuk beberapa properti, nilai bilangan bulat yang lebih rendah menunjukkan kepentingan yang lebih tinggi, sementara di properti lain bilangan bulat yang lebih tinggi menunjukkan kepentingan yang lebih tinggi.

Enum
NO_ORDER Tidak ada urutan peringkat untuk properti. Hasil tidak disesuaikan dengan nilai properti ini.
ASCENDING Properti ini diberi peringkat dari atas ke bawah. Nilai yang lebih rendah menunjukkan peringkat yang lebih rendah.
DESCENDING Properti ini diberi peringkat dalam urutan menurun. Nilai yang lebih rendah menunjukkan peringkat yang lebih tinggi.

EnumPropertyOptions.EnumOperatorOptions

Digunakan untuk menyediakan operator penelusuran untuk properti enum. Tindakan ini bersifat opsional. Operator query.search memungkinkan pengguna membatasi kueri untuk kolom tertentu yang relevan dengan jenis item yang ditelusuri. Misalnya, jika Anda tidak memberikan operator untuk properti enum priority dengan kemungkinan nilai p0 dan p1, kueri yang berisi istilah p0 akan menampilkan item yang memiliki p0 sebagai nilai properti priority, serta item apa pun yang berisi string p0 di kolom lainnya. Jika Anda memberikan nama operator untuk enum, seperti priority, pengguna penelusuran dapat menggunakan operator tersebut untuk menyaring hasil hanya ke item yang memiliki p0 sebagai nilai properti ini, dengan kueri priority:p0.

Representasi JSON 
{
  "operatorName": string
}
Kolom
operatorName

string

Menunjukkan nama operator yang diperlukan dalam kueri untuk mengisolasi properti enum. Misalnya, jika operatorName adalah priority dan nama properti adalah priorityVal, kueri seperti priority:<value> hanya akan menampilkan hasil jika nilai properti bernama priorityVal cocok dengan <value>. Sebaliknya, penelusuran yang menggunakan &lt;value&gt; yang sama tanpa operator akan menampilkan semua item dengan &lt;value&gt; cocok dengan nilai properti String atau teks dalam kolom konten untuk item tersebut. Nama operator hanya boleh berisi huruf kecil (a-z). Panjang maksimum adalah 32 karakter.

DatePropertyOptions

Opsi untuk properti tanggal.

Representasi JSON 
{
  "operatorOptions": {
    object (DatePropertyOptions.DateOperatorOptions)
  }
}
Kolom
operatorOptions

object (DatePropertyOptions.DateOperatorOptions)

Jika ditetapkan, menjelaskan bagaimana tanggal harus digunakan sebagai operator penelusuran.

DatePropertyOptions.DateOperatorOptions

Opsional. Menyediakan operator penelusuran untuk properti tanggal. Operator query.search memungkinkan pengguna membatasi kueri untuk kolom tertentu yang relevan dengan jenis item yang ditelusuri.

Representasi JSON 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Kolom
operatorName

string

Menunjukkan string sebenarnya yang diperlukan dalam kueri untuk mengisolasi properti tanggal. Sebagai contoh, anggaplah objek skema pelacakan masalah memiliki properti bernama closeDate yang menentukan operator dengan operatorName closedon. Untuk penelusuran data tersebut, kueri seperti closedon:&lt;value&gt; hanya menampilkan hasil jika nilai properti closedon:&lt;value&gt; cocok dengan closedon:&lt;value&gt;. Sebaliknya, penelusuran yang menggunakan &lt;value&gt; yang sama tanpa operator akan menampilkan semua item dengan &lt;value&gt; cocok dengan nilai properti String atau teks dalam kolom konten untuk sumber data yang diindeks. Nama operator hanya boleh berisi huruf kecil (a-z). Panjang maksimum adalah 32 karakter.
lessThanOperatorName

string

Menunjukkan nama operator yang diperlukan dalam kueri untuk mengisolasi properti tanggal menggunakan operator lebih kecil dari. Misalnya, jika lessThanOperatorName closedbefore dan nama properti adalah closeDate, kueri seperti closedbefore:<value> hanya akan menampilkan hasil ketika nilai properti bernama closeDate lebih awal dari <value>. Nama operator hanya boleh berisi huruf kecil (a-z). Panjang maksimum adalah 32 karakter.
greaterThanOperatorName

string

Menunjukkan nama operator yang diperlukan dalam kueri untuk mengisolasi properti tanggal menggunakan operator lebih besar dari. Misalnya, jika moreThanOperatorName closedafter dan nama properti adalah closeDate, kueri seperti closedafter:<value> akan menampilkan hasil hanya ketika nilai properti bernama closeDate lebih besar dari <value>. Nama operator hanya boleh berisi huruf kecil (a-z). Panjang maksimum adalah 32 karakter.

TextPropertyOptions

Opsi untuk properti teks.

Representasi JSON 
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (TextPropertyOptions.TextOperatorOptions)
  }
}
Kolom
retrievalImportance

object (RetrievalImportance)

Menunjukkan pentingnya kualitas penelusuran token dalam kolom saat digunakan untuk pengambilan.
operatorOptions

object (TextPropertyOptions.TextOperatorOptions)

Jika ditetapkan, menjelaskan cara penggunaan properti sebagai operator penelusuran.

RetrievalImportance

Representasi JSON 
{
  "importance": enum (RetrievalImportance.Importance)
}
Kolom
importance

enum (RetrievalImportance.Importance)

Menunjukkan nilai penting peringkat yang diberikan ke properti saat cocok selama pengambilan. Setelah ditetapkan, tingkat kepentingan token properti tidak dapat diubah.

RetrievalImportance.Importance

Enum
DEFAULT Perlakukan pencocokan seperti pencocokan teks isi.
HIGHEST Perlakukan kecocokan seperti kecocokan terhadap judul item.
HIGH Perlakukan kecocokan dengan tingkat kepentingan yang lebih tinggi daripada teks isi.
LOW Tangani kecocokan dengan tingkat kepentingan yang lebih rendah daripada teks isi.
NONE Jangan cocokkan dengan kolom ini selama pengambilan. Properti ini masih dapat digunakan untuk pencocokan operator, facet, dan saran jika diinginkan.

TextPropertyOptions.TextOperatorOptions

Digunakan untuk menyediakan operator penelusuran pada properti teks. Tindakan ini bersifat opsional. Operator query.search memungkinkan pengguna membatasi kueri untuk kolom tertentu yang relevan dengan jenis item yang ditelusuri.

Representasi JSON 
{
  "operatorName": string,
  "exactMatchWithOperator": boolean
}
Kolom
operatorName

string

Menunjukkan nama operator yang diperlukan dalam kueri untuk mengisolasi properti teks. Misalnya, jika operatorName adalah subject dan nama properti adalah subjectLine, kueri seperti subject:<value> hanya akan menampilkan hasil jika nilai properti bernama subjectLine cocok dengan <value>. Sebaliknya, penelusuran yang menggunakan &lt;value&gt; yang sama tanpa operator akan menampilkan semua item dengan &lt;value&gt; cocok dengan nilai properti teks atau teks dalam kolom konten untuk item tersebut. Nama operator hanya boleh berisi huruf kecil (a-z). Panjang maksimum adalah 32 karakter.
exactMatchWithOperator

boolean

Jika true (benar), nilai teks akan ditokenkan sebagai satu nilai atomik dalam penelusuran operator dan pencocokan facet. Misalnya, jika nama operator adalah "genre" dan nilainya adalah "fiksi ilmiah" pembatasan kueri "genre:science" dan "genre:fiksi" tidak sesuai dengan item; "genre:fiksi ilmiah" fungsi tersebut. Pencocokan nilai teks peka huruf besar/kecil dan tidak menghapus karakter khusus. Jika salah, teks akan dijadikan token. Misalnya, jika nilainya adalah "fiksi ilmiah" kueri "genre:sains" dan "genre:fiksi" cocok dengan item.

HtmlPropertyOptions

Opsi untuk properti HTML.

Representasi JSON 
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (HtmlPropertyOptions.HtmlOperatorOptions)
  }
}
Kolom
retrievalImportance

object (RetrievalImportance)

Menunjukkan pentingnya kualitas penelusuran token dalam kolom saat digunakan untuk pengambilan. Hanya dapat disetel ke DEFAULT atau NONE.
operatorOptions

object (HtmlPropertyOptions.HtmlOperatorOptions)

Jika ditetapkan, menjelaskan cara penggunaan properti sebagai operator penelusuran.

HtmlPropertyOptions.HtmlOperatorOptions

Digunakan untuk menyediakan operator penelusuran untuk properti html. Tindakan ini bersifat opsional. Operator query.search memungkinkan pengguna membatasi kueri untuk kolom tertentu yang relevan dengan jenis item yang ditelusuri.

Representasi JSON 
{
  "operatorName": string
}
Kolom
operatorName

string

Menunjukkan nama operator yang diperlukan dalam kueri untuk mengisolasi properti html. Misalnya, jika operatorName adalah subject dan nama properti adalah subjectLine, kueri seperti subject:<value> hanya akan menampilkan hasil jika nilai properti bernama subjectLine cocok dengan <value>. Sebaliknya, penelusuran yang menggunakan &lt;value&gt; yang sama tanpa operator akan menampilkan semua item dengan &lt;value&gt; cocok dengan nilai properti HTML atau teks dalam kolom konten untuk item tersebut. Nama operator hanya boleh berisi huruf kecil (a-z). Panjang maksimum adalah 32 karakter.

PropertyDisplayOptions

Opsi tampilan untuk properti.

Representasi JSON 
{
  "displayLabel": string
}
Kolom
displayLabel

string

Label yang mudah digunakan untuk properti yang digunakan jika properti ditentukan untuk ditampilkan di ObjectDisplayOptions. Jika disediakan, label tampilan akan ditampilkan di depan nilai properti jika properti merupakan bagian dari opsi tampilan objek. Misalnya, jika nilai properti adalah '1', nilai itu sendiri mungkin bukan konteks yang berguna bagi pengguna. Jika nama tampilan yang diberikan adalah 'priority', pengguna akan melihat 'priority : 1' di hasil penelusuran yang memberikan konteks yang jelas kepada pengguna penelusuran. Ini adalah OPSIONAL; jika tidak diberikan, hanya nilai properti yang akan ditampilkan. Panjang maksimum adalah 64 karakter.