REST Resource: properties.audiences

المرجع: الجمهور

رسالة مورد تمثّل شريحة جمهور في "إحصاءات Google 4".

تمثيل JSON
{
  "name": string,
  "displayName": string,
  "description": string,
  "membershipDurationDays": integer,
  "adsPersonalizationEnabled": boolean,
  "eventTrigger": {
    object (AudienceEventTrigger)
  },
  "exclusionDurationMode": enum (AudienceExclusionDurationMode),
  "filterClauses": [
    {
      object (AudienceFilterClause)
    }
  ]
}
الحقول
name

string

النتائج فقط. اسم المورد لمورد الجمهور هذا. التنسيق: properties/{propertyId}/audiences/{audienceId}

displayName

string

مطلوبة. الاسم المعروض للجمهور.

description

string

مطلوبة. وصف الجمهور.

membershipDurationDays

integer

مطلوبة. غير قابل للتغيير. المدة التي يجب أن يظل فيها المستخدِم ضمن شريحة الجمهور. لا يمكن ضبطه على أكثر من 540 يومًا.

adsPersonalizationEnabled

boolean

النتائج فقط. ويتم ضبط تلك القيمة تلقائيًا من خلال "إحصاءات Google" على "خطأ" إذا كانت هذه شريحة جمهور للإعلانات غير المخصّصة وتم استبعادها من تخصيص الإعلانات.

eventTrigger

object (AudienceEventTrigger)

اختياريّ. تُحدِّد حدثًا لتسجيله عندما ينضم مستخدم إلى "الجمهور". وفي حال تركها بدون ضبط، لن يتم تسجيل أي حدث عند انضمام أحد المستخدمين إلى الجمهور.

exclusionDurationMode

enum (AudienceExclusionDurationMode)

غير قابل للتغيير. تُحدِّد مدة استمرار الاستثناء للمستخدمين الذين يستوفون فلتر الاستثناء. ويتم تطبيقه على كل عبارات الفلتر "استبعاد" ويتم تجاهلها في حال عدم توفّر عبارة فلتر "استبعاد" في شريحة الجمهور.

filterClauses[]

object (AudienceFilterClause)

مطلوبة. غير قابل للتغيير. قائمة بدون ترتيب. عبارات التصفية التي تعرِّف الجمهور. سيتمّ الجمع بين جميع العبارات والجُمل معًا.

AudienceEventTrigger

تُحدِّد حدثًا لتسجيله عندما ينضم مستخدم إلى "الجمهور".

تمثيل JSON
{
  "eventName": string,
  "logCondition": enum (LogCondition)
}
الحقول
eventName

string

مطلوبة. اسم الحدث الذي سيتم تسجيله

logCondition

enum (LogCondition)

مطلوبة. الوقت المناسب لتسجيل الحدث.

LogCondition

لتحديد وقت تسجيل الحدث.

عمليات التعداد
LOG_CONDITION_UNSPECIFIED لم يتم تحديد شرط السجلّ.
AUDIENCE_JOINED يجب تسجيل الحدث فقط عند انضمام مستخدم.
AUDIENCE_MEMBERSHIP_RENEWED يجب تسجيل الحدث عند استيفاء شرط "الجمهور"، حتى إذا كان المستخدم عضوًا في شريحة الجمهور حاليًا.

AudienceExclusionDurationMode

تُحدِّد مدة استمرار الاستثناء للمستخدمين الذين يستوفون فلتر الاستثناء.

عمليات التعداد
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED عدم تحديد صيغة مخاطبة
EXCLUDE_TEMPORARILY استبعاد مستخدمين من الجمهور خلال الفترات التي يستوفون فيها عبارة الفلتر.
EXCLUDE_PERMANENTLY استبعاد مستخدمين من الجمهور إذا استوفوا في أي وقت عبارة الفلتر.

AudienceFilterClause

عبارة عن تعريف إما عامل تصفية بسيط أو عامل تصفية. يمكن أن يكون الفلتر شاملاً (على سبيل المثال، يتم تضمين المستخدمين الذين يستوفون عبارة الفلتر في "الجمهور") أو حصريًا (على سبيل المثال، يتم استبعاد المستخدمين الذين يستوفون عبارة الفلتر من الجمهور).

تمثيل 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

تحدِّد كيفية تقييم المستخدمين للانضمام إلى شريحة جمهور معيّنة.

عمليات التعداد
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. يجب ضبط هذا الحقل لتطبيق AudienceFilterExpion ذي المستوى الأعلى.

orGroup

object (AudienceFilterExpressionList)

قائمة من التعبيرات يُشار إليها بالاختصار OR. لا يمكن أن تحتوي على AudienceFilterExpressions مع andGroup أو orGroup.

notExpression

object (AudienceFilterExpression)

تعبير فلتر يجب عدم تعديله (على سبيل المثال، مقلوب أو مُكمّل). لا يمكن أن تتضمّن سوى السمة OrMetricFilter فقط. لا يمكن ضبط هذا الحقل على المستوى الأعلى في 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

