本頁說明如何即時記錄使用者事件。媒體應用程式需要使用者事件。如果您不使用媒體應用程式,則不需要匯入使用者事件。不過,建議您為自訂搜尋和推薦應用程式記錄使用者事件。
如要瞭解可記錄的使用者事件類型,請參閱 userEvents
物件的 eventType
欄位。您可以擷取使用者事件,改善結果品質。舉例來說,使用者事件會影響搜尋結果的排名。點閱率較高的結果會獲得提升,點閱率較低的結果則會被埋沒。請勿為尚未匯入的文件記錄使用者事件。
如果您使用的是附加多個資料儲存區的搜尋應用程式,Google 建議您在位置層級擷取使用者事件,而非在資料儲存層級擷取。這樣一來,系統就能將特定使用者事件傳送至相關聯的資料儲存庫。如要在位置層級 (而非資料儲存庫層級) 擷取來自不同 dataStores
的文件使用者事件,請參閱 userEvents.write
。
如要大量匯入歷來使用者事件,請參閱「匯入歷來使用者事件」。
您可以透過下列方式記錄使用者事件:
如要瞭解使用者事件的 JSON 表示法,請參閱 API 參考資料中的 userEvents
。
事前準備
匯入使用者事件前:
使用 JavaScript 像素記錄即時使用者事件
如要使用 JavaScript 像素記錄使用者事件,請按照下列步驟操作:
- 建立 API 金鑰,用於呼叫
userEvents.collect
方法。 - 如要查看收集使用者事件的 JavaScript 代碼範例,請參閱JavaScript 像素範例。
建立 API 金鑰
如果您使用 JavaScript 像素收集使用者瀏覽器的使用者事件,就必須使用 API 金鑰。
如要建立 API 金鑰以呼叫 userEvents.collect
方法,請完成下列步驟:
前往 Google Cloud 控制台的「憑證」頁面。
在 Google Cloud 控制台頁面頂端的專案下拉式選單中,選取專案 (專案可能已選取)。
按一下「建立憑證」,然後選取「API 金鑰」。請勿加入任何參照網址限制。部分使用者隱私權設定不會傳遞參照網址。
- 請記下產生的 API 金鑰,您會在呼叫使用者事件記錄時使用這組金鑰。
為提升安全性,請在 API 金鑰中新增 HTTP 限制,限制對
https://discoveryengine.googleapis.com/*
中的 AI 應用程式服務存取權。
JavaScript 像素範例
以下範例會使用 JavaScript 像素記錄 view-item
使用者事件。
如要瞭解使用者事件的 JSON 表示法,請參閱 API 參考資料中的 userEvents
。
<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>
使用 userEvents.write
方法記錄即時使用者事件
REST
您可以使用 userEvents.write
方法,直接從後端伺服器將使用者事件傳送至 API。
如要記錄使用者事件,請向 userEvents.write
方法傳送 POST 要求,並提供適當的要求主體。如要瞭解使用者事件的 JSON 表示法,請參閱 API 參考資料中的 userEvents
。
如果您要記錄位置層級的使用者事件,請使用 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#
詳情請參閱 AI Applications C# API 參考說明文件。
如要向 AI Applications 進行驗證,請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。
Go
詳情請參閱 AI Applications Go API 參考說明文件。
如要向 AI Applications 進行驗證,請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。
Java
詳情請參閱 AI Applications Java API 參考說明文件。
如要向 AI Applications 進行驗證,請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。
Python
詳情請參閱 AI Applications Python API 參考說明文件。
如要向 AI Applications 進行驗證,請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。
Ruby
詳情請參閱 AI Applications Ruby API 參考說明文件。
如要向 AI Applications 進行驗證,請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。