REST Resource: properties.audiences

منبع: مخاطب

یک پیام منبع نشان دهنده یک مخاطب GA4.

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

string

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

displayName

string

ضروری. نام نمایشی مخاطب.

description

string

ضروری. توصیف مخاطب

membershipDurationDays

integer

ضروری. تغییرناپذیر. مدت زمانی که کاربر باید در یک مخاطب بماند. نمی توان آن را روی بیش از 540 روز تنظیم کرد.

adsPersonalizationEnabled

boolean

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

eventTrigger

object ( AudienceEventTrigger )

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

exclusionDurationMode

enum ( AudienceExclusionDurationMode )

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

filterClauses[]

object ( AudienceFilterClause )

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

AudienceEventTrigger

زمانی که کاربر به Audience می‌پیوندد، رویدادی را برای ثبت نام مشخص می‌کند.

نمایندگی JSON
{
  "eventName": string,
  "logCondition": enum (LogCondition)
}
زمینه های
eventName

string

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

logCondition

enum ( LogCondition )

ضروری. چه زمانی باید رویداد را ثبت کرد.

وضعیت ورود

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

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

AudienceExclusionDurationMode

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

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

AudienceFilterClause

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

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

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

AudienceSimpleFilter

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

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

enum ( AudienceFilterScope )

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

filterExpression

object ( AudienceFilterExpression )

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

AudienceFilterScope

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

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

AudienceFilterExpression

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

نمایندگی 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'ed با هم. نمی تواند حاوی AudienceFilterExpressions با andGroup یا orGroup باشد.

notExpression

object ( AudienceFilterExpression )

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

dimensionOrMetricFilter

object ( AudienceDimensionOrMetricFilter )

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

eventFilter

object ( AudienceEventFilter )

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

AudienceFilterExpressionList

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

نمایندگی JSON
{
  "filterExpressions": [
    {
      object (AudienceFilterExpression)
    }
  ]
}
زمینه های
filterExpressions[]

object ( AudienceFilterExpression )

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

AudienceDimensionOrMetricFilter

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

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

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

atAnyPointInTime

boolean

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

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

inAnyNDayPeriod

integer

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

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

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

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

object ( StringFilter )

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

inListFilter

object ( InListFilter )

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

numericFilter

object ( NumericFilter )

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

betweenFilter

object ( BetweenFilter )

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

StringFilter

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

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

enum ( MatchType )

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

value

string

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

caseSensitive

boolean

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

MatchType

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

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

InListFilter

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

نمایندگی JSON
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
زمینه های
values[]

string

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

caseSensitive

boolean

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

فیلتر عددی

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

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

enum ( Operation )

ضروری. عملیات بر روی یک فیلتر عددی اعمال می شود.

value

object ( NumericValue )

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

عمل

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

Enums
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 )

ضروری. با این عدد به پایان می رسد.

AudienceEventFilter

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

نمایندگی JSON
{
  "eventName": string,
  "eventParameterFilterExpression": {
    object (AudienceFilterExpression)
  }
}
زمینه های
eventName

string

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

eventParameterFilterExpression

object ( AudienceFilterExpression )

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

AudienceSequenceFilter

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

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

enum ( AudienceFilterScope )

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

sequenceMaximumDuration

string ( Duration format)

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

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

sequenceSteps[]

object ( AudienceSequenceStep )

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

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 )

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

AudienceClauseType

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

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

مواد و روش ها

archive

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

create

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

get

 جستجو برای یک مخاطب

list

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

patch

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