REST Resource: properties.reportTasks

المرجع: ReportTask

إعدادات مهمة تقرير محدّدة.

تمثيل JSON
{
  "name": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "reportMetadata": {
    object (ReportMetadata)
  }
}
الحقول
name

string

النتائج فقط. المُعرّف. اسم مورد مهمة التقارير الذي تم تعيينه أثناء الإنشاء التنسيق: "properties/{property}/reportTasks/{reportTask}"

reportDefinition

object (ReportDefinition)

اختياريّ. تعريف تقرير لاسترجاع بيانات التقرير، ويصف بنية التقرير. وهي تشمل عادةً الحقول التي سيتم تضمينها في التقرير والمعايير التي سيتم استخدامها لفلترة البيانات.

reportMetadata

object (ReportMetadata)

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

ReportDefinition

تعريف كيفية تشغيل التقرير.

تمثيل JSON
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean
}
الحقول
dimensions[]

object (Dimension)

اختياريّ. السمات المطلوبة وعرضها.

metrics[]

object (Metric)

اختياريّ. المقاييس المطلوبة وعرضها.

dateRanges[]

object (DateRange)

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

dimensionFilter

object (FilterExpression)

اختياريّ. تسمح لك فلاتر السمات بطلب قيم سمات معيّنة فقط في التقرير. للمزيد من المعلومات، اطّلِع على أساسيات فلاتر السمات للحصول على أمثلة. لا يمكن استخدام المقاييس في هذا الفلتر.

metricFilter

object (FilterExpression)

اختياريّ. عبارة فلتر المقاييس تُطبق بعد تجميع صفوف التقرير، على غرار SQL التي تحتوي على عبارة. لا يمكن استخدام السمات في هذا الفلتر.

offset

string (int64 format)

اختياريّ. عدد صفوف صف البداية من مساحة التخزين في "إحصاءات Google". يتم احتساب الصف الأول على أنه الصف 0.

عند إنشاء مهمة تقرير، تُحدِّد المَعلمتَان offset وlimit المجموعة الفرعية من صفوف البيانات من مساحة التخزين في "إحصاءات Google" التي سيتم تضمينها في التقرير الذي تمّ إنشاؤه. على سبيل المثال، إذا كان هناك إجمالي 300,000 صف في مساحة التخزين في "إحصاءات Google"، قد تحتوي مهمة التقرير الأوّلية على أول 10,000 صفّ بحدٍّ أقصى 10,000 صف وإزاحة 0. بعد ذلك، يمكن لمهمة تقرير أخرى أن تغطي الصفوف الـ 10000 التالية بحد أقصى 10000 وإزاحة 10000.

limit

string (int64 format)

اختياريّ. عدد الصفوف المطلوب عرضها في التقرير. وفي حال عدم تحديد قيمة، يتم عرض 10,000 صف. تعرض واجهة برمجة التطبيقات 250,000 صف كحد أقصى لكل طلب، بغض النظر عن العدد الذي تطلبه. يجب أن تكون قيمة الحقل "limit" موجبة.

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

metricAggregations[]

enum (MetricAggregation)

اختياريّ. تجميع المقاييس سيتمّ عرض قيم المقاييس المجمَّعة في الصفوف التي يتم فيها ضبط قيم السمة على "RESERVED_(MetricAggregation)".

orderBys[]

object (OrderBy)

اختياريّ. لتحديد كيفية ترتيب الصفوف في الاستجابة.

currencyCode

string

اختياريّ. تمثّل هذه السمة رمز عملة بتنسيق ISO4217، مثل AED أو USD أو JPY. إذا كان هذا الحقل فارغًا، يستخدِم التقرير العملة التلقائية للموقع الإلكتروني.

cohortSpec

object (CohortSpec)

اختياريّ. مجموعة مجموعات نموذجية مرتبطة بهذا الطلب. إذا كانت هناك مجموعة نموذجية في الطلب، يجب أن تتوفّر سمة "المجموعة النموذجية".

keepEmptyRows

boolean

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

بغض النظر عن إعداد keepEmptyRows هذا، لا يمكن عرض سوى البيانات التي سجّلها الموقع على "إحصاءات Google 4" في التقرير.

