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)

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

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

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

بغض النظر عن إعداد 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(country, ", ", city).

DimensionExpression

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

تمثيل JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "lowerCase": {
    object (CaseExpression)
  },
  "upperCase": {
    object (CaseExpression)
  },
  "concatenate": {
    object (ConcatenateExpression)
  }
  // End of mutually exclusive fields.
}
الحقول
حدِّد نوعًا واحدًا من تعبيرات السمة لـ DimensionExpression. في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
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 = "الولايات المتحدة، فرنسا" وقيمة السمة 2 = "اليابان" وفاصلة = ","، سيتضمّن الردّ "الولايات المتحدة، فرنسا، اليابان".

المقياس

القياسات الكمّية للتقرير على سبيل المثال، المقياس 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
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "andGroup": {
    object (FilterExpressionList)
  },
  "orGroup": {
    object (FilterExpressionList)
  },
  "notExpression": {
    object (FilterExpression)
  },
  "filter": {
    object (Filter)
  }
  // End of mutually exclusive fields.
}
الحقول
حدِّد نوعًا واحدًا من تعبيرات الفلتر لـ FilterExpression. في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
andGroup

object (FilterExpressionList)

تتضمّن FilterExpressions في andGroup علاقة AND.

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,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  },
  "emptyFilter": {
    object (EmptyFilter)
  }
  // End of mutually exclusive fields.
}
الحقول
fieldName

string

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

حدِّد نوعًا واحدًا من الفلاتر لـ Filter. في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
stringFilter

object (StringFilter)

فلتر السلاسل ذات الصلة

inListFilter

object (InListFilter)

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

numericFilter

object (NumericFilter)

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

betweenFilter

object (BetweenFilter)

فلتر للبحث بين قيمتين

emptyFilter

object (EmptyFilter)

فلتر للقيم الفارغة، مثل القيم (not set) و""

نهاية الحقول التي يستبعد كلّ منها الآخر

StringFilter

فلتر السلسلة

تمثيل JSON
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
الحقول
matchType

enum (MatchType)

نوع المطابقة لهذا الفلتر.

value

string

تمثّل قيمة السلسلة المستخدَمة للمطابقة.

caseSensitive

boolean

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

MatchType

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

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

InListFilter

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

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

string

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

caseSensitive

boolean

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

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
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "int64Value": string,
  "doubleValue": number
  // End of mutually exclusive fields.
}
الحقول
إحدى القيم الرقمية التالية هي قائمة بالحقول التي لا يمكن استخدامها معًا. سيتم ضبط حقل واحد على الأكثر في الردّ:
int64Value

string (int64 format)

قيمة العدد الصحيح

doubleValue

number

قيمة مزدوجة

نهاية الحقول التي يستبعد كلّ منها الآخر

BetweenFilter

للتعبير عن أنّ النتيجة يجب أن تكون بين رقمَين (بما في ذلك الرقمَين).

تمثيل JSON
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
الحقول
fromValue

object (NumericValue)

يبدأ بهذا الرقم.

toValue

object (NumericValue)

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

EmptyFilter

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

فلترة القيم الفارغة تطابق قيم السمات التي تكون قيمها "" أو (not set). استخدِم هذا الفلتر لمطابقة الصفوف التي تتضمّن قيم سمات غير متوفّرة أو غير مكتملة، أو اجمعه مع notExpression لاستبعادها من التقرير بدون الفلترة لكلّ من "" و(not set) بشكل منفصل.

MetricAggregation

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

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

OrderBy

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "metric": {
    object (MetricOrderBy)
  },
  "dimension": {
    object (DimensionOrderBy)
  }
  // End of mutually exclusive fields.
}
الحقول
desc

boolean

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

حدِّد نوعًا واحدًا من ترتيب النتائج حسب OrderBy. في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
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

في حال ضبط القيمة على "صحيح"، يتم تجميع النتائج من يوم التفاعل الأول إلى يوم الانتهاء. غير متاح في 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

يستخدم المعيار 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"

taskRowCount

integer

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

errorMessage

string

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

totalRowCount

integer

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

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

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

ولاية

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

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

الطُرق

create

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

get

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

list

تعرض هذه الطريقة جميع مهام التقارير لموقع معيّن.

query

يستردّ هذا الإجراء محتوى مهمة تقرير.