Method: projects.locations.collections.dataStores.userEvents.purge

Menghapus secara permanen semua peristiwa pengguna yang ditentukan oleh filter yang diberikan. Bergantung pada jumlah peristiwa yang ditentukan oleh filter, operasi ini dapat memerlukan waktu berjam-jam atau berhari-hari untuk diselesaikan. Untuk menguji filter, gunakan perintah daftar terlebih dahulu.

Permintaan HTTP

POST https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:purge

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Nama resource katalog tempat peristiwa dibuat. Formatnya adalah projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "filter": string,
  "force": boolean
}
Kolom
filter

string

Wajib. String filter untuk menentukan peristiwa yang akan dihapus dengan batas panjang 5.000 karakter. Kolom yang memenuhi syarat untuk pemfilteran adalah:

  • eventType: String UserEvent.event_type dengan tanda petik ganda.
  • eventTime: dalam format "zulu" ISO 8601.
  • userPseudoId: String yang diapit tanda petik ganda. Menentukan ini akan menghapus semua peristiwa yang terkait dengan pengunjung.
  • userId: String yang diapit tanda petik ganda. Menentukan ini akan menghapus semua peristiwa yang terkait dengan pengguna.

Catatan: API ini hanya mendukung penghapusan rentang maksimum 30 hari.

Contoh:

  • Menghapus semua acara dalam rentang waktu: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"
  • Menghapus eventType tertentu dalam rentang waktu: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"
  • Menghapus semua acara untuk pengunjung tertentu dalam rentang waktu: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"
  • Menghapus peristiwa 30 hari terakhir di dalam DataStore: *

Kolom pemfilteran diasumsikan memiliki AND implisit.
force

boolean

Kolom force saat ini tidak didukung. Permintaan penghapusan total peristiwa pengguna akan menghapus semua peristiwa yang dapat dihapus total secara permanen. Setelah pengembangan selesai: Jika force disetel ke salah (false), metode ini akan menampilkan jumlah penghapusan yang diharapkan tanpa menghapus peristiwa pengguna. Kolom ini akan ditetapkan secara default ke false jika tidak disertakan dalam permintaan.

Isi respons

Jika berhasil, isi respons akan berisi instance Operation.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource parent:

  • discoveryengine.userEvents.purge

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.