على سبيل المثال، إذا لم يسجِّل أحد المواقع حدث purchase مطلقًا، لن يتضمّن طلب البحث عن السمة eventName والمقياس eventCount صفًا يحتوي على eventName: "purchase" وeventCount: 0.

السمة

تمثِّل هذه السمات بياناتك. على سبيل المثال، تشير سمة "المدينة" إلى المدينة التي نشأ منها الحدث. قيم السمات في ردود التقارير هي سلاسل؛ على سبيل المثال، يمكن أن تكون المدينة "باريس" أو "نيويورك".

تمثيل JSON
{
  "name": string,
  "dimensionExpression": {
    object (DimensionExpression)
  }
}
الحقول
name

string

اسم السمة. اطّلِع على سمات واجهة برمجة التطبيقات للحصول على قائمة بأسماء السمات المتوافقة مع طرق إعداد التقارير الأساسية مثل runReport وbatchRunReports. اطّلِع على السمات في الوقت الفعلي للحصول على قائمة بأسماء السمات التي تتيحها طريقة runRealtimeReport. اطّلِع على سمات مسار الإحالة الناجحة للحصول على قائمة بأسماء السمات التي تتيحها طريقة runFunnelReport.

إذا تم تحديد dimensionExpression، يمكن أن يكون name أي سلسلة تريدها ضمن مجموعة الأحرف المسموح بها. على سبيل المثال، إذا كان dimensionExpression يجمع بين country وcity، يمكنك تسمية هذه السمة countryAndCity. يجب أن تتطابق أسماء السمات التي تختارها مع التعبير العادي "^[a-zA-Z0-9_]$".

تتم الإشارة إلى السمات من قِبل name في dimensionFilter وorderBys وdimensionExpression وpivots.

dimensionExpression

object (DimensionExpression)

يمكن أن تكون سمة واحدة نتيجة تعبير سمات متعددة. على سبيل المثال، البُعد "البلد، المدينة": concatenate(country, ", ", city).

DimensionExpression

يتم استخدامه للتعبير عن سمة هي نتيجة صيغة سمات متعددة. أمثلة على الاستخدامات: 1) LowCase(السمة) 2) concatenate(dimension1, icon, feature2).

تمثيل JSON
{

  // Union field one_expression can be only one of the following:
  "lowerCase": {
    object (CaseExpression)
  },
  "upperCase": {
    object (CaseExpression)
  },
  "concatenate": {
    object (ConcatenateExpression)
  }
  // End of list of possible types for union field one_expression.
}
الحقول
حقل الاتحاد one_expression حدِّد نوعًا واحدًا من تعبيرات السمات في DimensionExpression. يمكن أن يكون الحقل "one_expression" واحدًا فقط مما يلي:
lowerCase

object (CaseExpression)

تُستخدَم هذه الوظيفة لتحويل قيمة سمة إلى أحرف صغيرة.

upperCase

object (CaseExpression)

تُستخدَم هذه الوظيفة لتحويل قيمة سمة إلى أحرف كبيرة.

concatenate

object (ConcatenateExpression)

تُستخدَم هذه الوظيفة لدمج قيم السمات في سمة واحدة. على سبيل المثال، البُعد "البلد، المدينة": concatenate(country, ", ", city).

CaseExpression

تُستخدَم لتحويل قيمة سمة إلى حالة واحدة.

تمثيل JSON
{
  "dimensionName": string
}
الحقول
dimensionName

string

اسم السمة يجب أن يشير الاسم إلى اسم في حقل "السمات" بالطلب.

ConcatenateExpression

تُستخدَم هذه الوظيفة لدمج قيم السمات في سمة واحدة.

تمثيل JSON
{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}
الحقول
dimensionNames[]

string

أسماء السمات يجب أن تشير الأسماء إلى الأسماء في حقل الأبعاد بالطلب.

delimiter

string

المحدِّد الموضوع بين أسماء السمات.

غالبًا ما تكون المحدِّدات أحرفًا مفردة مثل "|" أو ","، ولكنها يمكن أن تكون سلاسل أطول. وإذا كانت قيمة السمة تحتوي على المحدِّد، سيظهر كلاهما استجابةً بدون أي فرق. على سبيل المثال، إذا كانت قيمة السمة 1 = "US,FR"، وكانت قيمة السمة 2 = "JP" والمحدِّد = ","، ستحتوي الاستجابة على "US,FR,JP".

المقياس

يشير ذلك المصطلح إلى المقاييس الكمية لأحد التقارير. على سبيل المثال، المقياس eventCount هو إجمالي عدد الأحداث. يُسمح للطلبات بما يصل إلى 10 مقاييس.

تمثيل JSON
{
  "name": string,
  "expression": string,
  "invisible": boolean
}
الحقول
name

string

اسم المقياس. اطّلِع على مقاييس واجهة برمجة التطبيقات للحصول على قائمة بأسماء المقاييس المتوافقة مع طرق إعداد التقارير الأساسية مثل runReport وbatchRunReports. اطّلِع على المقاييس في الوقت الفعلي للحصول على قائمة بأسماء المقاييس التي تتيحها الطريقة runRealtimeReport. راجِع مقاييس مسار الإحالة الناجحة للحصول على قائمة بأسماء المقاييس المتوافقة مع الطريقة runFunnelReport.

إذا تم تحديد expression، يمكن أن يكون name أي سلسلة تريدها ضمن مجموعة الأحرف المسموح بها. على سبيل المثال، إذا كان expression هو screenPageViews/sessions، يمكنك تسمية هذا المقياس باسم = viewsPerSession. يجب أن تتطابق أسماء المقاييس التي تختارها مع التعبير العادي ^[a-zA-Z0-9_]$.

تتم الإشارة إلى المقاييس من خلال name في metricFilter وorderBys والمقياس expression.

expression

string

تعبير رياضي للمقاييس المشتقة. على سبيل المثال، مقياس عدد الأحداث لكلّ مستخدِم هو eventCount/totalUsers.

invisible

boolean

يشير إلى ما إذا كان أحد المقاييس غير مرئي في استجابة التقرير. إذا لم يكن المقياس مرئيًا، لن ينتج عنه عمود في الاستجابة، ولكن يمكن استخدامه في metricFilter أو orderBys أو أحد المقاييس expression.

DateRange

مجموعة متجاورة من الأيام: startDate، startDate + 1، ...، endDate. يُسمح للطلبات بما يصل إلى 4 نطاقات زمنية.

تمثيل JSON
{
  "startDate": string,
  "endDate": string,
  "name": string
}
الحقول
startDate

string

تمثّل هذه السمة تاريخ البدء الشامل لطلب البحث بالتنسيق YYYY-MM-DD. لا يمكن أن يقع بعد endDate. يتم أيضًا قبول التنسيق NdaysAgo أو yesterday أو today، وفي هذه الحالة، يتم استنتاج التاريخ استنادًا إلى المنطقة الزمنية لإعداد التقارير للموقع.

endDate

string

تمثّل هذه السمة تاريخ الانتهاء الشامل لطلب البحث بالتنسيق YYYY-MM-DD. لا يمكن أن يقع قبل startDate. يتم أيضًا قبول التنسيق NdaysAgo أو yesterday أو today، وفي هذه الحالة، يتم استنتاج التاريخ استنادًا إلى المنطقة الزمنية لإعداد التقارير للموقع.

name

string

يعيّن اسمًا لهذا النطاق الزمني. وتتم قيمة السمة "dateRange" لهذا الاسم في ردّ على تقرير. وفي حال ضبطها، لا يمكن أن تبدأ بـ date_range_ أو RESERVED_. في حال ترك هذه السياسة بدون ضبط، تتم تسمية النطاقات الزمنية باستخدام الفهرس المستند إلى صفر في الطلب: date_range_0 وdate_range_1 وما إلى ذلك.

FilterExpression

للتعبير عن فلاتر السمات أو المقاييس يجب أن تكون الحقول في FilterExpression نفسها إما جميع السمات أو جميع المقاييس.

تمثيل JSON
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FilterExpressionList)
  },
  "orGroup": {
    object (FilterExpressionList)
  },
  "notExpression": {
    object (FilterExpression)
  },
  "filter": {
    object (Filter)
  }
  // End of list of possible types for union field expr.
}
الحقول
حقل الاتحاد expr حدِّد نوعًا واحدًا من تعبيرات الفلتر للحقل "FilterExpression". يمكن أن يكون الحقل "expr" واحدًا فقط مما يلي:
andGroup

