Halaman ini menjelaskan cara merekam peristiwa pengguna secara real time. Peristiwa pengguna diperlukan untuk aplikasi media. Jika Anda tidak menggunakan aplikasi media, Anda tidak perlu mengimpor peristiwa pengguna. Namun, merekam peristiwa pengguna direkomendasikan untuk aplikasi penelusuran kustom dan rekomendasi.
Untuk jenis peristiwa pengguna yang dapat Anda rekam, lihat kolom eventType
dari objek
userEvents
. Dengan menyerap peristiwa pengguna, Anda dapat meningkatkan kualitas hasil Anda. Misalnya, peristiwa pengguna memengaruhi peringkat hasil penelusuran. Hasil dengan rasio klik-tayang yang lebih tinggi akan dipromosikan, sementara hasil dengan rasio klik-tayang yang lebih rendah akan disembunyikan. Jangan merekam peristiwa pengguna untuk dokumen yang belum Anda impor.
Jika Anda menggunakan aplikasi penelusuran dengan beberapa penyimpanan data terlampir, Google merekomendasikan agar Anda menyerap peristiwa pengguna di tingkat lokasi, bukan di tingkat penyimpanan data. Hal ini memungkinkan peristiwa pengguna tertentu dikirim ke penyimpanan data yang terkait dengannya. Untuk menyerap peristiwa pengguna dengan dokumen dari
dataStores
yang berbeda di tingkat lokasi, bukan di tingkat
penyimpanan data, lihat userEvents.write
.
Untuk mengimpor peristiwa pengguna historis secara massal, lihat Mengimpor peristiwa pengguna historis.
Anda dapat merekam peristiwa pengguna dengan cara berikut:
Untuk representasi JSON bagi peristiwa pengguna, lihat
userEvents
dalam referensi API.
Sebelum memulai
Sebelum Anda mengimpor peristiwa pengguna:
- Buat penyimpanan data dan aplikasi.
- Tinjau Tentang peristiwa pengguna media atau Tentang peristiwa pengguna untuk mengetahui persyaratan peristiwa pengguna.
Merekam peristiwa pengguna real-time dengan piksel JavaScript
Untuk merekam peristiwa pengguna dengan piksel JavaScript:
- Buat kunci API untuk panggilan ke metode
userEvents.collect
. - Lihat contoh piksel JavaScript untuk 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 untuk panggilan ke metode userEvents.collect
, selesaikan langkah-langkah berikut:
Di konsol Google Cloud , buka halaman Credentials.
Di menu drop-down project di bagian atas halaman konsol, pilih project Anda (project mungkin sudah dipilih). Google Cloud
Klik Create credentials, lalu pilih API key. Jangan tambahkan batasan perujuk. Beberapa setelan privasi pengguna tidak meneruskan URL perujuk.
- Catat kunci API yang dibuat, yang akan Anda gunakan saat memanggil pencatatan log peristiwa pengguna.
Untuk meningkatkan keamanan, tambahkan pembatasan HTTP ke Kunci API Anda untuk membatasi akses ke layanan Aplikasi AI di
https://discoveryengine.googleapis.com/*
.
Contoh piksel JavaScript
Contoh berikut mencatat peristiwa pengguna view-item
menggunakan piksel JavaScript.
Untuk representasi JSON untuk 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 Anda.
Untuk merekam peristiwa pengguna, kirim permintaan POST ke metode userEvents.write
dan berikan isi permintaan yang sesuai. Untuk representasi JSON untuk peristiwa
pengguna, lihat userEvents
dalam referensi API.
Jika Anda merekam peristiwa pengguna di tingkat lokasi, gunakan endpoint
https://discoveryengine.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/userEvents:write
.
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/v1/projects/PROJECT_NUMBER/locations/global/dataStores/DATA_STORE_ID/userEvents:write"
C#
Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi API C# Aplikasi AI.
Untuk melakukan autentikasi ke Aplikasi AI, 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 Aplikasi AI.
Untuk melakukan autentikasi ke Aplikasi AI, 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 Aplikasi AI.
Untuk melakukan autentikasi ke Aplikasi AI, 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 Aplikasi AI.
Untuk melakukan autentikasi ke Aplikasi AI, 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 Aplikasi AI.
Untuk melakukan autentikasi ke Aplikasi AI, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal.