Method: properties.runFunnelReport

گزارش قیف سفارشی داده‌های رویداد Google Analytics شما را برمی‌گرداند. داده های برگردانده شده از API به صورت جدولی با ستون هایی برای ابعاد و معیارهای درخواستی است.

کاوش قیف به شما این امکان را می‌دهد تا مراحلی را که کاربران برای تکمیل یک کار برمی‌دارند تجسم کنید و به سرعت ببینید که در هر مرحله چقدر موفق یا شکست می‌خورند. به عنوان مثال، چگونه مشتریان بالقوه خریدار و سپس خریدار می شوند؟ چگونه خریداران یکباره تبدیل به خریداران تکراری می شوند؟ با این اطلاعات، می توانید سفرهای ناکارآمد یا رها شده مشتریان را بهبود ببخشید. برای کسب اطلاعات بیشتر، به کاوش‌های قیف GA4 مراجعه کنید.

این روش در ثبات آلفا با هدف جمع‌آوری بازخورد در نحو و قابلیت‌ها قبل از ورود به بتا معرفی شده است. برای ارائه بازخورد خود در مورد این API، بازخورد گزارش قیف Google Analytics Data API را تکمیل کنید.

درخواست HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runFunnelReport

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

پارامترهای مسیر

پارامترها
property

string

اختیاری. یک شناسه دارایی Google Analytics که رویدادهای آن ردیابی می شوند. در مسیر URL و نه بدنه مشخص شده است. برای کسب اطلاعات بیشتر، ببینید شناسه ملک خود را از کجا پیدا کنید . در یک درخواست دسته ای، این ویژگی یا باید نامشخص باشد یا با ویژگی سطح دسته ای سازگار باشد.

مثال: خواص/1234

درخواست بدن

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

نمایندگی JSON 
{
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "funnel": {
    object (Funnel)
  },
  "funnelBreakdown": {
    object (FunnelBreakdown)
  },
  "funnelNextAction": {
    object (FunnelNextAction)
  },
  "funnelVisualizationType": enum (FunnelVisualizationType),
  "segments": [
    {
      object (Segment)
    }
  ],
  "limit": string,
  "dimensionFilter": {
    object (FilterExpression)
  },
  "returnPropertyQuota": boolean
}
فیلدها
date Ranges[]

object ( DateRange )

اختیاری. محدوده تاریخ داده برای خواندن. اگر چندین محدوده تاریخ درخواست شود، هر ردیف پاسخ حاوی یک شاخص محدوده تاریخ مبتنی بر صفر خواهد بود. اگر دو محدوده تاریخ همپوشانی داشته باشند، داده‌های رویداد برای روزهای همپوشانی در ردیف‌های پاسخ برای هر دو محدوده تاریخ گنجانده می‌شود.

funnel

object ( Funnel )

اختیاری. پیکربندی قیف این درخواست. این پیکربندی قیف مورد نیاز است.

funnel Breakdown

object ( FunnelBreakdown )

اختیاری. اگر مشخص شده باشد، این تفکیک بعد به پاسخ گزارش فرعی جدول قیف اضافه می کند. این بعد تجزیه هر مرحله قیف را به مقادیر منحصر به فرد بعد شکست گسترش می دهد. برای مثال، تفکیک بر اساس بعد deviceCategory ردیف‌هایی را برای mobile ، tablet ، desktop و کل ایجاد می‌کند.

funnel Next Action

object ( FunnelNextAction )

اختیاری. در صورت مشخص شدن، اقدام بعدی یک بعد به پاسخ گزارش فرعی تجسم قیف اضافه می کند. این بعد اقدام بعدی هر مرحله قیف را به مقادیر منحصر به فرد اقدام بعدی گسترش می دهد. به عنوان مثال، اقدام بعدی بعد eventName ، ردیف‌هایی را برای چندین رویداد (مثلا session_start و click ) و کل ایجاد می‌کند.

اقدام بعدی فقط eventName و بیشتر ابعاد صفحه/صفحه مانند pageTitle و pagePath را پشتیبانی می‌کند.

funnel Visualization Type

enum ( FunnelVisualizationType )

اختیاری. نوع تجسم قیف ابعاد موجود در پاسخ گزارش فرعی تجسم قیف را کنترل می کند. اگر مشخص نشده باشد، STANDARD_FUNNEL استفاده می شود.

segments[]

object ( Segment )

اختیاری. تنظیمات بخش ها بخش‌ها زیرمجموعه‌ای از داده‌های یک ویژگی هستند. در یک گزارش قیف با بخش ها، قیف در هر بخش ارزیابی می شود.

هر بخش مشخص شده در این درخواست یک ردیف جداگانه در پاسخ ایجاد می کند. در پاسخ، هر بخش با نام خود مشخص شد.

پارامتر segments اختیاری است. درخواست ها به 4 بخش محدود می شود.

limit

string ( int64 format)

اختیاری. تعداد ردیف هایی که باید برگردانده شوند. اگر مشخص نشده باشد، 10000 ردیف برگردانده می شود. API حداکثر 250000 سطر را در هر درخواست برمی گرداند، مهم نیست که چقدر درخواست کنید. limit باید مثبت باشد

API همچنین می‌تواند ردیف‌های کمتری را نسبت به limit درخواستی برگرداند، اگر مقادیر ابعاد به اندازه limit وجود نداشته باشد.

dimension Filter

object ( FilterExpression )

اختیاری. فیلترهای ابعاد به شما امکان می دهند فقط مقادیر ابعاد خاصی را در گزارش بخواهید. برای کسب اطلاعات بیشتر، برای مثال به ایجاد گزارش: فیلترهای ابعاد مراجعه کنید. معیارها را نمی توان در این فیلتر استفاده کرد.

return Property Quota

boolean

اختیاری. وضعیت فعلی سهمیه این Analytics Property را تغییر می‌دهد یا خیر. سهمیه در PropertyQuota برگردانده می شود.

بدن پاسخگو

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

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "funnelTable": {
    object (FunnelSubReport)
  },
  "funnelVisualization": {
    object (FunnelSubReport)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string
}
فیلدها
funnel Table

object ( FunnelSubReport )

جدول قیف گزارشی با مرحله قیف، بخش، بعد شکست، کاربران فعال، نرخ تکمیل، رها شدن و نرخ رهاسازی است.

بعد بخش فقط در صورت درخواست بخش در این پاسخ وجود دارد. بعد شکست فقط در صورت درخواست در این پاسخ وجود دارد.

funnel Visualization

object ( FunnelSubReport )

تجسم قیف یک گزارش با مرحله قیف، بخش، تاریخ، بعد اقدام بعدی و کاربران فعال است.

بعد بخش فقط در صورت درخواست بخش در این پاسخ وجود دارد. بعد تاریخ فقط در صورتی در این پاسخ وجود دارد که از طریق نوع قیف TRENDED_FUNNEL درخواست شده باشد. بعد اقدام بعدی فقط در صورت درخواست در پاسخ وجود دارد.

property Quota

object ( PropertyQuota )

وضعیت سهمیه این Analytics Property شامل این درخواست است.

kind

string

مشخص می کند که این پیام چه نوع منبعی است. این kind همیشه رشته ثابت "analyticsData#runFunnelReport" است. برای تمایز بین انواع پاسخ در JSON مفید است.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

قیف

قیف را در یک درخواست گزارش قیف پیکربندی می کند. یک قیف در حین گذر از مراحل متوالی از کاربران گزارش می دهد.

کاوش قیف به شما این امکان را می‌دهد تا مراحلی را که کاربران برای تکمیل یک کار برمی‌دارند تجسم کنید و به سرعت ببینید که در هر مرحله چقدر موفق یا شکست می‌خورند. به عنوان مثال، چگونه مشتریان بالقوه خریدار و سپس خریدار می شوند؟ چگونه خریداران یکباره تبدیل به خریداران تکراری می شوند؟ با این اطلاعات، می توانید سفرهای ناکارآمد یا رها شده مشتریان را بهبود ببخشید.

نمایندگی JSON 
{
  "isOpenFunnel": boolean,
  "steps": [
    {
      object (FunnelStep)
    }
  ]
}
فیلدها
is Open Funnel

boolean

در قیف باز کاربران در هر مرحله می توانند وارد قیف شوند و در قیف بسته کاربران باید در مرحله اول وارد قیف شوند. اختیاری. اگر مشخص نباشد، از یک قیف بسته استفاده می شود.

steps[]

object ( FunnelStep )

مراحل متوالی این قیف.

FunnelStep

مراحل سفر کاربر را که می خواهید اندازه گیری کنید، مشخص می کند. مراحل شامل یک یا چند شرط است که کاربران شما باید آن‌ها را داشته باشند تا در آن مرحله از سفر قیف قرار گیرند.

نمایندگی JSON 
{
  "name": string,
  "isDirectlyFollowedBy": boolean,
  "filterExpression": {
    object (FunnelFilterExpression)
  },
  "withinDurationFromPriorStep": string
}
فیلدها
name

string

نام متمایز این مرحله. اگر نامشخص باشد، مراحل با یک نام نمایه شده بر اساس 1 نامگذاری می شوند (به عنوان مثال "0."، "1."، و غیره). این نام مقدار رشته ای را که توسط بعد funnelStepName برگردانده شده است، تعریف می کند. به عنوان مثال، مشخص کردن name = Purchase در مرحله سوم قیف درخواست، 3. Purchase در پاسخ گزارش قیف.

is Directly Followed By

boolean

اگر درست باشد، این مرحله باید مستقیماً از مرحله قبل پیروی کند. اگر نادرست باشد، ممکن است رویدادهایی بین مرحله قبل و این مرحله وجود داشته باشد. اگر مشخص نشده باشد، isDirectlyFollowedBy به عنوان نادرست در نظر گرفته می شود.

filter Expression

object ( FunnelFilterExpression )

شرطی که کاربران شما باید داشته باشند تا در این مرحله از سفر قیف قرار گیرند.

within Duration From Prior Step

string ( Duration format)

اگر مشخص شده باشد، این مرحله باید در این مدت از اتمام مرحله قبلی کامل شود. withinDurationFromPriorStep شامل نقطه پایانی در دانه بندی میکروثانیه است. به عنوان مثال، مدت زمان 5 ثانیه را می توان در 4.9 یا 5.0 ثانیه تکمیل کرد، اما نه 5 ثانیه و 1 میکروثانیه.

withinDurationFromPriorStep اختیاری است و اگر مشخص نباشد، مراحل ممکن است با هر مدت زمانی از هم جدا شوند.

مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s ' ختم می شود. مثال: "3.5s" .

FunnelFilterExpression

ترکیبی از فیلترهای قیف را بیان می کند.

نمایندگی JSON 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FunnelFilterExpressionList)
  },
  "orGroup": {
    object (FunnelFilterExpressionList)
  },
  "notExpression": {
    object (FunnelFilterExpression)
  },
  "funnelFieldFilter": {
    object (FunnelFieldFilter)
  },
  "funnelEventFilter": {
    object (FunnelEventFilter)
  }
  // End of list of possible types for union field expr.
}
فیلدها
expr فیلد اتحادیه یک نوع فیلتر را برای FunnelFilterExpression مشخص کنید. expr می تواند تنها یکی از موارد زیر باشد:
and Group

object ( FunnelFilterExpressionList )

FunnelFilterExpression در andGroup یک رابطه AND دارد.

or Group

object ( FunnelFilterExpressionList )

FunnelFilterExpression در orGroup یک رابطه OR دارد.

not Expression

object ( FunnelFilterExpression )

FunnelFilterExpression از notExpression نیست.

funnel Field Filter

object ( FunnelFieldFilter )

یک فیلتر قیف برای یک بعد یا متریک.

funnel Event Filter

object ( FunnelEventFilter )

فیلتری ایجاد می کند که رویدادهای یک نام رویداد را مطابقت دهد. اگر یک عبارت فیلتر پارامتر مشخص شده باشد، فقط زیرمجموعه رویدادهایی که با نام رویداد واحد و عبارات فیلتر پارامتر مطابقت دارند با این فیلتر رویداد مطابقت دارند.

FunnelFilterExpressionList

لیستی از عبارات فیلتر قیف.

نمایندگی JSON 
{
  "expressions": [
    {
      object (FunnelFilterExpression)
    }
  ]
}
فیلدها
expressions[]

object ( FunnelFilterExpression )

لیست عبارات فیلتر قیف.

FunnelFieldFilter

عبارتی برای فیلتر ابعاد یا مقادیر متریک.

نمایندگی JSON 
{
  "fieldName": string,

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
فیلدها
field Name

string

نام ابعاد یا نام متریک.

فیلد اتحادیه one_filter . یک نوع فیلتر را مشخص کنید. one_filter تنها می تواند یکی از موارد زیر باشد:
string Filter

object ( StringFilter )

فیلتر مربوط به رشته ها

in List Filter

object ( InListFilter )

فیلتری برای مقادیر در لیست.

numeric Filter

object ( NumericFilter )

فیلتری برای مقادیر عددی یا تاریخ.

between Filter

object ( BetweenFilter )

یک فیلتر برای بین دو مقدار.

FunnelEventFilter

فیلتری ایجاد می کند که رویدادهای یک نام رویداد را مطابقت دهد. اگر یک عبارت فیلتر پارامتر مشخص شده باشد، فقط زیرمجموعه رویدادهایی که با نام رویداد واحد و عبارات فیلتر پارامتر مطابقت دارند با این فیلتر رویداد مطابقت دارند.

نمایندگی JSON 
{
  "eventName": string,
  "funnelParameterFilterExpression": {
    object (FunnelParameterFilterExpression)
  }
}
فیلدها
event Name

string

این فیلتر رویدادهای این نام رویداد را منطبق می‌کند. نام رویداد الزامی است.

funnel Parameter Filter Expression

object ( FunnelParameterFilterExpression )

اگر مشخص شده باشد، این فیلتر با رویدادهایی مطابقت دارد که با نام رویداد واحد و عبارات فیلتر پارامتر مطابقت دارند.

در داخل عبارت فیلتر پارامتر، فقط فیلترهای پارامتر موجود است.

FunnelParameterFilterExpression

ترکیبی از فیلترهای قیف را بر روی پارامترها بیان می کند.

نمایندگی JSON 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FunnelParameterFilterExpressionList)
  },
  "orGroup": {
    object (FunnelParameterFilterExpressionList)
  },
  "notExpression": {
    object (FunnelParameterFilterExpression)
  },
  "funnelParameterFilter": {
    object (FunnelParameterFilter)
  }
  // End of list of possible types for union field expr.
}
فیلدها
expr فیلد اتحادیه یک نوع فیلتر را برای FunnelParameterFilterExpression مشخص کنید. expr می تواند تنها یکی از موارد زیر باشد:
and Group

object ( FunnelParameterFilterExpressionList )

FunnelParameterFilterExpression در andGroup یک رابطه AND دارد.

or Group

object ( FunnelParameterFilterExpressionList )

FunnelParameterFilterExpression در orGroup یک رابطه OR دارد.

not Expression

object ( FunnelParameterFilterExpression )

FunnelParameterFilterExpression از notExpression نیست.

funnel Parameter Filter

object ( FunnelParameterFilter )

یک فیلتر پارامتر قیف اولیه.

FunnelParameterFilterExpressionList

فهرستی از عبارات فیلتر پارامتر قیف.

نمایندگی JSON 
{
  "expressions": [
    {
      object (FunnelParameterFilterExpression)
    }
  ]
}
فیلدها
expressions[]

object ( FunnelParameterFilterExpression )

فهرست عبارات فیلتر پارامتر قیف.

FunnelParameterFilter

عبارتی برای فیلتر کردن مقادیر پارامتر در یک قیف.

نمایندگی JSON 
{

  // Union field one_parameter can be only one of the following:
  "eventParameterName": string,
  "itemParameterName": string
  // End of list of possible types for union field one_parameter.

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
فیلدها
فیلد اتحادیه one_parameter . فیلدی که در حال فیلتر شدن است. one_parameter می تواند تنها یکی از موارد زیر باشد:
event Parameter Name

string

این فیلتر بر روی پارامتر رویداد مشخص شده ارزیابی می شود. پارامترهای رویداد به عنوان پارامترهای رویداد ثبت می شوند. پارامترهای رویداد شامل فیلدهایی مانند "firebase_screen" و "currency" است.

پارامترهای رویداد فقط در بخش‌ها و قیف‌ها قابل استفاده هستند و فقط می‌توانند در فیلتر نزولی از یک EventFilter استفاده شوند. در یک فیلتر نزولی از یک EventFilter باید از پارامترهای رویداد یا آیتم استفاده شود.

item Parameter Name

string

این فیلتر بر اساس پارامتر مورد مشخص شده ارزیابی می شود. پارامترهای آیتم به عنوان پارامتر در آرایه آیتم ثبت می شوند. پارامترهای مورد شامل فیلدهایی مانند "item_name" و "item_category" هستند.

پارامترهای مورد فقط در بخش‌ها و قیف‌ها قابل استفاده هستند و فقط می‌توانند در فیلتر نزولی از EventFilter استفاده شوند. در یک فیلتر نزولی از یک EventFilter باید از پارامترهای رویداد یا آیتم استفاده شود.

پارامترهای مورد فقط در رویدادهای تجارت الکترونیک در دسترس هستند. برای کسب اطلاعات بیشتر در مورد رویدادهای تجارت الکترونیک، راهنمای اندازه گیری تجارت الکترونیک را ببینید.

فیلد اتحادیه one_filter . یک نوع فیلتر را مشخص کنید. one_filter تنها می تواند یکی از موارد زیر باشد:
string Filter

object ( StringFilter )

فیلتر مربوط به رشته ها

in List Filter

object ( InListFilter )

فیلتری برای مقادیر در لیست.

numeric Filter

object ( NumericFilter )

فیلتری برای مقادیر عددی یا تاریخ.

between Filter

object ( BetweenFilter )

یک فیلتر برای بین دو مقدار.

Funnel Breakdown

خرابی ها به پاسخ گزارش فرعی جدول قیف بعد می افزایند.

نمایندگی JSON 
{
  "breakdownDimension": {
    object (Dimension)
  },
  "limit": string
}
فیلدها
breakdown Dimension

object ( Dimension )

ستون ابعاد به پاسخ گزارش فرعی جدول قیف اضافه شد. بعد شکست هر مرحله قیف را تجزیه می کند. اگر funnelBreakdown مشخص شده باشد، یک breakdownDimension معتبر لازم است.

limit

string ( int64 format)

حداکثر تعداد مقادیر متمایز بعد شکست که در پاسخ بازگردانده می شود. اگر محدودیت مشخص نشده باشد از limit 5 استفاده می شود. حد مجاز باید از صفر تجاوز کند و نباید از 15 تجاوز کند.

FunnelNextAction

اقدامات بعدی مقدار یک بعد را بعد از رسیدن کاربر به یک مرحله اما قبل از رسیدن همان کاربر به مرحله بعدی نشان می دهد. به عنوان مثال، اگر nextActionDimension eventName باشد، nextActionDimension در ردیف مرحله قیف i اولین رویداد را پس از رویدادی که کاربر را به مرحله قیف i م واجد شرایط می‌کند، اما قبل از رسیدن کاربر به مرحله i+1 قیف برمی‌گرداند.

نمایندگی JSON 
{
  "nextActionDimension": {
    object (Dimension)
  },
  "limit": string
}
فیلدها
next Action Dimension

object ( Dimension )

ستون بعد به پاسخ گزارش فرعی تجسم قیف اضافه شد. بعد اقدام بعدی بعد از اینکه کاربر به مرحله i قیف رسید مقدار بعد بعدی این بعد را برمی گرداند.

nextActionDimension در حال حاضر فقط eventName و بیشتر ابعاد صفحه/صفحه مانند pageTitle و pagePath را پشتیبانی می کند. nextActionDimension نمی تواند یک عبارت بعد باشد.

limit

string ( int64 format)

حداکثر تعداد مقادیر متمایز بعد شکست که در پاسخ بازگردانده می شود. اگر محدودیت مشخص نشده باشد از limit 5 استفاده می شود. حد مجاز باید از صفر تجاوز کند و نباید از 5 تجاوز کند.

FunnelVisualizationType

ابعاد موجود در پاسخ گزارش فرعی تجسم قیف را کنترل می کند.

Enums
FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED نوع نامشخص
STANDARD_FUNNEL یک قیف استاندارد (پله ای). گزارش فرعی تجسم قیف در پاسخ حاوی تاریخ نخواهد بود.
TRENDED_FUNNEL یک قیف ترند (نمودار خطی). گزارش فرعی تجسم قیف در پاسخ حاوی بعد تاریخ خواهد بود.

بخش

یک بخش زیرمجموعه ای از داده های Analytics شما است. برای مثال، از کل مجموعه کاربران شما، یک بخش ممکن است کاربران یک کشور یا شهر خاص باشد. بخش دیگر ممکن است کاربرانی باشند که خط خاصی از محصولات را خریداری می کنند یا از بخش خاصی از سایت شما بازدید می کنند یا رویدادهای خاصی را در برنامه شما راه اندازی می کنند.

برای کسب اطلاعات بیشتر، Segment Builder را ببینید.

نمایندگی JSON 
{
  "name": string,

  // Union field one_segment_scope can be only one of the following:
  "userSegment": {
    object (UserSegment)
  },
  "sessionSegment": {
    object (SessionSegment)
  },
  "eventSegment": {
    object (EventSegment)
  }
  // End of list of possible types for union field one_segment_scope.
}
فیلدها
name

string

نام این بخش اگر نامشخص باشد، بخش‌ها «بخش» نامیده می‌شوند. این نام مقدار رشته ای را که توسط بعد segment برگردانده شده است، تعریف می کند. بعد segment ، نام بخش ها را با شماره شاخص 1 بخش در درخواست پیشوند می دهد (به عنوان مثال "1. Segment"، "2. Segment"، و غیره).

فیلد اتحادیه one_segment_scope . یک بخش در یک محدوده مشخص شده است. one_segment_scope تنها می تواند یکی از موارد زیر باشد:
user Segment

object ( UserSegment )

بخش‌های کاربر زیرمجموعه‌ای از کاربرانی هستند که با سایت یا برنامه شما درگیر هستند.

session Segment

object ( SessionSegment )

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

event Segment

object ( EventSegment )

بخش‌های رویداد زیرمجموعه‌ای از رویدادهایی هستند که در سایت یا برنامه شما راه‌اندازی شده‌اند.

بخش کاربر

بخش‌های کاربر زیرمجموعه‌ای از کاربرانی هستند که با سایت یا برنامه شما درگیر هستند. به عنوان مثال، کاربرانی که قبلا خرید کرده اند؛ کاربرانی که مواردی را به سبد خرید خود اضافه کرده‌اند، اما خریدی را تکمیل نکرده‌اند.

نمایندگی JSON 
{
  "userInclusionCriteria": {
    object (UserSegmentCriteria)
  },
  "exclusion": {
    object (UserSegmentExclusion)
  }
}
فیلدها
user Inclusion Criteria

object ( UserSegmentCriteria )

مشخص می کند که چه کاربرانی در این بخش قرار می گیرند. اختیاری.

exclusion

object ( UserSegmentExclusion )

مشخص می کند کدام کاربران در این بخش مستثنی هستند. اختیاری.

UserSegmentCriteria

اگر رویدادهای کاربر شرایط موجود در معیارها را داشته باشند، یک کاربر با یک معیار مطابقت دارد.

نمایندگی JSON 
{
  "andConditionGroups": [
    {
      object (UserSegmentConditionGroup)
    }
  ],
  "andSequenceGroups": [
    {
      object (UserSegmentSequenceGroup)
    }
  ]
}
فیلدها
and Condition Groups[]

object ( UserSegmentConditionGroup )

اگر کاربر با هر یک از این andConditionGroups و هر یک از andSequenceGroups مطابقت داشته باشد، یک کاربر با این معیار مطابقت دارد. اگر andSequenceGroups مشخص شده باشد، andConditionGroups ممکن است خالی باشد.

and Sequence Groups[]

object ( UserSegmentSequenceGroup )

اگر کاربر با هر یک از این andSequenceGroups و هر یک از andConditionGroups مطابقت داشته باشد، یک کاربر با این معیار مطابقت دارد. andSequenceGroups ممکن است خالی باشد اگر andConditionGroups مشخص شده باشد.

UserSegmentConditionGroup

شرایط به Analytics می‌گوید چه داده‌هایی را در بخش گنجانده یا از آن حذف کند.

نمایندگی JSON 
{
  "conditionScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
فیلدها
condition Scoping

enum ( UserCriteriaScoping )

داده ها بر اساس اینکه با گروه شرایط مطابقت دارند شامل یا از بخش حذف می شوند. این محدوده تعیین می کند که قبل از اینکه گروه شرط مطابقت داشته باشد یا خیر، segmentFilterExpression بر روی چند رویداد ارزیابی می شود. به عنوان مثال، اگر conditionScoping = USER_CRITERIA_WITHIN_SAME_SESSION ، عبارت در تمام رویدادهای یک جلسه ارزیابی می‌شود، و سپس، تعیین می‌شود که گروه شرط برای این کاربر مطابقت داشته باشد یا خیر. برای مثال، اگر conditionScoping = USER_CRITERIA_WITHIN_SAME_EVENT ، عبارت بر روی یک رویداد ارزیابی می‌شود، و سپس تعیین می‌شود که گروه شرط برای این کاربر مطابقت داشته باشد یا خیر.

اختیاری. اگر مشخص نشده باشد، conditionScoping = ACROSS_ALL_SESSIONS استفاده می شود.

segment Filter Expression

object ( SegmentFilterExpression )

داده ها بر اساس مطابقت با این عبارت شامل یا از بخش حذف می شوند. عبارات معیارهای ابعاد، معیارها و/یا پارامترها را بیان می کنند.

UserCriteriaScoping

محدوده مشخص می کند که در صورت رعایت یک معیار، کدام رویدادها هنگام ارزیابی در نظر گرفته می شوند.

Enums
USER_CRITERIA_SCOPING_UNSPECIFIED محدوده معیارهای نامشخص مشخص نکنید.
USER_CRITERIA_WITHIN_SAME_EVENT اگر معیارها در یک رویداد برآورده شوند، کاربر با معیارها مطابقت دارد.
USER_CRITERIA_WITHIN_SAME_SESSION اگر معیارها در یک جلسه برآورده شود، کاربر با معیارها مطابقت دارد.
USER_CRITERIA_ACROSS_ALL_SESSIONS اگر معیارها توسط هر رویدادی برای کاربر برآورده شود، کاربر با معیارها مطابقت دارد.

SegmentFilterExpression

ترکیبی از فیلترهای بخش را بیان می کند.

نمایندگی JSON 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (SegmentFilterExpressionList)
  },
  "orGroup": {
    object (SegmentFilterExpressionList)
  },
  "notExpression": {
    object (SegmentFilterExpression)
  },
  "segmentFilter": {
    object (SegmentFilter)
  },
  "segmentEventFilter": {
    object (SegmentEventFilter)
  }
  // End of list of possible types for union field expr.
}
فیلدها
expr فیلد اتحادیه یک نوع فیلتر را برای SegmentFilterExpression مشخص کنید. expr می تواند تنها یکی از موارد زیر باشد:
and Group

object ( SegmentFilterExpressionList )

SegmentFilterExpression در andGroup یک رابطه AND دارد.

or Group

object ( SegmentFilterExpressionList )

SegmentFilterExpression در orGroup یک رابطه OR دارد.

not Expression

object ( SegmentFilterExpression )

SegmentFilterExpression مربوط به notExpression نیست.

segment Filter

object ( SegmentFilter )

یک فیلتر بخش اولیه

segment Event Filter

object ( SegmentEventFilter )

فیلتری ایجاد می کند که رویدادهای یک نام رویداد را مطابقت دهد. اگر یک عبارت فیلتر پارامتر مشخص شده باشد، فقط زیرمجموعه رویدادهایی که با نام رویداد واحد و عبارات فیلتر پارامتر مطابقت دارند با این فیلتر رویداد مطابقت دارند.

SegmentFilterExpressionList

لیستی از عبارات فیلتر بخش.

نمایندگی JSON 
{
  "expressions": [
    {
      object (SegmentFilterExpression)
    }
  ]
}
فیلدها
expressions[]

object ( SegmentFilterExpression )

لیست عبارات فیلتر بخش

بخش فیلتر

عبارتی برای فیلتر ابعاد یا مقادیر متریک.

نمایندگی JSON 
{
  "fieldName": string,
  "filterScoping": {
    object (SegmentFilterScoping)
  },

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
فیلدها
field Name

string

نام ابعاد یا نام متریک.

filter Scoping

object ( SegmentFilterScoping )

محدوده فیلتر را مشخص می کند.

فیلد اتحادیه one_filter . یک نوع فیلتر را برای Filter مشخص کنید. one_filter تنها می تواند یکی از موارد زیر باشد:
string Filter

object ( StringFilter )

فیلتر مربوط به رشته ها

in List Filter

object ( InListFilter )

فیلتری برای مقادیر در لیست.

numeric Filter

object ( NumericFilter )

فیلتری برای مقادیر عددی یا تاریخ.

between Filter

object ( BetweenFilter )

یک فیلتر برای بین دو مقدار.

SegmentFilterScoping

محدوده‌ها مشخص می‌کنند که چگونه ابعاد و معیارهای رویدادهای متعدد هنگام ارزیابی یک فیلتر بخش در نظر گرفته شود.

نمایندگی JSON 
{
  "atAnyPointInTime": boolean
}
فیلدها
at Any Point In Time

boolean

اگر atAnyPointInTime درست باشد، اگر این فیلتر برای هر رویدادی در محدوده تاریخ درخواست به درستی ارزیابی شود، برای همه رویدادها درست ارزیابی می‌شود.

این پارامتر atAnyPointInTime محدوده تاریخ رویدادهای گزارش را افزایش نمی دهد. اگر atAnyPointInTime درست باشد، هنگام ارزیابی این فیلتر فقط رویدادهایی در محدوده تاریخ گزارش در نظر گرفته می‌شوند.

این atAnyPointInTime تنها زمانی می‌تواند مشخص شود که محدوده معیار ACROSS_ALL_SESSIONS باشد و نتوان آن را در دنباله‌ها مشخص کرد.

اگر محدوده معیار ACROSS_ALL_SESSIONS باشد، در صورت نامشخص از atAnyPointInTime = false استفاده می شود.

SegmentEventFilter

فیلتری ایجاد می کند که رویدادهای یک نام رویداد را مطابقت دهد. اگر یک عبارت فیلتر پارامتر مشخص شده باشد، فقط زیرمجموعه رویدادهایی که با نام رویداد واحد و عبارات فیلتر پارامتر مطابقت دارند با این فیلتر رویداد مطابقت دارند.

نمایندگی JSON 
{
  "eventName": string,
  "segmentParameterFilterExpression": {
    object (SegmentParameterFilterExpression)
  }
}
فیلدها
event Name

string

این فیلتر رویدادهای این نام رویداد را منطبق می‌کند. نام رویداد الزامی است.

segment Parameter Filter Expression

object ( SegmentParameterFilterExpression )

اگر مشخص شده باشد، این فیلتر با رویدادهایی مطابقت دارد که با نام رویداد واحد و عبارات فیلتر پارامتر مطابقت دارند.

در داخل عبارت فیلتر پارامتر، فقط فیلترهای پارامتر موجود است.

SegmentParameterFilterExpression

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

نمایندگی JSON 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (SegmentParameterFilterExpressionList)
  },
  "orGroup": {
    object (SegmentParameterFilterExpressionList)
  },
  "notExpression": {
    object (SegmentParameterFilterExpression)
  },
  "segmentParameterFilter": {
    object (SegmentParameterFilter)
  }
  // End of list of possible types for union field expr.
}
فیلدها
expr فیلد اتحادیه یک نوع فیلتر را برای SegmentParameterFilterExpression مشخص کنید. expr می تواند تنها یکی از موارد زیر باشد:
and Group

object ( SegmentParameterFilterExpressionList )

SegmentParameterFilterExpression در andGroup یک رابطه AND دارد.

or Group

object ( SegmentParameterFilterExpressionList )

SegmentParameterFilterExpression در orGroup یک رابطه OR دارد.

not Expression

object ( SegmentParameterFilterExpression )

SegmentParameterFilterExpression از notExpression نیست.

segment Parameter Filter

object ( SegmentParameterFilter )

یک فیلتر پارامتر بخش اولیه

SegmentParameterFilterExpressionList

لیستی از عبارات فیلتر پارامتر بخش.

نمایندگی JSON 
{
  "expressions": [
    {
      object (SegmentParameterFilterExpression)
    }
  ]
}
فیلدها
expressions[]

object ( SegmentParameterFilterExpression )

لیست عبارات فیلتر پارامتر بخش.

SegmentParameterFilter

عبارتی برای فیلتر کردن مقادیر پارامتر در یک بخش.

نمایندگی JSON 
{
  "filterScoping": {
    object (SegmentParameterFilterScoping)
  },

  // Union field one_parameter can be only one of the following:
  "eventParameterName": string,
  "itemParameterName": string
  // End of list of possible types for union field one_parameter.

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
فیلدها
filter Scoping

object ( SegmentParameterFilterScoping )

محدوده فیلتر را مشخص می کند.

فیلد اتحادیه one_parameter . فیلدی که در حال فیلتر شدن است. one_parameter می تواند تنها یکی از موارد زیر باشد:
event Parameter Name

string

این فیلتر بر روی پارامتر رویداد مشخص شده ارزیابی می شود. پارامترهای رویداد به عنوان پارامترهای رویداد ثبت می شوند. پارامترهای رویداد شامل فیلدهایی مانند "firebase_screen" و "currency" است.

پارامترهای رویداد فقط در بخش‌ها و قیف‌ها قابل استفاده هستند و فقط می‌توانند در فیلتر نزولی از یک EventFilter استفاده شوند. در یک فیلتر نزولی از یک EventFilter باید از پارامترهای رویداد یا آیتم استفاده شود.

item Parameter Name

string

این فیلتر بر اساس پارامتر مورد مشخص شده ارزیابی می شود. پارامترهای آیتم به عنوان پارامتر در آرایه آیتم ثبت می شوند. پارامترهای مورد شامل فیلدهایی مانند "item_name" و "item_category" هستند.

پارامترهای مورد فقط در بخش‌ها و قیف‌ها قابل استفاده هستند و فقط می‌توانند در فیلتر نزولی از EventFilter استفاده شوند. در یک فیلتر نزولی از یک EventFilter باید از پارامترهای رویداد یا آیتم استفاده شود.

پارامترهای مورد فقط در رویدادهای تجارت الکترونیک در دسترس هستند. برای کسب اطلاعات بیشتر در مورد رویدادهای تجارت الکترونیک، راهنمای اندازه گیری تجارت الکترونیک را ببینید.

فیلد اتحادیه one_filter . یک نوع فیلتر را مشخص کنید. one_filter تنها می تواند یکی از موارد زیر باشد:
string Filter

object ( StringFilter )

فیلتر مربوط به رشته ها

in List Filter

object ( InListFilter )

فیلتری برای مقادیر در لیست.

numeric Filter

object ( NumericFilter )

فیلتری برای مقادیر عددی یا تاریخ.

between Filter

object ( BetweenFilter )

یک فیلتر برای بین دو مقدار.

SegmentParameterFilterScoping

محدوده ها مشخص می کنند که چگونه چندین رویداد باید در هنگام ارزیابی فیلتر پارامتر بخش در نظر گرفته شود.

نمایندگی JSON 
{
  "inAnyNDayPeriod": string
}
فیلدها
in Any N Day Period

string ( int64 format)

پارامتر را در بازه زمانی مشخص شده از روزهای قبل از اعمال فیلتر جمع می کند. فقط در صورتی پشتیبانی می شود که محدوده معیارها ACROSS_ALL_SESSIONS یا WITHIN_SAME_SESSION باشد. فقط در صورتی پشتیبانی می شود که پارامتر event_count باشد.

برای مثال، اگر inAnyNDayPeriod 3 باشد، eventName "خرید"، پارامتر رویداد "event_count" و معیارهای فیلتر بیشتر از 5 باشد، این فیلتر تعداد رویدادهای خرید را در هر 3 روز متوالی در گزارش جمع می‌کند. محدوده تاریخ؛ اگر تعداد رویدادهای خرید او در هر دوره 3 روزه متوالی از 5 بیشتر شود، معیارهای این فیلتر را برای گنجاندن در این بخش پاس می کند. به عنوان مثال، دوره های 2021-11-01 تا 2021-11-03، 2021-11-02 تا 2021-11-04، 2021-11-03 تا 2021-11-05 و غیره در نظر گرفته می شود.

محدوده تاریخ به منظور داشتن یک پنجره کامل N روز نزدیک به شروع محدوده تاریخ تمدید نمی شود. به عنوان مثال اگر گزارشی برای 01-11-2021 تا 2021-11-10 و inAnyNDayPeriod = 3 باشد، دوره دو روزه اول به طور موثر کوتاه می شود زیرا هیچ داده رویدادی خارج از محدوده تاریخ گزارش خوانده نمی شود. به عنوان مثال، چهار دوره اول به طور موثر خواهد بود: 2021-11-01 تا 2021-11-01، 2021-11-01 تا 2021-11-02، 2021-11-01 تا 2021-11-03، و 2021- 11-02 تا 2021-11-04.

inAnyNDayPeriod اختیاری است. اگر مشخص نشده باشد، segmentParameterFilter برای هر رویداد به صورت جداگانه اعمال می شود.

UserSegmentSequenceGroup

شرایطی را تعریف کنید که باید در یک نظم خاص رخ دهد تا کاربر عضوی از بخش باشد.

نمایندگی JSON 
{
  "sequenceScoping": enum (UserCriteriaScoping),
  "sequenceMaximumDuration": string,
  "userSequenceSteps": [
    {
      object (UserSequenceStep)
    }
  ]
}
فیلدها
sequence Scoping

enum ( UserCriteriaScoping )

تمام مراحل توالی باید در محدوده مورد نظر رعایت شود تا کاربر با توالی مطابقت داشته باشد. به عنوان مثال، اگر sequenceScoping = USER_CRITERIA_WITHIN_SAME_SESSION ، تمام مراحل دنباله باید در یک جلسه کامل شوند تا کاربر با توالی مطابقت داشته باشد. sequenceScoping = USER_CRITERIA_WITHIN_SAME_EVENT پشتیبانی نمی شود.

اختیاری. اگر مشخص نشده باشد، conditionScoping = ACROSS_ALL_SESSIONS استفاده می شود.

sequence Maximum Duration

string ( Duration format)

دوره زمانی را که کل دنباله باید در آن اتفاق بیفتد را مشخص می کند. به عنوان مثال، 30 دقیقه. sequenceMaximumDuration شامل نقطه پایانی در دانه بندی میکروثانیه است. به عنوان مثال یک دنباله با حداکثر مدت زمان 5 ثانیه می تواند در 4.9 یا 5.0 ثانیه کامل شود، اما نه 5 ثانیه و 1 میکروثانیه.

sequenceMaximumDuration اختیاری است و اگر مشخص نشده باشد، توالی ها می توانند در هر مدت زمانی تکمیل شوند.

مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s ' ختم می شود. مثال: "3.5s" .

user Sequence Steps[]

object ( UserSequenceStep )

دنباله ای مرتب از مراحل شرط. رویدادهای کاربر باید هر مرحله را کامل کنند تا کاربر با UserSegmentSequenceGroup مطابقت داشته باشد.

UserSequenceStep

شرایطی که باید در ترتیب مراحل مشخص شده رخ دهد تا این کاربر با توالی مطابقت داشته باشد.

نمایندگی JSON 
{
  "isDirectlyFollowedBy": boolean,
  "stepScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
فیلدها
is Directly Followed By

boolean

اگر درست باشد، رویدادی که این مرحله را برآورده می‌کند باید رویداد بعدی بعد از رویدادی باشد که آخرین مرحله را برآورده می‌کند. اگر نادرست باشد، این مرحله به طور غیرمستقیم از مرحله قبل پیروی می کند. برای مثال، ممکن است رویدادهایی بین مرحله قبل و این مرحله وجود داشته باشد. isDirectlyFollowedBy باید برای مرحله اول نادرست باشد.

step Scoping

enum ( UserCriteriaScoping )

برای تطبیق کاربر با توالی، این مرحله توالی باید در محدوده مورد نظر رعایت شود. به عنوان مثال اگر sequenceScoping = WITHIN_SAME_SESSION ، این مراحل دنباله باید در یک جلسه کامل شود تا کاربر بتواند با توالی مطابقت داشته باشد. stepScoping = ACROSS_ALL_SESSIONS فقط در صورتی مجاز است که sequenceScoping = ACROSS_ALL_SESSIONS .

اختیاری. اگر مشخص نشده باشد، stepScoping از همان UserCriteriaScoping به عنوان sequenceScoping استفاده می کند.

segment Filter Expression

object ( SegmentFilterExpression )

اگر رویدادهای کاربر با این عبارت مطابقت داشته باشند، این مرحله دنباله را مطابقت می دهد. عبارات معیارهای ابعاد، معیارها و/یا پارامترها را بیان می کنند.

UserSegmentExclusion

مشخص می کند کدام کاربران در این بخش مستثنی شده اند.

نمایندگی JSON 
{
  "userExclusionDuration": enum (UserExclusionDuration),
  "userExclusionCriteria": {
    object (UserSegmentCriteria)
  }
}
فیلدها
user Exclusion Duration

enum ( UserExclusionDuration )

مشخص می‌کند که اگر کاربر با userExclusionCriteria مطابقت داشته باشد، یک طرد چقدر طول خواهد کشید.

اختیاری. اگر مشخص نشده باشد، userExclusionDuration USER_EXCLUSION_TEMPORARY استفاده می شود.

user Exclusion Criteria

object ( UserSegmentCriteria )

اگر کاربری این شرایط را داشته باشد، کاربر از عضویت در بخش userExclusionDuration حذف می‌شود.

UserExclusionDuration

در صورتی که کاربر با userExclusionCriteria مطابقت داشته باشد، گزینه‌هایی را برای مدت زمان ماندگاری یک حذف برمی‌شمارد.

Enums
USER_EXCLUSION_DURATION_UNSPECIFIED مدت زمان حذف نامشخص مشخص نکنید.
USER_EXCLUSION_TEMPORARY در دوره‌هایی که کاربر شرایط userExclusionCriteria را دارد، به طور موقت کاربران را از بخش حذف کنید.
USER_EXCLUSION_PERMANENT اگر کاربر شرایط userExclusionCriteria را برآورده کند، برای همیشه کاربران را از بخش حذف کنید.

SessionSegment

بخش‌های جلسه زیرمجموعه‌هایی از جلساتی هستند که در سایت یا برنامه شما رخ داده‌اند: به عنوان مثال، تمام جلساتی که از یک کمپین تبلیغاتی خاص منشا گرفته‌اند.

نمایندگی JSON 
{
  "sessionInclusionCriteria": {
    object (SessionSegmentCriteria)
  },
  "exclusion": {
    object (SessionSegmentExclusion)
  }
}
فیلدها
session Inclusion Criteria

object ( SessionSegmentCriteria )

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

exclusion

object ( SessionSegmentExclusion )

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

معیارهای بخش SessionSegment

در صورتی که رویدادهای جلسه با شرایط موجود در معیارها مطابقت داشته باشند، یک جلسه با یک معیار مطابقت دارد.

نمایندگی JSON 
{
  "andConditionGroups": [
    {
      object (SessionSegmentConditionGroup)
    }
  ]
}
فیلدها
and Condition Groups[]

object ( SessionSegmentConditionGroup )

یک جلسه با این معیار مطابقت دارد اگر جلسه با هر یک از این andConditionGroups مطابقت داشته باشد.

SessionSegmentConditionGroup

شرایط به Analytics می‌گوید چه داده‌هایی را در بخش گنجانده یا از آن حذف کند.

نمایندگی JSON 
{
  "conditionScoping": enum (SessionCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
فیلدها
condition Scoping

enum ( SessionCriteriaScoping )

داده ها بر اساس اینکه با گروه شرایط مطابقت دارند شامل یا از بخش حذف می شوند. این محدوده تعیین می کند که قبل از اینکه گروه شرط مطابقت داشته باشد یا خیر، segmentFilterExpression بر روی چند رویداد ارزیابی می شود. به عنوان مثال، اگر conditionScoping = SESSION_CRITERIA_WITHIN_SAME_SESSION ، عبارت بر روی تمام رویدادهای یک جلسه ارزیابی می‌شود، و سپس، تعیین می‌شود که گروه شرط برای این جلسه مطابقت داشته باشد یا خیر. به عنوان مثال، اگر conditionScoping = SESSION_CRITERIA_WITHIN_SAME_EVENT ، عبارت بر روی یک رویداد واحد ارزیابی می‌شود، و سپس، تعیین می‌شود که گروه شرط برای این جلسه مطابقت داشته باشد یا خیر.

اختیاری. اگر مشخص نشده باشد، از یک conditionScoping WITHIN_SAME_SESSION استفاده می شود.

segment Filter Expression

object ( SegmentFilterExpression )

داده ها بر اساس مطابقت با این عبارت شامل یا از بخش حذف می شوند. عبارات معیارهای ابعاد، معیارها و/یا پارامترها را بیان می کنند.

معیارهای جلسه

Scoping مشخص می کند که در صورت رعایت یک جلسه، کدام رویدادها هنگام ارزیابی در نظر گرفته می شوند.

Enums
SESSION_CRITERIA_SCOPING_UNSPECIFIED محدوده معیارهای نامشخص مشخص نکنید.
SESSION_CRITERIA_WITHIN_SAME_EVENT اگر معیارها در یک رویداد برآورده شوند، جلسه با معیارها مطابقت دارد.
SESSION_CRITERIA_WITHIN_SAME_SESSION اگر معیارها در یک جلسه برآورده شود، جلسه با معیارها مطابقت دارد.

SessionSegmentExclusion

مشخص می کند کدام جلسات در این بخش حذف می شوند.

نمایندگی JSON 
{
  "sessionExclusionDuration": enum (SessionExclusionDuration),
  "sessionExclusionCriteria": {
    object (SessionSegmentCriteria)
  }
}
فیلدها
session Exclusion Duration

enum ( SessionExclusionDuration )

مشخص می‌کند که اگر یک جلسه با sessionExclusionCriteria مطابقت داشته باشد، یک محرومیت چقدر طول خواهد کشید.

اختیاری. اگر مشخص نشده باشد، از sessionExclusionDuration SESSION_EXCLUSION_TEMPORARY استفاده می شود.

session Exclusion Criteria

object ( SessionSegmentCriteria )

اگر جلسه ای این شرط را داشته باشد، جلسه از عضویت در بخش مربوط به sessionExclusionDuration حذف می شود.

SessionExclusionDuration

اگر یک جلسه با sessionExclusionCriteria مطابقت داشته باشد، گزینه‌هایی را برای مدت زمان ماندگاری یک حذف برمی‌شمارد.

Enums
SESSION_EXCLUSION_DURATION_UNSPECIFIED مدت زمان حذف نامشخص مشخص نکنید.
SESSION_EXCLUSION_TEMPORARY در طول دوره هایی که جلسه با شرط sessionExclusionCriteria مطابقت دارد، به طور موقت جلسات را از بخش حذف کنید.
SESSION_EXCLUSION_PERMANENT اگر جلسه با شرط sessionExclusionCriteria مطابقت داشته باشد، به‌طور دائم جلسات را از بخش حذف کنید.

بخش رویداد

بخش‌های رویداد زیرمجموعه‌ای از رویدادهایی هستند که در سایت یا برنامه شما راه‌اندازی شده‌اند. به عنوان مثال، تمام رویدادهای خرید انجام شده در یک مکان خاص؛ رویدادهای app_exception که در یک سیستم عامل خاص رخ داده است.

نمایندگی JSON 
{
  "eventInclusionCriteria": {
    object (EventSegmentCriteria)
  },
  "exclusion": {
    object (EventSegmentExclusion)
  }
}
فیلدها
event Inclusion Criteria

object ( EventSegmentCriteria )

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

exclusion

object ( EventSegmentExclusion )

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

معیارهای بخش رویداد

یک رویداد با یک معیار مطابقت دارد اگر رویداد شرایط موجود در معیارها را داشته باشد.

نمایندگی JSON 
{
  "andConditionGroups": [
    {
      object (EventSegmentConditionGroup)
    }
  ]
}
فیلدها
and Condition Groups[]

object ( EventSegmentConditionGroup )

یک رویداد با این معیار مطابقت دارد اگر رویداد با هر یک از این andConditionGroups مطابقت داشته باشد.

EventSegmentConditionGroup

شرایط به Analytics می‌گوید چه داده‌هایی را در بخش گنجانده یا از آن حذف کند.

نمایندگی JSON 
{
  "conditionScoping": enum (EventCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
فیلدها
condition Scoping

enum ( EventCriteriaScoping )

conditionScoping باید همیشه EVENT_CRITERIA_WITHIN_SAME_EVENT باشد.

اختیاری. اگر مشخص نشده باشد، از یک conditionScoping EVENT_CRITERIA_WITHIN_SAME_EVENT استفاده می شود.

segment Filter Expression

object ( SegmentFilterExpression )

داده ها بر اساس مطابقت با این عبارت شامل یا از بخش حذف می شوند. عبارات معیارهای ابعاد، معیارها و/یا پارامترها را بیان می کنند.

EventCriteriaScoping

Scoping مشخص می کند که اگر رویدادی معیاری را داشته باشد، چه رویدادهایی در هنگام ارزیابی در نظر گرفته می شوند.

Enums
EVENT_CRITERIA_SCOPING_UNSPECIFIED محدوده معیارهای نامشخص مشخص نکنید.
EVENT_CRITERIA_WITHIN_SAME_EVENT اگر معیارها در یک رویداد برآورده شوند، رویداد با معیارها مطابقت دارد.

EventSegmentExclusion

مشخص می‌کند کدام رویدادها در این بخش حذف می‌شوند.

نمایندگی JSON 
{
  "eventExclusionDuration": enum (EventExclusionDuration),
  "eventExclusionCriteria": {
    object (EventSegmentCriteria)
  }
}
فیلدها
event Exclusion Duration

enum ( EventExclusionDuration )

eventExclusionDuration باید همیشه PERMANENTLY_EXCLUDE باشد.

اختیاری. اگر مشخص نشده باشد، یک eventExclusionDuration EVENT_EXCLUSION_PERMANENT استفاده می‌شود.

event Exclusion Criteria

object ( EventSegmentCriteria )

اگر رویدادی دارای این شرط باشد، رویداد از عضویت در بخش رویداد eventExclusionDuration حذف می‌شود.

EventExclusionDuration

اگر رویدادی با eventExclusionCriteria مطابقت داشته باشد، گزینه‌هایی را برای مدت زمان ماندگاری یک استثنا برمی‌شمارد.

Enums
EVENT_EXCLUSION_DURATION_UNSPECIFIED مدت زمان حذف نامشخص مشخص نکنید.
EVENT_EXCLUSION_PERMANENT اگر رویداد با شرط eventExclusionCriteria مطابقت داشته باشد، رویدادها را برای همیشه از بخش حذف کنید.

FunnelSubReport

گزارش‌های فرعی قیف حاوی مقادیر داده‌های ابعاد و متریک است. به عنوان مثال، 12 کاربر به مرحله دوم قیف رسیدند.

نمایندگی JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "metadata": {
    object (FunnelResponseMetadata)
  }
}
فیلدها
dimension Headers[]

object ( DimensionHeader )

ستون های ابعاد را توصیف می کند. گزارش های قیف همیشه شامل بعد مرحله قیف در پاسخ های گزارش فرعی می شود. در صورت درخواست، ابعاد اضافی مانند خرابی‌ها، تاریخ‌ها و اقدامات بعدی ممکن است در پاسخ وجود داشته باشد.

metric Headers[]

object ( MetricHeader )

ستون های متریک را توصیف می کند. گزارش های قیف همیشه شامل کاربران فعال در پاسخ های گزارش فرعی می شود. جدول قیف شامل معیارهای اضافی مانند نرخ تکمیل، رها شدن، و نرخ رها شدن است.

rows[]

object ( Row )

ردیف هایی از ترکیبات ارزش ابعاد و مقادیر متریک در گزارش.

metadata

object ( FunnelResponseMetadata )

فراداده برای گزارش قیف.

FunnelResponseMetadata

فراداده پاسخ گزارش قیف حاوی اطلاعات اضافی درباره گزارش قیف است.

نمایندگی JSON 
{
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ]
}
فیلدها
sampling Metadatas[]

object ( SamplingMetadata )

اگر از نتایج گزارش قیف نمونه برداری شود، این نشان می دهد که چند درصد از رویدادها در این گزارش قیف استفاده شده است. برای هر محدوده تاریخ، یک samplingMetadatas پر شده است. هر samplingMetadatas با یک محدوده تاریخ مطابقت دارد تا محدوده‌های تاریخ در درخواست مشخص شود.

اما اگر از نتایج نمونه برداری نشود، این فیلد تعریف نمی شود.

،

گزارش قیف سفارشی داده‌های رویداد Google Analytics شما را برمی‌گرداند. داده های برگردانده شده از API به صورت جدولی با ستون هایی برای ابعاد و معیارهای درخواستی است.

کاوش قیف به شما این امکان را می‌دهد تا مراحلی را که کاربران برای تکمیل یک کار برمی‌دارند تجسم کنید و به سرعت ببینید که در هر مرحله چقدر موفق یا شکست می‌خورند. به عنوان مثال، چگونه مشتریان بالقوه خریدار و سپس خریدار می شوند؟ چگونه خریداران یکباره تبدیل به خریداران تکراری می شوند؟ با این اطلاعات، می توانید سفرهای ناکارآمد یا رها شده مشتریان را بهبود ببخشید. برای کسب اطلاعات بیشتر، به کاوش‌های قیف GA4 مراجعه کنید.

این روش در ثبات آلفا با هدف جمع‌آوری بازخورد در نحو و قابلیت‌ها قبل از ورود به بتا معرفی شده است. برای ارائه بازخورد خود در مورد این API، بازخورد گزارش قیف Google Analytics Data API را تکمیل کنید.

درخواست HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runFunnelReport

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

پارامترهای مسیر

پارامترها
property

string

اختیاری. یک شناسه دارایی Google Analytics که رویدادهای آن ردیابی می شوند. در مسیر URL و نه بدنه مشخص شده است. برای کسب اطلاعات بیشتر، ببینید شناسه ملک خود را از کجا پیدا کنید . در یک درخواست دسته ای، این ویژگی یا باید نامشخص باشد یا با ویژگی سطح دسته ای سازگار باشد.

مثال: خواص/1234

درخواست بدن

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

نمایندگی JSON 
{
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "funnel": {
    object (Funnel)
  },
  "funnelBreakdown": {
    object (FunnelBreakdown)
  },
  "funnelNextAction": {
    object (FunnelNextAction)
  },
  "funnelVisualizationType": enum (FunnelVisualizationType),
  "segments": [
    {
      object (Segment)
    }
  ],
  "limit": string,
  "dimensionFilter": {
    object (FilterExpression)
  },
  "returnPropertyQuota": boolean
}
فیلدها
date Ranges[]

object ( DateRange )

اختیاری. محدوده تاریخ داده برای خواندن. اگر چندین محدوده تاریخ درخواست شود، هر ردیف پاسخ حاوی یک شاخص محدوده تاریخ مبتنی بر صفر خواهد بود. اگر دو محدوده تاریخ همپوشانی داشته باشند، داده‌های رویداد برای روزهای همپوشانی در ردیف‌های پاسخ برای هر دو محدوده تاریخ گنجانده می‌شود.

funnel

object ( Funnel )

اختیاری. پیکربندی قیف این درخواست. این پیکربندی قیف مورد نیاز است.

funnel Breakdown

object ( FunnelBreakdown )

اختیاری. اگر مشخص شده باشد، این تفکیک بعد به پاسخ گزارش فرعی جدول قیف اضافه می کند. این بعد تجزیه هر مرحله قیف را به مقادیر منحصر به فرد بعد شکست گسترش می دهد. برای مثال، تفکیک بر اساس بعد deviceCategory ردیف‌هایی را برای mobile ، tablet ، desktop و کل ایجاد می‌کند.

funnel Next Action

object ( FunnelNextAction )

اختیاری. در صورت مشخص شدن، اقدام بعدی یک بعد به پاسخ گزارش فرعی تجسم قیف اضافه می کند. این بعد اقدام بعدی هر مرحله قیف را به مقادیر منحصر به فرد اقدام بعدی گسترش می دهد. به عنوان مثال، اقدام بعدی بعد eventName ، ردیف‌هایی را برای چندین رویداد (مثلا session_start و click ) و کل ایجاد می‌کند.

اقدام بعدی فقط eventName و بیشتر ابعاد صفحه/صفحه مانند pageTitle و pagePath را پشتیبانی می‌کند.

funnel Visualization Type

enum ( FunnelVisualizationType )

اختیاری. نوع تجسم قیف ابعاد موجود در پاسخ گزارش فرعی تجسم قیف را کنترل می کند. اگر مشخص نشده باشد، STANDARD_FUNNEL استفاده می شود.

segments[]

object ( Segment )

اختیاری. تنظیمات بخش ها بخش‌ها زیرمجموعه‌ای از داده‌های یک ویژگی هستند. در یک گزارش قیف با بخش ها، قیف در هر بخش ارزیابی می شود.

هر بخش مشخص شده در این درخواست یک ردیف جداگانه در پاسخ ایجاد می کند. در پاسخ ، هر بخش با نام خود مشخص می شود.

پارامتر بخش اختیاری است. درخواست ها به 4 بخش محدود می شوند.

limit

string ( int64 format)

اختیاری. تعداد ردیف هایی که باید برگردانده شوند. اگر مشخص نشده باشد، 10000 ردیف برگردانده می شود. API حداکثر 250000 سطر را در هر درخواست برمی گرداند، مهم نیست که چقدر درخواست کنید. limit باید مثبت باشد

API همچنین می‌تواند ردیف‌های کمتری را نسبت به limit درخواستی برگرداند، اگر مقادیر ابعاد به اندازه limit وجود نداشته باشد.

dimension Filter

object ( FilterExpression )

اختیاری. فیلترهای ابعاد به شما امکان می دهند فقط مقادیر خاص ابعاد را در گزارش بخواهید. برای کسب اطلاعات بیشتر ، به ایجاد یک گزارش مراجعه کنید: فیلترهای ابعاد برای مثال. معیارها را نمی توان در این فیلتر استفاده کرد.

return Property Quota

boolean

اختیاری. آیا می تواند وضعیت فعلی سهمیه این ملک تحلیلی را برگرداند. سهمیه در PropertyQuota برگردانده می شود.

بدن پاسخگو

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

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "funnelTable": {
    object (FunnelSubReport)
  },
  "funnelVisualization": {
    object (FunnelSubReport)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string
}
فیلدها
funnel Table

object ( FunnelSubReport )

جدول قیف گزارشی با مرحله قیف ، بخش ، ابعاد تجزیه ، کاربران فعال ، میزان تکمیل ، رها کردن و میزان رها کردن است.

در صورت درخواست یک بخش ، بعد قطعه فقط در این پاسخ وجود دارد. بعد تجزیه فقط در صورت درخواست در این پاسخ وجود دارد.

funnel Visualization

object ( FunnelSubReport )

تجسم قیف گزارشی با مرحله قیف ، بخش ، تاریخ ، بعد عمل بعدی و کاربران فعال است.

در صورت درخواست یک بخش ، بعد قطعه فقط در این پاسخ وجود دارد. در صورت درخواست از طریق نوع قیف TRENDED_FUNNEL بعد تاریخ فقط در این پاسخ وجود دارد. بعد عمل بعدی فقط در صورت درخواست در پاسخ وجود دارد.

property Quota

object ( PropertyQuota )

وضعیت سهمیه این ملک Analytics از جمله این درخواست.

kind

string

مشخص می کند که این پیام چه نوع منبعی است. این kind همیشه رشته ثابت "AnalyticsData#RunfunnelReport" است. برای تمایز بین انواع پاسخ در JSON مفید است.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

قیف

قیف را در درخواست گزارش قیف پیکربندی می کند. یک قیف از کاربران گزارش می دهد که آنها دنباله ای از مراحل را پشت سر می گذارند.

کاوش قیف به شما این امکان را می‌دهد تا مراحلی را که کاربران برای تکمیل یک کار برمی‌دارند تجسم کنید و به سرعت ببینید که در هر مرحله چقدر موفق یا شکست می‌خورند. به عنوان مثال، چگونه مشتریان بالقوه خریدار و سپس خریدار می شوند؟ چگونه خریداران یکباره تبدیل به خریداران تکراری می شوند؟ با این اطلاعات، می توانید سفرهای ناکارآمد یا رها شده مشتریان را بهبود ببخشید.

نمایندگی JSON 
{
  "isOpenFunnel": boolean,
  "steps": [
    {
      object (FunnelStep)
    }
  ]
}
فیلدها
is Open Funnel

boolean

در یک قیف باز ، کاربران می توانند در هر مرحله وارد قیف شوند و در یک قیف بسته ، کاربران باید در مرحله اول وارد قیف شوند. اختیاری. در صورت نامشخص ، از قیف بسته استفاده می شود.

steps[]

object ( FunnelStep )

مراحل متوالی این قیف.

قیف

مراحل سفر کاربر را که می خواهید اندازه گیری کنید تعریف کنید. مراحل حاوی یک یا چند شرط است که کاربران شما باید در آن ملاقات کنند تا در آن مرحله از سفر قیف قرار بگیرند.

نمایندگی JSON 
{
  "name": string,
  "isDirectlyFollowedBy": boolean,
  "filterExpression": {
    object (FunnelFilterExpression)
  },
  "withinDurationFromPriorStep": string
}
فیلدها
name

string

نام متمایز این مرحله. در صورت نامشخص ، مراحل با یک نام فهرست بندی شده 1 مستقر (به عنوان مثال "0" ، "1." و غیره) نامگذاری می شود. این نام مقدار رشته ای را که توسط ابعاد funnelStepName بازگردانده شده است تعریف می کند. به عنوان مثال ، مشخص کردن name = Purchase در مرحله سوم قیف درخواست 3. Purchase در پاسخ گزارش قیف تولید می کند.

is Directly Followed By

boolean

اگر درست باشد ، این مرحله باید مستقیماً مرحله قبلی را دنبال کند. در صورت دروغ بودن ، می توان رویدادهایی بین مرحله قبلی و این مرحله رخ داد. اگر نامشخص باشد ، isDirectlyFollowedBy به عنوان نادرست رفتار می شود.

filter Expression

object ( FunnelFilterExpression )

شرایطی که کاربران شما باید ملاقات کنند تا در این مرحله از سفر قیف گنجانده شوند.

within Duration From Prior Step

string ( Duration format)

در صورت مشخص شدن ، این مرحله باید در این مدت زمان اتمام مرحله قبلی انجام شود. withinDurationFromPriorStep شامل نقطه پایانی در دانه بندی میکرو ثانیه است. به عنوان مثال مدت 5 ثانیه می تواند در 4.9 یا 5.0 ثانیه تکمیل شود ، اما 5 ثانیه و 1 میکرو ثانیه نیست.

withinDurationFromPriorStep اختیاری است ، و در صورت نامشخص ، ممکن است مراحل با هر مدت زمان از هم جدا شود.

مدت زمان در ثانیه با حداکثر نه رقم کسری ، که با " s " پایان می یابد. مثال: "3.5s" .

فاحش

ترکیبی از فیلترهای قیف را بیان می کند.

نمایندگی JSON 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FunnelFilterExpressionList)
  },
  "orGroup": {
    object (FunnelFilterExpressionList)
  },
  "notExpression": {
    object (FunnelFilterExpression)
  },
  "funnelFieldFilter": {
    object (FunnelFieldFilter)
  },
  "funnelEventFilter": {
    object (FunnelEventFilter)
  }
  // End of list of possible types for union field expr.
}
فیلدها
Union Field expr . یک نوع فیلتر را برای FunnelFilterExpression مشخص کنید. expr فقط می تواند یکی از موارد زیر باشد:
and Group

object ( FunnelFilterExpressionList )

FunnelfilterExpression در andGroup دارای یک رابطه و رابطه است.

or Group

object ( FunnelFilterExpressionList )

FunnelfilterExpression در orGroup دارای یک رابطه یا رابطه است.

not Expression

object ( FunnelFilterExpression )

FunnelfilterExpression از notExpression نیست.

funnel Field Filter

object ( FunnelFieldFilter )

یک فیلتر قیف برای ابعاد یا متریک.

funnel Event Filter

object ( FunnelEventFilter )

فیلتری را ایجاد می کند که مطابق با وقایع یک نام یک رویداد باشد. اگر یک بیان فیلتر پارامتر مشخص شده باشد ، فقط زیر مجموعه رویدادهایی که هم با نام رویداد واحد مطابقت دارند و عبارات فیلتر پارامتر با این فیلتر رویداد مطابقت دارند.

funnelfilterexpressionList

لیستی از عبارات فیلتر قیف.

نمایندگی JSON 
{
  "expressions": [
    {
      object (FunnelFilterExpression)
    }
  ]
}
فیلدها
expressions[]

object ( FunnelFilterExpression )

لیست عبارات فیلتر قیف.

قله

عبارتی برای فیلتر کردن ابعاد یا مقادیر متریک.

نمایندگی JSON 
{
  "fieldName": string,

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
فیلدها
field Name

string

نام ابعاد یا نام متریک.

Union Field one_filter . یک نوع فیلتر را مشخص کنید. one_filter فقط می تواند یکی از موارد زیر باشد:
string Filter

object ( StringFilter )

فیلتر مربوط به رشته ها.

in List Filter

object ( InListFilter )

یک فیلتر برای مقادیر لیست.

numeric Filter

object ( NumericFilter )

فیلتر برای مقادیر عددی یا تاریخ.

between Filter

object ( BetweenFilter )

یک فیلتر برای دو مقدار.

funneleventfilter

فیلتری را ایجاد می کند که مطابق با وقایع یک نام یک رویداد باشد. اگر یک بیان فیلتر پارامتر مشخص شده باشد ، فقط زیر مجموعه رویدادهایی که هم با نام رویداد واحد مطابقت دارند و عبارات فیلتر پارامتر با این فیلتر رویداد مطابقت دارند.

نمایندگی JSON 
{
  "eventName": string,
  "funnelParameterFilterExpression": {
    object (FunnelParameterFilterExpression)
  }
}
فیلدها
event Name

string

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

funnel Parameter Filter Expression

object ( FunnelParameterFilterExpression )

در صورت مشخص شدن ، این فیلتر با رویدادهایی مطابقت دارد که هم با نام رویداد واحد و هم عبارات فیلتر پارامتر مطابقت دارند.

در داخل بیان فیلتر پارامتر ، فقط فیلترهای پارامتر در دسترس هستند.

funnelparameterfilterexpression

ترکیبی از فیلترهای قیف را بر روی پارامترها بیان می کند.

نمایندگی JSON 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FunnelParameterFilterExpressionList)
  },
  "orGroup": {
    object (FunnelParameterFilterExpressionList)
  },
  "notExpression": {
    object (FunnelParameterFilterExpression)
  },
  "funnelParameterFilter": {
    object (FunnelParameterFilter)
  }
  // End of list of possible types for union field expr.
}
فیلدها
Union Field expr . یک نوع فیلتر را برای FunnelParameterFilterExpression مشخص کنید. expr فقط می تواند یکی از موارد زیر باشد:
and Group

object ( FunnelParameterFilterExpressionList )

FunnelParameterFilterExpression در andGroup دارای یک رابطه و رابطه است.

or Group

object ( FunnelParameterFilterExpressionList )

FunnelParameterFilterExpression در orGroup دارای یک رابطه یا رابطه است.

not Expression

object ( FunnelParameterFilterExpression )

FunnelParameterFilterExpression از notExpression نیست.

funnel Parameter Filter

object ( FunnelParameterFilter )

فیلتر پارامتر قیف اولیه.

funnelparameterfilterexpressionList

لیستی از عبارات فیلتر پارامتر قیف.

نمایندگی JSON 
{
  "expressions": [
    {
      object (FunnelParameterFilterExpression)
    }
  ]
}
فیلدها
expressions[]

object ( FunnelParameterFilterExpression )

لیست عبارات فیلتر پارامتر قیف.

قیراط

عبارتی برای فیلتر کردن مقادیر پارامتر در یک قیف.

نمایندگی JSON 
{

  // Union field one_parameter can be only one of the following:
  "eventParameterName": string,
  "itemParameterName": string
  // End of list of possible types for union field one_parameter.

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
فیلدها
Union Field one_parameter . فیلدی که فیلتر می شود. one_parameter فقط می تواند یکی از موارد زیر باشد:
event Parameter Name

string

این فیلتر در پارامتر رویداد مشخص شده ارزیابی می شود. پارامترهای رویداد به عنوان پارامترهای این رویداد ثبت می شوند. پارامترهای رویداد شامل زمینه هایی مانند "firebase_screen" و "ارز" است.

پارامترهای رویداد فقط در بخش ها و قیف ها قابل استفاده است و فقط می توان در یک فیلتر نسبتی از یک رویداد از EventFilter استفاده کرد. در یک فیلتر نسبتی از یک رویداد یا پارامترهای رویداد یا مورد استفاده می شود.

item Parameter Name

string

این فیلتر در پارامتر مورد مشخص شده ارزیابی می شود. پارامترهای مورد به عنوان پارامترهای موجود در آرایه مورد ثبت می شوند. پارامترهای موردی شامل زمینه هایی مانند "item_name" و "item_category" است.

پارامترهای مورد فقط در بخش ها و قیف ها قابل استفاده است و فقط می توان در یک فیلتر نسبتی از یک رویداد از یک رویداد استفاده کرد. در یک فیلتر نسبتی از یک رویداد یا پارامترهای رویداد یا مورد استفاده می شود.

پارامترهای مورد فقط در رویدادهای تجارت الکترونیک موجود است. برای کسب اطلاعات بیشتر در مورد وقایع تجارت الکترونیک ، به راهنمای تجارت الکترونیک مراجعه کنید.

Union Field one_filter . یک نوع فیلتر را مشخص کنید. one_filter فقط می تواند یکی از موارد زیر باشد:
string Filter

object ( StringFilter )

فیلتر مربوط به رشته ها.

in List Filter

object ( InListFilter )

یک فیلتر برای مقادیر لیست.

numeric Filter

object ( NumericFilter )

فیلتر برای مقادیر عددی یا تاریخ.

between Filter

object ( BetweenFilter )

یک فیلتر برای دو مقدار.

تداخل

خرابی ها ابعادی را به پاسخ گزارش زیر جدول قیف اضافه می کنند.

نمایندگی JSON 
{
  "breakdownDimension": {
    object (Dimension)
  },
  "limit": string
}
فیلدها
breakdown Dimension

object ( Dimension )

ستون ابعاد اضافه شده به پاسخ گزارش زیر جدول قیف. بعد شکست ، هر مرحله قیف را تجزیه می کند. در صورت مشخص شدن funnelBreakdown یک breakdownDimension معتبر لازم است.

limit

string ( int64 format)

حداکثر تعداد مقادیر متمایز بعد تجزیه برای بازگشت در پاسخ. اگر حد مشخص نشده باشد از limit 5 استفاده می شود. حد باید از صفر فراتر رود و نمی تواند از 15 تجاوز کند.

عمل

اقدامات بعدی پس از دستیابی کاربر به یک مرحله ، مقدار یک بعد را بیان می کند اما قبل از اینکه همان کاربر به مرحله بعدی برسد. به عنوان مثال اگر nextActionDimension eventName باشد ، سپس nextActionDimension در ردیف مرحله قیف i Th اولین رویداد را پس از رویدادی که کاربر را به مرحله قیف i Th واجد شرایط می کند ، باز می گرداند اما قبل از اینکه کاربر به مرحله قیف i+1 برسد.

نمایندگی JSON 
{
  "nextActionDimension": {
    object (Dimension)
  },
  "limit": string
}
فیلدها
next Action Dimension

object ( Dimension )

ستون ابعاد اضافه شده به پاسخ گزارش زیر تجسم قیف. بعد عمل بعدی بعد از رسیدن کاربر به مرحله قیف i ، مقدار بعد بعدی این بعد را برمی گرداند.

nextActionDimension در حال حاضر فقط از eventName و بیشتر ابعاد صفحه / صفحه مانند pageTitle و pagePath پشتیبانی می کند. nextActionDimension نمی تواند یک بیان ابعاد باشد.

limit

string ( int64 format)

حداکثر تعداد مقادیر متمایز بعد تجزیه برای بازگشت در پاسخ. اگر حد مشخص نشده باشد از limit 5 استفاده می شود. حد باید از صفر فراتر رود و نمی تواند از 5 تجاوز کند.

funnelvisionizationType

ابعاد موجود در پاسخ گزارش زیر گزارش قیف را کنترل می کند.

Enums
FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED نوع نامشخص
STANDARD_FUNNEL قیف استاندارد (پله ای). گزارش فرعی تجسم قیف در پاسخ حاوی تاریخ نخواهد بود.
TRENDED_FUNNEL قیف گراند (نمودار خط). گزارش زیر تجسم قیف در پاسخ شامل بعد تاریخ خواهد بود.

بخش

یک بخش زیر مجموعه ای از داده های تحلیلی شما است. برای مثال، از کل مجموعه کاربران شما، یک بخش ممکن است کاربران یک کشور یا شهر خاص باشد. بخش دیگری ممکن است کاربرانی باشد که خط خاصی از محصولات را خریداری می کنند یا به بخش خاصی از سایت شما مراجعه می کنند یا رویدادهای خاصی را در برنامه شما ایجاد می کنند.

برای کسب اطلاعات بیشتر ، به بخش سازنده بخش مراجعه کنید.

نمایندگی JSON 
{
  "name": string,

  // Union field one_segment_scope can be only one of the following:
  "userSegment": {
    object (UserSegment)
  },
  "sessionSegment": {
    object (SessionSegment)
  },
  "eventSegment": {
    object (EventSegment)
  }
  // End of list of possible types for union field one_segment_scope.
}
فیلدها
name

string

نام این بخش. در صورت نامشخص ، بخش ها "بخش" نامگذاری می شوند. این نام مقدار رشته ای را که توسط ابعاد segment برگشته است ، تعریف می کند. پیشوند segment نام بخش را با شماره شاخص 1 مبتنی بر بخش در درخواست (به عنوان مثال "بخش 1. بخش" ، "2. بخش" و غیره) می گذارد.

Union Field one_segment_scope . یک بخش در یک محدوده مشخص شده است. one_segment_scope فقط می تواند یکی از موارد زیر باشد:
user Segment

object ( UserSegment )

بخش های کاربر زیر مجموعه کاربرانی هستند که با سایت یا برنامه شما درگیر هستند.

session Segment

object ( SessionSegment )

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

event Segment

object ( EventSegment )

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

کاربران

بخش های کاربر زیر مجموعه کاربرانی هستند که با سایت یا برنامه شما درگیر هستند. به عنوان مثال ، کاربرانی که قبلاً خریداری کرده اند. کاربرانی که مواردی را به چرخ دستی های خرید خود اضافه کردند ، اما خرید را کامل نکردند.

نمایندگی JSON 
{
  "userInclusionCriteria": {
    object (UserSegmentCriteria)
  },
  "exclusion": {
    object (UserSegmentExclusion)
  }
}
فیلدها
user Inclusion Criteria

object ( UserSegmentCriteria )

تعریف می کند که کاربران در این بخش گنجانده شده اند. اختیاری.

exclusion

object ( UserSegmentExclusion )

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

کاربران

اگر رویدادهای کاربر شرایط موجود در معیارها را برآورده کند ، یک کاربر با معیارهایی مطابقت دارد.

نمایندگی JSON 
{
  "andConditionGroups": [
    {
      object (UserSegmentConditionGroup)
    }
  ],
  "andSequenceGroups": [
    {
      object (UserSegmentSequenceGroup)
    }
  ]
}
فیلدها
and Condition Groups[]

object ( UserSegmentConditionGroup )

اگر کاربر با هر یک از این andConditionGroups و هر یک از andSequenceGroups مطابقت داشته باشد ، یک کاربر با این معیارها مطابقت دارد. در صورت مشخص شدن andSequenceGroups andConditionGroups ممکن است گروههای و گروههای مختلف خالی باشند.

and Sequence Groups[]

object ( UserSegmentSequenceGroup )

اگر کاربر با هر یک از این andSequenceGroups و هر یک از andConditionGroups مطابقت داشته باشد ، یک کاربر با این معیارها مطابقت دارد. و در صورت مشخص شدن andConditionGroups andSequenceGroups ممکن است خالی باشند.

گروه کاربران

شرایط به تجزیه و تحلیل می گوید که داده ها چه چیزی را شامل می شوند یا از این بخش خارج می شوند.

نمایندگی JSON 
{
  "conditionScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
فیلدها
condition Scoping

enum ( UserCriteriaScoping )

داده ها بر اساس اگر با گروه شرایط مطابقت داشته باشد ، از بخش گنجانده شده یا از آن خارج شده است. این scoping مشخص می کند که قبل از اینکه گروه شرایط مشخص شود که با هم مطابقت داشته باشد یا نه ، چه تعداد segmentFilterExpression رویدادها را تعیین می کند. به عنوان مثال اگر conditionScoping = USER_CRITERIA_WITHIN_SAME_SESSION ، این عبارت در تمام رویدادها در یک جلسه ارزیابی می شود ، و سپس ، گروه شرط تعیین می شود که برای این کاربر مطابقت داشته باشد یا خیر. به عنوان مثال اگر conditionScoping = USER_CRITERIA_WITHIN_SAME_EVENT ، این عبارت در یک رویداد واحد ارزیابی می شود ، و سپس ، گروه شرط تعیین می شود که برای این کاربر مطابقت داشته باشد یا خیر.

اختیاری. اگر نامشخص باشد ، conditionScoping = ACROSS_ALL_SESSIONS استفاده می شود.

segment Filter Expression

object ( SegmentFilterExpression )

داده ها بر اساس اگر با این عبارت مطابقت داشته باشد ، از این بخش حذف شده یا از آن خارج شده است. عبارات معیارهای مربوط به ابعاد ، معیارها و/یا پارامترها را بیان می کنند.

کاربری CriteriasCoping

Scoping مشخص می کند که هنگام ارزیابی کاربر با معیارها ، کدام رویدادها در نظر گرفته می شود.

Enums
USER_CRITERIA_SCOPING_UNSPECIFIED معیارهای نامشخص. مشخص نکنید
USER_CRITERIA_WITHIN_SAME_EVENT اگر معیارها در یک رویداد راضی باشد ، کاربر با معیارها مطابقت دارد.
USER_CRITERIA_WITHIN_SAME_SESSION اگر معیارها در یک جلسه راضی باشد ، کاربر با معیارها مطابقت دارد.
USER_CRITERIA_ACROSS_ALL_SESSIONS اگر معیارها از هر رویدادی برای کاربر راضی باشد ، کاربر با معیارها مطابقت دارد.

SegmentFilterExpression

ترکیبی از فیلترهای بخش را بیان می کند.

نمایندگی JSON 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (SegmentFilterExpressionList)
  },
  "orGroup": {
    object (SegmentFilterExpressionList)
  },
  "notExpression": {
    object (SegmentFilterExpression)
  },
  "segmentFilter": {
    object (SegmentFilter)
  },
  "segmentEventFilter": {
    object (SegmentEventFilter)
  }
  // End of list of possible types for union field expr.
}
فیلدها
Union Field expr . یک نوع فیلتر را برای SegmentFilterExpression مشخص کنید. expr فقط می تواند یکی از موارد زیر باشد:
and Group

object ( SegmentFilterExpressionList )

SegmentFilterExpression در andGroup دارای یک رابطه و رابطه است.

or Group

object ( SegmentFilterExpressionList )

SegmentFilterExpression در orGroup دارای یک رابطه یا رابطه است.

not Expression

object ( SegmentFilterExpression )

SegmentFilterExpression از notExpression نیست.

segment Filter

object ( SegmentFilter )

یک فیلتر بخش ابتدایی.

segment Event Filter

object ( SegmentEventFilter )

فیلتری را ایجاد می کند که مطابق با وقایع یک نام یک رویداد باشد. اگر یک بیان فیلتر پارامتر مشخص شده باشد ، فقط زیر مجموعه رویدادهایی که هم با نام رویداد واحد مطابقت دارند و عبارات فیلتر پارامتر با این فیلتر رویداد مطابقت دارند.

SegmentFilterExpressionList

لیستی از عبارات فیلتر قطعه.

نمایندگی JSON 
{
  "expressions": [
    {
      object (SegmentFilterExpression)
    }
  ]
}
فیلدها
expressions[]

object ( SegmentFilterExpression )

لیست عبارات فیلتر بخش

بخش

عبارتی برای فیلتر کردن ابعاد یا مقادیر متریک.

نمایندگی JSON 
{
  "fieldName": string,
  "filterScoping": {
    object (SegmentFilterScoping)
  },

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
فیلدها
field Name

string

نام ابعاد یا نام متریک.

filter Scoping

object ( SegmentFilterScoping )

دامنه فیلتر را مشخص می کند.

Union Field one_filter . یک نوع فیلتر را برای Filter مشخص کنید. one_filter فقط می تواند یکی از موارد زیر باشد:
string Filter

object ( StringFilter )

فیلتر مربوط به رشته ها.

in List Filter

object ( InListFilter )

یک فیلتر برای مقادیر لیست.

numeric Filter

object ( NumericFilter )

فیلتر برای مقادیر عددی یا تاریخ.

between Filter

object ( BetweenFilter )

یک فیلتر برای دو مقدار.

بخش

Scopings مشخص می کند که چگونه ابعاد و معیارهای چندین رویداد هنگام ارزیابی فیلتر قطعه باید در نظر گرفته شود.

نمایندگی JSON 
{
  "atAnyPointInTime": boolean
}
فیلدها
at Any Point In Time

boolean

اگر atAnyPointInTime درست باشد ، اگر در مورد هر رویدادی در محدوده تاریخ درخواست ارزیابی شود ، این فیلتر برای همه رویدادها درست ارزیابی می کند.

این پارامتر atAnyPointInTime دامنه تاریخ وقایع موجود در گزارش را گسترش نمی دهد. اگر atAnyPointInTime صحیح باشد ، فقط در هنگام ارزیابی این فیلتر ، فقط رویدادهای موجود در محدوده تاریخ گزارش در نظر گرفته می شوند.

این atAnyPointInTime فقط در صورتی که معیارها ACROSS_ALL_SESSIONS باشد ، می تواند مشخص شود و در توالی ها قادر به مشخص شدن نیست.

اگر معیارهای scoping ACROSS_ALL_SESSIONS باشد ، در صورت نامشخص از atAnyPointInTime = false استفاده می شود.

بخش eventfilter

فیلتری را ایجاد می کند که مطابق با وقایع یک نام یک رویداد باشد. اگر یک بیان فیلتر پارامتر مشخص شده باشد ، فقط زیر مجموعه رویدادهایی که هم با نام رویداد واحد مطابقت دارند و عبارات فیلتر پارامتر با این فیلتر رویداد مطابقت دارند.

نمایندگی JSON 
{
  "eventName": string,
  "segmentParameterFilterExpression": {
    object (SegmentParameterFilterExpression)
  }
}
فیلدها
event Name

string

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

segment Parameter Filter Expression

object ( SegmentParameterFilterExpression )

در صورت مشخص شدن ، این فیلتر با رویدادهایی مطابقت دارد که هم با نام رویداد واحد و هم عبارات فیلتر پارامتر مطابقت دارند.

در داخل بیان فیلتر پارامتر ، فقط فیلترهای پارامتر در دسترس هستند.

SegmentParameterFilterExpression

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

نمایندگی JSON 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (SegmentParameterFilterExpressionList)
  },
  "orGroup": {
    object (SegmentParameterFilterExpressionList)
  },
  "notExpression": {
    object (SegmentParameterFilterExpression)
  },
  "segmentParameterFilter": {
    object (SegmentParameterFilter)
  }
  // End of list of possible types for union field expr.
}
فیلدها
Union Field expr . یک نوع فیلتر را برای SegmentParameterFilterExpression مشخص کنید. expr فقط می تواند یکی از موارد زیر باشد:
and Group

object ( SegmentParameterFilterExpressionList )

بخش parparameterfilterexpression در andGroup دارای یک رابطه و رابطه است.

or Group

object ( SegmentParameterFilterExpressionList )

بخش parparameterfilterexpression در orGroup دارای یک رابطه یا رابطه است.

not Expression

object ( SegmentParameterFilterExpression )

بخش parparameterfilterexpression از notExpression نیست.

segment Parameter Filter

object ( SegmentParameterFilter )

فیلتر پارامتر بخش ابتدایی.

SegmentParameterFilterExpressionList

لیستی از عبارات فیلتر پارامتر قطعه.

نمایندگی JSON 
{
  "expressions": [
    {
      object (SegmentParameterFilterExpression)
    }
  ]
}
فیلدها
expressions[]

object ( SegmentParameterFilterExpression )

لیست عبارات فیلتر پارامتر بخش.

بخش پاراگرامتر

عبارتی برای فیلتر کردن مقادیر پارامتر در یک بخش.

