Method: userActivity.search

מחזירה נתונים של פעילות משתמשים.

בקשת HTTP

POST https://analyticsreporting.googleapis.com/v4/userActivity:search

כתובת ה-URL כוללת תחביר gRPC קידוד מחדש.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON
{
  "dateRange": {
    object(DateRange)
  },
  "viewId": string,
  "user": {
    object(User)
  },
  "activityTypes": [
    enum(ActivityType)
  ],
  "pageSize": number,
  "pageToken": string
}
שדות
dateRange

object(DateRange)

טווח התאריכים שממנו יש לאחזר את פעילות המשתמש. אם לא מציינים טווח תאריכים, טווח התאריכים המוגדר כברירת מחדל הוא (startDate: date הנוכחי - 7 ימים, endDate: התאריך הנוכחי - יום אחד).

viewId

string

חובה. מזהה התצוגה המפורטת ב-Analytics שממנו יש לאחזר נתונים. כל SearchUserActivityRequest חייב להכיל את viewId.

user

object(User)

חובה. מזהה המשתמש הייחודי שעבורו רוצים לשלוח שאילתה. כל SearchUserActivityRequest חייב להכיל את השדה הזה.

activityTypes[]

enum(ActivityType)

כל סוגי הפעילות המבוקשים. יוחזרו רק פעילויות שתואמות לסוגים אלה. אם השדה ריק, יוחזרו כל הפעילויות.

pageSize

number

גודל הדף מיועד להחלפה ומציין את המספר המקסימלי של שורות שהוחזרו. גודל הדף צריך להיות > 0. אם הערך הוא 0 או אם השדה לא מוגדר, הבקשה תחזיר את ברירת המחדל של 1,000 שורות לכל דף.

pageToken

string

אסימון המשך לקבלת הדף הבא של התוצאות. הוספת זאת לבקשה תחזיר את השורות אחרי pageToken. הפרמטר pageToken צריך להיות הערך המוחזר בפרמטר nextPageToken בתגובה לבקשה ל-SearchUserActivityRequest.

גוף התגובה

אם התגובה מוצלחת, גוף התגובה מכיל נתונים במבנה הבא:

התגובה משיחה אחת (userActivity:get).

ייצוג JSON
{
  "sessions": [
    {
      object(UserActivitySession)
    }
  ],
  "totalRows": number,
  "nextPageToken": string,
  "sampleRate": number
}
שדות
sessions[]

object(UserActivitySession)

כל רשומה מייצגת ביקור (פרטי המכשיר, משך זמן וכו').

totalRows

number

סה"כ השורות שהוחזרו על ידי השאילתה הזו (בכל הדפים השונים).

nextPageToken

string

יש להעביר את האסימון הזה אל SearchUserActivityRequest כדי לאחזר את הדף הבא.

sampleRate

number

שדה זה מייצג את קצב הדגימה של בקשה נתונה, והמספר הוא בין 0.0 ל-1.0. פרטים נוספים מופיעים במדריך למפתחים.

היקפי הרשאה

יש צורך באחד מהיקפי ה-OAuth הבאים:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

משתמש

מכיל מידע לזיהוי משתמש מסוים.

ייצוג JSON
{
  "type": enum(UserIdType),
  "userId": string
}
שדות
type

enum(UserIdType)

סוג המשתמש בבקשה. השדה userId משויך לסוג הזה.

userId

string

המזהה הייחודי של המשתמש שעבורו מבקשים את הנתונים.

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(Activity)
    }
  ],
  "sessionDate": string
}
שדות
sessionId

string

המזהה הייחודי של הסשן.

deviceCategory

string

סוג המכשיר שבשימוש: "mobile", "tablet" וכו'.

platform

string

הפלטפורמה שבה התרחשה הפעילות: "android", "ios" וכו'.

dataSource

string

מקור הנתונים של היט. כברירת מחדל, היטים שנשלחים מ-analytics.js מדווחים כ-"web", והיטים שנשלחים מערכות SDK לנייד מדווחים כ-"app". אפשר לשנות את הערכים האלה ב-Measurement Protocol.

activities[]

object(Activity)

מייצג תצוגה מפורטת של כל אחת מהפעילויות באתר הזה.

sessionDate

string

תאריך הפעילות הזו בפורמט ISO-8601.

פעילות

פעילות מייצגת נתונים לגבי פעילות של משתמש. חשוב לזכור שפעילות שונה מהיט. היט עשוי לגרום למספר פעילויות. לדוגמה, אם היט כולל עסקה והשלמת מטרה עסקית, יהיו שתי פרוטומות של פעילות על ההיט הזה, אחת עבור ECOMMERCE ואחת עבור GOAL. לעומת זאת, היטים מרובים יכולים גם ליצור פעילות אחת. במסחר אלקטרוני קלאסי, נתונים על עסקה אחת עשויים להישלח כמה היטים. ההיטים האלה ימוזגו לפעילות ECOMMERCE אחת.

