Method: properties.runFunnelReport

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

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

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

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
property

string

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

مثال: ویژگی‌ها/۱۲۳۴

درخواست بدنه

بدنه درخواست شامل داده‌هایی با ساختار زیر است:

نمایش 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
}
فیلدها
dateRanges[]

object ( DateRange )

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

funnel

object ( Funnel )

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

funnelBreakdown

object ( FunnelBreakdown )

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

funnelNextAction

object ( FunnelNextAction )

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

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

funnelVisualizationType

enum ( FunnelVisualizationType )

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

segments[]

object ( Segment )

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

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

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

limit

string ( int64 format)

اختیاری. تعداد ردیف‌هایی که باید برگردانده شوند. اگر مشخص نشود، ۱۰۰۰۰ ردیف برگردانده می‌شود. API حداکثر ۲۵۰۰۰۰ ردیف را در هر درخواست برمی‌گرداند، مهم نیست چند ردیف درخواست کنید. limit باید مثبت باشد.

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

dimensionFilter

object ( FilterExpression )

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

returnPropertyQuota

boolean

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

بدنه پاسخ

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

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

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

object ( FunnelSubReport )

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

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

funnelVisualization

object ( FunnelSubReport )

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

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

propertyQuota

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)
    }
  ]
}
فیلدها
isOpenFunnel

boolean

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

steps[]

object ( FunnelStep )

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

قیف مرحله‌ای

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

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

string

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

isDirectlyFollowedBy

boolean

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

filterExpression

object ( FunnelFilterExpression )

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

withinDurationFromPriorStep

string ( Duration format)

در صورت مشخص شدن، این مرحله باید در این مدت زمان از تکمیل مرحله قبلی تکمیل شود. withinDurationFromPriorStep شامل نقطه پایانی در دانه‌بندی میکروثانیه است. برای مثال، مدت زمان ۵ ثانیه می‌تواند در ۴.۹ یا ۵.۰ ثانیه تکمیل شود، اما ۵ ثانیه و ۱ میکروثانیه نمی‌تواند.

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

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

عبارت FunnelFilter

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

نمایش JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "andGroup": {
    object (FunnelFilterExpressionList)
  },
  "orGroup": {
    object (FunnelFilterExpressionList)
  },
  "notExpression": {
    object (FunnelFilterExpression)
  },
  "funnelFieldFilter": {
    object (FunnelFieldFilter)
  },
  "funnelEventFilter": {
    object (FunnelEventFilter)
  }
  // End of mutually exclusive fields.
}
فیلدها
یک نوع فیلتر برای FunnelFilterExpression مشخص کنید. در زیر لیستی از فیلدهای ناسازگار آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
andGroup

object ( FunnelFilterExpressionList )

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

orGroup

object ( FunnelFilterExpressionList )

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

notExpression

object ( FunnelFilterExpression )

FunnelFilterExpression از notExpression نیست.

funnelFieldFilter

object ( FunnelFieldFilter )

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

funnelEventFilter

object ( FunnelEventFilter )

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

پایان میدان‌های ناسازگار.

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

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

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

object ( FunnelFilterExpression )

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

فیلتر قیفی

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

نمایش JSON 
{
  "fieldName": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of mutually exclusive fields.
}
فیلدها
fieldName

string

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

یک نوع فیلتر را مشخص کنید. در زیر لیستی از فیلدهای ناسازگار آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
stringFilter

object ( StringFilter )

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

inListFilter

object ( InListFilter )

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

numericFilter

object ( NumericFilter )

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

betweenFilter

object ( BetweenFilter )

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

پایان میدان‌های ناسازگار.

فیلتر رویداد قیفی

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

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

string

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

funnelParameterFilterExpression

object ( FunnelParameterFilterExpression )

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

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

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

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