object (FilterExpressionList)

هناك علاقة "و" لـ "FilterExpressions" في andGroup.

orGroup

object (FilterExpressionList)

لـ FilterExpressions في orGroup علاقة OR.

notExpression

object (FilterExpression)

لا يعتبر FilterExpression ليس من notExpression.

filter

object (Filter)

عامل تصفية أساسي. في FilterExpression نفسها، يجب أن تكون جميع أسماء حقول الفلتر إما كل السمات أو جميع المقاييس.

FilterExpressionList

قائمة بتعبيرات الفلاتر

تمثيل JSON
{
  "expressions": [
    {
      object (FilterExpression)
    }
  ]
}
الحقول
expressions[]

object (FilterExpression)

قائمة بتعبيرات الفلاتر

تصفية

تعبير لفلترة قيم السمات أو المقاييس

تمثيل JSON
{
  "fieldName": string,

  // 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

اسم السمة أو اسم المقياس. يجب أن يكون اسمًا معرّفًا في السمات أو المقاييس.

حقل الاتحاد one_filter حدِّد نوعًا واحدًا من الفلاتر للحقل "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، تكون قيمة السلسلة حسّاسة لحالة الأحرف.

MatchType

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

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

InListFilter

يجب أن تكون النتيجة في قائمة قيم السلسلة.

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

string

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

caseSensitive

boolean

إذا كانت القيمة true، تكون قيمة السلسلة حسّاسة لحالة الأحرف.

NumericFilter

فلاتر القيم الرقمية أو المتعلقة بالتاريخ

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

enum (Operation)

نوع العملية لهذا الفلتر

value

object (NumericValue)

قيمة رقمية أو قيمة تاريخ.

العملية

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

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

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)

ينتهي بهذا الرقم.

MetricAggregation

يمثل تجميع المقاييس.

عمليات التعداد
METRIC_AGGREGATION_UNSPECIFIED عامل تشغيل غير محدّد.
TOTAL عامل التشغيل SUM.
MINIMUM الحد الأدنى لعامل التشغيل.
MAXIMUM الحد الأقصى لعامل التشغيل.
COUNT عامل التشغيل "Count" (العدد).

OrderBy

تحدد "الترتيب حسب" كيفية فرز الصفوف في الرد. على سبيل المثال، يكون ترتيب الصفوف حسب عدد الأحداث التنازلي هو ترتيب واحد، بينما يكون ترتيب الصفوف حسب سلسلة اسم الحدث ترتيبًا مختلفًا.

تمثيل JSON
{
  "desc": boolean,

  // Union field one_order_by can be only one of the following:
  "metric": {
    object (MetricOrderBy)
  },
  "dimension": {
    object (DimensionOrderBy)
  }
  // End of list of possible types for union field one_order_by.
}
الحقول
desc

boolean

إذا كانت الإجابة "صحيح"، يتم الترتيب تنازليًا.

حقل الاتحاد one_order_by تحديد نوع واحد من الطلب حسب السمة OrderBy يمكن أن يكون الحقل "one_order_by" واحدًا فقط مما يلي:
metric

object (MetricOrderBy)

يرتب النتائج حسب قيم أحد المقاييس.

dimension

object (DimensionOrderBy)

يعمل على ترتيب النتائج حسب قيم السمة.

MetricOrderBy

للترتيب حسب قيم المقياس.

تمثيل JSON
{
  "metricName": string
}
الحقول
metricName

string

اسم مقياس في الطلب حسب الطلب.

DimensionOrderBy

يتمّ الترتيب حسب قِيم السمات.

تمثيل JSON
{
  "dimensionName": string,
  "orderType": enum (OrderType)
}
الحقول
dimensionName

string

اسم السمة في الطلب حسب الطلب.

orderType

enum (OrderType)

تتحكّم هذه السياسة في قاعدة ترتيب قيم السمة.

OrderType

قاعدة لترتيب قيم أبعاد السلسلة وفقًا لها.

عمليات التعداد
ORDER_TYPE_UNSPECIFIED غير محدد
ALPHANUMERIC الترتيب الأبجدي الرقمي حسب نقطة رمز يونيكود. على سبيل المثال، "2" < "A" < "X" < "b" < "z".
CASE_INSENSITIVE_ALPHANUMERIC ترتيب أبجدي رقمي غير حساس لحالة الأحرف حسب نقطة رمز يونيكود الصغيرة. على سبيل المثال، "2" < "A" < "b" < "X" < "z".
NUMERIC يتم تحويل قيم السمات إلى أرقام قبل الترتيب. على سبيل المثال، في الترتيب NUMERIC، يكون "25" < "100"، وفي ALPHANUMERIC للترتيب، "100" < "25". تحتوي جميع قيم السمات غير الرقمية على قيمة ترتيب متساوية أسفل جميع القيم الرقمية.

CohortSpec

مواصفات المجموعات النموذجية لتقرير المجموعة النموذجية.

تنشئ تقارير المجموعات النموذجية سلسلة زمنية للحفاظ على المستخدمين في المجموعة النموذجية. على سبيل المثال، يمكنك اختيار المجموعة النموذجية للمستخدمين الذين تم اكتسابهم في الأسبوع الأول من أيلول (سبتمبر) ومتابعة تلك المجموعة النموذجية خلال الأسابيع الستة التالية. يتم تحديد المستخدمين الذين تم اكتسابهم في الأسبوع الأول من المجموعة النموذجية لشهر أيلول (سبتمبر) في عنصر cohort. عند اتّباع هذه المجموعة النموذجية خلال الأسابيع الستة المقبلة، يتم تحديد ذلك في عنصر cohortsRange.

للحصول على أمثلة، يُرجى الاطّلاع على أمثلة على تقارير المجموعات النموذجية.

يمكن أن يعرض الردّ على التقرير سلسلة زمنية أسبوعية يوضِّح فيها أن تطبيقك احتفظ بنسبة 60% من هذه المجموعة النموذجية بعد ثلاثة أسابيع و25% من هذه المجموعة النموذجية بعد ستة أسابيع. يمكن حساب هاتين النسبتين باستخدام المقياس "cohortActiveUsers/cohortTotalUsers"، وسيتم استخدامهما باعتبارهما صفين منفصلين في التقرير.

تمثيل JSON
{
  "cohorts": [
    {
      object (Cohort)
    }
  ],
  "cohortsRange": {
    object (CohortsRange)
  },
  "cohortReportSettings": {
    object (CohortReportSettings)
  }
}
الحقول
cohorts[]

object (Cohort)

تحدِّد معايير الاختيار لتجميع المستخدمين في مجموعات نموذجية.

وتحدِّد معظم تقارير المجموعات النموذجية مجموعة نموذجية واحدة فقط. وفي حال تحديد مجموعات نموذجية متعدّدة، يمكن التعرّف على كل مجموعة نموذجية في التقرير حسب اسمها.

cohortsRange

object (CohortsRange)

تتبع تقارير المجموعات النموذجية المجموعات النموذجية على مدار نطاق زمني ممتد لإعداد التقارير. يحدّد هذا النطاق مدة إزاحة لمتابعة المجموعات النموذجية بعدها.

cohortReportSettings

object (CohortReportSettings)

الإعدادات الاختيارية لتقرير المجموعة النموذجية.

المجموعة النموذجية

تحدد معايير اختيار المجموعة النموذجية. المجموعة النموذجية هي مجموعة من المستخدمين تجمعهم خاصية مشتركة. على سبيل المثال، ينتمي المستخدمون الذين لديهم firstSessionDate نفسه إلى المجموعة النموذجية نفسها.

تمثيل JSON
{
  "name": string,
  "dimension": string,
  "dateRange": {
    object (DateRange)
  }
}
الحقول
name

string

يحدّد اسمًا لهذه المجموعة النموذجية. وتتم قيمة السمة "cohort" لهذا الاسم في ردّ على تقرير. وفي حال ضبطها، لا يمكن أن تبدأ بـ cohort_ أو RESERVED_. في حال ترك هذه السياسة بدون ضبط، تتم تسمية المجموعات النموذجية حسب المؤشر الصفري cohort_0 وcohort_1 وما إلى ذلك.

dimension

string

السمة التي تستخدمها المجموعة النموذجية. مطلوبة وهي متوافقة مع firstSessionDate فقط.

dateRange

object (DateRange)