ייצוג JSON
{
  "activityTime": string,
  "source": string,
  "medium": string,
  "channelGrouping": string,
  "campaign": string,
  "keyword": string,
  "hostname": string,
  "landingPagePath": string,
  "activityType": enum(ActivityType),
  "customDimension": [
    {
      object(CustomDimension)
    }
  ],

  // Union field activity_details can be only one of the following:
  "pageview": {
    object(PageviewData)
  },
  "appview": {
    object(ScreenviewData)
  },
  "ecommerce": {
    object(EcommerceData)
  },
  "goals": {
    object(GoalSetData)
  },
  "event": {
    object(EventData)
  }
  // End of list of possible types for union field activity_details.
}
שדות
activityTime

string (Timestamp format)

חותמת זמן של הפעילות.

חותמת זמן בפורמט RFC3339 UTC "Zulu" בדיוק של ננו-שניות. דוגמה: "2014-10-02T15:01:23.045123456Z"

source

string

המקור של ההפניות. במעקב ידני אחר קמפיין הוא הערך של הפרמטר utm_source למעקב אחר קמפיינים. התיוג האוטומטי של AdWords הוא google. אם לא משתמשים באף אחד מהדומיינים, זהו הדומיין של המקור (למשל, document.referrer) שמפנה את המשתמשים. ייתכן שהוא כולל גם כתובת ליציאה. אם משתמשים הגיעו ללא גורם מפנה, הערך שלו הוא (ישיר).

medium

string

סוג ההפניות. במעקב ידני אחר קמפיין הוא הערך של הפרמטר utm_medium למעקב אחר קמפיינים. עבור תיוג אוטומטי של AdWords, זהו מחיר לקליק. אם המשתמשים מגיעים ממנוע חיפוש שזוהה על ידי Google Analytics, החיפוש הוא אורגני. אם הגורם המפנה אינו מנוע חיפוש, הוא הפניה. אם משתמשים הגיעו ישירות לנכס והמסמך document.referrer ריק, הערך שלו הוא (ללא).

channelGrouping

string

קבוצת הערוצים המשויכת לסשן של משתמש קצה עבור התצוגה המפורטת הזו (מוגדר על ידי קיבוצי הערוצים של התצוגה המפורטת).

campaign

string

במעקב ידני אחר קמפיין הוא הערך של פרמטר המעקב utm_campaign. לצורך התיוג האוטומטי של AdWords, זהו השם של הקמפיינים באינטרנט שבהם אתם משתמשים בנכס. אם לא משתמשים באף אחד מהערכים, הערך שלו הוא (not set).

keyword

string

במעקב ידני אחר קמפיין הוא הערך של הפרמטר utm_term למעקב אחר קמפיינים. עבור תנועה ב-AdWords, היא מכילה את הקריטריונים המתאימים ביותר לטירגוט. ברשת המדיה, שייתכן שקריטריוני טירגוט מרובים גרמו להצגתה, היא מחזירה את קריטריוני הטירגוט התואמים ביותר שנבחרו על ידי Google Ads. הסוג הזה יכול להיות display_keyword, מיקום האתר, boomuserlist, user_תחומי עניין, גיל או מגדר. אחרת, הערך שלו הוא (not set).

hostname

string

שם המארח שממנו נשלחה בקשת המעקב.

landingPagePath

string

הדף הראשון של משתמשים' או דף הנחיתה.

activityType

enum(ActivityType)

סוג הפעילות הזו.

customDimension[]

object(CustomDimension)

רשימה של כל המאפיינים המותאמים אישית המשויכים לפעילות זו.

שדה איחוד activity_details. בהתאם לactivity_type, יוגדר בדיוק אחד מהשדות הבאים. activity_details יכול להיות רק אחד מאלה:
pageview

object(PageviewData)

המדיניות הזו תוגדר אם activityType הוא PAGEVIEW. השדה הזה כולל את כל הפרטים על המבקר ועל הדף שבו הוא ביקר.

appview

object(ScreenviewData)

המדיניות הזו תוגדר אם activityType הוא SCREEN_VIEW.

ecommerce

object(EcommerceData)

המדיניות הזו תוגדר אם activityType הוא ECOMMERCE.

goals

object(GoalSetData)

השדה הזה מכיל רשימה של כל היעדים שמולאו בפעילות הזו כאשר activityType שווה ל-GOAL.

event

object(EventData)

שדה זה מכיל את כל הפרטים הקשורים לאירוע, והוא יוגדר אם activityType שווה ל-EVENT.

מאפיין מותאם אישית

מאפיין מותאם אישית.

ייצוג JSON
{
  "index": number,
  "value": string
}
שדות
index

number

מספר המשבצת של מאפיין מותאם אישית.

value

string

הערך של המאפיין המותאם אישית. ערך ברירת המחדל (כלומר, מחרוזת ריקה) מציין ניקוי של ערך המאפיין המותאם אישית של היקף הזמן/המבקר.

נתוני צפייה בדף

מוצגים פרטים שנאספו כשהמבקר צופה בדף.

ייצוג JSON
{
  "pagePath": string,
  "pageTitle": string
}
שדות
pagePath

