- בקשת HTTP
- גוף הבקשה
- גוף התגובה
- היקפי הרשאה
- משתמש
- UserIdType
- סוג הפעילות
- UserActivitySession
- פעילות
- מאפיין מותאם אישית
- PageviewData
- נתוני צפייה במסך
- נתוני מסחר אלקטרוני
- מסחר אלקטרוני
- נתוני עסקאות
- נתוני מוצרים
- סוג מסחר אלקטרוני
- DestinationSetData
- מטרה עסקית
- נתוני אירועים
- רוצים לנסות?
מחזירה נתונים של פעילות משתמשים.
בקשת HTTP
POST https://analyticsreporting.googleapis.com/v4/userActivity:search
כתובת ה-URL כוללת תחביר gRPC קידוד מחדש.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON | |
---|---|
{ "dateRange": { object( |
שדות | |
---|---|
dateRange |
טווח התאריכים שממנו יש לאחזר את פעילות המשתמש. אם לא מציינים טווח תאריכים, טווח התאריכים המוגדר כברירת מחדל הוא (startDate: date הנוכחי - 7 ימים, endDate: התאריך הנוכחי - יום אחד). |
viewId |
חובה. מזהה התצוגה המפורטת ב-Analytics שממנו יש לאחזר נתונים. כל SearchUserActivityRequest חייב להכיל את |
user |
חובה. מזהה המשתמש הייחודי שעבורו רוצים לשלוח שאילתה. כל 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
מייצגים סוגים שונים של זיהוי משתמשים זמינים.
Enums | |
---|---|
USER_ID_TYPE_UNSPECIFIED |
כאשר לא מציינים את סוג מזהה המשתמש, סוג ברירת המחדל שבו הוא יהיה CLIENT_ID. |
USER_ID |
משתמש יחיד, למשל חשבון משתמש מחובר, שעשוי ליצור אינטראקציה עם תוכן במכשיר אחד או יותר או במופע דפדפן אחד או יותר. |
CLIENT_ID |
מזהה הלקוח שהוקצה על ידי Analytics. |
סוג פעילות
Enums | |
---|---|
ACTIVITY_TYPE_UNSPECIFIED |
סוג הפעילות לא יכלול אף פעם את הערך הזה בתשובה. שימוש בסוג הזה בבקשה יגרום לשגיאה. |
PAGEVIEW |
משמש כאשר הפעילות גרמה לכך שמבקר הציג דף. |
SCREENVIEW |
משמש כאשר הפעילות נגרמת ממבקר שמשתמש באפליקציה במכשיר נייד. |
GOAL |
משמש לציון פעילות מסוג יעד. |
ECOMMERCE |
עסקת המסחר האלקטרוני בוצעה על ידי המבקר בדף. |
EVENT |
משמשים כאשר הפעילות היא אירוע. |
פעילות משתמש בפעילות
הנתון הזה מייצג ביקור של משתמש במכשיר מסוים בפרק זמן מסוים במהלך תקופת זמן מסוימת.
ייצוג JSON | |
---|---|
{
"sessionId": string,
"deviceCategory": string,
"platform": string,
"dataSource": string,
"activities": [
{
object( |
שדות | |
---|---|
sessionId |
המזהה הייחודי של הסשן. |
deviceCategory |
סוג המכשיר שבשימוש: "mobile", "tablet" וכו'. |
platform |
הפלטפורמה שבה התרחשה הפעילות: "android", "ios" וכו'. |
dataSource |
מקור הנתונים של היט. כברירת מחדל, היטים שנשלחים מ-analytics.js מדווחים כ-"web", והיטים שנשלחים מערכות SDK לנייד מדווחים כ-"app". אפשר לשנות את הערכים האלה ב-Measurement Protocol. |
activities[] |
מייצג תצוגה מפורטת של כל אחת מהפעילויות באתר הזה. |
sessionDate |
תאריך הפעילות הזו בפורמט ISO-8601. |
פעילות
פעילות מייצגת נתונים לגבי פעילות של משתמש. חשוב לזכור שפעילות שונה מהיט. היט עשוי לגרום למספר פעילויות. לדוגמה, אם היט כולל עסקה והשלמת מטרה עסקית, יהיו שתי פרוטומות של פעילות על ההיט הזה, אחת עבור ECOMMERCE ואחת עבור GOAL. לעומת זאת, היטים מרובים יכולים גם ליצור פעילות אחת. במסחר אלקטרוני קלאסי, נתונים על עסקה אחת עשויים להישלח כמה היטים. ההיטים האלה ימוזגו לפעילות 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) שמפנה את המשתמשים. ייתכן שהוא כולל גם כתובת ליציאה. אם משתמשים הגיעו ללא גורם מפנה, הערך שלו הוא (ישיר). |
|
medium |
סוג ההפניות. במעקב ידני אחר קמפיין הוא הערך של הפרמטר utm_medium למעקב אחר קמפיינים. עבור תיוג אוטומטי של AdWords, זהו מחיר לקליק. אם המשתמשים מגיעים ממנוע חיפוש שזוהה על ידי Google Analytics, החיפוש הוא אורגני. אם הגורם המפנה אינו מנוע חיפוש, הוא הפניה. אם משתמשים הגיעו ישירות לנכס והמסמך document.referrer ריק, הערך שלו הוא (ללא). |
|
channelGrouping |
קבוצת הערוצים המשויכת לסשן של משתמש קצה עבור התצוגה המפורטת הזו (מוגדר על ידי קיבוצי הערוצים של התצוגה המפורטת). |
|
campaign |
במעקב ידני אחר קמפיין הוא הערך של פרמטר המעקב utm_campaign. לצורך התיוג האוטומטי של AdWords, זהו השם של הקמפיינים באינטרנט שבהם אתם משתמשים בנכס. אם לא משתמשים באף אחד מהערכים, הערך שלו הוא (not set). |
|
keyword |
במעקב ידני אחר קמפיין הוא הערך של הפרמטר utm_term למעקב אחר קמפיינים. עבור תנועה ב-AdWords, היא מכילה את הקריטריונים המתאימים ביותר לטירגוט. ברשת המדיה, שייתכן שקריטריוני טירגוט מרובים גרמו להצגתה, היא מחזירה את קריטריוני הטירגוט התואמים ביותר שנבחרו על ידי Google Ads. הסוג הזה יכול להיות display_keyword, מיקום האתר, boomuserlist, user_תחומי עניין, גיל או מגדר. אחרת, הערך שלו הוא (not set). |
|
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 |
כתובת ה-URL של הדף שבו המבקר צפה. |
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 |
הסוג של פעילות המסחר האלקטרוני. |
פעולה מסחר אלקטרוני
קבוצת כל הפעולות המשויכות לפעולת מסחר אלקטרוני.
Enums | |
---|---|
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 |
מזהה העסקה שסופק על ידי שיטת המעקב אחר מסחר אלקטרוני, עבור הרכישה בעגלת הקניות. |
transactionRevenue |
ההכנסה הכוללת מהמכירה (לא כולל משלוח ומיסים) של העסקה. |
transactionTax |
המס הכולל על העסקה. |
transactionShipping |
עלות המשלוח הכוללת. |
נתוני המוצר
פרטי המוצרים בעסקת מסחר אלקטרוני.
ייצוג JSON | |
---|---|
{ "productSku": string, "productName": string, "itemRevenue": number, "productQuantity": string } |
שדות | |
---|---|
productSku |
קוד ייחודי שמייצג את המוצר. |
productName |
שם המוצר, שסופק על ידי האפליקציה למעקב אחר מסחר אלקטרוני, עבור הפריטים שנרכשו. |
itemRevenue |
ההכנסה הכוללת מפריטי מוצרים שנרכשו. |
productQuantity |
המספר הכולל של יחידות המוצרים בעסקה. |
סוג מסחר אלקטרוני
זה מייצג את סוג הנתונים של המסחר האלקטרוני שמוחזרו.
Enums | |
---|---|
ECOMMERCE_TYPE_UNSPECIFIED |
משמש כשסוג הפעילות במסחר אלקטרוני לא מוגדר. |
CLASSIC |
משמש כשיש לפעילות מידע על מסחר אלקטרוני קלאסי (ללא אופטימיזציה). |
ENHANCED |
משמש כשהפעילות כוללת מידע משופר על מסחר אלקטרוני. |
יעד setData
מייצג קבוצה של יעדים שהושגו בפעילות.
ייצוג 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 |
כתובת ה-URL של הדף שבו יעד זה הושלם. |
goalPreviousStep1 |
כתובת ה-URL של הדף, שלב אחד לפני השלמת היעד. |
goalPreviousStep2 |
כתובת ה-URL של הדף בשני שלבים לפני השלמת היעד. |
goalPreviousStep3 |
כתובת ה-URL של הדף שלושה שלבים לפני השלמת היעד. |
goalName |
שם המטרה העסקית. |
נתוני אירוע
מוצגים כל הפרטים הקשורים לאירוע.
ייצוג JSON | |
---|---|
{ "eventCategory": string, "eventAction": string, "eventLabel": string, "eventValue": string, "eventCount": string } |
שדות | |
---|---|
eventCategory |
האובייקט בדף שהייתה לו אינטראקציה איתו. Eg: 'Video'. |
eventAction |
סוג האינטראקציה עם האובייקט. E.: 'play'. |
eventLabel |
התווית מצורפת לאירוע. |
eventValue |
ערך נומרי שמשויך לאירוע. |
eventCount |
מספר האירועים כאלה בפעילות הזו. |