- HTTP 要求
- 要求主體
- 回應主體
- 授權範圍
- 使用者
- 使用者 ID 類型
- 活動類型
- UserActivitySession
- 活動
- CustomDimension
- PageviewData
- ScreenviewData
- 電子商務資料
- 電子商務動作
- TransactionData
- ProductData
- 電子商務類型
- 目標組合資料
- 目標資料
- EventData
- 試試看!
傳回使用者活動資料。
HTTP 要求
POST https://analyticsreporting.googleapis.com/v4/userActivity:search
此網址使用 gRPC 轉碼語法。
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 | |
---|---|
{ "dateRange": { object( |
欄位 | |
---|---|
dateRange |
擷取使用者活動的日期範圍。如未提供日期範圍,預設日期範圍為 (startDate: current date - 7 days, endDate: current date - 1 days)。 |
viewId |
必要,用來擷取資料的 Analytics (分析) 資料檢視 ID。每個 SearchUserActivityRequest 都必須包含 |
user |
必要,要查詢的唯一使用者 ID。每個 SearchUserActivityRequest 都必須包含這個欄位。 |
activityTypes[] |
要求的所有活動類型組合。回應中只會傳回與這些類型相符的播映資訊。如果空白,系統會傳回所有活動。 |
pageSize |
頁面大小適用於分頁,並指定傳回的資料列數量上限。頁面大小應為 >>0。如果值為 0,或是欄位未指定,則要求將傳回每頁 1000 列的預設值。 |
pageToken |
用於取得下一頁下一頁的接續權杖。將這項資訊新增至要求,將傳回 pageToken 後面的資料列。pageToken 應為 SearchUserActivityRequest 要求中的下一個 PageToken 參數傳回的值。 |
回應主體
如果成功,回應主體即會包含具有以下結構的資料:
userActivity:get
呼叫的回應。
JSON 表示法 | |
---|---|
{
"sessions": [
{
object( |
欄位 | |
---|---|
sessions[] |
每個記錄都代表一個工作階段 (裝置詳細資料、時間長度等)。 |
totalRows |
這項查詢傳回的資料列總數 (位於不同頁面)。 |
nextPageToken |
這個權杖應傳遞至 SearchUserActivityRequest 以擷取下一頁。 |
sampleRate |
|
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
使用者
含有專門用來識別特定使用者的資訊。
JSON 表示法 | |
---|---|
{
"type": enum( |
欄位 | |
---|---|
type |
要求中的使用者類型,欄位 |
userId |
要求取得資料的使用者專屬 ID。 |
使用者 ID 類型
代表可使用的各種使用者識別資訊。
列舉 | |
---|---|
USER_ID_TYPE_UNSPECIFIED |
如未指定 User-ID 類型,則使用的預設類型為 CLIENT_ID。 |
USER_ID |
可能在一或多部裝置和/或瀏覽器上與內容互動的同一名使用者 (例如已登入帳戶的使用者)。 |
CLIENT_ID |
Analytics (分析) 已指派 clientId。 |
活動類型
列舉 | |
---|---|
ACTIVITY_TYPE_UNSPECIFIED |
ActivityType 在回應中一律不會有這個值。在要求中使用這種錯誤會導致錯誤。 |
PAGEVIEW |
活動因訪客瀏覽網頁而使用。 |
SCREENVIEW |
活動是訪客在行動裝置上使用應用程式而產生的活動。 |
GOAL |
用於表示目標類型活動。 |
ECOMMERCE |
電子商務交易者在網頁上進行電子商務交易。 |
EVENT |
在活動做為事件時使用。 |
使用者活動工作階段
這代表在特定時間範圍內,在特定裝置上執行的使用者工作階段。
JSON 表示法 | |
---|---|
{
"sessionId": string,
"deviceCategory": string,
"platform": string,
"dataSource": string,
"activities": [
{
object( |
欄位 | |
---|---|
sessionId |
工作階段的專屬 ID。 |
deviceCategory |
使用的裝置類型:「&mobile;」和「平板電腦」等 |
platform |
發生活動的平台:「android」和「ios」等。 |
dataSource |
這是匹配的資料來源。根據預設,analytics.js 傳送的命中資料會顯示為「網站」,從行動 SDK 傳送的命中資料則為「應用程式」。您可以在 Measurement Protocol 中覆寫這些值。 |
activities[] |
代表本工作階段中每項活動的詳細檢視。 |
sessionDate |
這個工作階段的日期,採 ISO-8601 格式。 |
活動
「活動」代表使用者的活動資料。請注意,「活動」與命中不同。命中可能會導致多次活動。舉例來說,如果命中包含交易和目標達成數,則該次命中會有兩個活動原型,一個用於 ECOMMERCE 和一個目標。相反地,多次命中也能建構單一活動。在傳統電子商務中,特定交易的資料可能會透過多個命中傳送。這些命中將合併為單一 ECOMMERCE 活動。
JSON 表示法 | |
---|---|
{ "activityTime": string, "source": string, "medium": string, "channelGrouping": string, "campaign": string, "keyword": string, "hostname": string, "landingPagePath": string, "activityType": enum( |
欄位 | ||
---|---|---|
activityTime |
活動的時間戳記。 RFC3339 世界標準時間「Zulu」格式的時間戳記,精確度達奈秒單位,範例: |
|
source |
參照連結網址的來源。如果是手動廣告活動追蹤,這是 utm_source 廣告活動追蹤參數的值。如果是 AdWords 自動標記,則代表 Google。如果這兩個來源都不使用,則來源是指使用者參照的來源網域 (例如 document.referrer)。也可能包含通訊埠位址。如果使用者未加入參照網址,其值會是 (直接)。 |
|
medium |
參照連結網址類型。如果是手動廣告活動追蹤,這是 utm_medium 廣告活動追蹤參數的值。在 AdWords 自動標記中,就是單次點擊出價。如果使用者來自 Google Analytics (分析) 偵測到的搜尋引擎,則屬於自然流量。如果參照網址不是搜尋引擎,則是指參照連結網址。如果使用者是直接前往資源,而且 document.referrer 為空白,其值會是 (無)。 |
|
channelGrouping |
與這個資料檢視的使用者工作階段相關聯的管道分組 (由資料檢視的管道分組定義)。 |
|
campaign |
如果是手動廣告活動追蹤,這是 utm_campaign 廣告活動追蹤參數的值。對於 AdWords 自動標記,這是指您在資源中使用的線上廣告活動名稱。如果這兩個選項皆未使用,其值會是「(未設定)」。 |
|
keyword |
如果是手動廣告活動追蹤,這是 utm_term 廣告活動追蹤參數的值。如果是 AdWords 流量,則會包含最符合的指定條件。如果多媒體廣告聯播網有多個廣告指定條件,導致廣告無法顯示,系統會傳回與 Google Ads 所選最適合的指定條件。其類型可以是 display_keyword、網站刊登位置、omomlist、使用者興趣、年齡或性別。否則,這個值會是 (未設定)。 |
|
hostname |
發出追蹤要求的主機名稱。 |
|
landingPagePath |
使用者 # 中的第一個網頁;工作階段或到達網頁。 |
|
activityType |
此活動的類型。 |
|
customDimension[] |
與這個活動相關聯的所有自訂維度清單。 |
|
聯集欄位 activity_details 。視 activity_type 而定,只會設定下列其中一個欄位。activity_details 只能是下列其中一個值: |
||
pageview |
如果 |
|
appview |
如果 |
|
ecommerce |
如果 |
|
goals |
這個欄位包含當 |
|
event |
這個欄位包含與活動相關的所有詳細資料,如果 |
自訂維度
自訂維度。
JSON 表示法 | |
---|---|
{ "index": number, "value": string } |
欄位 | |
---|---|
index |
自訂維度的版位數量。 |
value |
自訂維度的值。預設值 (即空白字串) 表示清除工作階段數/訪客範圍自訂維度值。 |
網頁瀏覽資料
代表訪客瀏覽網頁時系統收集的詳細資料。
JSON 表示法 | |
---|---|
{ "pagePath": string, "pageTitle": string } |
欄位 | |
---|---|
pagePath |
訪客瀏覽過的網頁網址。 |
pageTitle |
訪客瀏覽過的網頁標題。 |
畫面瀏覽資料
JSON 表示法 | |
---|---|
{ "screenName": string, "mobileDeviceBranding": string, "mobileDeviceModel": string, "appName": string } |
欄位 | |
---|---|
screenName |
畫面的名稱。 |
mobileDeviceBranding |
行動製造商或品牌名稱。例如「Google」和「Apple」等 |
mobileDeviceModel |
行動裝置型號。例如「Pixel」或「iPhone」等。 |
appName |
應用程式名稱。 |
電子商務資料
與使用者活動相關的電子商務詳細資料。
JSON 表示法 | |
---|---|
{ "actionType": enum( |
欄位 | |
---|---|
actionType |
與這項電子商務動作相關的動作。 |
transaction |
這項電子商務動作的交易詳情。 |
products[] |
這筆交易中的產品詳細資料。 |
ecommerceType |
這項電子商務活動的類型。 |
電子商務
與電子商務動作相關的所有動作組合。
列舉 | |
---|---|
UNKNOWN |
動作類型不明。 |
CLICK |
點擊產品清單。 |
DETAILS_VIEW |
查看產品詳細資料。 |
ADD_TO_CART |
將產品加入購物車。 |
REMOVE_FROM_CART |
從購物車中移除產品。 |
CHECKOUT |
結帳。 |
PAYMENT |
購買完成。 |
REFUND |
購買退款。 |
CHECKOUT_OPTION |
結帳選項。 |
交易資料
代表訪客在網頁上執行交易時所收集的詳細資料。
JSON 表示法 | |
---|---|
{ "transactionId": string, "transactionRevenue": number, "transactionTax": number, "transactionShipping": number } |
欄位 | |
---|---|
transactionId |
使用電子商務追蹤方法為購物車中的交易提供的交易 ID。 |
transactionRevenue |
交易的總收益 (不含運費和稅金)。 |
transactionTax |
交易的稅金總額。 |
transactionShipping |
運費總額。 |
產品資料
電子商務交易的產品詳細資料。
JSON 表示法 | |
---|---|
{ "productSku": string, "productName": string, "itemRevenue": number, "productQuantity": string } |
欄位 | |
---|---|
productSku |
代表產品的專屬代碼。 |
productName |
電子商務追蹤應用程式提供的已購買產品名稱。 |
itemRevenue |
售出產品總收益。 |
productQuantity |
交易中的這項產品單位總數。 |
電子商務類型
這代表要傳回的電子商務資料類型。
列舉 | |
---|---|
ECOMMERCE_TYPE_UNSPECIFIED |
未指定電子商務活動類型時使用。 |
CLASSIC |
當活動具有傳統版 (非加強型) 電子商務資訊時。 |
ENHANCED |
用於提供加強型電子商務資訊的活動。 |
目標組合資料
代表活動中達成的一組目標。
JSON 表示法 | |
---|---|
{
"goals": [
{
object( |
欄位 | |
---|---|
goals[] |
目前活動中達成的所有目標。 |
目標資料
代表與目標相關的所有詳細資料。
JSON 表示法 | |
---|---|
{ "goalIndex": number, "goalCompletions": string, "goalValue": number, "goalCompletionLocation": string, "goalPreviousStep1": string, "goalPreviousStep2": string, "goalPreviousStep3": string, "goalName": string } |
欄位 | |
---|---|
goalIndex |
這是指為設定檔所設定的目標。 |
goalCompletions |
此活動中的目標達成總次數。 |
goalValue |
這個目標中的值。 |
goalCompletionLocation |
目標達成的網頁網址。 |
goalPreviousStep1 |
目標達成前一步的網頁網址。 |
goalPreviousStep2 |
目標達成前兩個步驟的網頁網址。 |
goalPreviousStep3 |
目標達成前三個步驟的網頁網址。 |
goalName |
目標的名稱。 |
事件資料
代表與活動相關的所有詳細資料。
JSON 表示法 | |
---|---|
{ "eventCategory": string, "eventAction": string, "eventLabel": string, "eventValue": string, "eventCount": string } |
欄位 | |
---|---|
eventCategory |
發生網頁上互動的物件。例如:##99;Video'. |
eventAction |
與物件的互動類型。例如:##99;play' |
eventLabel |
附加於事件的標籤。 |
eventValue |
與事件相關聯的數字值。 |
eventCount |
此活動中的這類事件數量。 |