نمایندگی JSON 
{
  "filterScoping": {
    object (SegmentParameterFilterScoping)
  },

  // Union field one_parameter can be only one of the following:
  "eventParameterName": string,
  "itemParameterName": string
  // End of list of possible types for union field one_parameter.

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
فیلدها
filter Scoping

object ( SegmentParameterFilterScoping )

دامنه فیلتر را مشخص می کند.

Union Field one_parameter . فیلدی که فیلتر می شود. one_parameter فقط می تواند یکی از موارد زیر باشد:
event Parameter Name

string

این فیلتر در پارامتر رویداد مشخص شده ارزیابی می شود. پارامترهای رویداد به عنوان پارامترهای این رویداد ثبت می شوند. پارامترهای رویداد شامل زمینه هایی مانند "firebase_screen" و "ارز" است.

پارامترهای رویداد فقط در بخش ها و قیف ها قابل استفاده است و فقط می توان در یک فیلتر نسبتی از یک رویداد از EventFilter استفاده کرد. در یک فیلتر نسبتی از یک رویداد یا پارامترهای رویداد یا مورد استفاده می شود.

item Parameter Name

string

این فیلتر در پارامتر مورد مشخص شده ارزیابی می شود. پارامترهای مورد به عنوان پارامترهای موجود در آرایه مورد ثبت می شوند. پارامترهای موردی شامل زمینه هایی مانند "item_name" و "item_category" است.

پارامترهای مورد فقط در بخش ها و قیف ها قابل استفاده است و فقط می توان در یک فیلتر نسبتی از یک رویداد از یک رویداد استفاده کرد. در یک فیلتر نسبتی از یک رویداد یا پارامترهای رویداد یا مورد استفاده می شود.

پارامترهای مورد فقط در رویدادهای تجارت الکترونیک موجود است. برای کسب اطلاعات بیشتر در مورد وقایع تجارت الکترونیک ، به راهنمای تجارت الکترونیک مراجعه کنید.

Union Field one_filter . یک نوع فیلتر را مشخص کنید. one_filter فقط می تواند یکی از موارد زیر باشد:
string Filter

object ( StringFilter )

فیلتر مربوط به رشته ها.

in List Filter

object ( InListFilter )

یک فیلتر برای مقادیر لیست.

numeric Filter

object ( NumericFilter )

فیلتر برای مقادیر عددی یا تاریخ.

between Filter

object ( BetweenFilter )

یک فیلتر برای دو مقدار.

segmentparameterfilterscoping

Scopings مشخص می کند که چگونه چندین رویداد را باید هنگام ارزیابی فیلتر پارامتر قطعه در نظر گرفت.

نمایندگی JSON 
{
  "inAnyNDayPeriod": string
}
فیلدها
in Any N Day Period

string ( int64 format)

پارامتر را در مدت مشخصی از روزها قبل از استفاده از فیلتر جمع می کند. فقط اگر معیارها ACROSS_ALL_SESSIONS یا WITHIN_SAME_SESSION باشد پشتیبانی می شود. فقط اگر پارامتر event_count باشد پشتیبانی می شود.

به عنوان مثال اگر inAnyNDayPeriod 3 باشد ، نام رویداد "خرید" است ، پارامتر رویداد "event_count" است و معیارهای فیلتر بیشتر از 5 است ، این فیلتر تعداد رویداد خرید را در هر 3 دوره روز متوالی در گزارش جمع می کند. محدوده تاریخ ؛ اگر تعداد رویدادهای خرید آنها در هر 3 دوره متوالی بیش از 5 باشد ، یک کاربر معیارهای این فیلتر را در این بخش قرار می دهد. به عنوان مثال ، دوره های 2021-11-01 تا 2021-11-03 ، 2021-11-02 تا 2021-11-04 ، 2021-11-03 تا 2021-11-05 و غیره در نظر گرفته خواهد شد.

محدوده تاریخ به منظور داشتن یک پنجره کامل روز N در نزدیکی شروع محدوده تاریخ تمدید نمی شود. به عنوان مثال اگر گزارشی برای 2021-11-01 تا 2021-11-10 و inAnyNDayPeriod = 3 باشد ، دوره دو روزه اول به طور مؤثر کوتاه می شود زیرا هیچ داده ای در خارج از محدوده تاریخ گزارش خوانده نمی شود. به عنوان مثال ، چهار دوره اول به طور مؤثر خواهد بود: 2021-11-01 تا 2021-11-01 ، 2021-11-01 تا 2021-11-02 ، 2021-11-01 تا 2021-11-03 و 2021- 11-02 تا 2021-11-04.

inAnyNDayPeriod اختیاری است. اگر مشخص نشده باشد ، segmentParameterFilter به صورت جداگانه برای هر رویداد اعمال می شود.

گروه کاربران

شرایطی را تعریف کنید که باید به ترتیب خاصی رخ دهد تا کاربر عضو این بخش باشد.

نمایندگی JSON 
{
  "sequenceScoping": enum (UserCriteriaScoping),
  "sequenceMaximumDuration": string,
  "userSequenceSteps": [
    {
      object (UserSequenceStep)
    }
  ]
}
فیلدها
sequence Scoping

enum ( UserCriteriaScoping )

تمام مراحل دنباله باید در Scoping برای کاربر مطابقت داشته باشد تا دنباله مطابقت داشته باشد. به عنوان مثال اگر sequenceScoping = USER_CRITERIA_WITHIN_SAME_SESSION ، تمام مراحل دنباله باید در یک جلسه انجام شود تا کاربر با دنباله مطابقت داشته باشد. sequenceScoping = USER_CRITERIA_WITHIN_SAME_EVENT پشتیبانی نمی شود.

اختیاری. اگر نامشخص باشد ، conditionScoping = ACROSS_ALL_SESSIONS استفاده می شود.

sequence Maximum Duration

string ( Duration format)

دوره زمانی را که کل دنباله باید در آن رخ دهد ، تعریف می کند. به عنوان مثال ، 30 دقیقه. sequenceMaximumDuration شامل نقطه پایانی در دانه بندی میکرو ثانیه است. به عنوان مثال ، دنباله ای با حداکثر مدت 5 ثانیه می تواند در 4.9 یا 5.0 ثانیه تکمیل شود ، اما 5 ثانیه و 1 میکرو ثانیه نیست.

sequenceMaximumDuration اختیاری است و در صورت نامشخص ، توالی ها می توانند در هر مدت زمان تکمیل شوند.

مدت زمان در ثانیه با حداکثر نه رقم کسری ، که با " s " پایان می یابد. مثال: "3.5s" .

user Sequence Steps[]

object ( UserSequenceStep )

یک توالی سفارش داده شده از مراحل شرط. رویدادهای کاربر باید هر مرحله را انجام دهد تا کاربر بتواند با UserSegmentSequenceGroup مطابقت داشته باشد.

userSequencestep

شرایطی که باید در ترتیب مرحله مشخص شده برای این کاربر با دنباله مطابقت داشته باشد.

نمایندگی JSON 
{
  "isDirectlyFollowedBy": boolean,
  "stepScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
فیلدها
is Directly Followed By

boolean

اگر درست باشد ، رویداد رضایت از این مرحله باید بعد از رویداد آخرین مرحله ، رویداد بعدی باشد. اگر نادرست باشد ، این مرحله به طور غیر مستقیم از مرحله قبلی پیروی می کند. به عنوان مثال ، ممکن است بین مرحله قبلی و این مرحله اتفاقاتی رخ دهد. isDirectlyFollowedBy باید برای اولین قدم نادرست باشد.

step Scoping

enum ( UserCriteriaScoping )

این مرحله توالی باید در Scoping برای کاربر مطابقت داشته باشد تا دنباله مطابقت داشته باشد. به عنوان مثال اگر sequenceScoping = WITHIN_SAME_SESSION ، این توالی باید در یک جلسه انجام شود تا کاربر با دنباله مطابقت داشته باشد. stepScoping = ACROSS_ALL_SESSIONS فقط در صورتی مجاز است که sequenceScoping = ACROSS_ALL_SESSIONS .

اختیاری. در صورت نامشخص ، stepScoping از همان UserCriteriaScoping به عنوان sequenceScoping استفاده می کند.

segment Filter Expression

object ( SegmentFilterExpression )

اگر رویدادهای آنها با این عبارت مطابقت داشته باشد ، یک کاربر با این مرحله دنباله مطابقت دارد. عبارات معیارهای مربوط به ابعاد ، معیارها و/یا پارامترها را بیان می کنند.

کاربران

مشخص می کند که کدام کاربران در این بخش حذف شده اند.

نمایندگی JSON 
{
  "userExclusionDuration": enum (UserExclusionDuration),
  "userExclusionCriteria": {
    object (UserSegmentCriteria)
  }
}
فیلدها
user Exclusion Duration

enum ( UserExclusionDuration )

مشخص می کند اگر کاربر با userExclusionCriteria مطابقت داشته باشد ، چه مدت دوام خواهد داشت.

اختیاری. اگر نامشخص باشد ، از userExclusionDuration USER_EXCLUSION_TEMPORARY استفاده می شود.

user Exclusion Criteria

object ( UserSegmentCriteria )

اگر کاربر این شرایط را برآورده کند ، کاربر از عضویت در این بخش برای userExclusionDuration خارج می شود.

UserexclusionDuration

گزینه هایی را برای مدت طولانی دوام می آورد اگر کاربر با userExclusionCriteria مطابقت داشته باشد.

Enums
USER_EXCLUSION_DURATION_UNSPECIFIED مدت زمان محرومیت نامشخص. مشخص نکنید
USER_EXCLUSION_TEMPORARY به طور موقت کاربران را از این بخش در دوره هایی که کاربر با شرایط userExclusionCriteria ملاقات می کند ، محروم می کند.
USER_EXCLUSION_PERMANENT اگر کاربر تا به حال شرایط userExclusionCriteria را برآورده کند ، کاربران را از این بخش محروم می کند.

جلسه جلسه

بخش های جلسه زیر مجموعه ای از جلسات هستند که در سایت یا برنامه شما اتفاق می افتد: به عنوان مثال ، تمام جلسات ناشی از یک تبلیغات تبلیغاتی خاص.

نمایندگی JSON 
{
  "sessionInclusionCriteria": {
    object (SessionSegmentCriteria)
  },
  "exclusion": {
    object (SessionSegmentExclusion)
  }
}
فیلدها
session Inclusion Criteria

object ( SessionSegmentCriteria )

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

exclusion

object ( SessionSegmentExclusion )

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

جلسه

اگر رویدادهای جلسه شرایط موجود در معیارها را برآورده کند ، یک جلسه با معیارهایی مطابقت دارد.

نمایندگی JSON 
{
  "andConditionGroups": [
    {
      object (SessionSegmentConditionGroup)
    }
  ]
}
فیلدها
and Condition Groups[]

object ( SessionSegmentConditionGroup )

اگر جلسه با هر یک از این andConditionGroups مطابقت داشته باشد ، یک جلسه با این معیارها مطابقت دارد.

گروه جلسه

شرایط به تجزیه و تحلیل می گوید که داده ها چه چیزی را شامل می شوند یا از این بخش خارج می شوند.

نمایندگی JSON 
{
  "conditionScoping": enum (SessionCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
فیلدها
condition Scoping

enum ( SessionCriteriaScoping )

داده ها بر اساس اگر با گروه شرایط مطابقت داشته باشد ، از بخش گنجانده شده یا از آن خارج شده است. این scoping مشخص می کند که قبل از اینکه گروه شرایط مشخص شود که با هم مطابقت داشته باشد یا نه ، چه تعداد segmentFilterExpression رویدادها را تعیین می کند. به عنوان مثال اگر conditionScoping = SESSION_CRITERIA_WITHIN_SAME_SESSION ، این عبارت در تمام رویدادها در یک جلسه ارزیابی می شود ، و سپس ، گروه شرط تعیین می شود که برای این جلسه مطابقت داشته باشد یا خیر. به عنوان مثال اگر conditionScoping = SESSION_CRITERIA_WITHIN_SAME_EVENT ، این عبارت در یک رویداد واحد ارزیابی می شود ، و سپس ، گروه شرط تعیین می شود که برای این جلسه مطابقت داشته باشد یا خیر.

اختیاری. در صورت نامشخص ، از conditionScoping در WITHIN_SAME_SESSION استفاده می شود.

segment Filter Expression

object ( SegmentFilterExpression )

داده ها بر اساس اگر با این عبارت مطابقت داشته باشد ، از این بخش حذف شده یا از آن خارج شده است. عبارات معیارهای مربوط به ابعاد ، معیارها و/یا پارامترها را بیان می کنند.

sessioncriteriascoping

Scoping مشخص می کند که هنگام ارزیابی یک جلسه ، کدام یک از رویدادها در نظر گرفته می شود.

Enums
SESSION_CRITERIA_SCOPING_UNSPECIFIED معیارهای نامشخص. مشخص نکنید
SESSION_CRITERIA_WITHIN_SAME_EVENT اگر معیارها در یک رویداد راضی باشد ، جلسه با معیارها مطابقت دارد.
SESSION_CRITERIA_WITHIN_SAME_SESSION اگر معیارها در یک جلسه راضی باشد ، جلسه با معیارها مطابقت دارد.

SessionSegmentExclusion

مشخص می کند که کدام جلسات در این بخش حذف شده است.

نمایندگی JSON 
{
  "sessionExclusionDuration": enum (SessionExclusionDuration),
  "sessionExclusionCriteria": {
    object (SessionSegmentCriteria)
  }
}
فیلدها
session Exclusion Duration

enum ( SessionExclusionDuration )

مشخص می کند که اگر یک جلسه با sessionExclusionCriteria مطابقت داشته باشد ، چه مدت دوام خواهد داشت.

اختیاری. اگر نامشخص باشد ، از یک sessionExclusionDuration از SESSION_EXCLUSION_TEMPORARY استفاده می شود.

session Exclusion Criteria

object ( SessionSegmentCriteria )

اگر یک جلسه با این شرایط روبرو شود ، جلسه از عضویت در بخش برای sessionExclusionDuration مستثنی است.

SessionexclusionDuration

گزینه هایی را برای چه مدت دوام می آورد اگر یک جلسه با sessionExclusionCriteria مطابقت داشته باشد.

Enums
SESSION_EXCLUSION_DURATION_UNSPECIFIED مدت زمان محرومیت نامشخص. مشخص نکنید
SESSION_EXCLUSION_TEMPORARY جلسات را به طور موقت از این بخش در دوره هایی که جلسه با شرایط sessionExclusionCriteria ملاقات می کند ، حذف کنید.
SESSION_EXCLUSION_PERMANENT اگر جلسه همیشه با شرایط sessionExclusionCriteria ملاقات کند ، جلسات را از این بخش محروم می کند.

بخش حادثه

بخش های رویداد زیر مجموعه رویدادهایی هستند که در سایت یا برنامه شما ایجاد شده اند. به عنوان مثال ، تمام رویدادهای خرید ساخته شده در یک مکان خاص. رویدادهای APP_EXception که در یک سیستم عامل خاص رخ داده است.

نمایندگی JSON 
{
  "eventInclusionCriteria": {
    object (EventSegmentCriteria)
  },
  "exclusion": {
    object (EventSegmentExclusion)
  }
}
فیلدها
event Inclusion Criteria

object ( EventSegmentCriteria )

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

exclusion

object ( EventSegmentExclusion )

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

EventSegmentCriteria

اگر این رویداد شرایط موجود در معیارها را برآورده کند ، یک رویداد مطابق با معیارها است.

نمایندگی JSON 
{
  "andConditionGroups": [
    {
      object (EventSegmentConditionGroup)
    }
  ]
}
فیلدها
and Condition Groups[]

object ( EventSegmentConditionGroup )

اگر این رویداد با هر یک از این andConditionGroups مطابقت داشته باشد ، یک رویداد با این معیارها مطابقت دارد.

گروه EventSetmentConditionGroup

شرایط به تجزیه و تحلیل می گوید که داده ها چه چیزی را شامل می شوند یا از این بخش خارج می شوند.

نمایندگی JSON 
{
  "conditionScoping": enum (EventCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
فیلدها
condition Scoping

enum ( EventCriteriaScoping )

conditionScoping همیشه باید EVENT_CRITERIA_WITHIN_SAME_EVENT باشد.

اختیاری. اگر نامشخص باشد ، از conditionScoping EVENT_CRITERIA_WITHIN_SAME_EVENT استفاده می شود.

segment Filter Expression

object ( SegmentFilterExpression )

داده ها بر اساس اگر با این عبارت مطابقت داشته باشد ، از این بخش حذف شده یا از آن خارج شده است. عبارات معیارهای مربوط به ابعاد ، معیارها و/یا پارامترها را بیان می کنند.

اتفاقات

Scoping مشخص می کند که هنگام ارزیابی یک رویداد ، کدام یک از رویدادها در نظر گرفته می شود.

Enums
EVENT_CRITERIA_SCOPING_UNSPECIFIED معیارهای نامشخص. مشخص نکنید
EVENT_CRITERIA_WITHIN_SAME_EVENT اگر معیارها در یک رویداد راضی باشد ، این رویداد با معیارها مطابقت دارد.

EventSegmentExclusion

مشخص می کند که کدام وقایع در این بخش حذف شده اند.

نمایندگی JSON 
{
  "eventExclusionDuration": enum (EventExclusionDuration),
  "eventExclusionCriteria": {
    object (EventSegmentCriteria)
  }
}
فیلدها
event Exclusion Duration

enum ( EventExclusionDuration )

eventExclusionDuration باید همیشه PERMANENTLY_EXCLUDE باشد.

اختیاری. اگر نامشخص باشد ، از یک eventExclusionDuration از EVENT_EXCLUSION_PERMANENT استفاده می شود.

event Exclusion Criteria

object ( EventSegmentCriteria )

اگر یک رویداد با این شرایط روبرو شود ، این رویداد از عضویت در این بخش برای eventExclusionDuration خارج می شود.

EventExclusionDuration

گزینه هایی را برای چه مدت دوام می آورد اگر یک رویداد با رویداد eventExclusionCriteria مطابقت داشته باشد.

Enums
EVENT_EXCLUSION_DURATION_UNSPECIFIED مدت زمان محرومیت نامشخص. مشخص نکنید
EVENT_EXCLUSION_PERMANENT اگر این رویداد تا به حال شرایط eventExclusionCriteria را برآورده کند ، وقایع را از این بخش محروم می کند.

قله

گزارش های زیر قیف حاوی ابعاد و مقادیر داده متریک است. به عنوان مثال ، 12 کاربر به مرحله دوم قیف رسیدند.

نمایندگی JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "metadata": {
    object (FunnelResponseMetadata)
  }
}
فیلدها
dimension Headers[]

object ( DimensionHeader )

ستون های ابعاد را توصیف می کند. گزارش های قیف همیشه شامل ابعاد قدم قیف در پاسخ های گزارش زیر است. ابعاد اضافی مانند خرابی ، تاریخ و اقدامات بعدی ممکن است در صورت درخواست در پاسخ وجود داشته باشد.

metric Headers[]

object ( MetricHeader )

ستون های متریک را توصیف می کند. گزارش های قیف همیشه شامل کاربران فعال در پاسخ های گزارش زیر است. جدول قیف شامل معیارهای اضافی مانند نرخ تکمیل ، رها کردن و نرخ ترک است.

rows[]

object ( Row )

ردیف هایی از ترکیبات ارزش ابعاد و مقادیر متریک در گزارش.

metadata

object ( FunnelResponseMetadata )

ابرداده برای گزارش قیف.

funnelresponsemetadata

پاسخ گزارش قیف ، ابرداده اطلاعات اضافی در مورد گزارش قیف دارد.

نمایندگی JSON 
{
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ]
}
فیلدها
sampling Metadatas[]

object ( SamplingMetadata )

اگر نتایج گزارش قیف نمونه برداری شود ، این توصیف می کند که درصد از وقایع در این گزارش قیف استفاده شده است. یک samplingMetadatas برای هر محدوده تاریخ جمع شده است. هر samplingMetadatas با یک محدوده تاریخ مطابقت دارد به منظور مشخص شدن محدوده تاریخ در درخواست.

اما اگر نتایج نمونه برداری نشود ، این قسمت تعریف نمی شود.

،

یک گزارش قیف سفارشی از داده های رویداد Google Analytics خود را برمی گرداند. داده های برگشتی از API به عنوان جدول با ستون هایی برای ابعاد و معیارهای درخواست شده است.

کاوش قیف به شما این امکان را می‌دهد تا مراحلی را که کاربران برای تکمیل یک کار برمی‌دارند تجسم کنید و به سرعت ببینید که در هر مرحله چقدر موفق یا شکست می‌خورند. به عنوان مثال، چگونه مشتریان بالقوه خریدار و سپس خریدار می شوند؟ چگونه خریداران یکباره تبدیل به خریداران تکراری می شوند؟ با این اطلاعات، می توانید سفرهای ناکارآمد یا رها شده مشتریان را بهبود ببخشید. برای کسب اطلاعات بیشتر ، به اکتشافات قیف GA4 مراجعه کنید.

این روش با هدف جمع آوری بازخورد در مورد نحو و قابلیت ها قبل از ورود به بتا در ثبات آلفا معرفی شده است. برای ارائه نظرات خود در مورد این API ، بازخورد گزارش دهی قیف API API Google Analytics را تکمیل کنید.

درخواست HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runFunnelReport

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

پارامترهای مسیر

پارامترها
property

string

اختیاری. یک شناسه دارایی Google Analytics که رویدادهای آن ردیابی می شوند. در مسیر URL و نه بدنه مشخص شده است. برای کسب اطلاعات بیشتر، ببینید شناسه ملک خود را از کجا پیدا کنید . در یک درخواست دسته ای ، این ملک باید نامشخص باشد یا با خاصیت سطح دسته ای سازگار باشد.

مثال: خواص/1234

درخواست بدن

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

نمایندگی JSON 
{
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "funnel": {
    object (Funnel)
  },
  "funnelBreakdown": {
    object (FunnelBreakdown)
  },
  "funnelNextAction": {
    object (FunnelNextAction)
  },
  "funnelVisualizationType": enum (FunnelVisualizationType),
  "segments": [
    {
      object (Segment)
    }
  ],
  "limit": string,
  "dimensionFilter": {
    object (FilterExpression)
  },
  "returnPropertyQuota": boolean
}
فیلدها
date Ranges[]

object ( DateRange )

اختیاری. محدوده تاریخ داده ها برای خواندن. در صورت درخواست دامنه های چند تاریخ ، هر سطر پاسخ شامل شاخص محدوده تاریخ مبتنی بر صفر خواهد بود. اگر دو محدوده تاریخ همپوشانی داشته باشد ، داده های رویداد برای روزهای همپوشانی در ردیف های پاسخ برای هر دو محدوده تاریخ گنجانده شده است.

funnel

object ( Funnel )

اختیاری. پیکربندی قیف این درخواست. این پیکربندی قیف مورد نیاز است.

funnel Breakdown

object ( FunnelBreakdown )

اختیاری. در صورت مشخص شدن ، این شکست ابعادی را به پاسخ گزارش زیر جدول قیف اضافه می کند. این بعد شکست ، هر مرحله قیف را به مقادیر منحصر به فرد بعد تجزیه گسترش می دهد. به عنوان مثال ، شکست توسط ابعاد deviceCategory ردیف هایی را برای mobile ، tablet ، desktop و کل ایجاد می کند.

funnel Next Action

object ( FunnelNextAction )

اختیاری. در صورت مشخص شدن ، عمل بعدی ابعادی را به پاسخ گزارش زیر گزارش قیف اضافه می کند. این بعد عمل بعدی هر مرحله قیف را به مقادیر منحصر به فرد عمل بعدی گسترش می دهد. به عنوان مثال ، یک اقدام بعدی از بعد eventName ردیف هایی را برای چندین رویداد (به عنوان مثال session_start & click ) و کل ایجاد می کند.

اقدام بعدی فقط از eventName و بیشتر ابعاد صفحه / صفحه مانند pageTitle و pagePath پشتیبانی می کند.

funnel Visualization Type

enum ( FunnelVisualizationType )

اختیاری. نوع تجسم قیف ، ابعاد موجود در پاسخ گزارش زیر گزارش قیف را کنترل می کند. اگر مشخص نشده باشد ، از STANDARD_FUNNEL استفاده می شود.

segments[]

object ( Segment )

اختیاری. تنظیمات بخش ها. بخش ها زیر مجموعه داده های یک ویژگی هستند. در یک گزارش قیف با بخش ها ، قیف در هر بخش ارزیابی می شود.

هر بخش مشخص شده در این درخواست یک ردیف جداگانه در پاسخ ایجاد می کند. در پاسخ ، هر بخش با نام خود مشخص می شود.

پارامتر بخش ها اختیاری است. درخواست ها به 4 بخش محدود می شوند.

limit

string ( int64 format)

اختیاری. تعداد ردیف هایی که باید برگردانده شوند. اگر مشخص نشده باشد، 10000 ردیف برگردانده می شود. API حداکثر 250000 سطر را در هر درخواست برمی گرداند، مهم نیست که چقدر درخواست کنید. limit باید مثبت باشد

API همچنین می‌تواند ردیف‌های کمتری را نسبت به limit درخواستی برگرداند، اگر مقادیر ابعاد به اندازه limit وجود نداشته باشد.

dimension Filter

object ( FilterExpression )

اختیاری. فیلترهای ابعاد به شما امکان می دهند فقط مقادیر خاص ابعاد را در گزارش بخواهید. برای کسب اطلاعات بیشتر ، به ایجاد یک گزارش مراجعه کنید: فیلترهای ابعاد برای مثال. معیارها را نمی توان در این فیلتر استفاده کرد.

return Property Quota

boolean

اختیاری. آیا می تواند وضعیت فعلی سهمیه این ملک تحلیلی را برگرداند. سهمیه در PropertyQuota برگردانده می شود.

بدن پاسخگو

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

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "funnelTable": {
    object (FunnelSubReport)
  },
  "funnelVisualization": {
    object (FunnelSubReport)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string
}
فیلدها
funnel Table

object ( FunnelSubReport )

جدول قیف گزارشی با مرحله قیف ، بخش ، ابعاد تجزیه ، کاربران فعال ، میزان تکمیل ، رها کردن و میزان رها کردن است.

در صورت درخواست یک بخش ، بعد قطعه فقط در این پاسخ وجود دارد. بعد تجزیه فقط در صورت درخواست در این پاسخ وجود دارد.

funnel Visualization

object ( FunnelSubReport )

تجسم قیف گزارشی با مرحله قیف ، بخش ، تاریخ ، بعد عمل بعدی و کاربران فعال است.

در صورت درخواست یک بخش ، بعد قطعه فقط در این پاسخ وجود دارد. در صورت درخواست از طریق نوع قیف TRENDED_FUNNEL بعد تاریخ فقط در این پاسخ وجود دارد. بعد عمل بعدی فقط در صورت درخواست در پاسخ وجود دارد.

property Quota

object ( PropertyQuota )

وضعیت سهمیه این ملک Analytics از جمله این درخواست.

kind

string

مشخص می کند که این پیام چه نوع منبعی است. این kind همیشه رشته ثابت "AnalyticsData#RunfunnelReport" است. برای تمایز بین انواع پاسخ در JSON مفید است.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

قیف

قیف را در درخواست گزارش قیف پیکربندی می کند. یک قیف از کاربران گزارش می دهد که آنها دنباله ای از مراحل را پشت سر می گذارند.

کاوش قیف به شما این امکان را می‌دهد تا مراحلی را که کاربران برای تکمیل یک کار برمی‌دارند تجسم کنید و به سرعت ببینید که در هر مرحله چقدر موفق یا شکست می‌خورند. به عنوان مثال، چگونه مشتریان بالقوه خریدار و سپس خریدار می شوند؟ چگونه خریداران یکباره تبدیل به خریداران تکراری می شوند؟ با این اطلاعات، می توانید سفرهای ناکارآمد یا رها شده مشتریان را بهبود ببخشید.

نمایندگی JSON 
{
  "isOpenFunnel": boolean,
  "steps": [
    {
      object (FunnelStep)
    }
  ]
}
فیلدها
is Open Funnel

boolean

در یک قیف باز ، کاربران می توانند در هر مرحله وارد قیف شوند و در یک قیف بسته ، کاربران باید در مرحله اول وارد قیف شوند. اختیاری. در صورت نامشخص ، از قیف بسته استفاده می شود.

steps[]

object ( FunnelStep )

مراحل متوالی این قیف.

قیف

مراحل سفر کاربر را که می خواهید اندازه گیری کنید تعریف کنید. مراحل حاوی یک یا چند شرط است که کاربران شما باید در آن ملاقات کنند تا در آن مرحله از سفر قیف قرار بگیرند.

نمایندگی JSON 
{
  "name": string,
  "isDirectlyFollowedBy": boolean,
  "filterExpression": {
    object (FunnelFilterExpression)
  },
  "withinDurationFromPriorStep": string
}
فیلدها
name

string

نام متمایز این مرحله. در صورت نامشخص ، مراحل با یک نام فهرست بندی شده 1 مستقر (به عنوان مثال "0" ، "1." و غیره) نامگذاری می شود. این نام مقدار رشته ای را که توسط ابعاد funnelStepName بازگردانده شده است تعریف می کند. به عنوان مثال ، مشخص کردن name = Purchase در مرحله سوم قیف درخواست 3. Purchase در پاسخ گزارش قیف تولید می کند.

is Directly Followed By

boolean

اگر درست باشد ، این مرحله باید مستقیماً مرحله قبلی را دنبال کند. در صورت دروغ بودن ، می توان رویدادهایی بین مرحله قبلی و این مرحله رخ داد. اگر نامشخص باشد ، isDirectlyFollowedBy به عنوان نادرست رفتار می شود.

filter Expression

object ( FunnelFilterExpression )

شرایطی که کاربران شما باید ملاقات کنند تا در این مرحله از سفر قیف گنجانده شوند.

within Duration From Prior Step

string ( Duration format)

در صورت مشخص شدن ، این مرحله باید در این مدت زمان اتمام مرحله قبلی انجام شود. withinDurationFromPriorStep شامل نقطه پایانی در دانه بندی میکرو ثانیه است. به عنوان مثال مدت 5 ثانیه می تواند در 4.9 یا 5.0 ثانیه تکمیل شود ، اما 5 ثانیه و 1 میکرو ثانیه نیست.

withinDurationFromPriorStep اختیاری است ، و در صورت نامشخص ، ممکن است مراحل با هر مدت زمان از هم جدا شود.

مدت زمان در ثانیه با حداکثر نه رقم کسری ، که با " s " پایان می یابد. مثال: "3.5s" .

FunnelFilterExpression

Expresses combinations of funnel filters.

نمایندگی JSON 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FunnelFilterExpressionList)
  },
  "orGroup": {
    object (FunnelFilterExpressionList)
  },
  "notExpression": {
    object (FunnelFilterExpression)
  },
  "funnelFieldFilter": {
    object (FunnelFieldFilter)
  },
  "funnelEventFilter": {
    object (FunnelEventFilter)
  }
  // End of list of possible types for union field expr.
}
فیلدها
Union field expr . Specify one type of filter for FunnelFilterExpression . expr can be only one of the following:
and Group

object ( FunnelFilterExpressionList )

The FunnelFilterExpression in andGroup have an AND relationship.

or Group

object ( FunnelFilterExpressionList )

The FunnelFilterExpression in orGroup have an OR relationship.

not Expression

object ( FunnelFilterExpression )

The FunnelFilterExpression is NOT of notExpression .

funnel Field Filter

object ( FunnelFieldFilter )

A funnel filter for a dimension or metric.

funnel Event Filter

object ( FunnelEventFilter )

Creates a filter that matches events of a single event name. If a parameter filter expression is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter.

FunnelFilterExpressionList

A list of funnel filter expressions.

نمایندگی JSON 
{
  "expressions": [
    {
      object (FunnelFilterExpression)
    }
  ]
}
فیلدها
expressions[]

object ( FunnelFilterExpression )

The list of funnel filter expressions.

FunnelFieldFilter

An expression to filter dimension or metric values.

نمایندگی JSON 
{
  "fieldName": string,

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
فیلدها
field Name

string

The dimension name or metric name.

Union field one_filter . Specify one type of filter. one_filter can be only one of the following:
string Filter

object ( StringFilter )

Strings related filter.

in List Filter

object ( InListFilter )

A filter for in list values.

numeric Filter

object ( NumericFilter )

A filter for numeric or date values.

between Filter

object ( BetweenFilter )

A filter for between two values.

FunnelEventFilter

Creates a filter that matches events of a single event name. If a parameter filter expression is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter.

نمایندگی JSON 
{
  "eventName": string,
  "funnelParameterFilterExpression": {
    object (FunnelParameterFilterExpression)
  }
}
فیلدها
event Name

string

This filter matches events of this single event name. Event name is required.

funnel Parameter Filter Expression

object ( FunnelParameterFilterExpression )

If specified, this filter matches events that match both the single event name and the parameter filter expressions.

Inside the parameter filter expression, only parameter filters are available.

FunnelParameterFilterExpression

Expresses combinations of funnel filters on parameters.

نمایندگی JSON 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FunnelParameterFilterExpressionList)
  },
  "orGroup": {
    object (FunnelParameterFilterExpressionList)
  },
  "notExpression": {
    object (FunnelParameterFilterExpression)
  },
  "funnelParameterFilter": {
    object (FunnelParameterFilter)
  }
  // End of list of possible types for union field expr.
}
فیلدها
Union field expr . Specify one type of filter for FunnelParameterFilterExpression . expr can be only one of the following:
and Group