نمایش JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "andGroup": {
    object (FunnelParameterFilterExpressionList)
  },
  "orGroup": {
    object (FunnelParameterFilterExpressionList)
  },
  "notExpression": {
    object (FunnelParameterFilterExpression)
  },
  "funnelParameterFilter": {
    object (FunnelParameterFilter)
  }
  // End of mutually exclusive fields.
}
فیلدها
یک نوع فیلتر برای FunnelParameterFilterExpression مشخص کنید. در زیر لیستی از فیلدهای ناسازگار آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
andGroup

object ( FunnelParameterFilterExpressionList )

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

orGroup

object ( FunnelParameterFilterExpressionList )

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

notExpression

object ( FunnelParameterFilterExpression )

FunnelParameterFilterExpression از نوع notExpression نیست.

funnelParameterFilter

object ( FunnelParameterFilter )

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

پایان میدان‌های ناسازگار.

FunnelParameterFilterExpressionList

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

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

object ( FunnelParameterFilterExpression )

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

فیلتر پارامتر قیفی

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

نمایش JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "eventParameterName": string,
  "itemParameterName": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of mutually exclusive fields.
}
فیلدها
فیلدی که فیلتر می‌شود. در زیر لیستی از فیلدهای ناسازگار آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
eventParameterName

string

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

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

itemParameterName

string

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

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

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

پایان میدان‌های ناسازگار.
یک نوع فیلتر را مشخص کنید. در زیر لیستی از فیلدهای ناسازگار آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
stringFilter

object ( StringFilter )

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

inListFilter

object ( InListFilter )

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

numericFilter

object ( NumericFilter )

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

betweenFilter

object ( BetweenFilter )

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

پایان میدان‌های ناسازگار.

خرابی قیف

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

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

object ( Dimension )

ستون بُعد (dimension) که به جدول قیف (funnel) اضافه شده و پاسخ را گزارش می‌دهد. بُعد تجزیه (breakdown dimension) هر مرحله از قیف را تجزیه و تحلیل می‌کند. در صورت مشخص شدن funnelBreakdown یک breakdownDimension معتبر مورد نیاز است.

limit

string ( int64 format)

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

FunnelNextAction

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

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

object ( Dimension )

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

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

limit

string ( int64 format)

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

نوع تجسم قیفی

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

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

بخش

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

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

نمایش JSON 
{
  "name": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "userSegment": {
    object (UserSegment)
  },
  "sessionSegment": {
    object (SessionSegment)
  },
  "eventSegment": {
    object (EventSegment)
  }
  // End of mutually exclusive fields.
}
فیلدها
name

string

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

یک بخش در یک محدوده مشخص شده است. در زیر لیستی از فیلدهای ناسازگار آمده است. حداکثر یکی از فیلدها در یک پاسخ تنظیم خواهد شد:
userSegment

object ( UserSegment )

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

sessionSegment

object ( SessionSegment )

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

eventSegment

object ( EventSegment )

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

پایان میدان‌های ناسازگار.

بخش کاربری

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

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

object ( UserSegmentCriteria )

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

exclusion

object ( UserSegmentExclusion )

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

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

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

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

object ( UserSegmentConditionGroup )

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

andSequenceGroups[]

object ( UserSegmentSequenceGroup )

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

گروه وضعیت بخش کاربر

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

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

enum ( UserCriteriaScoping )

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

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

segmentFilterExpression

object ( SegmentFilterExpression )

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

معیارهای کاربر

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

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

عبارت فیلتر قطعه‌ای

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

نمایش JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "andGroup": {
    object (SegmentFilterExpressionList)
  },
  "orGroup": {
    object (SegmentFilterExpressionList)
  },
  "notExpression": {
    object (SegmentFilterExpression)
  },
  "segmentFilter": {
    object (SegmentFilter)
  },
  "segmentEventFilter": {
    object (SegmentEventFilter)
  }
  // End of mutually exclusive fields.
}
فیلدها
یک نوع فیلتر برای SegmentFilterExpression مشخص کنید. در زیر لیستی از فیلدهای ناسازگار آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
andGroup