تختار المجموعة النموذجية المستخدمين الذين يقع تاريخ الاتصال الأول لهم بين تاريخ البدء وتاريخ الانتهاء المحدَّدين في dateRange. لا يحدِّد dateRange هذا النطاق الزمني الكامل لبيانات الأحداث المتوفّرة في تقرير المجموعة النموذجية. في تقرير المجموعة النموذجية، يتم توسيع نطاق dateRange هذا من خلال الدقة والمعادلة المتوفّرة في cohortsRange. وتتوفّر بيانات الأحداث للنطاق الزمني لإعداد التقارير الموسَّع في تقرير المجموعة النموذجية.

في طلب المجموعة النموذجية، يجب تحديد قيمة dateRange هذه، ويجب عدم تحديد قيمة dateRanges في RunReportRequest أو RunPivotReportRequest.

ويجب أن تتماشى سمة dateRange هذه بشكل عام مع دقة المجموعة النموذجية. إذا كان CohortsRange يستخدم الدقة اليومية، يمكن أن يكون dateRange يومًا واحدًا. في حال كان CohortsRange يستخدم الدقة الأسبوعية، يمكن محاذاة dateRange هذا مع حدود أسبوع، بدءًا من الأحد وينتهي يوم السبت. إذا كان CohortsRange يستخدم الدقة الشهرية، يمكن مواءمة dateRange هذا مع شهر، بدءًا من الأول وينتهي في آخر يوم من الشهر.

CohortsRange

تحدِّد هذه السياسة النطاق الزمني لإعداد التقارير الموسَّع لتقرير المجموعة النموذجية. تُحدِّد مدّة الإزاحة لمتابعة المجموعات النموذجية بعدها.

تمثيل JSON
{
  "granularity": enum (Granularity),
  "startOffset": integer,
  "endOffset": integer
}
الحقول
granularity

enum (Granularity)

مطلوبة. الدقة المستخدَمة لتفسير startOffset وendOffset للنطاق الزمني الموسَّع لإعداد التقارير لتقرير المجموعة النموذجية.

startOffset

integer

تحدّد startOffset تاريخ بدء النطاق الزمني الموسَّع لإعداد التقارير لتقرير المجموعة النموذجية. يتم عادةً ضبط startOffset على 0 بحيث تحتوي التقارير على بيانات من اكتساب المجموعة النموذجية فصاعدًا.

إذا كانت قيمة granularity هي DAILY، يكون startDate للنطاق الزمني الموسَّع لإعداد التقارير هو startDate في المجموعة النموذجية بالإضافة إلى startOffset يوم.

إذا كانت قيمة granularity هي WEEKLY، يكون startDate للنطاق الزمني الموسَّع لإعداد التقارير هو startDate في المجموعة النموذجية بالإضافة إلى startOffset * 7 يوم.

إذا كانت قيمة granularity هي MONTHLY، يكون startDate للنطاق الزمني الموسَّع لإعداد التقارير هو startDate في المجموعة النموذجية بالإضافة إلى startOffset * 30 يوم.

endOffset

integer

مطلوبة. تحدّد endOffset تاريخ انتهاء النطاق الزمني الموسَّع لإعداد التقارير لتقرير المجموعة النموذجية. يمكن أن تكون القيمة "endOffset" أي عدد صحيح موجب، ولكن يتم ضبطها عادةً على من 5 إلى 10 بحيث تحتوي التقارير على بيانات في المجموعة النموذجية للفترات الزمنية العديدة التالية للدقة.

إذا كانت قيمة granularity هي DAILY، يكون endDate للنطاق الزمني الموسَّع لإعداد التقارير هو endDate في المجموعة النموذجية بالإضافة إلى endOffset يوم.

إذا كانت قيمة granularity هي WEEKLY، يكون endDate للنطاق الزمني الموسَّع لإعداد التقارير هو endDate في المجموعة النموذجية بالإضافة إلى endOffset * 7 يوم.

إذا كانت قيمة granularity هي MONTHLY، يكون endDate للنطاق الزمني الموسَّع لإعداد التقارير هو endDate في المجموعة النموذجية بالإضافة إلى endOffset * 30 يوم.

درجة الدقة

الدقة المستخدَمة لتفسير startOffset وendOffset للنطاق الزمني الموسَّع لإعداد التقارير لتقرير المجموعة النموذجية.