مطلوبة. غير قابل للتغيير. اسم السمة أو اسم المقياس المطلوب فلترته. إذا كان اسم الحقل يشير إلى سمة أو مقياس مخصّصَين، ستتم إضافة بادئة النطاق إلى مقدّمة اسم المقياس أو السمات المخصّصة. لمزيد من المعلومات عن بادئات النطاق أو السمات/المقاييس المخصّصة، يُرجى الرجوع إلى مستندات Data API على "إحصاءات Google".

atAnyPointInTime

boolean

اختياريّ. يشير إلى ما إذا كان هذا الفلتر بحاجة إلى تقييم ديناميكي أم لا. وفي حال ضبطها على "صحيح"، ينضم المستخدِمون إلى الجمهور إذا استوفوا الشرط (التقييم الثابت). وفي حال ترك هذه السياسة بدون ضبط أو ضبطها على "خطأ"، سيكون تقييم المستخدِم للجمهور ديناميكيًا. تتمّ إضافة المستخدِمين إلى الجمهور إذا استوفوا الشروط وبعد ذلك تتمّ إزالتهم إن لم يعودوا مستوفين لها.

لا يمكن ضبط هذا الإعداد إلا عندما يكون نطاق الجمهور هو ACROSS_ALL_SESSIONS.

inAnyNDayPeriod

integer

اختياريّ. في حال ضبطها، يتم تحديد الفترة الزمنية التي يتم تقييم البيانات خلالها بعدد الأيام. وفي حال ترك هذه السياسة بدون ضبط، يتم تقييم بيانات الجمهور وفقًا لبيانات الفترة منذ الإنشاء (على سبيل المثال، فترة زمنية غير محدودة).

على سبيل المثال، في حال ضبط هذه السياسة على يوم واحد، لن يتم تقييم سوى بيانات اليوم الحالي. النقطة المرجعية هي اليوم الحالي عندما يكون 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

نوع المطابقة لفلتر السلسلة.

عمليات التعداد
MATCH_TYPE_UNSPECIFIED غير محدّد
EXACT المطابقة التامة لقيمة السلسلة.
BEGINS_WITH تبدأ بقيمة السلسلة.
ENDS_WITH تنتهي بقيمة السلسلة.
CONTAINS يحتوي على قيمة السلسلة.
FULL_REGEXP يتطابق التعبير العادي الكامل مع قيمة السلسلة.

InListFilter

فلتر لبُعد سلسلة يتطابق مع قائمة معيّنة من الخيارات.

تمثيل JSON
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
الحقول
values[]

string

مطلوبة. قائمة بقيم السلسلة المحتملة المطلوب مطابقتها معها. يجب ألا يكون الحقل فارغًا.

caseSensitive

boolean

اختياريّ. إذا كانت المطابقة صحيحة، تكون المطابقة حسّاسة لحالة الأحرف. وإذا كانت القيمة خاطئة، تكون المطابقة غير حساسة لحالة الأحرف.

NumericFilter

فلتر للقيم الرقمية أو التاريخ على إحدى السمات أو المقاييس.

تمثيل JSON
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
الحقول
operation

enum (Operation)

مطلوبة. العملية المطبقة على عامل تصفية رقمي.

value

object (NumericValue)

مطلوبة. القيمة الرقمية أو التاريخ المطلوب المطابقة معها.

العملية

العملية المطبقة على عامل تصفية رقمي.

عمليات التعداد
OPERATION_UNSPECIFIED غير محدد
EQUAL يساوي
LESS_THAN أقل من.
GREATER_THAN أكبر من.

NumericValue

لتمثيل رقم.

تمثيل 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

قيمة مزدوجة

BetweenFilter

فلتر للقيم الرقمية أو التاريخ بين قيم معيّنة على سمة أو مقياس.

تمثيل 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 واحدة لـ featureOrMetricFilter أو notExpression؛ وتكون أحرف AND غير متوافقة. وإضافةً إلى ذلك، إذا تضمّن فلترًا للفلتر 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)

اختياريّ. عند الضبط، يجب استيفاء هذه الخطوة ضمن RestricttDuration للخطوة السابقة (على سبيل المثال، t[i] - t[i-1] <= RestricttDuration). وفي حال ترك هذه السياسة بدون ضبط، لن تكون هناك أي متطلبات للمدة (تكون المدة غير محدودة فعليًا). ويتم تجاهله للخطوة الأولى.

مدة بالثواني يصل عددها إلى تسعة أرقام كسرية وتنتهي بـ "s". مثال: "3.5s".

filterExpression

object (AudienceFilterExpression)

مطلوبة. غير قابل للتغيير. تعبير منطقي لفلاتر الأحداث أو المقاييس أو سمات الجمهور في كل خطوة

AudienceClauseType

لتحديد ما إذا كانت هذه السمة عبارة عن فلتر تضمين أو استبعاد.

عمليات التعداد
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED نوع عبارة غير محدَّد
INCLUDE وسيتم تضمين المستخدِمين في "الجمهور" في حال استيفاء عبارة الفلتر.
EXCLUDE وسيتم استبعاد المستخدِمين من "الجمهور" في حال استيفاء عبارة الفلتر.

الطُرق

archive

أرشفة شريحة جمهور على موقع إلكتروني.

create

إنشاء شريحة جمهور.

get

ابحث عن شريحة جمهور واحدة.

list

يسرد شرائح الجمهور على موقع معيّن.

patch

تعديلات على شريحة جمهور على موقع.