object ( FunnelParameterFilterExpressionList )

The FunnelParameterFilterExpression in andGroup have an AND relationship.

or Group

object ( FunnelParameterFilterExpressionList )

The FunnelParameterFilterExpression in orGroup have an OR relationship.

not Expression

object ( FunnelParameterFilterExpression )

The FunnelParameterFilterExpression is NOT of notExpression .

funnel Parameter Filter

object ( FunnelParameterFilter )

A primitive funnel parameter filter.

FunnelParameterFilterExpressionList

A list of funnel parameter filter expressions.

نمایندگی JSON 
{
  "expressions": [
    {
      object (FunnelParameterFilterExpression)
    }
  ]
}
فیلدها
expressions[]

object ( FunnelParameterFilterExpression )

The list of funnel parameter filter expressions.

FunnelParameterFilter

An expression to filter parameter values in a funnel.

نمایندگی JSON 
{

  // Union field one_parameter can be only one of the following:
  "eventParameterName": string,
  "itemParameterName": string
  // End of list of possible types for union field one_parameter.

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
فیلدها
Union field one_parameter . The field that is being filtered. one_parameter can be only one of the following:
event Parameter Name

string

This filter will be evaluated on the specified event parameter. Event parameters are logged as parameters of the event. Event parameters include fields like "firebase_screen" & "currency".

Event parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used.

item Parameter Name

string

This filter will be evaluated on the specified item parameter. Item parameters are logged as parameters in the item array. Item parameters include fields like "item_name" & "item_category".

Item parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used.

Item parameters are only available in ecommerce events. To learn more about ecommerce events, see the Measure ecommerce guide.

Union field one_filter . Specify one type of filter. one_filter can be only one of the following:
string Filter

object ( StringFilter )

Strings related filter.

in List Filter

object ( InListFilter )

A filter for in list values.

numeric Filter

object ( NumericFilter )

A filter for numeric or date values.

between Filter

object ( BetweenFilter )

A filter for between two values.

FunnelBreakdown

Breakdowns add a dimension to the funnel table sub report response.

نمایندگی JSON 
{
  "breakdownDimension": {
    object (Dimension)
  },
  "limit": string
}
فیلدها
breakdown Dimension

object ( Dimension )

The dimension column added to the funnel table sub report response. The breakdown dimension breaks down each funnel step. A valid breakdownDimension is required if funnelBreakdown is specified.

limit

string ( int64 format)

The maximum number of distinct values of the breakdown dimension to return in the response. A limit of 5 is used if limit is not specified. Limit must exceed zero and cannot exceed 15.

FunnelNextAction

Next actions state the value for a dimension after the user has achieved a step but before the same user has achieved the next step. For example if the nextActionDimension is eventName , then nextActionDimension in the i th funnel step row will return first event after the event that qualified the user into the i th funnel step but before the user achieved the i+1 th funnel step.

نمایندگی JSON 
{
  "nextActionDimension": {
    object (Dimension)
  },
  "limit": string
}
فیلدها
next Action Dimension

object ( Dimension )

The dimension column added to the funnel visualization sub report response. The next action dimension returns the next dimension value of this dimension after the user has attained the i th funnel step.

nextActionDimension currently only supports eventName and most Page / Screen dimensions like pageTitle and pagePath . nextActionDimension cannot be a dimension expression.

limit

string ( int64 format)

The maximum number of distinct values of the breakdown dimension to return in the response. A limit of 5 is used if limit is not specified. Limit must exceed zero and cannot exceed 5.

FunnelVisualizationType

Controls the dimensions present in the funnel visualization sub report response.

Enums
FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED Unspecified type.
STANDARD_FUNNEL A standard (stepped) funnel. The funnel visualization sub report in the response will not contain date.
TRENDED_FUNNEL A trended (line chart) funnel. The funnel visualization sub report in the response will contain the date dimension.

بخش

A segment is a subset of your Analytics data. برای مثال، از کل مجموعه کاربران شما، یک بخش ممکن است کاربران یک کشور یا شهر خاص باشد. Another segment might be users who purchase a particular line of products or who visit a specific part of your site or trigger certain events in your app.

To learn more, see Segment Builder .

نمایندگی JSON 
{
  "name": string,

  // Union field one_segment_scope can be only one of the following:
  "userSegment": {
    object (UserSegment)
  },
  "sessionSegment": {
    object (SessionSegment)
  },
  "eventSegment": {
    object (EventSegment)
  }
  // End of list of possible types for union field one_segment_scope.
}
فیلدها
name

string

The name for this segment. If unspecified, segments are named "Segment". This name defines string value returned by the segment dimension. The segment dimension prefixes segment names by the 1-based index number of the segment in the request (for example "1. Segment", "2. Segment", etc.).

Union field one_segment_scope . A segment is specified in one scope. one_segment_scope can be only one of the following:
user Segment

object ( UserSegment )

User segments are subsets of users who engaged with your site or app.

session Segment

object ( SessionSegment )

Session segments are subsets of the sessions that occurred on your site or app.

event Segment

object ( EventSegment )

Event segments are subsets of events that were triggered on your site or app.

UserSegment

User segments are subsets of users who engaged with your site or app. For example, users who have previously purchased; users who added items to their shopping carts, but didn't complete a purchase.

نمایندگی JSON 
{
  "userInclusionCriteria": {
    object (UserSegmentCriteria)
  },
  "exclusion": {
    object (UserSegmentExclusion)
  }
}
فیلدها
user Inclusion Criteria

object ( UserSegmentCriteria )

Defines which users are included in this segment. اختیاری.

exclusion

object ( UserSegmentExclusion )

Defines which users are excluded in this segment. اختیاری.

UserSegmentCriteria

A user matches a criteria if the user's events meet the conditions in the criteria.

نمایندگی JSON 
{
  "andConditionGroups": [
    {
      object (UserSegmentConditionGroup)
    }
  ],
  "andSequenceGroups": [
    {
      object (UserSegmentSequenceGroup)
    }
  ]
}
فیلدها
and Condition Groups[]

object ( UserSegmentConditionGroup )

A user matches this criteria if the user matches each of these andConditionGroups and each of the andSequenceGroups . andConditionGroups may be empty if andSequenceGroups are specified.

and Sequence Groups[]

object ( UserSegmentSequenceGroup )

A user matches this criteria if the user matches each of these andSequenceGroups and each of the andConditionGroups . andSequenceGroups may be empty if andConditionGroups are specified.

UserSegmentConditionGroup

Conditions tell Analytics what data to include in or exclude from the segment.

نمایندگی JSON 
{
  "conditionScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
فیلدها
condition Scoping

enum ( UserCriteriaScoping )

Data is included or excluded from the segment based on if it matches the condition group. This scoping defines how many events the segmentFilterExpression is evaluated on before the condition group is determined to be matched or not. For example if conditionScoping = USER_CRITERIA_WITHIN_SAME_SESSION , the expression is evaluated on all events in a session, and then, the condition group is determined to be matched or not for this user. For example if conditionScoping = USER_CRITERIA_WITHIN_SAME_EVENT , the expression is evaluated on a single event, and then, the condition group is determined to be matched or not for this user.

اختیاری. If unspecified, conditionScoping = ACROSS_ALL_SESSIONS is used.

segment Filter Expression

object ( SegmentFilterExpression )

Data is included or excluded from the segment based on if it matches this expression. Expressions express criteria on dimension, metrics, and/or parameters.

UserCriteriaScoping

Scoping specifies which events are considered when evaluating if a user meets a criteria.

Enums
USER_CRITERIA_SCOPING_UNSPECIFIED Unspecified criteria scoping. Do not specify.
USER_CRITERIA_WITHIN_SAME_EVENT If the criteria is satisfied within one event, the user matches the criteria.
USER_CRITERIA_WITHIN_SAME_SESSION If the criteria is satisfied within one session, the user matches the criteria.
USER_CRITERIA_ACROSS_ALL_SESSIONS If the criteria is satisfied by any events for the user, the user matches the criteria.

SegmentFilterExpression

Expresses combinations of segment filters.

نمایندگی JSON 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (SegmentFilterExpressionList)
  },
  "orGroup": {
    object (SegmentFilterExpressionList)
  },
  "notExpression": {
    object (SegmentFilterExpression)
  },
  "segmentFilter": {
    object (SegmentFilter)
  },
  "segmentEventFilter": {
    object (SegmentEventFilter)
  }
  // End of list of possible types for union field expr.
}
فیلدها
Union field expr . Specify one type of filter for SegmentFilterExpression . expr can be only one of the following:
and Group

object ( SegmentFilterExpressionList )

The SegmentFilterExpression in andGroup have an AND relationship.

or Group

object ( SegmentFilterExpressionList )

The SegmentFilterExpression in orGroup have an OR relationship.

not Expression

object ( SegmentFilterExpression )

The SegmentFilterExpression is NOT of notExpression .

segment Filter

object ( SegmentFilter )

A primitive segment filter.

segment Event Filter

object ( SegmentEventFilter )

Creates a filter that matches events of a single event name. If a parameter filter expression is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter.

SegmentFilterExpressionList

A list of segment filter expressions.

نمایندگی JSON 
{
  "expressions": [
    {
      object (SegmentFilterExpression)
    }
  ]
}
فیلدها
expressions[]

object ( SegmentFilterExpression )

The list of segment filter expressions

SegmentFilter

An expression to filter dimension or metric values.

نمایندگی JSON 
{
  "fieldName": string,
  "filterScoping": {
    object (SegmentFilterScoping)
  },

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
فیلدها
field Name

string

The dimension name or metric name.

filter Scoping

object ( SegmentFilterScoping )

Specifies the scope for the filter.

Union field one_filter . Specify one type of filter for Filter . one_filter can be only one of the following:
string Filter

object ( StringFilter )

Strings related filter.

in List Filter

object ( InListFilter )

A filter for in list values.

numeric Filter

object ( NumericFilter )

A filter for numeric or date values.

between Filter

object ( BetweenFilter )

A filter for between two values.

SegmentFilterScoping

Scopings specify how the dimensions & metrics of multiple events should be considered when evaluating a segment filter.

نمایندگی JSON 
{
  "atAnyPointInTime": boolean
}
فیلدها
at Any Point In Time

boolean

If atAnyPointInTime is true, this filter evaluates to true for all events if it evaluates to true for any event in the date range of the request.

This atAnyPointInTime parameter does not extend the date range of events in the report. If atAnyPointInTime is true, only events within the report's date range are considered when evaluating this filter.

This atAnyPointInTime is only able to be specified if the criteria scoping is ACROSS_ALL_SESSIONS and is not able to be specified in sequences.

If the criteria scoping is ACROSS_ALL_SESSIONS , atAnyPointInTime = false is used if unspecified.

SegmentEventFilter

Creates a filter that matches events of a single event name. If a parameter filter expression is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter.

نمایندگی JSON 
{
  "eventName": string,
  "segmentParameterFilterExpression": {
    object (SegmentParameterFilterExpression)
  }
}
فیلدها
event Name

string

This filter matches events of this single event name. Event name is required.

segment Parameter Filter Expression

object ( SegmentParameterFilterExpression )

If specified, this filter matches events that match both the single event name and the parameter filter expressions.

Inside the parameter filter expression, only parameter filters are available.

SegmentParameterFilterExpression

Expresses combinations of segment filter on parameters.

نمایندگی JSON 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (SegmentParameterFilterExpressionList)
  },
  "orGroup": {
    object (SegmentParameterFilterExpressionList)
  },
  "notExpression": {
    object (SegmentParameterFilterExpression)
  },
  "segmentParameterFilter": {
    object (SegmentParameterFilter)
  }
  // End of list of possible types for union field expr.
}
فیلدها
Union field expr . Specify one type of filter for SegmentParameterFilterExpression . expr can be only one of the following:
and Group

object ( SegmentParameterFilterExpressionList )

The SegmentParameterFilterExpression in andGroup have an AND relationship.

or Group

object ( SegmentParameterFilterExpressionList )

The SegmentParameterFilterExpression in orGroup have an OR relationship.

not Expression

object ( SegmentParameterFilterExpression )

The SegmentParameterFilterExpression is NOT of notExpression .

segment Parameter Filter

object ( SegmentParameterFilter )

A primitive segment parameter filter.

SegmentParameterFilterExpressionList

A list of segment parameter filter expressions.

نمایندگی JSON 
{
  "expressions": [
    {
      object (SegmentParameterFilterExpression)
    }
  ]
}
فیلدها
expressions[]

object ( SegmentParameterFilterExpression )

The list of segment parameter filter expressions.

SegmentParameterFilter

An expression to filter parameter values in a segment.

