Method: userActivity.search

داده‌های فعالیت کاربر را برمی‌گرداند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{
  "dateRange": {
    object(DateRange)
  },
  "viewId": string,
  "user": {
    object(User)
  },
  "activityTypes": [
    enum(ActivityType)
  ],
  "pageSize": number,
  "pageToken": string
}
زمینه های
dateRange

object( DateRange )

محدوده تاریخی که برای بازیابی فعالیت کاربر. اگر محدوده تاریخ ارائه نشده باشد، محدوده تاریخ پیش‌فرض است (تاریخ شروع: تاریخ فعلی - 7 روز، تاریخ پایان: تاریخ فعلی - 1 روز).

viewId

string

ضروری. شناسه نمای Analytics که از آن داده ها بازیابی می شود. هر 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

نشان دهنده انواع مختلف شناسایی کاربر در دسترس است.

Enums
USER_ID_TYPE_UNSPECIFIED هنگامی که نوع شناسه کاربر مشخص نشده باشد، نوع پیش فرض استفاده شده CLIENT_ID خواهد بود.
USER_ID یک کاربر واحد، مانند یک حساب کاربری وارد شده، که ممکن است با محتوا در یک یا چند دستگاه و/یا نمونه مرورگر تعامل داشته باشد.
CLIENT_ID Analytics اختصاص داده شده به clientId.

نوع فعالیت

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

پلتفرمی که فعالیت روی آن انجام شده است: "اندروید"، "ios" و غیره.

dataSource

string

منبع داده یک ضربه به طور پیش فرض، بازدیدهای ارسال شده از analytics.js به عنوان "وب" و بازدیدهای ارسال شده از SDK های تلفن همراه به عنوان "برنامه" گزارش می شوند. این مقادیر را می توان در پروتکل اندازه گیری لغو کرد.

activities[]

object( Activity )

نمای دقیق هر یک از فعالیت های این جلسه را نشان می دهد.

sessionDate

string

تاریخ برگزاری این جلسه با فرمت ISO-8601.

فعالیت

یک Activity داده های مربوط به فعالیت یک کاربر را نشان می دهد. توجه داشته باشید که یک Activity با یک ضربه متفاوت است. یک ضربه ممکن است منجر به چندین فعالیت شود. به عنوان مثال، اگر یک ضربه شامل یک تراکنش و یک هدف باشد، دو پروتوی Activity برای این ضربه وجود خواهد داشت، یکی برای ECOMMERCE و دیگری برای GOAL. برعکس، چندین ضربه نیز می توانند یک Activity بسازند. در تجارت الکترونیک کلاسیک، داده‌های یک تراکنش ممکن است از طریق چندین بازدید ارسال شود. این بازدیدها در یک فعالیت 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، گوگل است. اگر از هیچ کدام استفاده نمی کنید، دامنه منبع (به عنوان مثال document.referrer) است که کاربران را ارجاع می دهد. همچنین ممکن است حاوی یک آدرس پورت باشد. اگر کاربران بدون ارجاع وارد شوند، مقدار آن (مستقیم) است.

medium

string

نوع ارجاعات برای ردیابی دستی کمپین، مقدار پارامتر ردیابی کمپین utm_medium است. برای برچسب گذاری خودکار AdWords، cpc است. اگر کاربران از موتور جستجوی شناسایی شده توسط Google Analytics آمده باشند، ارگانیک است. اگر ارجاع دهنده موتور جستجو نباشد، ارجاع است. اگر کاربران مستقیماً به ویژگی مراجعه کردند و document.referrer خالی باشد، مقدار آن (none) است.

channelGrouping

string

گروه کانال مرتبط با جلسه کاربر نهایی برای این نمایش (تعریف شده توسط گروه‌های کانال View).

campaign

string

برای ردیابی دستی کمپین، مقدار پارامتر ردیابی کمپین utm_campaign است. برای برچسب‌گذاری خودکار AdWords، نام(های) کمپین(های) تبلیغات آنلاینی است که برای دارایی استفاده می‌کنید. اگر از هیچکدام استفاده نکنید، مقدار آن (تنظیم نشده) است.

keyword

string

برای ردیابی دستی کمپین، مقدار پارامتر ردیابی کمپین utm_term است. برای ترافیک AdWords، دارای بهترین معیارهای منطبق برای هدف گیری است. برای شبکه نمایش، که در آن چندین معیار هدف‌گیری می‌تواند باعث نمایش آگهی شود، بهترین معیارهای هدف‌یابی منطبق را که توسط Ads انتخاب شده است، برمی‌گرداند. این می تواند display_keyword، محل قرارگیری سایت، boomuserlist، user_interest، سن یا جنسیت باشد. در غیر این صورت مقدار آن (تنظیم نشده) است.

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

نشانی اینترنتی صفحه ای که بازدیدکننده مشاهده کرده است.

pageTitle

string

عنوان صفحه ای که بازدید کننده مشاهده کرده است.

ScreenviewData

نمایندگی JSON
{
  "screenName": string,
  "mobileDeviceBranding": string,
  "mobileDeviceModel": string,
  "appName": string
}
زمینه های
screenName

string

نام صفحه نمایش.

mobileDeviceBranding

string

سازنده موبایل یا نام تجاری به عنوان مثال: "گوگل"، "اپل" و غیره.

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 )

نوع این فعالیت تجارت الکترونیک.

ECommerceAction

مجموعه ای از تمام اقدامات مرتبط با یک اقدام تجارت الکترونیک.

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 زمانی استفاده می شود که فعالیت اطلاعات تجارت الکترونیک را افزایش داده باشد.

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

آدرس صفحه یک گام قبل از تکمیل هدف.

goalPreviousStep2

string

آدرس صفحه دو مرحله قبل از تکمیل هدف.

goalPreviousStep3

string

آدرس صفحه سه مرحله قبل از تکمیل هدف.

goalName

string

نام هدف.

داده های رویداد

تمام جزئیات مربوط به یک رویداد را نشان می دهد.

نمایندگی 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)

تعداد چنین رویدادهایی در این فعالیت.

آن را امتحان کنید!