Halaman ini menjelaskan cara merekam peristiwa pengguna secara real time. Peristiwa pengguna diperlukan untuk rekomendasi media. Jika Anda tidak menggunakan rekomendasi media, impor peristiwa pengguna tidak diperlukan. Namun, merekam peristiwa pengguna direkomendasikan untuk aplikasi penelusuran media.
Untuk jenis peristiwa pengguna yang dapat Anda catat, lihat kolom eventType
dari objek userEvents
. Dengan menyerap peristiwa pengguna, Anda dapat meningkatkan
kualitas rekomendasi serta peringkat hasil penelusuran.
Hasil dengan rasio klik-tayang (CTR) yang lebih tinggi akan dioptimalkan, sedangkan hasil dengan rasio klik-tayang (CTR) yang lebih rendah akan disembunyikan. Jangan rekam peristiwa pengguna untuk dokumen yang belum Anda impor.
Jika Anda menggunakan aplikasi penelusuran dengan beberapa penyimpanan data yang terpasang, Google
menyarankan agar Anda menyerap peristiwa pengguna di tingkat lokasi, bukan
tingkat penyimpanan data. Hal ini memungkinkan peristiwa pengguna tertentu dikirim ke
penyimpanan data yang terkait. Untuk menyerap peristiwa pengguna dengan dokumen dari berbagai dataStores
di tingkat lokasi, bukan tingkat penyimpanan data, lihat userEvents.write
.
Untuk mengimpor peristiwa pengguna historis secara massal, lihat Mengimpor peristiwa pengguna historis.
Anda dapat mencatat peristiwa pengguna dengan cara berikut:
Untuk representasi JSON peristiwa pengguna, lihat userEvents
dalam referensi API.
Sebelum memulai
Sebelum mengimpor peristiwa pengguna:
- Buat penyimpanan data dan aplikasi.
- Tinjau Tentang peristiwa pengguna untuk mengetahui persyaratan peristiwa pengguna.
Merekam peristiwa pengguna real-time dengan piksel JavaScript
Untuk merekam peristiwa pengguna dengan piksel JavaScript:
- Membuat kunci API untuk panggilan ke metode
userEvents.Collect
- Lihat Contoh piksel JavaScript untuk mengetahui contoh tag JavaScript yang mengumpulkan peristiwa pengguna
Membuat kunci API
Kunci API diperlukan jika Anda menggunakan piksel JavaScript untuk mengumpulkan peristiwa pengguna dari browser pengguna.
Untuk membuat kunci API bagi panggilan ke metode userEvents.Collect
, selesaikan langkah-langkah berikut:
Di Konsol Google Cloud, buka halaman Kredensial.
Di menu drop-down project di bagian atas halaman konsol Google Cloud, pilih project Anda (project mungkin sudah dipilih).
Klik Create credentials, lalu pilih API key. Jangan tambahkan batasan perujuk. Beberapa setelan privasi pengguna tidak meneruskan URL perujuk.
- Catat kunci API yang dihasilkan, yang akan Anda gunakan saat memanggil logging peristiwa pengguna.
Untuk meningkatkan keamanan, tambahkan pembatasan HTTP ke Kunci API Anda untuk membatasi akses ke layanan Vertex AI Agent Builder di
https://discoveryengine.googleapis.com/*
.
Contoh piksel JavaScript
Contoh berikut mencatat peristiwa pengguna view-item
menggunakan piksel
JavaScript.
Untuk representasi JSON peristiwa pengguna, lihat userEvents
di referensi API.
<script type="text/javascript">
var user_event = {
"eventType" : "view-item",
"userPseudoId": "USER_PSEUDO_ID",
"userInfo": {
"userId": "USER_ID"
},
"attributionToken": "ATTRIBUTION_TOKEN",
"tagIds": "TAG_ID",
"documents": [
{
"id": "DOCUMENT_ID"
}
]
};
var _gre = _gre || {};
// Credentials for project.
_gre.apiKey = '[API_KEY]';
_gre.logEvent = user_event;
_gre.projectId = 'PROJECT_ID';
_gre.locationId = 'LOCATION_ID';
_gre.dataStoreId = 'DATA_STORE_ID';
(function() {
var gre = document.createElement('script'); gre.type = 'text/javascript'; gre.async = true;
gre.src = 'https://www.gstatic.com/discoveryengine/v1beta_event.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(gre, s);
})();
</script>
Merekam peristiwa pengguna real-time dengan metode userEvents.write
REST
Anda dapat menggunakan metode userEvents.write
untuk mengirim peristiwa pengguna langsung ke API dari server backend.
Untuk merekam peristiwa pengguna, kirim permintaan POST ke metode userEvents.write
dan
berikan isi permintaan yang sesuai. Untuk representasi JSON peristiwa pengguna, lihat userEvents
dalam referensi API.
Jika Anda memiliki aplikasi dengan beberapa penyimpanan data, Google merekomendasikan agar Anda
mengasimilasikan peristiwa di tingkat lokasi. Dalam hal ini, gunakan endpoint
https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_NUMBER/locations/LOCATION/userEvents:write
.
export GOOGLE_APPLICATION_CREDENTIALS=/tmp/my-key.json
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
--data "{
'eventType': 'view-item',
'userPseudoId': 'visitor0',
'eventTime': '2020-01-01T03:33:33.000001Z',
'tagIds': ['321'],
'attributionToken': 'ABC',
'attributes': {
'example_text_attribute': {
'text': ['text_1', 'text_2']
},
'example_number_attribute': {
'numbers': [3.14, 42, 1.2345]
}
},
'documents': [{
'id': 'abc'
}],
'userInfo': {
'userId': 'abc',
'userAgent': 'Mozilla/5.0'
},
'pageInfo': {
'uri': 'http://example',
'referrerUri': 'http://example',
'pageViewId': 'currentPageUri'
}
}" \\
"https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_NUMBER/locations/global/dataStores/DATA_STORE_ID/userEvents:write"
C#
Untuk mengetahui informasi selengkapnya, lihat Dokumentasi referensi API C# Vertex AI Agent Builder.
Untuk melakukan autentikasi ke Vertex AI Agent Builder, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Go
Untuk mengetahui informasi selengkapnya, lihat Dokumentasi referensi API Go Vertex AI Agent Builder.
Untuk melakukan autentikasi ke Vertex AI Agent Builder, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Java
Untuk mengetahui informasi selengkapnya, lihat Dokumentasi referensi API Java Vertex AI Agent Builder.
Untuk melakukan autentikasi ke Vertex AI Agent Builder, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Python
Untuk mengetahui informasi selengkapnya, lihat Dokumentasi referensi API Python Vertex AI Agent Builder.
Untuk melakukan autentikasi ke Vertex AI Agent Builder, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Ruby
Untuk mengetahui informasi selengkapnya, lihat Dokumentasi referensi API Ruby Vertex AI Agent Builder.
Untuk melakukan autentikasi ke Vertex AI Agent Builder, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal.