REST Resource: properties.audiences

منبع: مخاطبان

یک پیام منبع که نمایانگر یک مخاطب است.

نمایش JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "membershipDurationDays": integer,
  "adsPersonalizationEnabled": boolean,
  "eventTrigger": {
    object (AudienceEventTrigger)
  },
  "exclusionDurationMode": enum (AudienceExclusionDurationMode),
  "filterClauses": [
    {
      object (AudienceFilterClause)
    }
  ],
  "createTime": string
}
فیلدها
name

string

فقط خروجی. نام منبع برای این منبع مخاطب. قالب: properties/{propertyId}/audiences/{audienceId}

displayName

string

الزامی. نام نمایشی مخاطب.

description

string

الزامی. شرح مخاطب.

membershipDurationDays

integer

الزامی. تغییرناپذیر. مدت زمانی که یک کاربر باید در یک مخاطب بماند. نمی‌تواند بیش از ۵۴۰ روز تنظیم شود.

adsPersonalizationEnabled

boolean

فقط خروجی. اگر این مخاطب NPA باشد و از شخصی‌سازی تبلیغات حذف شود، به‌طور خودکار توسط GA روی false تنظیم می‌شود.

eventTrigger

object ( AudienceEventTrigger )

اختیاری. رویدادی را مشخص می‌کند که هنگام پیوستن کاربر به مخاطب ثبت می‌شود. اگر تنظیم نشود، هنگام پیوستن کاربر به مخاطب، هیچ رویدادی ثبت نمی‌شود.

exclusionDurationMode

enum ( AudienceExclusionDurationMode )

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

filterClauses[]

object ( AudienceFilterClause )

الزامی. تغییرناپذیر. لیست نامرتب. بندهای فیلتر که مخاطب را تعریف می‌کنند. همه بندها با هم AND می‌شوند.

createTime

string ( Timestamp format)

فقط خروجی. زمان ایجاد مخاطب.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

محرک رویداد مخاطب

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

نمایش JSON 
{
  "eventName": string,
  "logCondition": enum (LogCondition)
}
فیلدها
eventName

string

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

logCondition

enum ( LogCondition )

الزامی. چه زمانی رویداد ثبت شود.

وضعیت گزارش

زمان ثبت رویداد را تعیین می‌کند.

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

حالت مدت زمان حذف مخاطب

مشخص می‌کند که یک استثنا برای کاربرانی که شرایط فیلتر استثنا را دارند، چه مدت ادامه دارد.

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

بند فیلتر مخاطب

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

نمایش JSON 
{
  "clauseType": enum (AudienceClauseType),

  // Union field filter can be only one of the following:
  "simpleFilter": {
    object (AudienceSimpleFilter)
  },
  "sequenceFilter": {
    object (AudienceSequenceFilter)
  }
  // End of list of possible types for union field filter.
}
فیلدها
clauseType

enum ( AudienceClauseType )

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

filter فیلد یونیون.

filter فقط می‌تواند یکی از موارد زیر باشد:

simpleFilter

object ( AudienceSimpleFilter )

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

sequenceFilter

object ( AudienceSequenceFilter )

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

فیلتر ساده مخاطب

یک فیلتر ساده تعریف می‌کند که کاربر برای عضویت در مخاطب باید آن را برآورده کند.

نمایش JSON 
{
  "scope": enum (AudienceFilterScope),
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
فیلدها
scope

enum ( AudienceFilterScope )

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

filterExpression

object ( AudienceFilterExpression )

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

فیلتر مخاطبان

نحوه ارزیابی کاربران برای پیوستن به یک مخاطب را مشخص می‌کند.

انوم‌ها
AUDIENCE_FILTER_SCOPE_UNSPECIFIED محدوده مشخص نشده است.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT اگر شرط فیلتر در یک رویداد برآورده شود، کاربر به مخاطبان می‌پیوندد.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION اگر شرط فیلتر در یک جلسه برآورده شود، کاربر به مخاطبان می‌پیوندد.
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS اگر شرط فیلتر توسط هر رویدادی در هر جلسه‌ای برآورده شود، کاربر به مخاطب می‌پیوندد.

عبارت فیلتر مخاطب

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

نمایش JSON 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (AudienceFilterExpressionList)
  },
  "orGroup": {
    object (AudienceFilterExpressionList)
  },
  "notExpression": {
    object (AudienceFilterExpression)
  },
  "dimensionOrMetricFilter": {
    object (AudienceDimensionOrMetricFilter)
  },
  "eventFilter": {
    object (AudienceEventFilter)
  }
  // End of list of possible types for union field expr.
}
فیلدها
فیلد اتحادیه expr . عبارتی که برای یک فیلتر اعمال می‌شود. expr فقط می‌تواند یکی از موارد زیر باشد:
andGroup

object ( AudienceFilterExpressionList )

فهرستی از عبارات که باید با هم AND شوند. این فهرست فقط می‌تواند شامل AudienceFilterExpressions به همراه orGroup باشد. این باید برای AudienceFilterExpression سطح بالا تنظیم شود.

orGroup

object ( AudienceFilterExpressionList )

فهرستی از عبارات که باید با هم OR شوند. این فهرست نمی‌تواند شامل AudienceFilterExpressions به همراه andGroup یا orGroup باشد.

notExpression

object ( AudienceFilterExpression )

یک عبارت فیلتر که نباید تغییر کند (مثلاً معکوس، مکمل). این عبارت فقط می‌تواند شامل یک dimensionOrMetricFilter باشد. این عبارت را نمی‌توان در AudienceFilterExpression سطح بالا تنظیم کرد.

dimensionOrMetricFilter

object ( AudienceDimensionOrMetricFilter )

فیلتری روی یک بُعد یا معیار واحد. این فیلتر را نمی‌توان روی AudienceFilterExpression سطح بالا تنظیم کرد.

eventFilter

object ( AudienceEventFilter )

فیلتری ایجاد می‌کند که با یک رویداد خاص مطابقت دارد. این مورد را نمی‌توان در بالاترین سطح AudienceFilterExpression تنظیم کرد.

فیلتر مخاطبان - فهرست عبارات

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

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

object ( AudienceFilterExpression )

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

ابعاد مخاطب یا فیلتر متریک

یک فیلتر خاص برای یک بُعد یا معیار واحد.

نمایش JSON 
{
  "fieldName": string,
  "atAnyPointInTime": boolean,
  "inAnyNDayPeriod": integer,

  // 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.
}
فیلدها
fieldName

string

الزامی. تغییرناپذیر. نام بُعد یا نام معیار برای فیلتر کردن. اگر نام فیلد به یک بُعد یا معیار سفارشی اشاره داشته باشد، یک پیشوند دامنه به جلوی ابعاد یا نام معیار سفارشی اضافه می‌شود. برای اطلاعات بیشتر در مورد پیشوندهای دامنه یا ابعاد/معیارهای سفارشی، به مستندات API داده Google Analytics مراجعه کنید.

atAnyPointInTime

boolean

اختیاری. نشان می‌دهد که آیا این فیلتر نیاز به ارزیابی پویا دارد یا خیر. اگر روی true تنظیم شود، کاربران در صورتی که شرط را برآورده کرده باشند (ارزیابی استاتیک) به Audience ملحق می‌شوند. اگر تنظیم نشود یا روی false تنظیم شود، ارزیابی کاربر برای یک Audience پویا است؛ کاربران وقتی شرایط را برآورده می‌کنند به Audience اضافه می‌شوند و وقتی دیگر آنها را برآورده نمی‌کنند، حذف می‌شوند.

این فقط زمانی قابل تنظیم است که محدوده مخاطب ACROSS_ALL_SESSIONS باشد.

inAnyNDayPeriod

integer

اختیاری. در صورت تنظیم، بازه زمانی ارزیابی داده‌ها بر حسب تعداد روز را مشخص می‌کند. در صورت تنظیم نکردن، داده‌های مخاطبان در مقابل داده‌های طول عمر (مثلاً بازه زمانی نامحدود) ارزیابی می‌شوند.

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

فقط زمانی می‌توان آن را تنظیم کرد که محدوده مخاطبان ACROSS_ALL_SESSIONS باشد و نمی‌تواند بیشتر از ۶۰ روز باشد.

فیلد اتحادیه one_filter . یکی از فیلترهای بالا. one_filter فقط می‌تواند یکی از موارد زیر باشد:
stringFilter

object ( StringFilter )

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

inListFilter

object ( InListFilter )

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

numericFilter

object ( NumericFilter )

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

betweenFilter

object ( BetweenFilter )

فیلتری برای مقادیر عددی یا تاریخی بین مقادیر خاص روی یک بُعد یا معیار.

فیلتر رشته‌ای

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

نمایش JSON 
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
فیلدها
matchType

enum ( MatchType )

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

value

string

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

caseSensitive

boolean

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

نوع تطابق

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

