- درخواست HTTP
- درخواست بدن
- بدن پاسخگو
- محدوده مجوز
- کاربر
- UserIdType
- نوع فعالیت
- UserActivitySession
- فعالیت
- ابعاد سفارشی
- داده های مشاهده صفحه
- ScreenviewData
- داده های تجارت الکترونیک
- ECommerceAction
- داده های تراکنش
- اطلاعات محصول
- نوع تجارت الکترونیک
- GoalSetData
- GoalData
- داده های رویداد
- آن را امتحان کنید!
دادههای فعالیت کاربر را برمیگرداند.
درخواست HTTP
POST https://analyticsreporting.googleapis.com/v4/userActivity:search
URL از دستور GRPC Transcoding استفاده می کند.
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
نمایندگی JSON | |
---|---|
{ "dateRange": { object( |
زمینه های | |
---|---|
dateRange | محدوده تاریخی که برای بازیابی فعالیت کاربر. اگر محدوده تاریخ ارائه نشده باشد، محدوده تاریخ پیشفرض است (تاریخ شروع: تاریخ فعلی - 7 روز، تاریخ پایان: تاریخ فعلی - 1 روز). |
viewId | ضروری. شناسه نمای Analytics که از آن داده ها بازیابی می شود. هر SearchUserActivityRequest باید شامل |
user | ضروری. شناسه کاربری منحصر به فرد برای درخواست. هر SearchUserActivityRequest باید حاوی این فیلد باشد. |
activityTypes[] | مجموعه ای از انواع فعالیت های درخواستی فقط فعالیتهای مطابق با این نوع در پاسخ بازگردانده میشوند. اگر خالی باشد، تمام فعالیت ها برگردانده می شوند. |
pageSize | اندازه صفحه برای صفحه بندی است و حداکثر تعداد سطرهای برگشتی را مشخص می کند. اندازه صفحه باید > 0 باشد. اگر مقدار 0 باشد یا فیلد مشخص نشده باشد، درخواست 1000 ردیف در هر صفحه را به طور پیش فرض برمی گرداند. |
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 اختصاص داده شده به clientId. |
نوع فعالیت
Enums | |
---|---|
ACTIVITY_TYPE_UNSPECIFIED | ActivityType هرگز این مقدار را در پاسخ نخواهد داشت. استفاده از این نوع در درخواست منجر به خطا می شود. |
PAGEVIEW | زمانی استفاده میشود که فعالیت ناشی از مشاهده یک صفحه توسط بازدیدکننده باشد. |
SCREENVIEW | زمانی استفاده میشود که این فعالیت ناشی از استفاده بازدیدکننده از یک برنامه کاربردی در دستگاه تلفن همراه باشد. |
GOAL | برای نشان دادن آن فعالیت نوع هدف استفاده می شود. |
ECOMMERCE | یک معامله تجارت الکترونیک توسط بازدید کننده در صفحه انجام شد. |
EVENT | زمانی استفاده می شود که فعالیت یک رویداد باشد. |
UserActivitySession
این نشان دهنده یک جلسه کاربر است که در یک دستگاه خاص در یک زمان خاص در یک دوره زمانی انجام می شود.
نمایندگی JSON | |
---|---|
{
"sessionId": string,
"deviceCategory": string,
"platform": string,
"dataSource": string,
"activities": [
{
object( |
زمینه های | |
---|---|
sessionId | شناسه منحصر به فرد جلسه |
deviceCategory | نوع دستگاه مورد استفاده: "موبایل"، "تبلت" و غیره. |
platform | پلتفرمی که فعالیت روی آن انجام شده است: "اندروید"، "ios" و غیره. |
dataSource | منبع داده یک ضربه به طور پیش فرض، بازدیدهای ارسال شده از analytics.js به عنوان "وب" و بازدیدهای ارسال شده از SDK های تلفن همراه به عنوان "برنامه" گزارش می شوند. این مقادیر را می توان در پروتکل اندازه گیری لغو کرد. |
activities[] | نمای دقیق هر یک از فعالیت های این جلسه را نشان می دهد. |
sessionDate | تاریخ برگزاری این جلسه با فرمت 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( |
زمینه های | ||
---|---|---|
activityTime | مهر زمانی فعالیت یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با دقت نانوثانیه. مثال: | |
source | منبع ارجاعات برای ردیابی دستی کمپین، مقدار پارامتر ردیابی کمپین utm_source است. برای برچسب گذاری خودکار AdWords، گوگل است. اگر از هیچ کدام استفاده نمی کنید، دامنه منبع (به عنوان مثال document.referrer) است که کاربران را ارجاع می دهد. همچنین ممکن است حاوی یک آدرس پورت باشد. اگر کاربران بدون ارجاع وارد شوند، مقدار آن (مستقیم) است. | |
medium | نوع ارجاعات برای ردیابی دستی کمپین، مقدار پارامتر ردیابی کمپین utm_medium است. برای برچسب گذاری خودکار AdWords، cpc است. اگر کاربران از موتور جستجوی شناسایی شده توسط Google Analytics آمده باشند، ارگانیک است. اگر ارجاع دهنده موتور جستجو نباشد، ارجاع است. اگر کاربران مستقیماً به ویژگی مراجعه کردند و document.referrer خالی باشد، مقدار آن (none) است. | |
channelGrouping | گروه کانال مرتبط با جلسه کاربر نهایی برای این نمایش (تعریف شده توسط گروههای کانال View). | |
campaign | برای ردیابی دستی کمپین، مقدار پارامتر ردیابی کمپین utm_campaign است. برای برچسبگذاری خودکار AdWords، نام(های) کمپین(های) تبلیغات آنلاینی است که برای دارایی استفاده میکنید. اگر از هیچکدام استفاده نکنید، مقدار آن (تنظیم نشده) است. | |
keyword | برای ردیابی دستی کمپین، مقدار پارامتر ردیابی کمپین utm_term است. برای ترافیک AdWords، دارای بهترین معیارهای منطبق برای هدف گیری است. برای شبکه نمایش، که در آن چندین معیار هدفگیری میتواند باعث نمایش آگهی شود، بهترین معیارهای هدفیابی منطبق را که توسط Ads انتخاب شده است، برمیگرداند. این می تواند display_keyword، محل قرارگیری سایت، boomuserlist، user_interest، سن یا جنسیت باشد. در غیر این صورت مقدار آن (تنظیم نشده) است. | |
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 | نشانی اینترنتی صفحه ای که بازدیدکننده مشاهده کرده است. |
pageTitle | عنوان صفحه ای که بازدید کننده مشاهده کرده است. |
ScreenviewData
نمایندگی JSON | |
---|---|
{ "screenName": string, "mobileDeviceBranding": string, "mobileDeviceModel": string, "appName": string } |
زمینه های | |
---|---|
screenName | نام صفحه نمایش. |
mobileDeviceBranding | سازنده موبایل یا نام تجاری به عنوان مثال: "گوگل"، "اپل" و غیره. |
mobileDeviceModel | مدل دستگاه موبایل. به عنوان مثال: "Pixel"، "iPhone" و غیره. |
appName | نام برنامه |
داده های تجارت الکترونیک
جزئیات تجارت الکترونیک مرتبط با فعالیت کاربر.
نمایندگی JSON | |
---|---|
{ "actionType": enum( |
زمینه های | |
---|---|
actionType | اقدام مرتبط با این اقدام تجارت الکترونیک. |
transaction | جزئیات تراکنش این اقدام تجارت الکترونیک. |
products[] | جزئیات محصولات در این معامله. |
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 | شناسه تراکنش ارائه شده به روش رهگیری تجارت الکترونیک برای خرید در سبد خرید. |
transactionRevenue | کل درآمد فروش (به استثنای حمل و نقل و مالیات) معامله. |
transactionTax | کل مالیات برای معامله |
transactionShipping | کل هزینه حمل و نقل |
اطلاعات محصول
جزئیات محصولات در یک معامله تجارت الکترونیک.
نمایندگی JSON | |
---|---|
{ "productSku": string, "productName": string, "itemRevenue": number, "productQuantity": string } |
زمینه های | |
---|---|
productSku | کد منحصر به فرد که نشان دهنده محصول است. |
productName | نام محصول، ارائه شده توسط اپلیکیشن ردیابی تجارت الکترونیک، برای اقلام خریداری شده. |
itemRevenue | کل درآمد حاصل از اقلام محصول خریداری شده |
productQuantity | تعداد کل واحدهای این محصول در معامله. |
نوع تجارت الکترونیک
این نشان دهنده نوع داده های تجارت الکترونیکی است که بازگردانده می شوند.
Enums | |
---|---|
ECOMMERCE_TYPE_UNSPECIFIED | زمانی استفاده می شود که نوع فعالیت تجارت الکترونیک مشخص نشده باشد. |
CLASSIC | زمانی استفاده می شود که فعالیت دارای اطلاعات تجارت الکترونیک کلاسیک (غیر پیشرفته) باشد. |
ENHANCED | زمانی استفاده می شود که فعالیت اطلاعات تجارت الکترونیک را افزایش داده باشد. |
GoalSetData
نشان دهنده مجموعه ای از اهدافی است که در یک فعالیت به آنها رسیده است.
نمایندگی JSON | |
---|---|
{
"goals": [
{
object( |
زمینه های | |
---|---|
goals[] | تمام اهدافی که در فعالیت فعلی به دست آمد. |
GoalData
تمام جزئیات مربوط به یک هدف را نشان می دهد.
نمایندگی JSON | |
---|---|
{ "goalIndex": number, "goalCompletions": string, "goalValue": number, "goalCompletionLocation": string, "goalPreviousStep1": string, "goalPreviousStep2": string, "goalPreviousStep3": string, "goalName": string } |
زمینه های | |
---|---|
goalIndex | این هدف را به عنوان پیکربندی شده برای نمایه مشخص می کند. |
goalCompletions | تعداد کل اهداف تکمیل شده در این فعالیت. |
goalValue | ارزش در این هدف. |
goalCompletionLocation | URL صفحه ای که این هدف در آن تکمیل شد. |
goalPreviousStep1 | آدرس صفحه یک گام قبل از تکمیل هدف. |
goalPreviousStep2 | آدرس صفحه دو مرحله قبل از تکمیل هدف. |
goalPreviousStep3 | آدرس صفحه سه مرحله قبل از تکمیل هدف. |
goalName | نام هدف. |
داده های رویداد
تمام جزئیات مربوط به یک رویداد را نشان می دهد.
نمایندگی JSON | |
---|---|
{ "eventCategory": string, "eventAction": string, "eventLabel": string, "eventValue": string, "eventCount": string } |
زمینه های | |
---|---|
eventCategory | شیء موجود در صفحه که با آن تعامل داشت. به عنوان مثال: "ویدئو". |
eventAction | نوع تعامل با شی به عنوان مثال: "بازی". |
eventLabel | برچسب پیوست به رویداد. |
eventValue | مقدار عددی مرتبط با رویداد. |
eventCount | تعداد چنین رویدادهایی در این فعالیت. |