object ( SegmentFilterExpressionList )

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

orGroup

object ( SegmentFilterExpressionList )

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

notExpression

object ( SegmentFilterExpression )

عبارت SegmentFilterExpression از نوع notExpression نیست.

segmentFilter

object ( SegmentFilter )

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

segmentEventFilter

object ( SegmentEventFilter )

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

پایان میدان‌های ناسازگار.

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

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

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

object ( SegmentFilterExpression )

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

فیلتر قطعه‌ای

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of mutually exclusive fields.
}
فیلدها
fieldName

string

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

filterScoping

object ( SegmentFilterScoping )

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

یک نوع فیلتر برای Filter مشخص کنید. در زیر لیستی از فیلدهای ناسازگار آمده است. حداکثر یکی از فیلدها در یک پاسخ تنظیم خواهد شد:
stringFilter

object ( StringFilter )

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

inListFilter

object ( InListFilter )

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

numericFilter

object ( NumericFilter )

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

betweenFilter

object ( BetweenFilter )

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

پایان میدان‌های ناسازگار.

محدوده‌بندی فیلتر قطعه‌ای

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

نمایش JSON 
{
  "atAnyPointInTime": boolean
}
فیلدها
atAnyPointInTime

boolean

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

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

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

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

فیلتر رویداد قطعه

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

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

string

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

segmentParameterFilterExpression

object ( SegmentParameterFilterExpression )

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

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

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

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

نمایش JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "andGroup": {
    object (SegmentParameterFilterExpressionList)
  },
  "orGroup": {
    object (SegmentParameterFilterExpressionList)
  },
  "notExpression": {
    object (SegmentParameterFilterExpression)
  },
  "segmentParameterFilter": {
    object (SegmentParameterFilter)
  }
  // End of mutually exclusive fields.
}
فیلدها
یک نوع فیلتر برای SegmentParameterFilterExpression مشخص کنید. در زیر لیستی از فیلدهای ناسازگار آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
andGroup

object ( SegmentParameterFilterExpressionList )

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

orGroup

object ( SegmentParameterFilterExpressionList )

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

notExpression

object ( SegmentParameterFilterExpression )

عبارت SegmentParameterFilterExpression از نوع notExpression نیست.

segmentParameterFilter

object ( SegmentParameterFilter )

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

پایان میدان‌های ناسازگار.

فیلتر پارامتر سگمنت

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

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

object ( SegmentParameterFilterExpression )

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

فیلتر پارامتر قطعه

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "eventParameterName": string,
  "itemParameterName": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of mutually exclusive fields.
}
فیلدها
filterScoping

object ( SegmentParameterFilterScoping )

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

فیلدی که فیلتر می‌شود. در زیر لیستی از فیلدهای ناسازگار آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
eventParameterName

string

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

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

itemParameterName

string

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

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

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

پایان میدان‌های ناسازگار.
یک نوع فیلتر را مشخص کنید. در زیر لیستی از فیلدهای ناسازگار آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
stringFilter

object ( StringFilter )

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

inListFilter

object ( InListFilter )

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

numericFilter

object ( NumericFilter )

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

betweenFilter

object ( BetweenFilter )

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

پایان میدان‌های ناسازگار.

فیلتر پارامتر قطعه‌ای

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

نمایش JSON 
{
  "inAnyNDayPeriod": string
}
فیلدها
inAnyNDayPeriod

string ( int64 format)

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

