REST Resource: projects.locations.collections.engines.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.

Metode

create

 Membuat Kontrol.

delete

 Menghapus Kontrol.

get

 Mendapatkan Kontrol.

list

 Mencantumkan semua Kontrol berdasarkan induknya DataStore.

patch

 Memperbarui Kontrol.