- คำขอ HTTP
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- ผู้ใช้
- UserIdType
- ActivityType
- UserActivitySession
- กิจกรรม
- CustomDimension
- PageviewData
- ScreenviewData
- EcommerceData
- ECommerceAction
- TransactionData
- ProductData
- EcommerceType
- GoalSetData
- GoalData
- EventData
- ลองใช้งาน
แสดงผลข้อมูลกิจกรรมของผู้ใช้
คำขอ HTTP
POST https://analyticsreporting.googleapis.com/v4/userActivity:search
URL ใช้ไวยากรณ์การแปลง gRPC
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างต่อไปนี้
การแสดง JSON | |
---|---|
{ "dateRange": { object( |
ช่อง | |
---|---|
dateRange |
ช่วงวันที่ที่จะเรียกกิจกรรมของผู้ใช้ หากไม่ได้ระบุช่วงวันที่ ช่วงวันที่เริ่มต้นคือ (startDate: วันที่ปัจจุบัน - 7 วัน, endDate: วันที่ปัจจุบัน - 1 วัน) |
viewId |
ต้องระบุ รหัสข้อมูลพร็อพเพอร์ตี้ของ Analytics ที่จะดึงข้อมูล SearchUserActivityRequest ทั้งหมดต้องมี |
user |
ต้องระบุ ID ผู้ใช้ที่ไม่ซ้ำในการค้นหา SearchUserActivityRequest ทั้งหมดต้องมีช่องนี้ |
activityTypes[] |
ชุดประเภทกิจกรรมทั้งหมดที่ขอ ระบบจะแสดงผลเฉพาะกิจกรรมที่ตรงกับประเภทเหล่านี้ในคำตอบ หากว่างเปล่า ระบบจะส่งคืนกิจกรรมทั้งหมด |
pageSize |
ขนาดของหน้าเว็บมีไว้สำหรับการแบ่งหน้าและระบุจำนวนแถวที่ส่งกลับสูงสุด ขนาดหน้าควรมากกว่า 0 หากค่าเป็น 0 หรือไม่ได้ระบุฟิลด์ คำขอจะแสดงค่าเริ่มต้น 1, 000 แถวต่อหน้า |
pageToken |
โทเค็นความต่อเนื่องสำหรับรับผลการค้นหาหน้าถัดไป การเพิ่มข้อมูลนี้ไปยังคําขอจะแสดงแถวต่อจาก pageToken pageToken ควรเป็นค่าที่แสดงผลในพารามิเตอร์ nextPageToken ในการตอบสนองต่อคําขอ SearchUserActivityRequest |
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
คำตอบจากการโทร userActivity:get
การแสดง JSON | |
---|---|
{
"sessions": [
{
object( |
ช่อง | |
---|---|
sessions[] |
ระเบียนแต่ละรายการแสดงเซสชัน (รายละเอียดอุปกรณ์ ระยะเวลา ฯลฯ) |
totalRows |
แถวทั้งหมดที่แสดงผลโดยข้อความค้นหานี้ (จากหน้าต่างๆ) |
nextPageToken |
ระบบควรส่งโทเค็นนี้ไปยัง SearchUserActivityRequest เพื่อเรียกข้อมูลหน้าถัดไป |
sampleRate |
ช่องนี้แสดงอัตราการสุ่มตัวอย่างสำหรับคำขอที่ระบุและเป็นตัวเลขระหว่าง 0.0 ถึง 1.0 ดูรายละเอียดได้จากคู่มือนักพัฒนาซอฟต์แวร์ |
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
ผู้ใช้
มีข้อมูลที่ระบุตัวผู้ใช้ได้แบบไม่ซ้ำกัน
การแสดง JSON | |
---|---|
{
"type": enum( |
ช่อง | |
---|---|
type |
ประเภทของผู้ใช้ในคำขอ ช่อง |
userId |
รหัสที่ไม่ซ้ำกันของผู้ใช้ที่มีการขอข้อมูล |
UserIdType
แสดงการระบุตัวตนของผู้ใช้ประเภทต่างๆ ที่มี
Enum | |
---|---|
USER_ID_TYPE_UNSPECIFIED |
หากไม่ได้ระบุประเภทรหัสผู้ใช้ ประเภทเริ่มต้นที่ใช้จะเป็น CLIENT_ID |
USER_ID |
ผู้ใช้ 1 ราย เช่น บัญชีผู้ใช้ที่ลงชื่อเข้าใช้ ซึ่งอาจโต้ตอบกับเนื้อหาในอินสแตนซ์ของอุปกรณ์และ/หรือเบราว์เซอร์ 1 รายการขึ้นไป |
CLIENT_ID |
รหัสลูกค้าที่ Analytics กำหนด |
ActivityType
Enum | |
---|---|
ACTIVITY_TYPE_UNSPECIFIED |
ActivityType จะไม่มีค่านี้ในคำตอบ การใช้ประเภทนี้ในคำขอจะทำให้เกิดข้อผิดพลาด |
PAGEVIEW |
ใช้เมื่อกิจกรรมเป็นผลมาจากการที่ผู้เข้าชมดูหน้าเว็บ |
SCREENVIEW |
ใช้เมื่อกิจกรรมเกิดจากผู้เข้าชมที่ใช้แอปพลิเคชันบนอุปกรณ์เคลื่อนที่ |
GOAL |
ใช้เพื่อระบุว่ากิจกรรมประเภทเป้าหมาย |
ECOMMERCE |
ผู้เข้าชมหน้านี้ทำธุรกรรมอีคอมเมิร์ซ |
EVENT |
ใช้เมื่อกิจกรรมเป็นเหตุการณ์ |
UserActivitySession
ค่านี้แสดงถึงเซสชันของผู้ใช้ที่เกิดขึ้นในอุปกรณ์หนึ่งๆ ในช่วงเวลาหนึ่งๆ ในช่วงเวลาหนึ่ง
การแสดง JSON | |
---|---|
{
"sessionId": string,
"deviceCategory": string,
"platform": string,
"dataSource": string,
"activities": [
{
object( |
ช่อง | |
---|---|
sessionId |
รหัสที่ไม่ซ้ำกันของเซสชัน |
deviceCategory |
ประเภทของอุปกรณ์ที่ใช้ ได้แก่ "มือถือ" "แท็บเล็ต" ฯลฯ |
platform |
แพลตฟอร์มที่กิจกรรมเกิดขึ้น เช่น "android", "ios" ฯลฯ |
dataSource |
แหล่งข้อมูลของ Hit โดยค่าเริ่มต้น Hit ที่ส่งจาก analytics.js จะได้รับการรายงานเป็น "เว็บ" ขณะที่ Hit ที่ส่งจาก SDK อุปกรณ์เคลื่อนที่จะได้รับการรายงานเป็น "แอป" คุณลบล้างค่าเหล่านี้ได้ใน Measurement Protocol |
activities[] |
แสดงมุมมองโดยละเอียดของแต่ละกิจกรรมในเซสชันนี้ |
sessionDate |
วันที่ของเซสชันนี้ในรูปแบบ ISO-8601 |
กิจกรรม
กิจกรรมแสดงข้อมูลสำหรับกิจกรรมของผู้ใช้ โปรดทราบว่ากิจกรรมแตกต่างจาก Hit Hit อาจทำให้เกิดกิจกรรมหลายรายการ ตัวอย่างเช่น หาก Hit มีธุรกรรมและเป้าหมายที่สำเร็จ จะมี Pro กิจกรรม 2 รายการสำหรับ Hit นี้ โดยรายการหนึ่งคือ ECOMMERCE และอีกรายการหนึ่งคือ GOAL ในทางกลับกัน Hit หลายรายการก็สามารถสร้างกิจกรรมเดียวได้เช่นกัน ในอีคอมเมิร์ซแบบคลาสสิก ข้อมูลสำหรับธุรกรรมหนึ่งอาจส่งผ่าน Hit หลายครั้ง Hit เหล่านี้จะรวมเป็นกิจกรรม ECOMMERCE รายการเดียว
การแสดง JSON | |
---|---|
{ "activityTime": string, "source": string, "medium": string, "channelGrouping": string, "campaign": string, "keyword": string, "hostname": string, "landingPagePath": string, "activityType": enum( |
ช่อง | ||
---|---|---|
activityTime |
การประทับเวลาของกิจกรรม การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่แม่นยำเป็นหน่วยนาโนวินาที ตัวอย่าง: |
|
source |
แหล่งที่มาของการอ้างอิง สำหรับการติดตามแคมเปญด้วยตนเอง นี่คือค่าพารามิเตอร์การติดตามแคมเปญ utm_source ส่วนการติดแท็กอัตโนมัติของ AdWords ก็คือ Google ถ้าคุณไม่ได้ใช้ทั้งสองประเภท ข้อมูลนี้จะเป็นโดเมนของแหล่งที่มา (เช่น document.referrer) ที่อ้างอิงผู้ใช้ และอาจมีที่อยู่พอร์ตด้วย หากผู้ใช้เข้ามาโดยไม่มี URL ที่มา ค่าที่ได้จะเป็น (โดยตรง) |
|
medium |
ประเภทของการอ้างอิง สำหรับการติดตามแคมเปญด้วยตนเอง นี่คือค่าพารามิเตอร์การติดตามแคมเปญ utm_medium สำหรับการติดแท็กอัตโนมัติของ AdWords จะเป็น CPC หากผู้ใช้มาจากเครื่องมือค้นหาที่ Google Analytics ตรวจพบ นั่นจะเป็นการค้นหาทั่วไป หาก URL ที่มาไม่ใช่เครื่องมือค้นหา แสดงว่าเป็นการอ้างอิง หากผู้ใช้มาที่พร็อพเพอร์ตี้โดยตรงและ document.referrer จะว่างเปล่า ค่าจะเป็น (none) |
|
channelGrouping |
กลุ่มแชแนลที่เชื่อมโยงกับเซสชันของผู้ใช้ปลายทางสำหรับข้อมูลพร็อพเพอร์ตี้นี้ (กำหนดโดยการจัด Channel Group ของข้อมูลพร็อพเพอร์ตี้) |
|
campaign |
สำหรับการติดตามแคมเปญด้วยตนเอง นี่คือค่าพารามิเตอร์การติดตามแคมเปญ utm_campaign สำหรับการติดแท็กอัตโนมัติของ AdWords จะเป็นชื่อของแคมเปญโฆษณาออนไลน์ที่คุณใช้สำหรับพร็อพเพอร์ตี้ หากคุณไม่ใช้ทั้งสอง ค่าจะเป็น (not set) |
|
keyword |
สำหรับการติดตามแคมเปญด้วยตนเอง นี่คือค่าพารามิเตอร์การติดตามแคมเปญ utm_term สำหรับการเข้าชม AdWords การเข้าชมนี้มีเกณฑ์การกำหนดเป้าหมายที่ตรงที่สุด สำหรับเครือข่าย Display ซึ่งเกณฑ์การกำหนดเป้าหมายหลายเกณฑ์อาจทำให้โฆษณาแสดงได้ เครือข่ายนี้จะแสดงเกณฑ์การกำหนดเป้าหมายที่ตรงกันมากที่สุดตามที่ Google Ads เลือกไว้ ซึ่งอาจเป็น display_keyword, ตำแหน่งเว็บไซต์, boomuserlist, user_interest, อายุ หรือเพศ ไม่เช่นนั้นให้มีค่าเป็น (not set) |
|
hostname |
ชื่อโฮสต์ที่ส่งคำขอติดตาม |
|
landingPagePath |
หน้าแรกในเซสชันของผู้ใช้หรือหน้า Landing Page |
|
activityType |
ประเภทของกิจกรรมนี้ |
|
customDimension[] |
รายการมิติข้อมูลที่กําหนดเองทั้งหมดที่เชื่อมโยงกับกิจกรรมนี้ |
|
ฟิลด์สหภาพ activity_details ระบบจะตั้งค่าในช่องใดช่องหนึ่งต่อไปนี้ โดยขึ้นอยู่กับ activity_type activity_details ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
||
pageview |
ระบบจะตั้งค่านี้หาก |
|
appview |
ระบบจะตั้งค่านี้หาก |
|
ecommerce |
ระบบจะตั้งค่านี้หาก |
|
goals |
ช่องนี้มีรายการเป้าหมายทั้งหมดที่ได้รับในกิจกรรมนี้เมื่อ |
|
event |
ช่องนี้มีรายละเอียดทั้งหมดที่เกี่ยวข้องกับเหตุการณ์ และจะมีการตั้งค่าหาก |
CustomDimension
มิติข้อมูลที่กำหนดเอง
การแสดง JSON | |
---|---|
{ "index": number, "value": string } |
ช่อง | |
---|---|
index |
จำนวนช่องโฆษณาของมิติข้อมูลที่กำหนดเอง |
value |
ค่าของมิติข้อมูลที่กำหนดเอง ค่าเริ่มต้น (เช่น สตริงว่าง) จะหมายถึงการล้างค่ามิติข้อมูลที่กำหนดเองของขอบเขตประเภท/ผู้เข้าชม |
PageviewData
แสดงรายละเอียดที่รวบรวมเมื่อผู้เข้าชมดูหน้าเว็บ
การแสดง JSON | |
---|---|
{ "pagePath": string, "pageTitle": string } |
ช่อง | |
---|---|
pagePath |
URL ของหน้าเว็บที่ผู้เข้าชมดู |
pageTitle |
ชื่อของหน้าที่ผู้เข้าชมดู |
ScreenviewData
การแสดง JSON | |
---|---|
{ "screenName": string, "mobileDeviceBranding": string, "mobileDeviceModel": string, "appName": string } |
ช่อง | |
---|---|
screenName |
ชื่อหน้าจอ |
mobileDeviceBranding |
ผู้ผลิตอุปกรณ์เคลื่อนที่หรือชื่อแบรนด์ เช่น "Google", "Apple" ฯลฯ |
mobileDeviceModel |
รุ่นอุปกรณ์เคลื่อนที่ เช่น "Pixel", "iPhone" ฯลฯ |
appName |
ชื่อแอปพลิเคชัน |
EcommerceData
รายละเอียดอีคอมเมิร์ซที่เชื่อมโยงกับกิจกรรมของผู้ใช้
การแสดง JSON | |
---|---|
{ "actionType": enum( |
ช่อง | |
---|---|
actionType |
การดำเนินการที่เชื่อมโยงกับการดำเนินการอีคอมเมิร์ซนี้ |
transaction |
รายละเอียดธุรกรรมของการดำเนินการอีคอมเมิร์ซนี้ |
products[] |
รายละเอียดผลิตภัณฑ์ในธุรกรรมนี้ |
ecommerceType |
ประเภทของกิจกรรมอีคอมเมิร์ซนี้ |
ECommerceAction
ชุดของการดำเนินการทั้งหมดที่เชื่อมโยงกับการดำเนินการอีคอมเมิร์ซ
Enum | |
---|---|
UNKNOWN |
ไม่รู้จักประเภทการดำเนินการ |
CLICK |
คลิกผ่านรายการผลิตภัณฑ์ |
DETAILS_VIEW |
การดูรายละเอียดผลิตภัณฑ์ |
ADD_TO_CART |
เพิ่มผลิตภัณฑ์ลงในรถเข็น |
REMOVE_FROM_CART |
นำผลิตภัณฑ์ออกจากรถเข็น |
CHECKOUT |
ชำระเงิน |
PAYMENT |
การซื้อเสร็จสมบูรณ์ |
REFUND |
การคืนเงินจากการซื้อ |
CHECKOUT_OPTION |
ตัวเลือกการชำระเงิน |
TransactionData
แสดงรายละเอียดที่เก็บรวบรวมเมื่อผู้เข้าชมทำธุรกรรมบนหน้าเว็บ
การแสดง JSON | |
---|---|
{ "transactionId": string, "transactionRevenue": number, "transactionTax": number, "transactionShipping": number } |
ช่อง | |
---|---|
transactionId |
รหัสธุรกรรมที่ระบุโดยวิธีการติดตามอีคอมเมิร์ซสำหรับการซื้อสินค้าในรถเข็นช็อปปิ้ง |
transactionRevenue |
รายได้จากการขายทั้งหมด (ไม่รวมค่าจัดส่งและภาษี) ของธุรกรรม |
transactionTax |
ภาษีรวมสำหรับธุรกรรม |
transactionShipping |
ค่าจัดส่งทั้งหมด |
ProductData
รายละเอียดผลิตภัณฑ์ในธุรกรรมอีคอมเมิร์ซ
การแสดง JSON | |
---|---|
{ "productSku": string, "productName": string, "itemRevenue": number, "productQuantity": string } |
ช่อง | |
---|---|
productSku |
รหัสที่ไม่ซ้ำกันซึ่งแสดงถึงผลิตภัณฑ์ |
productName |
ชื่อผลิตภัณฑ์ที่ระบุโดยแอปพลิเคชันการติดตามอีคอมเมิร์ซสำหรับสินค้าที่ซื้อ |
itemRevenue |
รายได้ทั้งหมดจากรายการผลิตภัณฑ์ที่ซื้อ |
productQuantity |
จำนวนรวมของหน่วยผลิตภัณฑ์นี้ในธุรกรรม |
EcommerceType
ค่านี้แสดงถึงประเภทข้อมูลอีคอมเมิร์ซที่มีการส่งคืน
Enum | |
---|---|
ECOMMERCE_TYPE_UNSPECIFIED |
ใช้เมื่อไม่ได้ระบุประเภทกิจกรรมอีคอมเมิร์ซ |
CLASSIC |
ใช้เมื่อกิจกรรมมีข้อมูลอีคอมเมิร์ซแบบคลาสสิก (ยังไม่ปรับปรุง) |
ENHANCED |
ใช้เมื่อกิจกรรมมีการเพิ่มประสิทธิภาพข้อมูลอีคอมเมิร์ซ |
GoalSetData
หมายถึงชุดเป้าหมายที่ได้มาถึงในกิจกรรม
การแสดง JSON | |
---|---|
{
"goals": [
{
object( |
ช่อง | |
---|---|
goals[] |
เป้าหมายทั้งหมดที่บรรลุในกิจกรรมปัจจุบัน |
GoalData
แสดงรายละเอียดทั้งหมดที่เกี่ยวข้องกับเป้าหมาย
การแสดง JSON | |
---|---|
{ "goalIndex": number, "goalCompletions": string, "goalValue": number, "goalCompletionLocation": string, "goalPreviousStep1": string, "goalPreviousStep2": string, "goalPreviousStep3": string, "goalName": string } |
ช่อง | |
---|---|
goalIndex |
ค่านี้ระบุว่าเป้าหมายเป็นการกำหนดค่าสำหรับโปรไฟล์ |
goalCompletions |
จำนวนเป้าหมายที่สำเร็จทั้งหมดในกิจกรรมนี้ |
goalValue |
มูลค่าในเป้าหมายนี้ |
goalCompletionLocation |
URL ของหน้าที่เป้าหมายนี้เสร็จสมบูรณ์ |
goalPreviousStep1 |
URL ของหน้าเว็บ 1 ขั้นตอนก่อนเป้าหมายที่สำเร็จ |
goalPreviousStep2 |
URL ของหน้าเว็บ 2 ขั้นตอนก่อนเป้าหมายที่สำเร็จ |
goalPreviousStep3 |
URL ของหน้าเว็บ 3 ขั้นตอนก่อนเป้าหมายที่สำเร็จ |
goalName |
ชื่อเป้าหมาย |
EventData
แสดงรายละเอียดทั้งหมดที่เกี่ยวข้องกับกิจกรรม
การแสดง JSON | |
---|---|
{ "eventCategory": string, "eventAction": string, "eventLabel": string, "eventValue": string, "eventCount": string } |
ช่อง | |
---|---|
eventCategory |
ออบเจ็กต์บนหน้าเว็บที่มีการโต้ตอบ เช่น "วิดีโอ" |
eventAction |
ประเภทการโต้ตอบกับออบเจ็กต์ เช่น "เล่น" |
eventLabel |
แนบป้ายกำกับพร้อมกับกิจกรรมแล้ว |
eventValue |
ค่าตัวเลขที่เชื่อมโยงกับเหตุการณ์ |
eventCount |
จำนวนเหตุการณ์ดังกล่าวในกิจกรรมนี้ |