برای مثال، اگر inAnyNDayPeriod برابر با ۳، eventName برابر با "purchase"، پارامتر رویداد برابر با "event_count" و معیار فیلتر بزرگتر از ۵ باشد، این فیلتر تعداد رویدادهای خرید را در هر ۳ دوره روزانه متوالی در محدوده تاریخ گزارش جمع می‌کند؛ اگر تعداد رویدادهای خرید یک کاربر در هر ۳ دوره روزانه متوالی از ۵ بیشتر شود، معیارهای این فیلتر را برای قرار گرفتن در این بخش رعایت خواهد کرد. برای مثال، دوره‌های ۲۰۲۱-۱۱-۰۱ تا ۲۰۲۱-۱۱-۰۳، ۲۰۲۱-۱۱-۰۲ تا ۲۰۲۱-۱۱-۰۴، ۲۰۲۱-۱۱-۰۳ تا ۲۰۲۱-۱۱-۰۵ و غیره در نظر گرفته خواهند شد.

محدوده تاریخ به منظور داشتن یک پنجره کامل 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)
    }
  ]
}
فیلدها
sequenceScoping

enum ( UserCriteriaScoping )

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

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

sequenceMaximumDuration

string ( Duration format)

دوره زمانی که کل دنباله باید در آن رخ دهد را تعریف می‌کند؛ برای مثال، ۳۰ دقیقه. sequenceMaximumDuration شامل نقطه پایانی در دانه‌بندی میکروثانیه است. برای مثال، یک دنباله با حداکثر مدت زمان ۵ ثانیه می‌تواند در ۴.۹ یا ۵.۰ ثانیه تکمیل شود، اما نمی‌تواند ۵ ثانیه و ۱ میکروثانیه باشد.

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

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

userSequenceSteps[]

object ( UserSequenceStep )

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

مرحله توالی کاربر

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

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

boolean

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

stepScoping

enum ( UserCriteriaScoping )

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

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

segmentFilterExpression

object ( SegmentFilterExpression )

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

حذف بخش کاربری

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

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

enum ( UserExclusionDuration )

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

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

userExclusionCriteria

object ( UserSegmentCriteria )

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

مدت زمان حذف کاربر

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

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

بخش جلسه

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

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

object ( SessionSegmentCriteria )

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

exclusion

object ( SessionSegmentExclusion )

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

معیارهای بخش جلسه

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

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

object ( SessionSegmentConditionGroup )

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

گروه وضعیت بخش جلسه

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

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

enum ( SessionCriteriaScoping )

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

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

segmentFilterExpression

object ( SegmentFilterExpression )

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

معیارهای جلسه (SessionCriteriaScoping)

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

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

استثنای بخش جلسه

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

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

enum ( SessionExclusionDuration )

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

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

sessionExclusionCriteria

object ( SessionSegmentCriteria )

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

مدت زمان حذف جلسه

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

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

بخش رویداد

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

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

object ( EventSegmentCriteria )

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

exclusion

object ( EventSegmentExclusion )

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

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

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

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

object ( EventSegmentConditionGroup )

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

رویدادبخششرایطگروه

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

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

enum ( EventCriteriaScoping )

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

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

segmentFilterExpression

object ( SegmentFilterExpression )

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

معیارهای رویداد (EventCriteriaScoping)

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

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

استثنای بخش رویداد

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

JSON representation 
{
  "eventExclusionDuration": enum (EventExclusionDuration),
  "eventExclusionCriteria": {
    object (EventSegmentCriteria)
  }
}
فیلدها
eventExclusionDuration

enum ( EventExclusionDuration )

eventExclusionDuration should always be PERMANENTLY_EXCLUDE .

Optional. If unspecified, an eventExclusionDuration of EVENT_EXCLUSION_PERMANENT is used.

eventExclusionCriteria

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 representation 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "metadata": {
    object (FunnelResponseMetadata)
  }
}
فیلدها
dimensionHeaders[]

object ( DimensionHeader )

Describes dimension columns. 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.

metricHeaders[]

object ( MetricHeader )

Describes metric columns. 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 )

Rows of dimension value combinations and metric values in the report.

metadata

object ( FunnelResponseMetadata )

Metadata for the funnel report.

FunnelResponseMetadata

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

JSON representation 
{
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ]
}
فیلدها
samplingMetadatas[]

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.