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

مطلوبة. رقم تعريف الملف الشخصي في "إحصاءات Google" المطلوب استرداد البيانات منه. يجب أن يحتوي كل SearchUserActivityRequest على viewId.

user

object(User)

مطلوبة. رقم تعريف المستخدم الفريد المطلوب البحث عنه. يجب أن يحتوي كل SearchUserActivityRequest على هذا الحقل.

activityTypes[]

enum(ActivityType)

مجموعة من كل أنواع الأنشطة المطلوبة. سيتم عرض الأنشطة التي تتطابق مع هذه الأنواع فقط في الرد. إذا كانت الصفحة فارغة، سيتم عرض جميع الأنشطة.

pageSize

number

يُستخدم حجم الصفحة في الانتقال من صفحة إلى أخرى ويحدّد الحد الأقصى لعدد الصفوف التي يتم عرضها. يجب أن يكون حجم الصفحة أكبر من 0. إذا كانت القيمة 0 أو إذا لم يتم تحديد الحقل، سيعرض الطلب الإعداد التلقائي وهو 1000 صف لكل صفحة.

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

يمثل أنواعًا مختلفة من تحديد هوية المستخدم المتوفرة.

عمليات التعداد
USER_ID_TYPE_UNSPECIFIED عندما لا يتم تحديد نوع رقم تعريف المستخدم، يكون النوع الافتراضي المستخدم هو CLIENT_ID.
USER_ID مستخدم واحد، مثل حساب مستخدم مسجَّل الدخول، والذي قد يتفاعل مع المحتوى على نسخة لجهاز و/ أو متصفح واحد أو أكثر.
CLIENT_ID تم تحديد clientId لخدمة "إحصاءات Google".

ActivityType

عمليات التعداد
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 على أنها "ويب" ويتم الإبلاغ عن النتائج المُرسلة من حزم SDK للجوّال على أنها "تطبيق". ويمكن إلغاء هذه القيم في 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"، سيكون ذلك بدون أي تكلفة. وإذا لم يكن المُحيل محرك بحث، فهو إحالة. إذا أتى المستخدمون مباشرةً إلى الموقع الإلكتروني وكان document.referrer فارغًا، تكون قيمته (لا شيء).

channelGrouping

string

مجموعة القنوات المرتبطة بجلسة المستخدم النهائي لهذا الملف الشخصي (مُحدَّد من خلال تصنيفات القنوات إلى مجموعات للملف الشخصي).

campaign

string

وبالنسبة إلى التتبع اليدوي للحملة، تمثل قيمة معلمة تتبع حملة utm_campaign. بالنسبة إلى وضع العلامات التلقائي في AdWords، فهو عبارة عن أسماء الحملات الإعلانية على الإنترنت التي تستخدمها للموقع. وإذا لم تستخدم أيًا منهما، ستكون قيمته (not set).

keyword

string

وبالنسبة إلى التتبع اليدوي للحملة، فهي قيمة معلمة تتبع الحملة utm_term. وبالنسبة إلى زيارات AdWords، فهي تحتوي على أفضل معايير الاستهداف المطابقة. بالنسبة إلى الشبكة الإعلانية، إذا كان من الممكن أن تؤدّي معايير الاستهداف المتعدّدة إلى عرض الإعلان، فإنّها تعرِض أفضل معايير الاستهداف المطابقة كما هو محدَّد في "إعلانات Google". يمكن أن تكون هذه المعلومات عبارة عن 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" أو "تفاح" أو ما إلى ذلك.

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

مجموعة من كل الإجراءات المرتبطة بإجراء تجارة إلكترونية.

عمليات التعداد
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

وهي تمثل نوع بيانات التجارة الإلكترونية التي يتم عرضها.

عمليات التعداد
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

نوع التفاعل مع العنصر على سبيل المثال: "تشغيل".

eventLabel

string

تم إرفاق التصنيف مع الحدث.

eventValue

string (int64 format)

القيمة الرقمية المرتبطة بالحدث.

eventCount

string (int64 format)

عدد هذه الأحداث في هذا النشاط.

تجربة