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" إذا كانت هذه شريحة جمهور إعلانات غير مخصّصة وتم استبعادها من تخصيص الإعلانات.
eventTrigger

object (AudienceEventTrigger)

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

enum (AudienceExclusionDurationMode)

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

object (AudienceFilterClause)

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

string (Timestamp format)

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

يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف 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)

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

object (AudienceFilterExpressionList)

قائمة بالتعبيرات التي سيتم ربطها معًا باستخدام OR. لا يمكن أن يحتوي على 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، ولا يمكن استخدام ANDs من ORs. بالإضافة إلى ذلك، إذا كان يتضمّن فلترًا لـ "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)

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

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

object (AudienceFilterExpression)

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

AudienceClauseType

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

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

الطُرق

archive

 تؤدي هذه الطريقة إلى أرشفة شريحة جمهور في موقع.

create

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

get

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

list

 تعرض هذه السمة قوائم المستخدمين في أحد المواقع.

patch

 تعديل جمهور في موقع أو تطبيق