Schema

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

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.

object (ObjectOptions)

Opsi opsional spesifik per objek.

object (PropertyDefinition)

Definisi properti untuk objek. Jumlah elemen maksimum adalah 1.000.

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

object (ObjectOptions.FreshnessOptions)

Opsi keaktualan objek.

object (ObjectDisplayOptions)

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

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.

{
  "freshnessProperty": string,
  "freshnessDuration": string
}

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.

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".

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

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.

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.

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

object (ObjectDisplayOptions.DisplayedProperty)

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

{
  "propertyName": string
}

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.

{
  "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.
}

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.

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.

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.

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.

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.

boolean

Menunjukkan bahwa properti dapat digunakan untuk menghasilkan saran kueri.

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

object (PropertyDisplayOptions)

Opsi yang menentukan cara properti ditampilkan di halaman hasil Cloud Search jika ditentukan untuk ditampilkan di display options objek.

object (IntegerPropertyOptions)

object (DoublePropertyOptions)

object (TimestampPropertyOptions)

object (BooleanPropertyOptions)

object (ObjectPropertyOptions)

object (EnumPropertyOptions)

object (DatePropertyOptions)

object (TextPropertyOptions)

object (HtmlPropertyOptions)

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

enum (IntegerPropertyOptions.OrderedRanking)

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

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.

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.

object (IntegerPropertyOptions.IntegerOperatorOptions)

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

object (IntegerFacetingOptions)

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

{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}

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.

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.

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.

{
  "operatorOptions": {
    object (DoublePropertyOptions.DoubleOperatorOptions)
  }
}

object (DoublePropertyOptions.DoubleOperatorOptions)

Jika ditetapkan, menjelaskan cara penggunaan double sebagai operator penelusuran.

{
  "operatorName": string
}

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.

{
  "operatorOptions": {
    object (TimestampPropertyOptions.TimestampOperatorOptions)
  }
}

object (TimestampPropertyOptions.TimestampOperatorOptions)

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

{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}

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.

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.

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.

{
  "operatorOptions": {
    object (BooleanPropertyOptions.BooleanOperatorOptions)
  }
}

object (BooleanPropertyOptions.BooleanOperatorOptions)

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

{
  "operatorName": string
}

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.

{
  "subobjectProperties": [
    {
      object (PropertyDefinition)
    }
  ]
}

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.

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

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.

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).

object (EnumPropertyOptions.EnumOperatorOptions)

Jika ditetapkan, menjelaskan cara penggunaan enum sebagai operator penelusuran.

{
  "stringValue": string,
  "integerValue": integer
}

string

Nilai string EnumValuePair. Panjang maksimum adalah 32 karakter.

integer

Nilai bilangan bulat EnumValuePair yang tidak boleh negatif. Opsional.

{
  "operatorName": string
}

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.

{
  "operatorOptions": {
    object (DatePropertyOptions.DateOperatorOptions)
  }
}

object (DatePropertyOptions.DateOperatorOptions)

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

{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}

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.

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.

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 lama dari <value>. Nama operator hanya boleh berisi huruf kecil (a-z). Panjang maksimum adalah 32 karakter.

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

object (RetrievalImportance)

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

object (TextPropertyOptions.TextOperatorOptions)

Jika ditetapkan, menjelaskan cara penggunaan properti sebagai operator penelusuran.

{
  "importance": enum (RetrievalImportance.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.

{
  "operatorName": string,
  "exactMatchWithOperator": boolean
}

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.

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.

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

object (RetrievalImportance)

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

object (HtmlPropertyOptions.HtmlOperatorOptions)

Jika ditetapkan, menjelaskan cara penggunaan properti sebagai operator penelusuran.

{
  "operatorName": string
}

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.

{
  "displayLabel": string
}

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.