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)
    }
  ],
  "createTime": string
}
الحقول
name

string

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

displayName

string

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

description

string

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

membershipDurationDays

integer

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

adsPersonalizationEnabled

boolean

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

eventTrigger

object (AudienceEventTrigger)

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

exclusionDurationMode

enum (AudienceExclusionDurationMode)

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

filterClauses[]

object (AudienceFilterClause)

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

createTime

string (Timestamp format)

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

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".

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)

قائمة بالتعبيرات المطلوب إجراءها باستخدام 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

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

atAnyPointInTime

boolean

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

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

inAnyNDayPeriod

integer

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

على سبيل المثال، في حال ضبط هذه القيمة على يوم واحد، لن يتم تقييم سوى بيانات اليوم الحالي. تشير النقطة المرجعية إلى اليوم الحالي عندما يتم ضبط atAnyPointInTime بدون ضبط أو على false.

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

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

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

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