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: התאריך הנוכחי - 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 ClientId שהוקצה ל-Analytics.

ActivityType

טיפוסים בני מנייה (enums)
ACTIVITY_TYPE_UNSPECIFIED הערך הזה לא יופיע אף פעם בתגובה של ActivityType. שימוש בסוג זה בבקשה יגרום לשגיאה.
PAGEVIEW משמש כשהפעילות גרמה לכך שמבקר צפה בדף.
SCREENVIEW משמש כשהפעילות נבעה ממבקר שמשתמש באפליקציה במכשיר נייד.
GOAL משמש לציון פעילות מסוג יעד.
ECOMMERCE המבקר בדף ביצע עסקה של מסחר אלקטרוני.
EVENT משמש כשהפעילות היא אירוע.

UserActivitySession

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

ייצוג JSON 
{
  "sessionId": string,
  "deviceCategory": string,
  "platform": string,
  "dataSource": string,
  "activities": [
    {
      object(Activity)
    }
  ],
  "sessionDate": string
}
שדות
sessionId

string

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

deviceCategory

string

סוג המכשיר שבו נעשה שימוש: "נייד", "טאבלט" וכו'.

platform

string

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

dataSource

string

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

activities[]

object(Activity)

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

sessionDate

string

תאריך הסשן בפורמט ISO-8601.

פעילות

פעילות מייצגת נתונים לגבי פעילות של משתמש. חשוב לשים לב שפעילות שונה מהיט. היט אחד יכול לגרום למספר פעילויות. לדוגמה, אם היט כולל עסקה והשלמת יעד, יהיו שני קובצי Proto של פעילות עבור ההיט הזה, אחד עבור 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, מדויקת לננו-שניות. דוגמה: "2014-10-02T15:01:23.045123456Z"
source

string

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

medium

string

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

channelGrouping

string

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

campaign

string

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

keyword

string

במעקב ידני אחר קמפיין, זהו הערך של פרמטר המעקב utm_term. לתנועה ב-AdWords, הוא מכיל את קריטריוני המיקוד המתאימים ביותר. ברשת המדיה, שבה מספר קריטריוני טירגוט היו יכולים לגרום להצגת המודעה, היא מחזירה את קריטריוני הטירגוט המתאימים ביותר שנבחרו על ידי Google Ads. הערך הזה יכול להיות display_keyword, מיקום באתר, boomuserlist, user_interest, גיל או מגדר. אחרת, הערך שלו הוא (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.

CustomDimension

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

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

number

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

value

string

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

PageviewData

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

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

string

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

pageTitle

string

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

ScreenviewData

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

string

שם המסך.

mobileDeviceBranding

string

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

mobileDeviceModel

string

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

appName

string

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

EcommerceData

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

ייצוג 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)

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

ECommerceAction

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

טיפוסים בני מנייה (enums)
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

string

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

transactionRevenue

number

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

transactionTax

number

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

transactionShipping

number

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

ProductData

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

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

string

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

productName

string

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

itemRevenue

number

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

productQuantity

string (int64 format)

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

EcommerceType

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

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

GoalSetData

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

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

object(GoalData)

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

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

שם היעד.

EventData

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

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

string

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

eventAction

string

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

eventLabel

string

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

eventValue

string (int64 format)

ערך מספרי שמשויך לאירוע.

eventCount

string (int64 format)

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

רוצה לנסות?