- المورد: ReportTask
- ReportDefinition
- السمة
- DimensionExpression
- CaseExpression
- ConcatenateExpression
- المقياس
- DateRange
- FilterExpression
- FilterExpressionList
- الفلتر
- StringFilter
- MatchType
- InListFilter
- NumericFilter
- العملية
- NumericValue
- BetweenFilter
- MetricAggregation
- OrderBy
- MetricOrderBy
- DimensionOrderBy
- OrderType
- CohortSpec
- المجموعة النموذجية
- CohortsRange
- درجة الدقة
- CohortReportSettings
- ReportMetadata
- الولاية
- الطُرق
المورد: ReportTask
هو عملية ضبط مهمة خاصة بالتقارير.
تمثيل JSON |
---|
{ "name": string, "reportDefinition": { object ( |
الحقول | |
---|---|
name |
النتائج فقط. المُعرّف. اسم مورد مهمة التقرير الذي تمّ تعيينه أثناء الإنشاء. التنسيق: "Properties/{property}/reportTasks/{reportTask}" |
reportDefinition |
اختياريّ. تعريف تقرير لاسترجاع بيانات التقرير، ويصف بنية التقرير وعادةً ما يتضمّن الحقول التي سيتمّ تضمينها في التقرير والمعايير التي سيتمّ استخدامها لفلترة البيانات. |
reportMetadata |
النتائج فقط. البيانات الوصفية للتقرير لمهمة تقرير محددة، والتي توفر معلومات حول التقرير وهي تتضمن عادةً المعلومات التالية: اسم المورد للتقرير وحالة التقرير والطابع الزمني لإنشاء التقرير وغير ذلك. |
ReportDefinition
تمثّل هذه السمة تعريفًا لكيفية تشغيل التقرير.
تمثيل JSON |
---|
{ "dimensions": [ { object ( |
الحقول | |
---|---|
dimensions[] |
اختياريّ. السمات المطلوبة والمعروضة |
metrics[] |
اختياريّ. المقاييس المطلوبة والمعروضة |
dateRanges[] |
اختياريّ. النطاقات الزمنية للبيانات المطلوب قراءتها في حال طلب نطاقات زمنية متعددة، سيحتوي كل صف استجابة على فهرس نطاق زمني يستند إلى صفر. وفي حال تداخل نطاقَين زمنيَين، يتم تضمين بيانات الأحداث للأيام المتداخلة في صفوف الردود لكلا النطاقَين الزمنيَين. في طلب المجموعة النموذجية، يجب عدم تحديد قيمة |
dimensionFilter |
اختياريّ. تتيح لك فلاتر السمات طلب قيم سمات معيّنة فقط في التقرير. لمزيد من المعلومات، اطّلِع على أساسيات فلاتر السمات للحصول على أمثلة. لا يمكن استخدام المقاييس في هذا الفلتر. |
metricFilter |
اختياريّ. عبارة تصفية المقاييس. يتم تطبيقها بعد تجميع صفوف التقرير، على غرار لغة SQL التي تحتوي على عبارة. لا يمكن استخدام الأبعاد في هذا الفلتر. |
offset |
اختياريّ. عدد صفوف صف البداية من مساحة تخزين "إحصاءات Google" يتم احتساب الصف الأول على أنه الصف 0. عند إنشاء مهمة تقرير، تحدِّد المَعلمتَان |
limit |
اختياريّ. عدد الصفوف المطلوب عرضها في التقرير. في حال عدم تحديد قيمة الحقل، سيتم عرض 10,000 صف. تعرض واجهة برمجة التطبيقات 250,000 صف كحدٍ أقصى لكل طلب، بغض النظر عن عدد الصفوف التي تطلبها. يجب أن تكون قيمة ويمكن أن تعرض واجهة برمجة التطبيقات أيضًا صفوفًا أقل من قيمة |
metricAggregations[] |
اختياريّ. تجميع المقاييس. ستظهر قيم المقاييس المجمّعة في صفوف تم فيها ضبط قيم السمة على RESERVED_(MetricAggregation)". |
orderBys[] |
اختياريّ. لتحديد كيفية ترتيب الصفوف في الردّ. |
currencyCode |
اختياريّ. رمز عملة بتنسيق ISO4217، مثل "AED" و"USD" و"JPY". إذا كان الحقل فارغًا، يستخدِم التقرير العملة التلقائية للموقع. |
cohortSpec |
اختياريّ. المجموعة النموذجية المرتبطة بهذا الطلب. إذا كانت هناك مجموعة نموذجية في الطلب، تحتوي "المجموعة النموذجية" أن يكون متوفرًا. |
keepEmptyRows |
اختياريّ. إذا كانت القيمة "خطأ" أو "غير محدّدة"، لن يتم عرض كل صف يحتوي على جميع المقاييس التي تساوي 0. إذا كانت القيمة true، فسيتم عرض هذه الصفوف إذا لم تتم إزالتها بشكل منفصل بواسطة عامل تصفية. بغض النظر عن إعداد على سبيل المثال، إذا لم يسجِّل أحد المواقع حدث |
السمة
تمثِّل هذه السمات بياناتك. على سبيل المثال، تشير سمة "المدينة" إلى المدينة التي نشأ منها الحدث. قيم السمات في الردود على التقارير هي سلاسل. على سبيل المثال، يمكن أن تكون المدينة "القاهرة" أو "نيويورك".
تمثيل JSON |
---|
{
"name": string,
"dimensionExpression": {
object ( |
الحقول | |
---|---|
name |
اسم السمة. اطّلِع على سمات واجهة برمجة التطبيقات للاطّلاع على قائمة بأسماء السمات المتوافقة مع طرق إعداد التقارير الأساسية مثل إذا تم تحديد تتم الإشارة إلى السمات من قِبل |
dimensionExpression |
يمكن أن تكون سمة واحدة نتيجة تعبير عن سمات متعدّدة. على سبيل المثال، السمة "البلد, المدينة": concatenate(country, ", ", city). |
DimensionExpression
يُستخدَم للتعبير عن سمة تكون نتيجة صيغة سمات متعدّدة. أمثلة على الاستخدامات: 1) LowCase(dimension) 2) concatenate(dimension1, icon, dimension2).
تمثيل JSON |
---|
{ // Union field |
الحقول | |
---|---|
حقل الاتحاد one_expression . حدِّد نوعًا واحدًا من تعبيرات السمة DimensionExpression . يمكن أن يكون one_expression واحدًا فقط مما يلي: |
|
lowerCase |
تُستخدَم لتحويل قيمة السمة إلى أحرف صغيرة. |
upperCase |
تُستخدَم لتحويل قيمة السمة إلى أحرف كبيرة. |
concatenate |
تُستخدَم لدمج قيم السمات في سمة واحدة. على سبيل المثال، السمة "البلد, المدينة": concatenate(country, ", ", city). |
CaseExpression
يُستخدَم لتحويل قيمة السمة إلى حالة واحدة.
تمثيل JSON |
---|
{ "dimensionName": string } |
الحقول | |
---|---|
dimensionName |
اسم السمة. ويجب أن يشير الاسم إلى اسم في حقل الأبعاد ضِمن الطلب. |
ConcatenateExpression
تُستخدَم لدمج قيم السمات في سمة واحدة.
تمثيل JSON |
---|
{ "dimensionNames": [ string ], "delimiter": string } |
الحقول | |
---|---|
dimensionNames[] |
أسماء السمات. ويجب أن تشير الأسماء إلى الأسماء في حقل الأبعاد ضمن الطلب. |
delimiter |
المُحدِّد الموضوع بين أسماء السمات. غالبًا ما تكون المحدِّدات عبارة عن أحرف مفردة مثل "|". أو "," ولكن يمكن أن تكون سلاسل أطول. وإذا كانت قيمة السمة تحتوي على المُحدِّد، سيتم عرضهما استجابةً بدون فرق. على سبيل المثال، إذا كانت قيمة السمة 1 = "US,FR" وقيمة السمة 2 = "JP"، والمحدِّد = ","، ستتضمّن الاستجابة "US,FR,JP". |
المقياس
القياسات الكمية لتقرير ما. على سبيل المثال، المقياس "eventCount
" هو إجمالي عدد الأحداث. يُسمح بالطلبات على ما يصل إلى 10 مقاييس.
تمثيل JSON |
---|
{ "name": string, "expression": string, "invisible": boolean } |
الحقول | |
---|---|
name |
اسم المقياس. اطّلِع على مقاييس واجهة برمجة التطبيقات للاطّلاع على قائمة بأسماء المقاييس المتاحة في طرق إعداد التقارير الأساسية مثل إذا تم تحديد تتم الإحالة إلى المقاييس من قِبل |
expression |
تمثّل هذه السمة تعبيرًا حسابيًا للمقاييس الناتجة. على سبيل المثال، مقياس عدد الأحداث لكل مستخدم هو |
invisible |
يشير إلى ما إذا كان المقياس غير مرئي في ردّ التقرير. إذا كان المقياس غير مرئي، لن ينتج عنه عمود في الردّ، ولكن يمكن استخدامه في |
DateRange
مجموعة متجاورة من الأيام: startDate
، startDate + 1
، ...، endDate
. يُسمح بالطلبات لما يصل إلى 4 نطاقات زمنية.
تمثيل JSON |
---|
{ "startDate": string, "endDate": string, "name": string } |
الحقول | |
---|---|
startDate |
تاريخ البدء الشامل لطلب البحث بالتنسيق |
endDate |
تاريخ الانتهاء الشامل لطلب البحث بالتنسيق |
name |
لتعيين اسم لهذا النطاق الزمني. يتمّ تحديد قيمة السمة |
FilterExpression
للتعبير عن فلاتر السمات أو المقاييس. يلزم أن تكون الحقول في نفس FilterExpression إما جميع الأبعاد أو جميع المقاييس.
تمثيل JSON |
---|
{ // Union field |
الحقول | |
---|---|
حقل الاتحاد expr . حدِّد نوعًا واحدًا من تعبير الفلتر للسمة FilterExpression . يمكن أن يكون expr واحدًا فقط مما يلي: |
|
andGroup |
ترتبط عناصر filterExpressions في andGroup بعلاقة AND. |
orGroup |
تتوفر علاقة OR. |
notExpression |
لا يعتبر عامل التصفية بتغيير التعبير "notExpression". |
filter |
فلتر أساسي. وفي نفس الفلتر، يجب أن تكون جميع أسماء حقول الفلتر إما كل الأبعاد أو جميع المقاييس. |
FilterExpressionList
قائمة بتعبيرات الفلاتر
تمثيل JSON |
---|
{
"expressions": [
{
object ( |
الحقول | |
---|---|
expressions[] |
قائمة بتعبيرات الفلاتر |
تصفية
تعبير لفلترة قيم السمات أو المقاييس
تمثيل JSON |
---|
{ "fieldName": string, // Union field |
الحقول | |
---|---|
fieldName |
اسم السمة أو اسم المقياس. يجب أن يكون اسمًا محدّدًا في السمات أو المقاييس. |
حقل الاتحاد one_filter . حدِّد نوع فلتر واحدًا لـ Filter . يمكن أن يكون one_filter واحدًا فقط مما يلي: |
|
stringFilter |
الفلتر المرتبط بالسلاسل |
inListFilter |
فلتر لقيم القائمة. |
numericFilter |
فلتر للقيم الرقمية أو قيم التاريخ. |
betweenFilter |
عامل تصفية للقيم بين قيمتين. |
StringFilter
فلتر السلسلة
تمثيل JSON |
---|
{
"matchType": enum ( |
الحقول | |
---|---|
matchType |
نوع المطابقة لهذا الفلتر. |
value |
قيمة السلسلة المستخدمة للمطابقة. |
caseSensitive |
إذا كانت القيمة هي true، تكون قيمة السلسلة حسّاسة لحالة الأحرف. |
MatchType
نوع المطابقة لفلتر سلسلة
عمليات التعداد | |
---|---|
MATCH_TYPE_UNSPECIFIED |
غير محدّد |
EXACT |
مطابقة تامة لقيمة السلسلة. |
BEGINS_WITH |
تبدأ بقيمة السلسلة. |
ENDS_WITH |
ينتهي بقيمة السلسلة. |
CONTAINS |
يحتوي على قيمة السلسلة. |
FULL_REGEXP |
المطابقة الكاملة للتعبير العادي مع قيمة السلسلة. |
PARTIAL_REGEXP |
مطابقة جزئية للتعبير العادي مع قيمة السلسلة. |
InListFilter
ويجب أن تكون النتيجة في قائمة من قيم السلسلة.
تمثيل JSON |
---|
{ "values": [ string ], "caseSensitive": boolean } |
الحقول | |
---|---|
values[] |
قائمة قيم السلسلة. يجب ألا يكون الحقل فارغًا. |
caseSensitive |
إذا كانت القيمة هي true، تكون قيمة السلسلة حسّاسة لحالة الأحرف. |
NumericFilter
فلاتر للقيم الرقمية أو قيم التاريخ.
تمثيل JSON |
---|
{ "operation": enum ( |
الحقول | |
---|---|
operation |
نوع العملية لهذا الفلتر. |
value |
قيمة عددية أو قيمة تاريخ. |
العملية
العملية المطبقة على فلتر رقمي
عمليات التعداد | |
---|---|
OPERATION_UNSPECIFIED |
غير محدد |
EQUAL |
يساوي |
LESS_THAN |
أقل من |
LESS_THAN_OR_EQUAL |
أقل من أو يساوي |
GREATER_THAN |
أكبر من |
GREATER_THAN_OR_EQUAL |
أكبر من أو يساوي |
NumericValue
لتمثيل رقم.
تمثيل JSON |
---|
{ // Union field |
الحقول | |
---|---|
حقل الاتحاد one_value . يمكن أن تكون قيمة إحدى القيم الرقمية one_value واحدة فقط مما يلي: |
|
int64Value |
قيمة عدد صحيح |
doubleValue |
قيمة مزدوجة |
BetweenFilter
للتعبير عن أن النتيجة يجب أن تكون بين رقمين (شامل).
تمثيل JSON |
---|
{ "fromValue": { object ( |
الحقول | |
---|---|
fromValue |
يبدأ بهذا الرقم. |
toValue |
ينتهي بهذا الرقم. |
MetricAggregation
يمثل تجميع المقاييس.
عمليات التعداد | |
---|---|
METRIC_AGGREGATION_UNSPECIFIED |
عامل تشغيل غير محدَّد |
TOTAL |
SUM. |
MINIMUM |
الحد الأدنى لمشغّل شبكة الجوّال. |
MAXIMUM |
الحد الأقصى للمشغل. |
COUNT |
عامل تشغيل العدد. |
ترتيب
تحدد "الترتيب حسب" كيفية فرز الصفوف في الرد. على سبيل المثال، ترتيب الصفوف حسب عدد الأحداث تنازليًا هو ترتيب واحد، بينما يختلف ترتيب الصفوف حسب سلسلة اسم الحدث.
تمثيل JSON |
---|
{ "desc": boolean, // Union field |
الحقول | |
---|---|
desc |
إذا كانت القيمة هي true، يمكنك الترتيب تنازليًا. |
حقل الاتحاد one_order_by . حدِّد نوع طلب واحدًا في OrderBy . يمكن أن يكون one_order_by واحدًا فقط مما يلي: |
|
metric |
يعمل هذا الخيار على ترتيب النتائج حسب قيم المقياس. |
dimension |
ترتب النتائج حسب قيم السمة. |
MetricOrderBy
الترتيب حسب قيم المقياس
تمثيل JSON |
---|
{ "metricName": string } |
الحقول | |
---|---|
metricName |
تمثّل هذه السمة اسم مقياس في الطلب للطلب. |
DimensionOrderBy
ويتم الترتيب حسب قيم السمات.
تمثيل JSON |
---|
{
"dimensionName": string,
"orderType": enum ( |
الحقول | |
---|---|
dimensionName |
اسم سمة في الطلب لتقديم الطلب وفقًا لها. |
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 ( |
الحقول | |
---|---|
cohorts[] |
تُحدِّد معايير الاختيار لتجميع المستخدمين في مجموعات نموذجية. وتُحدِّد معظم تقارير المجموعات النموذجية مجموعة نموذجية واحدة فقط. في حال تحديد مجموعات نموذجية متعددة، يمكن التعرّف على كل مجموعة نموذجية في التقرير حسب اسمها. |
cohortsRange |
تتبع تقارير المجموعات النموذجية المجموعات النموذجية على مدار نطاق زمني موسع لإعداد التقارير. يحدّد هذا النطاق مدة إزاحة لمتابعة المجموعات النموذجية خلالها. |
cohortReportSettings |
إعدادات اختيارية لتقرير المجموعة النموذجية. |
المجموعة النموذجية
تحدد معايير اختيار المجموعة النموذجية. المجموعة النموذجية هي مجموعة من المستخدمِين لهم سمة مشترَكة. على سبيل المثال، ينتمي المستخدمون الذين لديهم سمة firstSessionDate
نفسها إلى المجموعة النموذجية نفسها.
تمثيل JSON |
---|
{
"name": string,
"dimension": string,
"dateRange": {
object ( |
الحقول | |
---|---|
name |
يعيّن اسمًا لهذه المجموعة النموذجية. يتمّ تحديد قيمة السمة |
dimension |
السمة التي تستخدمها المجموعة النموذجية. مطلوبة ولا تتوافق إلا مع |
dateRange |
وتختار المجموعة النموذجية المستخدمين الذين يقع تاريخ اللمس الأول بين تاريخ البدء وتاريخ الانتهاء المحدّدين في في طلب المجموعة النموذجية، تكون السمة يجب أن يتماشى نوع |
CohortsRange
تضبط هذه السياسة النطاق الزمني الموسَّع لإعداد التقارير في تقرير مجموعة نموذجية. يُحدِّد مدة معادلة لمتابعة المجموعات النموذجية.
تمثيل JSON |
---|
{
"granularity": enum ( |
الحقول | |
---|---|
granularity |
مطلوب. الدقة المستخدَمة لتفسير |
startOffset |
تحدّد السمة إذا كانت قيمة إذا كانت قيمة إذا كانت قيمة |
endOffset |
مطلوب. تحدّد السمة إذا كانت قيمة إذا كانت قيمة إذا كانت قيمة |
الدقة
الدقة المستخدَمة لتفسير startOffset
وendOffset
للنطاق الزمني الموسَّع لإعداد التقارير في تقرير مجموعة نموذجية
عمليات التعداد | |
---|---|
GRANULARITY_UNSPECIFIED |
لا يجب تحديدها مطلقًا. |
DAILY |
الدقة اليومية. ويشيع استخدام هذه السمة إذا كانت السمة dateRange للمجموعة النموذجية هي يوم واحد وكان الطلب يحتوي على السمة cohortNthDay . |
WEEKLY |
الدقة الأسبوعية. ويشيع استخدام هذه السمة إذا كانت مدة dateRange للمجموعة النموذجية أسبوعًا (تبدأ يوم الأحد وتنتهي يوم السبت) ويتضمّن الطلب cohortNthWeek . |
MONTHLY |
الدقة الشهرية. ويشيع استخدام هذه السمة إذا كانت مدة السمة dateRange للمجموعة النموذجية هي شهر وكان الطلب يحتوي على cohortNthMonth . |
CohortReportSettings
الإعدادات الاختيارية لتقرير المجموعة النموذجية.
تمثيل JSON |
---|
{ "accumulate": boolean } |
الحقول | |
---|---|
accumulate |
إذا كانت القيمة هي "صحيح"، يتم تجميع النتائج من يوم اللمس الأول إلى يوم الانتهاء. غير متاح في |
ReportMetadata
البيانات الوصفية للتقرير لمهمة محددة في التقرير
تمثيل JSON |
---|
{
"creationQuotaTokensCharged": integer,
"state": enum ( |
الحقول | |
---|---|
creationQuotaTokensCharged |
النتائج فقط. إجمالي رموز الحصة المميّزة التي تم تحصيلها أثناء إنشاء التقرير. بما أنّ عدد الرموز المميّزة هذا يعتمد على النشاط من حالة |
state |
النتائج فقط. الحالة الحالية لمهمة التقرير هذه |
beginCreatingTime |
النتائج فقط. وقت استدعاء الدالة طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: |
taskRowCount |
النتائج فقط. إجمالي عدد الصفوف في نتيجة التقرير. ستتم تعبئة هذا الحقل عندما تكون الولاية نشطة. يمكنك استخدام السمة |
errorMessage |
النتائج فقط. تتم تعبئة رسالة خطأ إذا تعذَّر تنفيذ مهمة تقرير أثناء الإنشاء. |
totalRowCount |
النتائج فقط. إجمالي عدد الصفوف في مساحة تخزين "إحصاءات Google". إذا كنت تريد إجراء طلبات بحث في صفوف بيانات إضافية خارج التقرير الحالي، يمكن لتلك الصفوف بدء مهمة تقرير جديدة استنادًا إلى يمثّل على سبيل المثال، لنفترض أنّ قيمة |
الحالة
حالة المعالجة.
عمليات التعداد | |
---|---|
STATE_UNSPECIFIED |
ولن يتم مطلقًا استخدام الحالة غير المحدّدة. |
CREATING |
يتم إنشاء التقرير حاليًا وسيصبح متاحًا في المستقبل. يحدث الإنشاء مباشرةً بعد استدعاء CreateReport. |
ACTIVE |
تم إنشاء التقرير بالكامل وهو جاهز لإرسال طلبات البحث. |
FAILED |
تعذّر إنشاء التقرير. |
الطُرق |
|
---|---|
|
يبدأ في إنشاء مهمة تقرير. |
|
الحصول على بيانات وصفية للتقرير حول مهمة تقرير محدّدة |
|
يسرد جميع مهام التقارير لأحد المواقع. |
|
لاسترداد محتوى مهمة تقرير. |