عمليات التعداد
GRANULARITY_UNSPECIFIED يجب عدم تحديدها مطلقًا.
DAILY الدقة اليومية. تُستخدم عادةً إذا كانت قيمة dateRange للمجموعة النموذجية هي يوم واحد وكان الطلب يحتوي على cohortNthDay.
WEEKLY الدقة الأسبوعية. تُستخدم عادةً إذا كانت قيمة dateRange للمجموعة النموذجية هي أسبوع (يبدأ من يوم الأحد وينتهي يوم السبت) ويحتوي الطلب على cohortNthWeek.
MONTHLY الدقة الشهرية. يشيع استخدامها إذا كانت المدة dateRange للمجموعة النموذجية هي شهر وكان الطلب يتضمّن cohortNthMonth.

CohortReportSettings

الإعدادات الاختيارية لتقرير المجموعة النموذجية.

تمثيل JSON
{
  "accumulate": boolean
}
الحقول
accumulate

boolean

إذا كانت القيمة true، يتم تجميع النتيجة من يوم اللمس الأول حتى يوم الانتهاء. غير متاح في RunReportRequest.

ReportMetadata

البيانات الوصفية للتقرير لمهمة تقرير محدّدة.

تمثيل JSON
{
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "taskRowCount": integer,
  "errorMessage": string,
  "totalRowCount": integer
}
الحقول
creationQuotaTokensCharged

integer

النتائج فقط. الرموز المميزة للحصة التي تم تحصيلها أثناء إنشاء التقرير بما أنّ عدد الرموز المميّزة هذا يعتمد على النشاط في حالة CREATING، سيتم إصلاح رسوم الرموز المميّزة هذه بعد دخول مهمة تقرير إلى الحالة ACTIVE أو FAILED.

state

enum (State)

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

beginCreatingTime

string (Timestamp format)

النتائج فقط. الوقت الذي تم فيه استدعاء "reportTasks.create" وبدأ التقرير حالة CREATING.

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

taskRowCount

integer

النتائج فقط. إجمالي عدد الصفوف في نتيجة التقرير. ستتم تعبئة هذا الحقل عندما تكون الحالة نشطة. يمكنك استخدام taskRowCount للتقسيم على صفحات ضمن حدود التقرير الحالي.

errorMessage

string

النتائج فقط. تتم تعبئة رسالة الخطأ في حال تعذُّر مهمة التقرير أثناء الإنشاء.

totalRowCount

integer

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

يمثل taskRowCount عدد الصفوف المتعلقة بالتقرير الحالي تحديدًا، في حين أن totalRowCount يشمل إجمالي عدد الصفوف في جميع البيانات التي يتم استردادها من مساحة التخزين في "إحصاءات Google".

على سبيل المثال، لنفترض أنّ قيمة taskRowCount للتقرير الحالي تبلغ 20 صفًا، وتعرض البيانات من أول 20 صفًا. وفي الوقت نفسه، تكون قيمة totalRowCount 30، ما يشير إلى توفُّر بيانات في جميع الصفوف الثلاثين. يمكن استخدام taskRowCount للتقسيم على صفحات بين الصفوف العشرين الأولية. لتوسيع التقرير وتضمين بيانات من جميع الصفوف الثلاثين، يمكن إنشاء مهمة تقرير جديدة باستخدام totalRowCount للوصول إلى المجموعة الكاملة التي تبلغ قيمتها 30 صفًا من البيانات.

الحالة

حالة المعالجة

عمليات التعداد
STATE_UNSPECIFIED لن يتم استخدام الحالة غير المحدّدة أبدًا.
CREATING يتم إنشاء التقرير حاليًا وسيكون متاحًا في المستقبل. يحدث الإنشاء فورًا بعد استدعاء CreateReport.
ACTIVE تم إنشاء التقرير بالكامل وهو جاهز للاستعلام.
FAILED تعذّر إنشاء التقرير.

الطُرق

create

يبدأ إنشاء مهمة تقرير.

get

عرض البيانات الوصفية للتقرير حول مهمة محددة في التقرير

list

يسرد جميع مهام التقارير لأحد المواقع.

query

استرداد محتوى مهمة التقرير