نمایندگی JSON 
{
  "filterScoping": {
    object (SegmentParameterFilterScoping)
  },

  // Union field one_parameter can be only one of the following:
  "eventParameterName": string,
  "itemParameterName": string
  // End of list of possible types for union field one_parameter.

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
فیلدها
filter Scoping

object ( SegmentParameterFilterScoping )

Specifies the scope for the filter.

Union field one_parameter . The field that is being filtered. one_parameter can be only one of the following:
event Parameter Name

string

This filter will be evaluated on the specified event parameter. Event parameters are logged as parameters of the event. Event parameters include fields like "firebase_screen" & "currency".

Event parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used.

item Parameter Name

string

This filter will be evaluated on the specified item parameter. Item parameters are logged as parameters in the item array. Item parameters include fields like "item_name" & "item_category".

Item parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used.

Item parameters are only available in ecommerce events. To learn more about ecommerce events, see the Measure ecommerce guide.

Union field one_filter . Specify one type of filter. one_filter can be only one of the following:
string Filter

object ( StringFilter )

Strings related filter.

in List Filter

object ( InListFilter )

A filter for in list values.

numeric Filter

object ( NumericFilter )

A filter for numeric or date values.

between Filter

object ( BetweenFilter )

A filter for between two values.

SegmentParameterFilterScoping

Scopings specify how multiple events should be considered when evaluating a segment parameter filter.

نمایندگی JSON 
{
  "inAnyNDayPeriod": string
}
فیلدها
in Any N Day Period

string ( int64 format)

Accumulates the parameter over the specified period of days before applying the filter. Only supported if criteria scoping is ACROSS_ALL_SESSIONS or WITHIN_SAME_SESSION . Only supported if the parameter is event_count .

For example if inAnyNDayPeriod is 3, the eventName is "purchase", the event parameter is "event_count", and the Filter's criteria is greater than 5, this filter will accumulate the event count of purchase events over every 3 consecutive day period in the report's date range; a user will pass this Filter's criteria to be included in this segment if their count of purchase events exceeds 5 in any 3 consecutive day period. For example, the periods 2021-11-01 to 2021-11-03, 2021-11-02 to 2021-11-04, 2021-11-03 to 2021-11-05, and etc. will be considered.

The date range is not extended for the purpose of having a full N day window near the start of the date range. For example if a report is for 2021-11-01 to 2021-11-10 and inAnyNDayPeriod = 3, the first two day period will be effectively shortened because no event data outside the report's date range will be read. For example, the first four periods will effectively be: 2021-11-01 to 2021-11-01, 2021-11-01 to 2021-11-02, 2021-11-01 to 2021-11-03, and 2021-11-02 to 2021-11-04.

inAnyNDayPeriod is optional. If not specified, the segmentParameterFilter is applied to each event individually.

UserSegmentSequenceGroup

Define conditions that must occur in a specific order for the user to be a member of the segment.

نمایندگی JSON 
{
  "sequenceScoping": enum (UserCriteriaScoping),
  "sequenceMaximumDuration": string,
  "userSequenceSteps": [
    {
      object (UserSequenceStep)
    }
  ]
}
فیلدها
sequence Scoping

enum ( UserCriteriaScoping )

All sequence steps must be satisfied in the scoping for the user to match the sequence. For example if sequenceScoping = USER_CRITERIA_WITHIN_SAME_SESSION , all sequence steps must complete within one session for the user to match the sequence. sequenceScoping = USER_CRITERIA_WITHIN_SAME_EVENT is not supported.

اختیاری. If unspecified, conditionScoping = ACROSS_ALL_SESSIONS is used.

sequence Maximum Duration

string ( Duration format)

Defines the time period in which the whole sequence must occur; for example, 30 Minutes. sequenceMaximumDuration is inclusive of the endpoint at the microsecond granularity. For example a sequence with a maximum duration of 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1 microsecond.

sequenceMaximumDuration is optional, and if unspecified, sequences can be completed in any time duration.

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

user Sequence Steps[]

object ( UserSequenceStep )

An ordered sequence of condition steps. A user's events must complete each step in order for the user to match the UserSegmentSequenceGroup .

UserSequenceStep

A condition that must occur in the specified step order for this user to match the sequence.

نمایندگی JSON 
{
  "isDirectlyFollowedBy": boolean,
  "stepScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
فیلدها
is Directly Followed By

boolean

If true, the event satisfying this step must be the very next event after the event satifying the last step. If false, this step indirectly follows the prior step; for example, there may be events between the prior step and this step. isDirectlyFollowedBy must be false for the first step.

step Scoping

enum ( UserCriteriaScoping )

This sequence step must be satisfied in the scoping for the user to match the sequence. For example if sequenceScoping = WITHIN_SAME_SESSION , this sequence steps must complete within one session for the user to match the sequence. stepScoping = ACROSS_ALL_SESSIONS is only allowed if the sequenceScoping = ACROSS_ALL_SESSIONS .

اختیاری. If unspecified, stepScoping uses the same UserCriteriaScoping as the sequenceScoping .

segment Filter Expression

object ( SegmentFilterExpression )

A user matches this sequence step if their events match this expression. Expressions express criteria on dimension, metrics, and/or parameters.

UserSegmentExclusion

Specifies which users are excluded in this segment.

نمایندگی JSON 
{
  "userExclusionDuration": enum (UserExclusionDuration),
  "userExclusionCriteria": {
    object (UserSegmentCriteria)
  }
}
فیلدها
user Exclusion Duration

enum ( UserExclusionDuration )

Specifies how long an exclusion will last if a user matches the userExclusionCriteria .

اختیاری. If unspecified, userExclusionDuration of USER_EXCLUSION_TEMPORARY is used.

user Exclusion Criteria

object ( UserSegmentCriteria )

If a user meets this condition, the user is excluded from membership in the segment for the userExclusionDuration .

UserExclusionDuration

Enumerates options for how long an exclusion will last if a user matches the userExclusionCriteria .

Enums
USER_EXCLUSION_DURATION_UNSPECIFIED Unspecified exclusion duration. Do not specify.
USER_EXCLUSION_TEMPORARY Temporarily exclude users from the segment during periods when the user meets the userExclusionCriteria condition.
USER_EXCLUSION_PERMANENT Permanently exclude users from the segment if the user ever meets the userExclusionCriteria condition.

SessionSegment

Session segments are subsets of the sessions that occurred on your site or app: for example, all the sessions that originated from a particular advertising campaign.

نمایندگی JSON 
{
  "sessionInclusionCriteria": {
    object (SessionSegmentCriteria)
  },
  "exclusion": {
    object (SessionSegmentExclusion)
  }
}
فیلدها
session Inclusion Criteria

object ( SessionSegmentCriteria )

Defines which sessions are included in this segment. اختیاری.

exclusion

object ( SessionSegmentExclusion )

Defines which sessions are excluded in this segment. اختیاری.

SessionSegmentCriteria

A session matches a criteria if the session's events meet the conditions in the criteria.

نمایندگی JSON 
{
  "andConditionGroups": [
    {
      object (SessionSegmentConditionGroup)
    }
  ]
}
فیلدها
and Condition Groups[]

object ( SessionSegmentConditionGroup )

A session matches this criteria if the session matches each of these andConditionGroups .

SessionSegmentConditionGroup

Conditions tell Analytics what data to include in or exclude from the segment.

نمایندگی JSON 
{
  "conditionScoping": enum (SessionCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
فیلدها
condition Scoping

enum ( SessionCriteriaScoping )

Data is included or excluded from the segment based on if it matches the condition group. This scoping defines how many events the segmentFilterExpression is evaluated on before the condition group is determined to be matched or not. For example if conditionScoping = SESSION_CRITERIA_WITHIN_SAME_SESSION , the expression is evaluated on all events in a session, and then, the condition group is determined to be matched or not for this session. For example if conditionScoping = SESSION_CRITERIA_WITHIN_SAME_EVENT , the expression is evaluated on a single event, and then, the condition group is determined to be matched or not for this session.

اختیاری. If unspecified, a conditionScoping of WITHIN_SAME_SESSION is used.

segment Filter Expression

object ( SegmentFilterExpression )

Data is included or excluded from the segment based on if it matches this expression. Expressions express criteria on dimension, metrics, and/or parameters.

SessionCriteriaScoping

Scoping specifies which events are considered when evaluating if a session meets a criteria.

Enums
SESSION_CRITERIA_SCOPING_UNSPECIFIED Unspecified criteria scoping. Do not specify.
SESSION_CRITERIA_WITHIN_SAME_EVENT If the criteria is satisfied within one event, the session matches the criteria.
SESSION_CRITERIA_WITHIN_SAME_SESSION If the criteria is satisfied within one session, the session matches the criteria.

SessionSegmentExclusion

Specifies which sessions are excluded in this segment.

نمایندگی JSON 
{
  "sessionExclusionDuration": enum (SessionExclusionDuration),
  "sessionExclusionCriteria": {
    object (SessionSegmentCriteria)
  }
}
فیلدها
session Exclusion Duration

enum ( SessionExclusionDuration )

Specifies how long an exclusion will last if a session matches the sessionExclusionCriteria .

اختیاری. If unspecified, a sessionExclusionDuration of SESSION_EXCLUSION_TEMPORARY is used.

session Exclusion Criteria

object ( SessionSegmentCriteria )

If a session meets this condition, the session is excluded from membership in the segment for the sessionExclusionDuration .

SessionExclusionDuration

Enumerates options for how long an exclusion will last if a session matches the sessionExclusionCriteria .

Enums
SESSION_EXCLUSION_DURATION_UNSPECIFIED Unspecified exclusion duration. Do not specify.
SESSION_EXCLUSION_TEMPORARY Temporarily exclude sessions from the segment during periods when the session meets the sessionExclusionCriteria condition.
SESSION_EXCLUSION_PERMANENT Permanently exclude sessions from the segment if the session ever meets the sessionExclusionCriteria condition.

EventSegment

Event segments are subsets of events that were triggered on your site or app. for example, all purchase events made in a particular location; app_exception events that occurred on a specific operating system.

نمایندگی JSON 
{
  "eventInclusionCriteria": {
    object (EventSegmentCriteria)
  },
  "exclusion": {
    object (EventSegmentExclusion)
  }
}
فیلدها
event Inclusion Criteria

object ( EventSegmentCriteria )

Defines which events are included in this segment. اختیاری.

exclusion

object ( EventSegmentExclusion )

Defines which events are excluded in this segment. اختیاری.

EventSegmentCriteria

An event matches a criteria if the event meet the conditions in the criteria.

نمایندگی JSON 
{
  "andConditionGroups": [
    {
      object (EventSegmentConditionGroup)
    }
  ]
}
فیلدها
and Condition Groups[]

object ( EventSegmentConditionGroup )

An event matches this criteria if the event matches each of these andConditionGroups .

EventSegmentConditionGroup

Conditions tell Analytics what data to include in or exclude from the segment.

نمایندگی JSON 
{
  "conditionScoping": enum (EventCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
فیلدها
condition Scoping

enum ( EventCriteriaScoping )

conditionScoping should always be EVENT_CRITERIA_WITHIN_SAME_EVENT .

اختیاری. If unspecified, a conditionScoping of EVENT_CRITERIA_WITHIN_SAME_EVENT is used.

segment Filter Expression

object ( SegmentFilterExpression )

Data is included or excluded from the segment based on if it matches this expression. Expressions express criteria on dimension, metrics, and/or parameters.

EventCriteriaScoping

Scoping specifies which events are considered when evaluating if an event meets a criteria.

Enums
EVENT_CRITERIA_SCOPING_UNSPECIFIED Unspecified criteria scoping. Do not specify.
EVENT_CRITERIA_WITHIN_SAME_EVENT If the criteria is satisfied within one event, the event matches the criteria.

EventSegmentExclusion

Specifies which events are excluded in this segment.

نمایندگی JSON 
{
  "eventExclusionDuration": enum (EventExclusionDuration),
  "eventExclusionCriteria": {
    object (EventSegmentCriteria)
  }
}
فیلدها
event Exclusion Duration

enum ( EventExclusionDuration )

eventExclusionDuration should always be PERMANENTLY_EXCLUDE .

اختیاری. If unspecified, an eventExclusionDuration of EVENT_EXCLUSION_PERMANENT is used.

event Exclusion Criteria

object ( EventSegmentCriteria )

If an event meets this condition, the event is excluded from membership in the segment for the eventExclusionDuration .

EventExclusionDuration

Enumerates options for how long an exclusion will last if an event matches the eventExclusionCriteria .

Enums
EVENT_EXCLUSION_DURATION_UNSPECIFIED Unspecified exclusion duration. Do not specify.
EVENT_EXCLUSION_PERMANENT Permanently exclude events from the segment if the event ever meets the eventExclusionCriteria condition.

FunnelSubReport

Funnel sub reports contain the dimension and metric data values. For example, 12 users reached the second step of the funnel.

نمایندگی JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "metadata": {
    object (FunnelResponseMetadata)
  }
}
فیلدها
dimension Headers[]

object ( DimensionHeader )

ستون های ابعاد را توصیف می کند. Funnel reports always include the funnel step dimension in sub report responses. Additional dimensions like breakdowns, dates, and next actions may be present in the response if requested.

metric Headers[]

object ( MetricHeader )

ستون های متریک را توصیف می کند. Funnel reports always include active users in sub report responses. The funnel table includes additional metrics like completion rate, abandonments, and abandonments rate.

rows[]

object ( Row )

ردیف هایی از ترکیبات ارزش ابعاد و مقادیر متریک در گزارش.

metadata

object ( FunnelResponseMetadata )

Metadata for the funnel report.

FunnelResponseMetadata

The funnel report's response metadata carries additional information about the funnel report.

نمایندگی JSON 
{
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ]
}
فیلدها
sampling Metadatas[]

object ( SamplingMetadata )

If funnel report results are sampled , this describes what percentage of events were used in this funnel report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

،

Returns a customized funnel report of your Google Analytics event data. The data returned from the API is as a table with columns for the requested dimensions and metrics.

کاوش قیف به شما این امکان را می‌دهد تا مراحلی را که کاربران برای تکمیل یک کار برمی‌دارند تجسم کنید و به سرعت ببینید که در هر مرحله چقدر موفق یا شکست می‌خورند. به عنوان مثال، چگونه مشتریان بالقوه خریدار و سپس خریدار می شوند؟ چگونه خریداران یکباره تبدیل به خریداران تکراری می شوند؟ با این اطلاعات، می توانید سفرهای ناکارآمد یا رها شده مشتریان را بهبود ببخشید. To learn more, see GA4 Funnel Explorations .

This method is introduced at alpha stability with the intention of gathering feedback on syntax and capabilities before entering beta. To give your feedback on this API, complete the Google Analytics Data API Funnel Reporting Feedback .

درخواست HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runFunnelReport

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

پارامترهای مسیر

پارامترها
property

string

اختیاری. یک شناسه دارایی Google Analytics که رویدادهای آن ردیابی می شوند. در مسیر URL و نه بدنه مشخص شده است. برای کسب اطلاعات بیشتر، ببینید شناسه ملک خود را از کجا پیدا کنید . Within a batch request, this property should either be unspecified or consistent with the batch-level property.

مثال: خواص/1234

درخواست بدن

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

نمایندگی JSON 
{
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "funnel": {
    object (Funnel)
  },
  "funnelBreakdown": {
    object (FunnelBreakdown)
  },
  "funnelNextAction": {
    object (FunnelNextAction)
  },
  "funnelVisualizationType": enum (FunnelVisualizationType),
  "segments": [
    {
      object (Segment)
    }
  ],
  "limit": string,
  "dimensionFilter": {
    object (FilterExpression)
  },
  "returnPropertyQuota": boolean
}
فیلدها
date Ranges[]

object ( DateRange )

اختیاری. Date ranges of data to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the event data for the overlapping days is included in the response rows for both date ranges.

funnel

object ( Funnel )

اختیاری. The configuration of this request's funnel. This funnel configuration is required.

funnel Breakdown

object ( FunnelBreakdown )

اختیاری. If specified, this breakdown adds a dimension to the funnel table sub report response. This breakdown dimension expands each funnel step to the unique values of the breakdown dimension. For example, a breakdown by the deviceCategory dimension will create rows for mobile , tablet , desktop , and the total.

funnel Next Action

object ( FunnelNextAction )

اختیاری. If specified, next action adds a dimension to the funnel visualization sub report response. This next action dimension expands each funnel step to the unique values of the next action. For example a next action of the eventName dimension will create rows for several events (for example session_start & click ) and the total.

Next action only supports eventName and most Page / Screen dimensions like pageTitle and pagePath .

funnel Visualization Type

enum ( FunnelVisualizationType )

اختیاری. The funnel visualization type controls the dimensions present in the funnel visualization sub report response. If not specified, STANDARD_FUNNEL is used.

segments[]

object ( Segment )

اختیاری. The configurations of segments. Segments are subsets of a property's data. In a funnel report with segments, the funnel is evaluated in each segment.

Each segment specified in this request produces a separate row in the response; in the response, each segment identified by its name.

The segments parameter is optional. Requests are limited to 4 segments.

limit

string ( int64 format)

اختیاری. تعداد ردیف هایی که باید برگردانده شوند. اگر مشخص نشده باشد، 10000 ردیف برگردانده می شود. API حداکثر 250000 سطر را در هر درخواست برمی گرداند، مهم نیست که چقدر درخواست کنید. limit باید مثبت باشد

API همچنین می‌تواند ردیف‌های کمتری را نسبت به limit درخواستی برگرداند، اگر مقادیر ابعاد به اندازه limit وجود نداشته باشد.

dimension Filter

object ( FilterExpression )

اختیاری. Dimension filters allow you to ask for only specific dimension values in the report. To learn more, see Creating a Report: Dimension Filters for examples. معیارها را نمی توان در این فیلتر استفاده کرد.

return Property Quota

boolean

اختیاری. Toggles whether to return the current state of this Analytics Property's quota. سهمیه در PropertyQuota برگردانده می شود.

بدن پاسخگو

The funnel report response contains two sub reports. The two sub reports are different combinations of dimensions and metrics.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "funnelTable": {
    object (FunnelSubReport)
  },
  "funnelVisualization": {
    object (FunnelSubReport)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string
}
فیلدها
funnel Table

object ( FunnelSubReport )

The funnel table is a report with the funnel step, segment, breakdown dimension, active users, completion rate, abandonments, and abandonments rate.

The segment dimension is only present in this response if a segment was requested. The breakdown dimension is only present in this response if it was requested.

funnel Visualization

object ( FunnelSubReport )

The funnel visualization is a report with the funnel step, segment, date, next action dimension, and active users.

The segment dimension is only present in this response if a segment was requested. The date dimension is only present in this response if it was requested through the TRENDED_FUNNEL funnel type. The next action dimension is only present in the response if it was requested.

property Quota

object ( PropertyQuota )

This Analytics Property's quota state including this request.

kind

string

مشخص می کند که این پیام چه نوع منبعی است. This kind is always the fixed string "analyticsData#runFunnelReport". برای تمایز بین انواع پاسخ در JSON مفید است.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

قیف

Configures the funnel in a funnel report request. A funnel reports on users as they pass through a sequence of steps.

کاوش قیف به شما این امکان را می‌دهد تا مراحلی را که کاربران برای تکمیل یک کار برمی‌دارند تجسم کنید و به سرعت ببینید که در هر مرحله چقدر موفق یا شکست می‌خورند. به عنوان مثال، چگونه مشتریان بالقوه خریدار و سپس خریدار می شوند؟ چگونه خریداران یکباره تبدیل به خریداران تکراری می شوند؟ با این اطلاعات، می توانید سفرهای ناکارآمد یا رها شده مشتریان را بهبود ببخشید.

نمایندگی JSON 
{
  "isOpenFunnel": boolean,
  "steps": [
    {
      object (FunnelStep)
    }
  ]
}
فیلدها
is Open Funnel

boolean

In an open funnel, users can enter the funnel in any step, and in a closed funnel, users must enter the funnel in the first step. اختیاری. If unspecified, a closed funnel is used.

steps[]

object ( FunnelStep )

The sequential steps of this funnel.

FunnelStep

Steps define the user journey you want to measure. Steps contain one or more conditions that your users must meet to be included in that step of the funnel journey.

نمایندگی JSON 
{
  "name": string,
  "isDirectlyFollowedBy": boolean,
  "filterExpression": {
    object (FunnelFilterExpression)
  },
  "withinDurationFromPriorStep": string
}
فیلدها
name

string

The distinctive name for this step. If unspecified, steps will be named by a 1 based indexed name (for example "0. ", "1. ", etc.). This name defines string value returned by the funnelStepName dimension. For example, specifying name = Purchase in the request's third funnel step will produce 3. Purchase in the funnel report response.

is Directly Followed By

boolean

If true, this step must directly follow the previous step. If false, there can be events between the previous step and this step. If unspecified, isDirectlyFollowedBy is treated as false.

filter Expression

object ( FunnelFilterExpression )

The condition that your users must meet to be included in this step of the funnel journey.

within Duration From Prior Step

string ( Duration format)

If specified, this step must complete within this duration of the completion of the prior step. withinDurationFromPriorStep is inclusive of the endpoint at the microsecond granularity. For example a duration of 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1 microsecond.

withinDurationFromPriorStep is optional, and if unspecified, steps may be separated by any time duration.

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

FunnelFilterExpression

Expresses combinations of funnel filters.

نمایندگی JSON 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FunnelFilterExpressionList)
  },
  "orGroup": {
    object (FunnelFilterExpressionList)
  },
  "notExpression": {
    object (FunnelFilterExpression)
  },
  "funnelFieldFilter": {
    object (FunnelFieldFilter)
  },
  "funnelEventFilter": {
    object (FunnelEventFilter)
  }
  // End of list of possible types for union field expr.
}
فیلدها
Union field expr . Specify one type of filter for FunnelFilterExpression . expr can be only one of the following:
and Group

object ( FunnelFilterExpressionList )

The FunnelFilterExpression in andGroup have an AND relationship.

or Group

object ( FunnelFilterExpressionList )

The FunnelFilterExpression in orGroup have an OR relationship.

not Expression

object ( FunnelFilterExpression )

The FunnelFilterExpression is NOT of notExpression .

funnel Field Filter

object ( FunnelFieldFilter )

A funnel filter for a dimension or metric.

funnel Event Filter

object ( FunnelEventFilter )

Creates a filter that matches events of a single event name. If a parameter filter expression is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter.

FunnelFilterExpressionList

A list of funnel filter expressions.

نمایندگی JSON 
{
  "expressions": [
    {
      object (FunnelFilterExpression)
    }
  ]
}
فیلدها
expressions[]

object ( FunnelFilterExpression )

The list of funnel filter expressions.

FunnelFieldFilter

An expression to filter dimension or metric values.

نمایندگی JSON 
{
  "fieldName": string,

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
فیلدها
field Name

string

The dimension name or metric name.

Union field one_filter . Specify one type of filter. one_filter can be only one of the following:
string Filter

object ( StringFilter )

Strings related filter.

in List Filter

object ( InListFilter )

A filter for in list values.

numeric Filter

object ( NumericFilter )

A filter for numeric or date values.

between Filter

object ( BetweenFilter )

A filter for between two values.

FunnelEventFilter

Creates a filter that matches events of a single event name. If a parameter filter expression is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter.

نمایندگی JSON 
{
  "eventName": string,
  "funnelParameterFilterExpression": {
    object (FunnelParameterFilterExpression)
  }
}
فیلدها
event Name

string

This filter matches events of this single event name. Event name is required.

funnel Parameter Filter Expression

object ( FunnelParameterFilterExpression )

If specified, this filter matches events that match both the single event name and the parameter filter expressions.

Inside the parameter filter expression, only parameter filters are available.

FunnelParameterFilterExpression

Expresses combinations of funnel filters on parameters.

نمایندگی JSON 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FunnelParameterFilterExpressionList)
  },
  "orGroup": {
    object (FunnelParameterFilterExpressionList)
  },
  "notExpression": {
    object (FunnelParameterFilterExpression)
  },
  "funnelParameterFilter": {
    object (FunnelParameterFilter)
  }
  // End of list of possible types for union field expr.
}
فیلدها
Union field expr . Specify one type of filter for FunnelParameterFilterExpression . expr can be only one of the following:
and Group

object ( FunnelParameterFilterExpressionList )

The FunnelParameterFilterExpression in andGroup have an AND relationship.

or Group

object ( FunnelParameterFilterExpressionList )

The FunnelParameterFilterExpression in orGroup have an OR relationship.

not Expression

object ( FunnelParameterFilterExpression )

The FunnelParameterFilterExpression is NOT of notExpression .

funnel Parameter Filter

object ( FunnelParameterFilter )

A primitive funnel parameter filter.

FunnelParameterFilterExpressionList

A list of funnel parameter filter expressions.

نمایندگی JSON 
{
  "expressions": [
    {
      object (FunnelParameterFilterExpression)
    }
  ]
}
فیلدها
expressions[]

object ( FunnelParameterFilterExpression )

The list of funnel parameter filter expressions.

FunnelParameterFilter

An expression to filter parameter values in a funnel.

