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

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

adsPersonalizationEnabled

boolean

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

eventTrigger

object (AudienceEventTrigger)

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

exclusionDurationMode

enum (AudienceExclusionDurationMode)

غير قابل للتغيير تحدّد هذه السمة مدة استمرار الاستبعاد للمستخدمين الذين يستوفون فلتر الاستبعاد. ويتم تطبيقها على جميع عبارات فلتر EXCLUDE ويتم تجاهلها عندما لا تتوفّر عبارة فلتر EXCLUDE في شريحة الجمهور.

filterClauses[]

object (AudienceFilterClause)

مطلوب. غير قابل للتغيير قائمة غير مرتّبة. فلترة الجمل التي تحدّد شريحة الجمهور سيتم ربط جميع الجمل معًا باستخدام "و".

createTime

string (Timestamp format)

النتائج فقط. الوقت الذي تم فيه إنشاء شريحة الجمهور.

يستخدم معيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه دائمًا مُعدَّلاً وفقًا لقاعدة Z ويستخدم 0 أو 3 أو 6 أو 9 أرقام عشرية. يتم أيضًا قبول Offsets غير "Z". على سبيل المثال: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30".

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)

قائمة بالتعبيرات التي سيتم ربطها معًا باستخدام "و" ولا يمكن أن يحتوي إلا على تعبيرات AudienceFilterExpressions مع orGroup. يجب ضبط هذا الإعداد لتعبير AudienceFilterExpression على المستوى الأعلى.

orGroup

object (AudienceFilterExpressionList)

قائمة بالتعبيرات التي سيتم ربطها ببعضها باستخدام "أو" ولا يمكن أن يحتوي على تعبيرات AudienceFilterExpressions مع andGroup أو orGroup.

notExpression

object (AudienceFilterExpression)

تعبير فلتر ليتمّ تطبيق NOT عليه (على سبيل المثال، تعبير فلتر مقلوب أو مكمّل) ولا يمكن أن يتضمّن سوى 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

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

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

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

MatchType

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

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

InListFilter

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

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

string

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

caseSensitive

boolean

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

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 من dimensionOrMetricFilter أو notExpression، ولا يُسمح باستخدام عنصرَي AND من عنصرَي OR. بالإضافة إلى ذلك، إذا كان يتضمّن فلترًا لـ "عدد الأحداث"، سيتمّ أخذ هذا الفلتر فقط في الاعتبار، وسيتمّ تجاهل جميع الفلاتر الأخرى.

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] <= مدة القيود). في حال عدم ضبط هذه القيمة، لا يكون هناك شرط بشأن المدة (تكون المدة غير محدودة بشكلٍ فعال). ويتم تجاهله في الخطوة الأولى.

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

filterExpression

object (AudienceFilterExpression)

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

AudienceClauseType

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

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

الطُرق

archive

لأرشفة شريحة جمهور على موقع

create

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

get

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

list

يُدرج شرائح الجمهور في موقع.

patch

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