انوم‌ها
MATCH_TYPE_UNSPECIFIED نامشخص
EXACT تطابق دقیق با مقدار رشته.
BEGINS_WITH با مقدار رشته‌ای شروع می‌شود.
ENDS_WITH با مقدار رشته‌ای به پایان می‌رسد.
CONTAINS شامل مقدار رشته‌ای است.
FULL_REGEXP عبارت منظم کامل با مقدار رشته مطابقت دارد.

فیلتر درون‌لیست

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

نمایش JSON 
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
فیلدها
values[]

string

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

caseSensitive

boolean

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

فیلتر عددی

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

نمایش JSON 
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
فیلدها
operation

enum ( Operation )

الزامی. عملیاتی که روی یک فیلتر عددی اعمال می‌شود.

value

object ( NumericValue )

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

عملیات

عملیاتی که روی یک فیلتر عددی اعمال می‌شود.

انوم‌ها
OPERATION_UNSPECIFIED نامشخص.
EQUAL مساوی.
LESS_THAN کمتر از.
GREATER_THAN بزرگتر از.

مقدار عددی

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

نمایش JSON 
{

  // Union field one_value can be only one of the following:
  "int64Value": string,
  "doubleValue": number
  // End of list of possible types for union field one_value.
}
فیلدها
فیلد یونیونی one_value . یکی از یک مقدار عددی. one_value فقط می‌تواند یکی از موارد زیر باشد:
int64Value

string ( int64 format)

مقدار عدد صحیح.

doubleValue

number

ارزش مضاعف.

بین فیلتر

فیلتری برای مقادیر عددی یا تاریخی بین مقادیر خاص روی یک بُعد یا معیار.

نمایش JSON 
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
فیلدها
fromValue

object ( NumericValue )

الزامی. با این شماره شروع می‌شود، شامل همه.

toValue

object ( NumericValue )

الزامی. به این شماره ختم می‌شود، شامل همه.

فیلتر رویداد مخاطب

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

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

string

الزامی. تغییرناپذیر. نام رویدادی که باید با آن مطابقت داده شود.

eventParameterFilterExpression

object ( AudienceFilterExpression )

اختیاری. در صورت مشخص شدن، این فیلتر با رویدادهایی مطابقت دارد که هم با نام رویداد واحد و هم با عبارات فیلتر پارامتر مطابقت دارند. AudienceEventFilter را نمی‌توان درون عبارت فیلتر پارامتر تنظیم کرد (برای مثال، فیلترهای رویداد تو در تو پشتیبانی نمی‌شوند). این باید یک andGroup واحد از dimensionOrMetricFilter یا notExpression باشد؛ ANDهای OR پشتیبانی نمی‌شوند. همچنین، اگر شامل فیلتری برای "eventCount" باشد، فقط آن یکی در نظر گرفته می‌شود؛ سایر فیلترها نادیده گرفته می‌شوند.

فیلتر توالی مخاطب

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

نمایش JSON 
{
  "scope": enum (AudienceFilterScope),
  "sequenceMaximumDuration": string,
  "sequenceSteps": [
    {
      object (AudienceSequenceStep)
    }
  ]
}
فیلدها
scope

enum ( AudienceFilterScope )

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

sequenceMaximumDuration

string ( Duration format)

اختیاری. دوره زمانی را که کل دنباله باید در آن رخ دهد، تعریف می‌کند.

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

sequenceSteps[]

object ( AudienceSequenceStep )

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

توالی مخاطب

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

نمایش JSON 
{
  "scope": enum (AudienceFilterScope),
  "immediatelyFollows": boolean,
  "constraintDuration": string,
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
فیلدها
scope

enum ( AudienceFilterScope )

الزامی. تغییرناپذیر. محدوده‌ی این مرحله را مشخص می‌کند.

immediatelyFollows

boolean

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

constraintDuration

string ( Duration format)

اختیاری. در صورت تنظیم، این مرحله باید در محدوده محدودیت مدت زمان مرحله قبل برآورده شود (برای مثال، t[i] - t[i-1] <= constraintDuration). اگر تنظیم نشود، هیچ الزامی برای مدت زمان وجود ندارد (مدت زمان عملاً نامحدود است). برای مرحله اول نادیده گرفته می‌شود.

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

filterExpression

object ( AudienceFilterExpression )

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

نوع بند مخاطب

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

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

روش‌ها

archive

 بایگانی مخاطبان در یک ملک.

create

 مخاطب ایجاد می‌کند.

get

 به دنبال یک مخاطب خاص بگردید.

list

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

patch

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