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,
  "samplingLevel": enum (SamplingLevel)
}
الحقول
dimensions[]

object (Dimension)

اختيارية: السمات المطلوبة والمعروضة

metrics[]

object (Metric)

اختيارية: المقاييس المطلوبة والمعروضة

dateRanges[]

object (DateRange)

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

dimensionFilter

object (FilterExpression)

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

metricFilter

object (FilterExpression)

اختيارية: عبارة الفلتر للمقاييس يتم تطبيقها بعد تجميع صفوف التقرير، تمامًا مثل عبارة having في SQL. لا يمكن استخدام السمات في هذا الفلتر.

offset

string (int64 format)

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

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

limit

string (int64 format)

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

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

metricAggregations[]

enum (MetricAggregation)

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

orderBys[]

object (OrderBy)

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

currencyCode

string

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

cohortSpec

object (CohortSpec)

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

keepEmptyRows

boolean

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

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

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

samplingLevel

enum (SamplingLevel)

اختيارية: مستوى أخذ العينات في التقرير

السمة

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

تمثيل 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(البلد, ", ", المدينة).

DimensionExpression

تُستخدَم للتعبير عن سمة هي نتيجة صيغة تتضمّن سمات متعددة. أمثلة على الاستخدامات: 1) lowerCase(السمة) 2) concatenate(السمة1, الرمز, السمة2).

تمثيل 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(البلد, ", ", المدينة).

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 بعلاقة AND.

orGroup

object (FilterExpressionList)

ترتبط FilterExpressions في orGroup بعلاقة OR.

notExpression

object (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)
  },
  "emptyFilter": {
    object (EmptyFilter)
  }
  // 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)

فلتر للقيم التي تتراوح بين قيمتَين

emptyFilter

object (EmptyFilter)

فلتر للقيم الفارغة، مثل "(غير محدّد)" و ""

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)

يبدأ بالرقم ‎1.

toValue

object (NumericValue)

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

EmptyFilter

لا يحتوي هذا النوع على أي حقول.

فلتِر القيم الفارغة.

MetricAggregation

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

عمليات التعداد
METRIC_AGGREGATION_UNSPECIFIED عامل تشغيل غير محدّد
TOTAL عامل التشغيل SUM
MINIMUM عامل تشغيل الحد الأدنى
MAXIMUM عامل التشغيل "أقصى"
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 ترتيب أبجدي رقمي حسب قيمة موضع رمز Unicode على سبيل المثال، "2" < "أ" < "س" < "ب" < "ز".
CASE_INSENSITIVE_ALPHANUMERIC ترتيب أبجدي رقمي غير حسّاس لحالة الأحرف حسب قيمة موضع رمز يونيكود بحالة الأحرف الصغيرة على سبيل المثال، "2" < "أ" < "ب" < "س" < "ص".
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.

SamplingLevel

فئات مستويات تحليل عيّنات الطلبات

عمليات التعداد
SAMPLING_LEVEL_UNSPECIFIED نوع غير محدّد
LOW تُطبّق مستوى أخذ عينات يبلغ 10 مليون على المواقع العادية و100 مليون على مواقع "إحصاءات Google‏ 360".
MEDIUM ميزة حصرية لمواقع "إحصاءات Google‏ 360" التي تبلغ فيها نسبة تحليل العينات مليارًا.
UNSAMPLED حصري لمواقع "إحصاءات Google‏ 360" إنّ الاستكشافات غير المستندة إلى عيّنات أكثر دقة ويمكن أن تكشف عن إحصاءات لا تظهر في الاستكشافات العادية. لمزيد من المعلومات، يُرجى الاطّلاع على https://support.google.com/analytics/answer/10896953.

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، ما يشير إلى توفّر بيانات لجميع الصفوف الـ 30. يمكن استخدام taskRowCount لإنشاء صفحات من خلال الصفوف العشرين الأولى. لتوسيع التقرير وتضمين بيانات من جميع الصفوف الـ 30، يمكن إنشاء مهمة تقرير جديدة باستخدام totalRowCount للوصول إلى المجموعة الكاملة من بيانات الصفوف الـ 30.

الحالة

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

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

الطُرق

create

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

get

تحصل هذه الطريقة على بيانات وصفية للتقرير حول مهمة تقرير معيّنة.

list

يسرد جميع مهام التقارير لموقع معيّن.

query

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