Method: projects.locations.collections.engines.completionConfig.removeSuggestion

Menghapus saran histori penelusuran di mesin telusur untuk pengguna. Tindakan ini akan menghapus saran agar tidak ditampilkan di AdvancedCompleteQueryResponse.recent_search_suggestions untuk pengguna ini. Jika pengguna menelusuri saran yang sama lagi, histori baru akan menggantikan dan menyarankan saran ini lagi.

Permintaan HTTP


POST https://discoveryengine.googleapis.com/v1alpha/{completionConfig=projects/*/locations/*/collections/*/engines/*/completionConfig}:removeSuggestion

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
completionConfig

string

Wajib. Nama resource mesin induk completionConfig yang saran histori penelusurannya akan dihapus, seperti projects/*/locations/global/collections/default_collection/engines/*/completionConfig.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "userPseudoId": string,
  "userInfo": {
    object (UserInfo)
  },
  "removeTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "searchHistorySuggestion": string,
  "removeAllSearchHistorySuggestions": boolean
  // End of mutually exclusive fields.
}
Kolom
userPseudoId

string

Wajib. ID unik untuk melacak pengunjung. Misalnya, hal ini dapat diterapkan dengan cookie HTTP, yang harus dapat mengidentifikasi pengunjung secara unik di satu perangkat. ID unik ini tidak boleh berubah jika pengunjung login atau logout dari situs.

Kolom ini TIDAK boleh memiliki nilai tetap seperti unknown_visitor.

ID ini harus sama dengan UserEvent.user_pseudo_id dan SearchRequest.user_pseudo_id.

Kolom harus berupa string berenkode UTF-8 dengan batas panjang 128.
userInfo

object (UserInfo)

Opsional. Informasi tentang pengguna akhir.

Informasi ID ini harus sama dengan UserEvent.user_info dan SearchRequest.user_info.
removeTime

string (Timestamp format)

Wajib. Waktu saat saran dihapus. Jika tidak disetel, waktu saat ini akan digunakan.

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".
Saran yang akan dihapus. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
searchHistorySuggestion

string

Saran histori penelusuran yang akan dihapus.
removeAllSearchHistorySuggestions

boolean

Menghapus semua saran histori penelusuran untuk pengguna.
Akhir kolom yang saling eksklusif.

Isi respons

Jika berhasil, isi respons akan kosong.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource completionConfig:

  • discoveryengine.completionConfigs.removeSuggestion

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.