نمایندگی JSON 
{

  // Union field one_parameter can be only one of the following:
  "eventParameterName": string,
  "itemParameterName": string
  // End of list of possible types for union field one_parameter.

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
فیلدها
Union field one_parameter . The field that is being filtered. one_parameter can be only one of the following:
event Parameter Name

string

This filter will be evaluated on the specified event parameter. Event parameters are logged as parameters of the event. Event parameters include fields like "firebase_screen" & "currency".

Event parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used.

item Parameter Name

string

This filter will be evaluated on the specified item parameter. Item parameters are logged as parameters in the item array. Item parameters include fields like "item_name" & "item_category".

Item parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used.

Item parameters are only available in ecommerce events. To learn more about ecommerce events, see the Measure ecommerce guide.

Union field one_filter . Specify one type of filter. one_filter can be only one of the following:
string Filter

object ( StringFilter )

Strings related filter.

in List Filter

object ( InListFilter )

A filter for in list values.

numeric Filter

object ( NumericFilter )

A filter for numeric or date values.

between Filter

object ( BetweenFilter )

A filter for between two values.

FunnelBreakdown

Breakdowns add a dimension to the funnel table sub report response.

نمایندگی JSON 
{
  "breakdownDimension": {
    object (Dimension)
  },
  "limit": string
}
فیلدها
breakdown Dimension

object ( Dimension )

The dimension column added to the funnel table sub report response. The breakdown dimension breaks down each funnel step. A valid breakdownDimension is required if funnelBreakdown is specified.

limit

string ( int64 format)

The maximum number of distinct values of the breakdown dimension to return in the response. A limit of 5 is used if limit is not specified. Limit must exceed zero and cannot exceed 15.

FunnelNextAction

Next actions state the value for a dimension after the user has achieved a step but before the same user has achieved the next step. For example if the nextActionDimension is eventName , then nextActionDimension in the i th funnel step row will return first event after the event that qualified the user into the i th funnel step but before the user achieved the i+1 th funnel step.

نمایندگی JSON 
{
  "nextActionDimension": {
    object (Dimension)
  },
  "limit": string
}
فیلدها
next Action Dimension

object ( Dimension )

The dimension column added to the funnel visualization sub report response. The next action dimension returns the next dimension value of this dimension after the user has attained the i th funnel step.

nextActionDimension currently only supports eventName and most Page / Screen dimensions like pageTitle and pagePath . nextActionDimension cannot be a dimension expression.

limit

string ( int64 format)

The maximum number of distinct values of the breakdown dimension to return in the response. A limit of 5 is used if limit is not specified. Limit must exceed zero and cannot exceed 5.

FunnelVisualizationType

Controls the dimensions present in the funnel visualization sub report response.

Enums
FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED Unspecified type.
STANDARD_FUNNEL A standard (stepped) funnel. The funnel visualization sub report in the response will not contain date.
TRENDED_FUNNEL A trended (line chart) funnel. The funnel visualization sub report in the response will contain the date dimension.

بخش

A segment is a subset of your Analytics data. برای مثال، از کل مجموعه کاربران شما، یک بخش ممکن است کاربران یک کشور یا شهر خاص باشد. Another segment might be users who purchase a particular line of products or who visit a specific part of your site or trigger certain events in your app.

To learn more, see Segment Builder .

نمایندگی JSON 
{
  "name": string,

  // Union field one_segment_scope can be only one of the following:
  "userSegment": {
    object (UserSegment)
  },
  "sessionSegment": {
    object (SessionSegment)
  },
  "eventSegment": {
    object (EventSegment)
  }
  // End of list of possible types for union field one_segment_scope.
}
فیلدها
name

string

The name for this segment. If unspecified, segments are named "Segment". This name defines string value returned by the segment dimension. The segment dimension prefixes segment names by the 1-based index number of the segment in the request (for example "1. Segment", "2. Segment", etc.).

Union field one_segment_scope . A segment is specified in one scope. one_segment_scope can be only one of the following:
user Segment

object ( UserSegment )

User segments are subsets of users who engaged with your site or app.

session Segment

object ( SessionSegment )

Session segments are subsets of the sessions that occurred on your site or app.

event Segment

object ( EventSegment )

Event segments are subsets of events that were triggered on your site or app.

UserSegment

User segments are subsets of users who engaged with your site or app. For example, users who have previously purchased; users who added items to their shopping carts, but didn't complete a purchase.

نمایندگی JSON 
{
  "userInclusionCriteria": {
    object (UserSegmentCriteria)
  },
  "exclusion": {
    object (UserSegmentExclusion)
  }
}
فیلدها
user Inclusion Criteria

object ( UserSegmentCriteria )

Defines which users are included in this segment. اختیاری.

exclusion

object ( UserSegmentExclusion )

Defines which users are excluded in this segment. اختیاری.

UserSegmentCriteria

A user matches a criteria if the user's events meet the conditions in the criteria.

نمایندگی JSON 
{
  "andConditionGroups": [
    {
      object (UserSegmentConditionGroup)
    }
  ],
  "andSequenceGroups": [
    {
      object (UserSegmentSequenceGroup)
    }
  ]
}
فیلدها
and Condition Groups[]

object ( UserSegmentConditionGroup )

A user matches this criteria if the user matches each of these andConditionGroups and each of the andSequenceGroups . andConditionGroups may be empty if andSequenceGroups are specified.

and Sequence Groups[]

object ( UserSegmentSequenceGroup )

A user matches this criteria if the user matches each of these andSequenceGroups and each of the andConditionGroups . andSequenceGroups may be empty if andConditionGroups are specified.

UserSegmentConditionGroup

Conditions tell Analytics what data to include in or exclude from the segment.

نمایندگی JSON 
{
  "conditionScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
فیلدها
condition Scoping

enum ( UserCriteriaScoping )

Data is included or excluded from the segment based on if it matches the condition group. This scoping defines how many events the segmentFilterExpression is evaluated on before the condition group is determined to be matched or not. For example if conditionScoping = USER_CRITERIA_WITHIN_SAME_SESSION , the expression is evaluated on all events in a session, and then, the condition group is determined to be matched or not for this user. For example if conditionScoping = USER_CRITERIA_WITHIN_SAME_EVENT , the expression is evaluated on a single event, and then, the condition group is determined to be matched or not for this user.

اختیاری. If unspecified, conditionScoping = ACROSS_ALL_SESSIONS is used.

segment Filter Expression

object ( SegmentFilterExpression )

Data is included or excluded from the segment based on if it matches this expression. Expressions express criteria on dimension, metrics, and/or parameters.

UserCriteriaScoping

Scoping specifies which events are considered when evaluating if a user meets a criteria.

Enums
USER_CRITERIA_SCOPING_UNSPECIFIED Unspecified criteria scoping. Do not specify.
USER_CRITERIA_WITHIN_SAME_EVENT If the criteria is satisfied within one event, the user matches the criteria.
USER_CRITERIA_WITHIN_SAME_SESSION If the criteria is satisfied within one session, the user matches the criteria.
USER_CRITERIA_ACROSS_ALL_SESSIONS If the criteria is satisfied by any events for the user, the user matches the criteria.

SegmentFilterExpression

Expresses combinations of segment filters.

نمایندگی JSON 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (SegmentFilterExpressionList)
  },
  "orGroup": {
    object (SegmentFilterExpressionList)
  },
  "notExpression": {
    object (SegmentFilterExpression)
  },
  "segmentFilter": {
    object (SegmentFilter)
  },
  "segmentEventFilter": {
    object (SegmentEventFilter)
  }
  // End of list of possible types for union field expr.
}
فیلدها
Union field expr . Specify one type of filter for SegmentFilterExpression . expr can be only one of the following:
and Group

object ( SegmentFilterExpressionList )

The SegmentFilterExpression in andGroup have an AND relationship.

or Group

object ( SegmentFilterExpressionList )

The SegmentFilterExpression in orGroup have an OR relationship.

not Expression

object ( SegmentFilterExpression )

The SegmentFilterExpression is NOT of notExpression .

segment Filter

object ( SegmentFilter )

A primitive segment filter.

segment Event Filter

object ( SegmentEventFilter )

Creates a filter that matches events of a single event name. If a parameter filter expression is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter.

SegmentFilterExpressionList

A list of segment filter expressions.

نمایندگی JSON 
{
  "expressions": [
    {
      object (SegmentFilterExpression)
    }
  ]
}
فیلدها
expressions[]

object ( SegmentFilterExpression )

The list of segment filter expressions

SegmentFilter

An expression to filter dimension or metric values.

نمایندگی JSON 
{
  "fieldName": string,
  "filterScoping": {
    object (SegmentFilterScoping)
  },

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
فیلدها
field Name

string

The dimension name or metric name.

filter Scoping

object ( SegmentFilterScoping )

Specifies the scope for the filter.

Union field one_filter . Specify one type of filter for Filter . one_filter can be only one of the following:
string Filter

object ( StringFilter )

Strings related filter.

in List Filter

object ( InListFilter )

A filter for in list values.

numeric Filter

object ( NumericFilter )

A filter for numeric or date values.

between Filter

object ( BetweenFilter )

A filter for between two values.

SegmentFilterScoping

Scopings specify how the dimensions & metrics of multiple events should be considered when evaluating a segment filter.

نمایندگی JSON 
{
  "atAnyPointInTime": boolean
}
فیلدها
at Any Point In Time

boolean

If atAnyPointInTime is true, this filter evaluates to true for all events if it evaluates to true for any event in the date range of the request.

This atAnyPointInTime parameter does not extend the date range of events in the report. If atAnyPointInTime is true, only events within the report's date range are considered when evaluating this filter.

This atAnyPointInTime is only able to be specified if the criteria scoping is ACROSS_ALL_SESSIONS and is not able to be specified in sequences.

If the criteria scoping is ACROSS_ALL_SESSIONS , atAnyPointInTime = false is used if unspecified.

SegmentEventFilter

Creates a filter that matches events of a single event name. If a parameter filter expression is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter.

نمایندگی JSON 
{
  "eventName": string,
  "segmentParameterFilterExpression": {
    object (SegmentParameterFilterExpression)
  }
}
فیلدها
event Name

string

This filter matches events of this single event name. Event name is required.

segment Parameter Filter Expression

object ( SegmentParameterFilterExpression )

If specified, this filter matches events that match both the single event name and the parameter filter expressions.

Inside the parameter filter expression, only parameter filters are available.

SegmentParameterFilterExpression

Expresses combinations of segment filter on parameters.

نمایندگی JSON 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (SegmentParameterFilterExpressionList)
  },
  "orGroup": {
    object (SegmentParameterFilterExpressionList)
  },
  "notExpression": {
    object (SegmentParameterFilterExpression)
  },
  "segmentParameterFilter": {
    object (SegmentParameterFilter)
  }
  // End of list of possible types for union field expr.
}
فیلدها
Union field expr . Specify one type of filter for SegmentParameterFilterExpression . expr can be only one of the following:
and Group

object ( SegmentParameterFilterExpressionList )

The SegmentParameterFilterExpression in andGroup have an AND relationship.

or Group

object ( SegmentParameterFilterExpressionList )

The SegmentParameterFilterExpression in orGroup have an OR relationship.

not Expression

object ( SegmentParameterFilterExpression )

The SegmentParameterFilterExpression is NOT of notExpression .

segment Parameter Filter

object ( SegmentParameterFilter )

A primitive segment parameter filter.

SegmentParameterFilterExpressionList

A list of segment parameter filter expressions.

نمایندگی JSON 
{
  "expressions": [
    {
      object (SegmentParameterFilterExpression)
    }
  ]
}
فیلدها
expressions[]

object ( SegmentParameterFilterExpression )

The list of segment parameter filter expressions.

SegmentParameterFilter

An expression to filter parameter values in a segment.

نمایندگی JSON 
{
  "filterScoping": {
    object (SegmentParameterFilterScoping)
  },

  // Union field one_parameter can be only one of the following:
  "eventParameterName": string,
  "itemParameterName": string
  // End of list of possible types for union field one_parameter.

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
فیلدها
filter Scoping

object ( SegmentParameterFilterScoping )

Specifies the scope for the filter.

Union field one_parameter . The field that is being filtered. one_parameter can be only one of the following:
event Parameter Name

string

This filter will be evaluated on the specified event parameter. Event parameters are logged as parameters of the event. Event parameters include fields like "firebase_screen" & "currency".

Event parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used.

item Parameter Name

string

This filter will be evaluated on the specified item parameter. Item parameters are logged as parameters in the item array. Item parameters include fields like "item_name" & "item_category".

Item parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used.

Item parameters are only available in ecommerce events. To learn more about ecommerce events, see the Measure ecommerce guide.

Union field one_filter . Specify one type of filter. one_filter can be only one of the following:
string Filter

object ( StringFilter )

Strings related filter.

in List Filter

object ( InListFilter )

A filter for in list values.

numeric Filter

object ( NumericFilter )

A filter for numeric or date values.

between Filter

object ( BetweenFilter )

A filter for between two values.

SegmentParameterFilterScoping

Scopings specify how multiple events should be considered when evaluating a segment parameter filter.

نمایندگی JSON 
{
  "inAnyNDayPeriod": string
}
فیلدها
in Any N Day Period

string ( int64 format)

Accumulates the parameter over the specified period of days before applying the filter. Only supported if criteria scoping is ACROSS_ALL_SESSIONS or WITHIN_SAME_SESSION . Only supported if the parameter is event_count .

For example if inAnyNDayPeriod is 3, the eventName is "purchase", the event parameter is "event_count", and the Filter's criteria is greater than 5, this filter will accumulate the event count of purchase events over every 3 consecutive day period in the report's date range; a user will pass this Filter's criteria to be included in this segment if their count of purchase events exceeds 5 in any 3 consecutive day period. For example, the periods 2021-11-01 to 2021-11-03, 2021-11-02 to 2021-11-04, 2021-11-03 to 2021-11-05, and etc. will be considered.

The date range is not extended for the purpose of having a full N day window near the start of the date range. For example if a report is for 2021-11-01 to 2021-11-10 and inAnyNDayPeriod = 3, the first two day period will be effectively shortened because no event data outside the report's date range will be read. For example, the first four periods will effectively be: 2021-11-01 to 2021-11-01, 2021-11-01 to 2021-11-02, 2021-11-01 to 2021-11-03, and 2021-11-02 to 2021-11-04.

inAnyNDayPeriod is optional. If not specified, the segmentParameterFilter is applied to each event individually.

UserSegmentSequenceGroup

Define conditions that must occur in a specific order for the user to be a member of the segment.

نمایندگی JSON 
{
  "sequenceScoping": enum (UserCriteriaScoping),
  "sequenceMaximumDuration": string,
  "userSequenceSteps": [
    {
      object (UserSequenceStep)
    }
  ]
}
فیلدها
sequence Scoping

enum ( UserCriteriaScoping )

All sequence steps must be satisfied in the scoping for the user to match the sequence. For example if sequenceScoping = USER_CRITERIA_WITHIN_SAME_SESSION , all sequence steps must complete within one session for the user to match the sequence. sequenceScoping = USER_CRITERIA_WITHIN_SAME_EVENT is not supported.

اختیاری. If unspecified, conditionScoping = ACROSS_ALL_SESSIONS is used.

sequence Maximum Duration

string ( Duration format)

Defines the time period in which the whole sequence must occur; for example, 30 Minutes. sequenceMaximumDuration is inclusive of the endpoint at the microsecond granularity. For example a sequence with a maximum duration of 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1 microsecond.

sequenceMaximumDuration is optional, and if unspecified, sequences can be completed in any time duration.

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

user Sequence Steps[]

object ( UserSequenceStep )

An ordered sequence of condition steps. A user's events must complete each step in order for the user to match the UserSegmentSequenceGroup .

UserSequenceStep

A condition that must occur in the specified step order for this user to match the sequence.

نمایندگی JSON 
{
  "isDirectlyFollowedBy": boolean,
  "stepScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
فیلدها
is Directly Followed By

boolean

If true, the event satisfying this step must be the very next event after the event satifying the last step. If false, this step indirectly follows the prior step; for example, there may be events between the prior step and this step. isDirectlyFollowedBy must be false for the first step.

step Scoping

enum ( UserCriteriaScoping )

This sequence step must be satisfied in the scoping for the user to match the sequence. For example if sequenceScoping = WITHIN_SAME_SESSION , this sequence steps must complete within one session for the user to match the sequence. stepScoping = ACROSS_ALL_SESSIONS is only allowed if the sequenceScoping = ACROSS_ALL_SESSIONS .

اختیاری. If unspecified, stepScoping uses the same UserCriteriaScoping as the sequenceScoping .

segment Filter Expression

object ( SegmentFilterExpression )

A user matches this sequence step if their events match this expression. Expressions express criteria on dimension, metrics, and/or parameters.

UserSegmentExclusion

Specifies which users are excluded in this segment.

نمایندگی JSON 
{
  "userExclusionDuration": enum (UserExclusionDuration),
  "userExclusionCriteria": {
    object (UserSegmentCriteria)
  }
}
فیلدها
user Exclusion Duration

enum ( UserExclusionDuration )

Specifies how long an exclusion will last if a user matches the userExclusionCriteria .

اختیاری. If unspecified, userExclusionDuration of USER_EXCLUSION_TEMPORARY is used.

user Exclusion Criteria

object ( UserSegmentCriteria )

If a user meets this condition, the user is excluded from membership in the segment for the userExclusionDuration .

UserExclusionDuration

Enumerates options for how long an exclusion will last if a user matches the userExclusionCriteria .

Enums
USER_EXCLUSION_DURATION_UNSPECIFIED Unspecified exclusion duration. Do not specify.
USER_EXCLUSION_TEMPORARY Temporarily exclude users from the segment during periods when the user meets the userExclusionCriteria condition.
USER_EXCLUSION_PERMANENT Permanently exclude users from the segment if the user ever meets the userExclusionCriteria condition.

SessionSegment

Session segments are subsets of the sessions that occurred on your site or app: for example, all the sessions that originated from a particular advertising campaign.

نمایندگی JSON 
{
  "sessionInclusionCriteria": {
    object (SessionSegmentCriteria)
  },
  "exclusion": {
    object (SessionSegmentExclusion)
  }
}
فیلدها
session Inclusion Criteria

object ( SessionSegmentCriteria )

Defines which sessions are included in this segment. اختیاری.

exclusion

object ( SessionSegmentExclusion )

Defines which sessions are excluded in this segment. اختیاری.

SessionSegmentCriteria

A session matches a criteria if the session's events meet the conditions in the criteria.

نمایندگی JSON 
{
  "andConditionGroups": [
    {
      object (SessionSegmentConditionGroup)
    }
  ]
}
فیلدها
and Condition Groups[]

object ( SessionSegmentConditionGroup )

A session matches this criteria if the session matches each of these andConditionGroups .

SessionSegmentConditionGroup

Conditions tell Analytics what data to include in or exclude from the segment.

نمایندگی JSON 
{
  "conditionScoping": enum (SessionCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
فیلدها
condition Scoping

enum ( SessionCriteriaScoping )

Data is included or excluded from the segment based on if it matches the condition group. This scoping defines how many events the segmentFilterExpression is evaluated on before the condition group is determined to be matched or not. For example if conditionScoping = SESSION_CRITERIA_WITHIN_SAME_SESSION , the expression is evaluated on all events in a session, and then, the condition group is determined to be matched or not for this session. For example if conditionScoping = SESSION_CRITERIA_WITHIN_SAME_EVENT , the expression is evaluated on a single event, and then, the condition group is determined to be matched or not for this session.

اختیاری. If unspecified, a conditionScoping of WITHIN_SAME_SESSION is used.

segment Filter Expression

object ( SegmentFilterExpression )

Data is included or excluded from the segment based on if it matches this expression. Expressions express criteria on dimension, metrics, and/or parameters.

SessionCriteriaScoping

Scoping specifies which events are considered when evaluating if a session meets a criteria.

Enums
SESSION_CRITERIA_SCOPING_UNSPECIFIED Unspecified criteria scoping. Do not specify.
SESSION_CRITERIA_WITHIN_SAME_EVENT If the criteria is satisfied within one event, the session matches the criteria.
SESSION_CRITERIA_WITHIN_SAME_SESSION If the criteria is satisfied within one session, the session matches the criteria.

SessionSegmentExclusion

Specifies which sessions are excluded in this segment.

نمایندگی JSON 
{
  "sessionExclusionDuration": enum (SessionExclusionDuration),
  "sessionExclusionCriteria": {
    object (SessionSegmentCriteria)
  }
}
فیلدها
session Exclusion Duration

enum ( SessionExclusionDuration )

Specifies how long an exclusion will last if a session matches the sessionExclusionCriteria .

اختیاری. If unspecified, a sessionExclusionDuration of SESSION_EXCLUSION_TEMPORARY is used.

session Exclusion Criteria

object ( SessionSegmentCriteria )

If a session meets this condition, the session is excluded from membership in the segment for the sessionExclusionDuration .

SessionExclusionDuration

Enumerates options for how long an exclusion will last if a session matches the sessionExclusionCriteria .

Enums
SESSION_EXCLUSION_DURATION_UNSPECIFIED Unspecified exclusion duration. Do not specify.
SESSION_EXCLUSION_TEMPORARY Temporarily exclude sessions from the segment during periods when the session meets the sessionExclusionCriteria condition.
SESSION_EXCLUSION_PERMANENT Permanently exclude sessions from the segment if the session ever meets the sessionExclusionCriteria condition.

EventSegment

Event segments are subsets of events that were triggered on your site or app. for example, all purchase events made in a particular location; app_exception events that occurred on a specific operating system.

نمایندگی JSON 
{
  "eventInclusionCriteria": {
    object (EventSegmentCriteria)
  },
  "exclusion": {
    object (EventSegmentExclusion)
  }
}
فیلدها
event Inclusion Criteria

object ( EventSegmentCriteria )

Defines which events are included in this segment. اختیاری.

exclusion

object ( EventSegmentExclusion )

Defines which events are excluded in this segment. اختیاری.

EventSegmentCriteria

An event matches a criteria if the event meet the conditions in the criteria.

نمایندگی JSON 
{
  "andConditionGroups": [
    {
      object (EventSegmentConditionGroup)
    }
  ]
}
فیلدها
and Condition Groups[]

object ( EventSegmentConditionGroup )

An event matches this criteria if the event matches each of these andConditionGroups .

EventSegmentConditionGroup

Conditions tell Analytics what data to include in or exclude from the segment.

نمایندگی JSON 
{
  "conditionScoping": enum (EventCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
فیلدها
condition Scoping

enum ( EventCriteriaScoping )

conditionScoping should always be EVENT_CRITERIA_WITHIN_SAME_EVENT .

اختیاری. If unspecified, a conditionScoping of EVENT_CRITERIA_WITHIN_SAME_EVENT is used.

segment Filter Expression

object ( SegmentFilterExpression )

Data is included or excluded from the segment based on if it matches this expression. Expressions express criteria on dimension, metrics, and/or parameters.

EventCriteriaScoping

Scoping specifies which events are considered when evaluating if an event meets a criteria.

Enums
EVENT_CRITERIA_SCOPING_UNSPECIFIED Unspecified criteria scoping. Do not specify.
EVENT_CRITERIA_WITHIN_SAME_EVENT If the criteria is satisfied within one event, the event matches the criteria.

EventSegmentExclusion

Specifies which events are excluded in this segment.

نمایندگی JSON 
{
  "eventExclusionDuration": enum (EventExclusionDuration),
  "eventExclusionCriteria": {
    object (EventSegmentCriteria)
  }
}
فیلدها
event Exclusion Duration

enum ( EventExclusionDuration )

eventExclusionDuration should always be PERMANENTLY_EXCLUDE .

اختیاری. If unspecified, an eventExclusionDuration of EVENT_EXCLUSION_PERMANENT is used.

event Exclusion Criteria

object ( EventSegmentCriteria )

If an event meets this condition, the event is excluded from membership in the segment for the eventExclusionDuration .

EventExclusionDuration

Enumerates options for how long an exclusion will last if an event matches the eventExclusionCriteria .

Enums
EVENT_EXCLUSION_DURATION_UNSPECIFIED Unspecified exclusion duration. Do not specify.
EVENT_EXCLUSION_PERMANENT Permanently exclude events from the segment if the event ever meets the eventExclusionCriteria condition.

FunnelSubReport

Funnel sub reports contain the dimension and metric data values. For example, 12 users reached the second step of the funnel.

نمایندگی JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "metadata": {
    object (FunnelResponseMetadata)
  }
}
فیلدها
dimension Headers[]

object ( DimensionHeader )

ستون های ابعاد را توصیف می کند. Funnel reports always include the funnel step dimension in sub report responses. Additional dimensions like breakdowns, dates, and next actions may be present in the response if requested.

metric Headers[]

object ( MetricHeader )

ستون های متریک را توصیف می کند. Funnel reports always include active users in sub report responses. The funnel table includes additional metrics like completion rate, abandonments, and abandonments rate.

rows[]

object ( Row )

ردیف هایی از ترکیبات ارزش ابعاد و مقادیر متریک در گزارش.

metadata

object ( FunnelResponseMetadata )

Metadata for the funnel report.

FunnelResponseMetadata

The funnel report's response metadata carries additional information about the funnel report.

نمایندگی JSON 
{
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ]
}
فیلدها
sampling Metadatas[]

object ( SamplingMetadata )

If funnel report results are sampled , this describes what percentage of events were used in this funnel report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.