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. إذا كانت القيمة true، فسيتم عرض هذه الصفوف إذا لم تتم إزالتها بشكل منفصل بواسطة عامل تصفية.

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

على سبيل المثال، إذا لم يسجِّل أحد المواقع حدث 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(dimension) 2) concatenate(dimension1, icon, dimension2).

تمثيل 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 بعلاقة AND.
orGroup

object (FilterExpressionList)

تتوفر علاقة OR.
notExpression

object (FilterExpression)

لا يعتبر عامل التصفية بتغيير التعبير "notExpression".
filter

object (Filter)

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

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 عامل تشغيل العدد.

ترتيب

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

تمثيل 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

إذا كانت القيمة هي true، يمكنك الترتيب تنازليًا.
حقل الاتحاد 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 الترتيب الأبجدي الرقمي غير حسّاس لحالة الأحرف حسب نقطة رمز Unicode بأحرف صغيرة. على سبيل المثال، "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

إذا كانت القيمة هي "صحيح"، يتم تجميع النتائج من يوم اللمس الأول إلى يوم الانتهاء. غير متاح في 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) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "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 لتقسيم الصفوف خلال أول 20 صفًا. لتوسيع التقرير وتضمين البيانات من جميع الصفوف الثلاثين، يمكن إنشاء مهمة تقرير جديدة باستخدام totalRowCount للوصول إلى المجموعة الكاملة المكونة من 30 صفًا من البيانات.

الحالة

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

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

الطُرق

create

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

get

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

list

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

query

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