REST Resource: projects.locations.collections.dataStores.controls

Resource: Control

Menentukan perilaku bersyarat yang akan diterapkan selama penyajian. Harus dilampirkan ke ServingConfig agar dipertimbangkan pada waktu penayangan. Tindakan yang diizinkan bergantung pada SolutionType.

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "associatedServingConfigIds": [
    string
  ],
  "solutionType": enum (SolutionType),
  "useCases": [
    enum (SearchUseCase)
  ],
  "conditions": [
    {
      object (Condition)
    }
  ],

  // Union field action can be only one of the following:
  "boostAction": {
    object (BoostAction)
  },
  "filterAction": {
    object (FilterAction)
  },
  "redirectAction": {
    object (RedirectAction)
  },
  "synonymsAction": {
    object (SynonymsAction)
  },
  "promoteAction": {
    object (PromoteAction)
  }
  // End of list of possible types for union field action.
}
Kolom
name

string

Tidak dapat diubah. Nama yang sepenuhnya memenuhi syarat projects/*/locations/global/dataStore/*/controls/*
displayName

string

Wajib. Nama yang dapat dibaca manusia. ID yang digunakan dalam tampilan UI.

Harus berupa string berenkode UTF-8. Batas panjang adalah 128 karakter. Jika tidak, error ARGUMEN TIDAK VALID akan ditampilkan.
associatedServingConfigIds[]

string

Hanya output. Daftar semua ID ServingConfig yang terlampir pada kontrol ini. Mungkin perlu waktu hingga 10 menit untuk memperbarui setelah perubahan.
solutionType

enum (SolutionType)

Wajib. Tidak dapat diubah. Solusi yang menjadi bagian dari kontrol.

Harus kompatibel dengan kategori resource. Jika tidak, error ARGUMEN TIDAK VALID akan ditampilkan.
useCases[]

enum (SearchUseCase)

Menentukan kasus penggunaan untuk kontrol. Memengaruhi kolom kondisi yang dapat ditetapkan. Hanya berlaku untuk SOLUTION_TYPE_SEARCH. Saat ini hanya mengizinkan satu kasus penggunaan per kontrol. Harus ditetapkan jika solutionType adalah SolutionType.SOLUTION_TYPE_SEARCH.
conditions[]

object (Condition)

Menentukan kapan tindakan terkait akan dipicu.

Hilangkan untuk selalu menerapkan tindakan. Saat ini hanya satu kondisi yang dapat ditentukan. Jika tidak, error ARGUMEN TIDAK VALID akan ditampilkan.

Kolom union action. Tindakan dibatasi menurut Vertikal dan Solusi

Wajib. action hanya dapat berupa salah satu dari hal berikut:
boostAction

object (BoostAction)

Menentukan kontrol jenis pendorong
filterAction

object (FilterAction)

Menentukan kontrol jenis filter Saat ini tidak didukung oleh Rekomendasi
redirectAction

object (RedirectAction)

Menentukan kontrol jenis pengalihan.
synonymsAction

object (SynonymsAction)

Memperlakukan sekelompok istilah sebagai sinonim satu sama lain.
promoteAction

object (PromoteAction)

Mempromosikan link tertentu berdasarkan kueri pemicu yang telah ditentukan sebelumnya.

BoostAction

Menyesuaikan urutan produk dalam daftar yang ditampilkan.

Representasi JSON 
{
  "boost": number,
  "filter": string,
  "dataStore": string,

  // Union field boost_spec can be only one of the following:
  "fixedBoost": number,
  "interpolationBoostSpec": {
    object (InterpolationBoostSpec)
  }
  // End of list of possible types for union field boost_spec.
}
Kolom
boost
(deprecated)

number

Kekuatan pendorong, yang harus berada dalam [-1, 1]. Peningkatan negatif berarti penurunan. Defaultnya adalah 0.0 (No-op).
filter

string

Wajib. Menentukan produk yang akan diterapkan peningkatannya.

Jika tidak ada filter yang diberikan, semua produk akan dipromosikan (No-op). Dokumentasi sintaksis: https://cloud.google.com/retail/docs/filter-and-order Panjang maksimum adalah 5.000 karakter. Jika tidak, error ARGUMEN TIDAK VALID akan ditampilkan.
dataStore

string

Wajib. Menentukan dokumen penyimpanan data mana yang dapat dipromosikan oleh kontrol ini. Nama lengkap penyimpanan data, misalnya projects/123/locations/global/collections/default_collection/dataStores/default_data_store
Kolom union boost_spec. Spesifikasi peningkatan nilai konstan atau peningkatan nilai berdasarkan peringkat kustom. boost_spec hanya ada berupa salah satu diantara berikut:
fixedBoost

number

Opsional. Kekuatan pendorong, yang harus berada dalam [-1, 1]. Peningkatan negatif berarti penurunan. Defaultnya adalah 0.0 (No-op).
interpolationBoostSpec

object (InterpolationBoostSpec)

Opsional. Spesifikasi kompleks untuk peringkat kustom berdasarkan nilai atribut yang ditentukan pelanggan.

InterpolationBoostSpec

Spesifikasi untuk peringkat kustom berdasarkan nilai atribut yang ditentukan pelanggan. Hal ini memberikan lebih banyak kontrol untuk peringkat yang disesuaikan daripada kombinasi (kondisi, peningkatan) sederhana di atas.

Representasi JSON 
{
  "fieldName": string,
  "attributeType": enum (AttributeType),
  "interpolationType": enum (InterpolationType),
  "controlPoints": [
    {
      object (ControlPoint)
    }
  ]
}
Kolom
fieldName

string

Opsional. Nama kolom yang nilainya akan digunakan untuk menentukan jumlah peningkat.
attributeType

enum (AttributeType)

Opsional. Jenis atribut yang akan digunakan untuk menentukan jumlah peningkat. Nilai atribut dapat diperoleh dari nilai kolom fieldName yang ditentukan. Untuk nilai numerik, prosesnya sederhana, yaitu attributeValue = numerical_field_value. Namun, dalam kasus keaktualan, attributeValue = (time.now() - datetime_field_value).
interpolationType

enum (InterpolationType)

Opsional. Jenis interpolasi yang akan diterapkan untuk menghubungkan titik kontrol yang tercantum di bawah.
controlPoints[]

object (ControlPoint)

Opsional. Titik kontrol yang digunakan untuk menentukan kurva. Fungsi monotonik (ditentukan melalui interpolationType di atas) melewati titik kontrol yang tercantum di sini.

AttributeType

Atribut(atau fungsi) yang akan diterapkan peringkat kustomnya.

Enum
ATTRIBUTE_TYPE_UNSPECIFIED AttributeType tidak ditentukan.
NUMERICAL Nilai kolom numerik akan digunakan untuk memperbarui jumlah peningkat secara dinamis. Dalam hal ini, attributeValue (nilai x) titik kontrol akan menjadi nilai sebenarnya dari kolom numerik yang boostAmount-nya ditentukan.
FRESHNESS Untuk kasus penggunaan keaktualan, nilai atribut akan berupa durasi antara waktu saat ini dan tanggal di kolom datetime yang ditentukan. Nilai harus diformat sebagai nilai XSD dayTimeDuration (subset terbatas dari nilai durasi ISO 8601). Pola untuk ini adalah: [nD][T[nH][nM][nS]]. Misalnya, 5D, 3DT12H30M, T24H.

InterpolationType

Jenis interpolasi yang akan diterapkan. Defaultnya adalah linear (Piecewise Linear).

Enum
INTERPOLATION_TYPE_UNSPECIFIED Jenis interpolasi tidak ditentukan. Dalam hal ini, nilai defaultnya adalah Linear.
LINEAR Interpolasi linear sepotong-sepotong akan diterapkan.

ControlPoint

Titik kontrol yang digunakan untuk menentukan kurva. Kurva yang ditentukan melalui titik kontrol ini hanya dapat meningkat atau menurun secara monoton(nilai konstan dapat diterima).

Representasi JSON 
{
  "attributeValue": string,
  "boostAmount": number
}
Kolom
attributeValue

string

Opsional. Dapat berupa salah satu dari: 1. Nilai kolom numerik. 2. Spesifikasi durasi untuk keaktualan: Nilai harus diformat sebagai nilai XSD dayTimeDuration (subset terbatas dari nilai durasi ISO 8601). Pola untuk ini adalah: [nD][T[nH][nM][nS]].
boostAmount

number

Opsional. Nilai antara -1 hingga 1 yang digunakan untuk meningkatkan skor jika attributeValue dievaluasi ke nilai yang ditentukan di atas.

FilterAction

Menentukan produk mana yang dapat disertakan dalam hasil. Menggunakan filter yang sama dengan promosi.

Representasi JSON 
{
  "filter": string,
  "dataStore": string
}
Kolom
filter

string

Wajib. Filter yang akan diterapkan pada hasil kondisi pencocokan.

Dokumentasi Sintaksis yang diperlukan: https://cloud.google.com/retail/docs/filter-and-order Panjang maksimum adalah 5.000 karakter. Jika tidak, error ARGUMEN TIDAK VALID akan ditampilkan.
dataStore

string

Wajib. Menentukan dokumen penyimpanan data mana yang dapat difilter oleh kontrol ini. Nama lengkap penyimpanan data, misalnya projects/123/locations/global/collections/default_collection/dataStores/default_data_store

RedirectAction

Mengarahkan pembeli ke URI yang disediakan.

Representasi JSON 
{
  "redirectUri": string
}
Kolom
redirectUri

string

Wajib. URI yang menjadi tujuan pengalihan pembeli.

Wajib. URI harus memiliki panjang yang sama atau kurang dari 2.000 karakter. Jika tidak, error ARGUMEN TIDAK VALID akan ditampilkan.

SynonymsAction

Membuat sekumpulan istilah yang akan bertindak sebagai sinonim satu sama lain.

Contoh: "senang" juga akan dianggap sebagai "bahagia", "bahagia" juga akan dianggap sebagai "senang".

Representasi JSON 
{
  "synonyms": [
    string
  ]
}
Kolom
synonyms[]

string

Menentukan sekumpulan sinonim. Dapat menentukan hingga 100 sinonim. Harus menentukan minimal 2 sinonim. Jika tidak, error ARGUMEN TIDAK VALID akan ditampilkan.

PromoteAction

Mempromosikan link tertentu berdasarkan beberapa kueri pemicu.

Contoh: Promosikan link toko sepatu saat menelusuri kata kunci shoe. Link dapat berada di luar penyimpanan data terkait.

Representasi JSON 
{
  "dataStore": string,
  "searchLinkPromotion": {
    object (SearchLinkPromotion)
  }
}
Kolom
dataStore

string

Wajib. Penyimpanan data yang terkait dengan promosi ini.

SearchLinkPromotion

Proto promosi mencakup URI dan informasi bantuan lainnya untuk menampilkan promosi.

Representasi JSON 
{
  "title": string,
  "uri": string,
  "document": string,
  "imageUri": string,
  "description": string,
  "enabled": boolean
}
Kolom
title

string

Wajib. Judul promosi. Panjang maksimum: 160 karakter.
uri

string

Opsional. URL untuk halaman yang ingin dipromosikan pengguna. Harus disetel untuk penelusuran situs. Untuk vertikal lainnya, atribut ini bersifat opsional.
document

string

Opsional. Document yang ingin dipromosikan pengguna. Untuk penelusuran situs, biarkan tidak disetel dan hanya isi uri. Dapat disetel bersama dengan URI.
imageUri

string

Opsional. URL gambar thumbnail promosi.
description

string

Opsional. Deskripsi Promosi. Panjang maksimum: 200 karakter.
enabled

boolean

Opsional. Promosi yang diaktifkan akan ditampilkan untuk semua konfigurasi penayangan yang terkait dengan induk kontrol tempat promosi ini dilampirkan.

Flag ini hanya digunakan untuk penelusuran situs dasar.

SearchUseCase

Menentukan sub-pembagian lebih lanjut dari SolutionType. Berlaku khusus untuk SOLUTION_TYPE_SEARCH.

Enum
SEARCH_USE_CASE_UNSPECIFIED Nilai yang digunakan saat tidak disetel. Tidak akan terjadi di CSS.
SEARCH_USE_CASE_BROWSE Jelajahi kasus penggunaan. Mengharapkan traffic memiliki query kosong.

Kondisi

Menentukan keadaan yang harus diperiksa sebelum mengizinkan perilaku

Representasi JSON 
{
  "queryTerms": [
    {
      object (QueryTerm)
    }
  ],
  "activeTimeRange": [
    {
      object (TimeRange)
    }
  ],
  "queryRegex": string
}
Kolom
queryTerms[]

object (QueryTerm)

Penelusuran hanya Daftar istilah untuk mencocokkan kueri. Tidak dapat disetel saat Condition.query_regex disetel.

Maksimum 10 istilah kueri.
activeTimeRange[]

object (TimeRange)

Rentang waktu yang menentukan kapan kondisi aktif.

Maksimum 10 rentang waktu.
queryRegex

string

Opsional. Regex kueri untuk mencocokkan seluruh kueri penelusuran. Tidak dapat disetel saat Condition.query_terms disetel. Hanya didukung untuk kontrol penayangan promosi Penelusuran Situs Dasar.

QueryTerm

Pencocok untuk kueri permintaan penelusuran

Representasi JSON 
{
  "value": string,
  "fullMatch": boolean
}
Kolom
value

string

Nilai kueri spesifik yang akan dicocokkan

Harus huruf kecil, harus UTF-8. Dapat memiliki maksimal 3 istilah yang dipisahkan spasi jika fullMatch bernilai benar (true). Tidak boleh berupa string kosong. Panjang maksimum 5.000 karakter.
fullMatch

boolean

Apakah kueri penelusuran harus sama persis dengan istilah kueri.

TimeRange

Digunakan untuk kondisi yang bergantung pada waktu.

Representasi JSON 
{
  "startTime": string,
  "endTime": string
}
Kolom
startTime

string (Timestamp format)

Awal rentang waktu.

Rentang bersifat inklusif.

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

string (Timestamp format)

Akhir rentang waktu.

Rentang bersifat inklusif. Harus di masa depan.

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

Metode

create

 Membuat Kontrol.

delete

 Menghapus Kontrol.

get

 Mendapatkan Kontrol.

list

 Mencantumkan semua Kontrol berdasarkan induknya DataStore.

patch

 Memperbarui Kontrol.