- Resource: SearchApplication
- DataSourceRestriction
- Sumber
- Source.PredefinedSource
- FilterOptions
- Filter
- Filter.ValueFilter
- Nilai
- Filter.CompositeFilter
- Filter.CompositeFilter.LogicOperator
- SourceConfig
- SourceScoringConfig
- SourceScoringConfig.SourceImportance
- SourceCrowdingConfig
- ScoringConfig
- SortOptions
- SortOptions.SortOrder
- FacetOptions
- IntegerFacetingOptions
- QueryInterpretationConfig
- Metode
Resource: SearchApplication
SearchApplication
Representasi JSON |
---|
{ "name": string, "displayName": string, "dataSourceRestrictions": [ { object ( |
Kolom | |
---|---|
name |
Nama Aplikasi Penelusuran. Format: searchapplications/{applicationId}. |
displayName |
Nama tampilan Aplikasi Penelusuran. Panjang maksimum adalah 300 karakter. |
dataSourceRestrictions[] |
Batasan diterapkan ke konfigurasi. Jumlah maksimum elemen adalah 10. |
sourceConfig[] |
Konfigurasi untuk sumber yang ditentukan dalam dataSourceRestrictions. |
scoringConfig |
Konfigurasi untuk hasil peringkat. |
defaultSortOptions |
Opsi default untuk mengurutkan hasil penelusuran |
defaultFacetOptions[] |
Bidang default untuk menampilkan hasil faset. Sumber yang disebutkan di sini juga telah disertakan di |
returnResultThumbnailUrls |
Dengan setiap hasil, kita harus menampilkan URI untuk thumbnail-nya (jika berlaku) |
operationIds[] |
Hanya output. ID Operasi Berjalan Lama (LRO) yang saat ini berjalan untuk skema ini. Kolom khusus output. |
enableAuditLog |
Menunjukkan apakah logging audit aktif/nonaktif untuk permintaan yang dibuat untuk aplikasi penelusuran di API kueri. |
queryInterpretationConfig |
Opsi default untuk interpretasi kueri |
DataSourceRestriction
Batasan pada Sumber Data.
Representasi JSON |
---|
{ "source": { object ( |
Kolom | |
---|---|
source |
Sumber pembatasan. |
filterOptions[] |
Opsi filter yang membatasi hasil. Jika ada beberapa filter, filter tersebut akan dikelompokkan berdasarkan jenis objek sebelum bergabung. Filter dengan jenis objek yang sama digabungkan secara konjungtif, lalu ekspresi yang dihasilkan digabungkan secara disjungtif. Jumlah maksimum elemen adalah 20. CATATAN: Suggest API saat ini hanya mendukung beberapa filter: "objecttype", "type", dan "mimetype". Untuk saat ini, filter khusus skema tidak dapat digunakan untuk memfilter saran. |
Sumber
Menentukan sumber untuk API saran/penelusuran.
Representasi JSON |
---|
{ // Union field |
Kolom | |
---|---|
Kolom union
|
|
name |
Nama sumber untuk konten yang diindeks oleh |
predefinedSource |
Sumber konten standar untuk Google Apps. |
Source.PredefinedSource
Sumber yang telah ditentukan sebelumnya:
Enum | |
---|---|
NONE |
|
QUERY_HISTORY |
Menyarankan kueri yang dikeluarkan oleh pengguna di masa lalu. Hanya valid jika digunakan dengan API saran. Diabaikan saat digunakan di API kueri. |
PERSON |
Menyarankan orang di organisasi. Hanya valid jika digunakan dengan API saran. Menghasilkan error saat digunakan di API kueri. |
GOOGLE_DRIVE |
|
GOOGLE_GMAIL |
|
GOOGLE_SITES |
|
GOOGLE_GROUPS |
|
GOOGLE_CALENDAR |
|
GOOGLE_KEEP |
FilterOptions
Opsi filter yang akan diterapkan pada kueri.
Representasi JSON |
---|
{
"objectType": string,
"filter": {
object ( |
Kolom | |
---|---|
objectType |
Jika objectType ditetapkan, hanya objek dari jenis tersebut yang ditampilkan. Ini harus sesuai dengan nama objek yang didaftarkan dalam definisi skema. Panjang maksimum adalah 256 karakter. |
filter |
Filter umum untuk membatasi penelusuran, seperti |
Filter
Cara umum untuk mengekspresikan filter dalam kueri, yang mendukung dua pendekatan:
1. Menetapkan ValueFilter. Nama harus cocok dengan operatorName yang ditentukan dalam skema untuk sumber data Anda.
2. Menetapkan CompositeFilter. Filter dievaluasi menggunakan operator logis. Operator tingkat teratas hanya dapat berupa AND atau NOT. DAN hanya dapat muncul di tingkat paling atas. OR hanya dapat muncul di bawah AND tingkat atas.
Representasi JSON |
---|
{ // Union field |
Kolom | |
---|---|
Kolom union
|
|
valueFilter |
|
compositeFilter |
|
Filter.ValueFilter
Representasi JSON |
---|
{
"operatorName": string,
"value": {
object ( |
Kolom | |
---|---|
operatorName |
|
value |
Nilai yang akan dibandingkan. |
Nilai
Definisi satu nilai dengan jenis generik.
Representasi JSON |
---|
{ // Union field |
Kolom | |
---|---|
Kolom union value . Nilai properti yang dinamai. value hanya ada berupa salah satu diantara berikut: |
|
stringValue |
|
integerValue |
|
doubleValue |
|
timestampValue |
Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: |
booleanValue |
|
dateValue |
|
Filter.CompositeFilter
Representasi JSON |
---|
{ "logicOperator": enum ( |
Kolom | |
---|---|
logicOperator |
Operator logika sub-filter. |
subFilters[] |
Sub-filter. |
Filter.CompositeFilter.LogicOperator
Enum | |
---|---|
AND |
Operator logika, yang hanya dapat diterapkan ke sub-filter. |
OR |
|
NOT |
TIDAK hanya dapat diterapkan pada satu subfilter. |
SourceConfig
Konfigurasi untuk sumber saat memproses permintaan query.search
atau query.suggest
.
Representasi JSON |
---|
{ "source": { object ( |
Kolom | |
---|---|
source |
Sumber yang akan menggunakan konfigurasi ini. |
scoringConfig |
Konfigurasi penskoran untuk sumber. |
crowdingConfig |
Konfigurasi kerumunan untuk sumber. |
SourceScoringConfig
Atur konfigurasi penskoran. Hal ini memungkinkan modifikasi peringkat hasil untuk suatu sumber.
Representasi JSON |
---|
{
"sourceImportance": enum ( |
Kolom | |
---|---|
sourceImportance |
Pentingnya sumber. |
SourceScoringConfig.SourceImportance
Pentingnya sumber yang dapat digunakan untuk menunjukkan apakah sumber harus diberi prioritas lebih dalam peringkat dibandingkan dengan sumber lain.
Enum | |
---|---|
DEFAULT |
|
LOW |
|
HIGH |
SourceCrowdingConfig
Tetapkan batas kerumunan hasil penelusuran. Kerumunan adalah situasi ketika beberapa hasil dari sumber atau host yang sama "memaksa" hasil lain, sehingga mengurangi kualitas penelusuran untuk pengguna. Untuk mendorong kualitas penelusuran dan keberagaman sumber yang lebih baik dalam hasil penelusuran, Anda dapat menetapkan kondisi untuk mengurangi hasil berulang berdasarkan sumber.
Representasi JSON |
---|
{ "numResults": integer, "numSuggestions": integer } |
Kolom | |
---|---|
numResults |
Jumlah maksimum hasil yang diizinkan dari sumber data di halaman hasil selama hasil dari sumber lain tidak habis. nilai yang ditentukan tidak boleh negatif. Nilai default digunakan jika nilai ini sama dengan 0. Untuk menonaktifkan kepadatan, tetapkan nilai lebih besar dari 100. |
numSuggestions |
Jumlah maksimum saran yang diizinkan dari sumber. Tidak ada batas yang akan ditetapkan pada hasil jika nilai ini kurang dari atau sama dengan 0. |
ScoringConfig
Konfigurasi skor untuk sumber saat memproses permintaan query.search
atau query.suggest
.
Representasi JSON |
---|
{ "disableFreshness": boolean, "disablePersonalization": boolean } |
Kolom | |
---|---|
disableFreshness |
Apakah akan menggunakan keaktualan sebagai sinyal peringkat. Secara default, keaktualan digunakan sebagai sinyal peringkat. Perhatikan bahwa setelan ini tidak tersedia di UI Admin. |
disablePersonalization |
Apakah hasil akan dipersonalisasi atau tidak. Secara default, sinyal pribadi akan digunakan untuk meningkatkan hasil. |
SortOptions
Representasi JSON |
---|
{
"operatorName": string,
"sortOrder": enum ( |
Kolom | |
---|---|
operatorName |
Nama operator yang sesuai dengan kolom yang akan diurutkan. Properti yang sesuai harus ditandai sebagai |
sortOrder |
Menaik adalah tata urutan {i>default<i} |
SortOptions.SortOrder
Enum | |
---|---|
ASCENDING |
|
DESCENDING |
FacetOptions
Menentukan operator yang akan ditampilkan hasil faset. Akan ada satu FacetResult untuk setiap kombinasi sourceName/objectType/operatorName.
Representasi JSON |
---|
{
"sourceName": string,
"objectType": string,
"operatorName": string,
"numFacetBuckets": integer,
"integerFacetingOptions": {
object ( |
Kolom | |
---|---|
sourceName |
Nama sumber yang akan digunakan faset. Format: datasources/{sourceId} Jika kosong, semua sumber data akan digunakan. |
objectType |
Jika objectType ditetapkan, hanya objek dari jenis tersebut yang akan digunakan untuk menghitung faset. Jika kosong, semua objek akan digunakan untuk menghitung faset. |
operatorName |
Nama operator yang dipilih untuk facet. @lihat cloudsearch.SchemaPropertyOptions |
numFacetBuckets |
Jumlah maksimum bucket faset yang harus ditampilkan untuk faset ini. Default-nya adalah 10. Nilai maksimum adalah 100. |
integerFacetingOptions |
Jika ditetapkan, menjelaskan opsi faset bilangan bulat untuk properti bilangan bulat yang diberikan. Properti bilangan bulat yang sesuai dalam skema harus ditandai sebagai isFacetable. Jumlah bucket yang ditampilkan adalah jumlah minimum sebesar ini dan numFacetBuckets. |
IntegerFacetingOptions
Digunakan untuk menentukan opsi facet bilangan bulat.
Representasi JSON |
---|
{ "integerBuckets": [ string ] } |
Kolom | |
---|---|
integerBuckets[] |
Bucket untuk nilai bilangan bulat tertentu harus dalam urutan menaik. Misalnya, jika nilai yang diberikan adalah (1,5,10,100), bucket facet berikut akan terbentuk {<1, [1,5), [5-10), [10-100), >=100}. |
QueryInterpretationConfig
Opsi default untuk menafsirkan kueri pengguna.
Representasi JSON |
---|
{ "forceVerbatimMode": boolean, "forceDisableSupplementalResults": boolean } |
Kolom | |
---|---|
forceVerbatimMode |
Aktifkan tanda ini untuk menonaktifkan semua pengoptimalan internal seperti interpretasi kueri dalam bahasa natural (NL), pengambilan hasil tambahan, dan penggunaan sinonim termasuk yang kustom. Jika tanda ini ditetapkan ke Benar (True), tanda ini akan lebih diutamakan daripada opsi yang ditetapkan di tingkat Kueri. Untuk nilai default False, tanda tingkat kueri akan menetapkan interpretasi yang benar untuk mode kata demi kata. |
forceDisableSupplementalResults |
Setel tanda ini untuk menonaktifkan pengambilan hasil tambahan, menyetel tanda di sini tidak akan mengambil hasil tambahan untuk kueri yang terkait dengan aplikasi penelusuran yang diberikan. Jika tanda ini ditetapkan ke Benar (True), tanda ini akan lebih diutamakan daripada opsi yang ditetapkan di tingkat Kueri. Untuk nilai default False, tanda tingkat kueri akan menetapkan interpretasi yang benar untuk hasil tambahan. |
Metode |
|
---|---|
|
Membuat aplikasi penelusuran. |
|
Menghapus aplikasi penelusuran. |
|
Mendapatkan aplikasi penelusuran tertentu. |
|
Mencantumkan semua aplikasi penelusuran. |
|
Memperbarui aplikasi penelusuran. |
|
Mereset aplikasi penelusuran ke setelan default. |
|
Memperbarui aplikasi penelusuran. |