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

اختياريّ. في حال كانت القيمة 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 
{

  // 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 = "الولايات المتحدة، فرنسا"، وقيمة السمة 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 
{

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

لا يكون 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)

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

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)

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

EmptyFilter

لا يتضمّن هذا النوع أي حقول.

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

MetricAggregation

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

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

OrderBy

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

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

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