string

כתובת ה-URL של הדף שבו המבקר צפה.

pageTitle

string

כותרת הדף שהמבקר צפה בו.

נתוני צפייה במסך

ייצוג JSON
{
  "screenName": string,
  "mobileDeviceBranding": string,
  "mobileDeviceModel": string,
  "appName": string
}
שדות
screenName

string

שם המסך.

mobileDeviceBranding

string

יצרן נייד או שם ממותג. למשל: "Google", "Apple" וכו'.

mobileDeviceModel

string

דגם של מכשיר נייד. למשל: "Pixel", "iPhone" וכו'.

appName

string

שם האפליקציה.

נתוני מסחר אלקטרוני

פרטי מסחר אלקטרוני המשויכים לפעילות המשתמש.

ייצוג JSON
{
  "actionType": enum(ECommerceAction),
  "transaction": {
    object(TransactionData)
  },
  "products": [
    {
      object(ProductData)
    }
  ],
  "ecommerceType": enum(EcommerceType)
}
שדות
actionType

enum(ECommerceAction)

פעולה המשויכת לפעולה זו של מסחר אלקטרוני.

transaction

object(TransactionData)

פרטי העסקה של פעולת המסחר האלקטרוני.

products[]

object(ProductData)

פרטי המוצרים בעסקה הזו.

ecommerceType

enum(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

string

מזהה העסקה שסופק על ידי שיטת המעקב אחר מסחר אלקטרוני, עבור הרכישה בעגלת הקניות.

transactionRevenue

number

ההכנסה הכוללת מהמכירה (לא כולל משלוח ומיסים) של העסקה.

transactionTax

number

המס הכולל על העסקה.

transactionShipping

number

עלות המשלוח הכוללת.

נתוני המוצר

פרטי המוצרים בעסקת מסחר אלקטרוני.

ייצוג JSON
{
  "productSku": string,
  "productName": string,
  "itemRevenue": number,
  "productQuantity": string
}
שדות
productSku

string

קוד ייחודי שמייצג את המוצר.

productName

string

שם המוצר, שסופק על ידי האפליקציה למעקב אחר מסחר אלקטרוני, עבור הפריטים שנרכשו.

itemRevenue

number

ההכנסה הכוללת מפריטי מוצרים שנרכשו.

productQuantity

string (int64 format)

המספר הכולל של יחידות המוצרים בעסקה.

סוג מסחר אלקטרוני

זה מייצג את סוג הנתונים של המסחר האלקטרוני שמוחזרו.

Enums
ECOMMERCE_TYPE_UNSPECIFIED משמש כשסוג הפעילות במסחר אלקטרוני לא מוגדר.
CLASSIC משמש כשיש לפעילות מידע על מסחר אלקטרוני קלאסי (ללא אופטימיזציה).
ENHANCED משמש כשהפעילות כוללת מידע משופר על מסחר אלקטרוני.

יעד setData

מייצג קבוצה של יעדים שהושגו בפעילות.

ייצוג JSON
{
  "goals": [
    {
      object(GoalData)
    }
  ]
}
שדות
goals[]

object(GoalData)

כל היעדים שמולאו בפעילות הנוכחית.

נתוני יעד

ייצוג של כל הפרטים הקשורים ליעד.

ייצוג JSON
{
  "goalIndex": number,
  "goalCompletions": string,
  "goalValue": number,
  "goalCompletionLocation": string,
  "goalPreviousStep1": string,
  "goalPreviousStep2": string,
  "goalPreviousStep3": string,
  "goalName": string
}
שדות
goalIndex

number

מזהה את היעד כפי שהוא מוגדר לפרופיל.

goalCompletions

string (int64 format)

המספר הכולל של השלמת מטרות עסקיות בפעילות זו.

goalValue

number

שווי המטרה העסקית הזו.

goalCompletionLocation

string

כתובת ה-URL של הדף שבו יעד זה הושלם.

goalPreviousStep1

string

כתובת ה-URL של הדף, שלב אחד לפני השלמת היעד.

goalPreviousStep2

string

כתובת ה-URL של הדף בשני שלבים לפני השלמת היעד.

goalPreviousStep3

string

כתובת ה-URL של הדף שלושה שלבים לפני השלמת היעד.

goalName

string

שם המטרה העסקית.

נתוני אירוע

מוצגים כל הפרטים הקשורים לאירוע.

ייצוג JSON
{
  "eventCategory": string,
  "eventAction": string,
  "eventLabel": string,
  "eventValue": string,
  "eventCount": string
}
שדות
eventCategory

string

האובייקט בדף שהייתה לו אינטראקציה איתו. Eg: 'Video'.

eventAction

string

סוג האינטראקציה עם האובייקט. E.: 'play'.

eventLabel

string

התווית מצורפת לאירוע.

eventValue

string (int64 format)

ערך נומרי שמשויך לאירוע.

eventCount

string (int64 format)

מספר האירועים כאלה בפעילות הזו.

רוצה לנסות?