- المورد: 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. إذا كانت القيمة "صحيح"، سيتم عرض هذه الصفوف إذا لم تتم إزالتها بشكل منفصل من خلال فلتر. بغض النظر عن إعداد على سبيل المثال، إذا لم يسجِّل أحد المواقع حدث |
السمة
تمثِّل هذه السمات بياناتك. على سبيل المثال، تشير سمة "المدينة" إلى المدينة التي نشأ منها الحدث. قيم السمات في ردود التقارير هي سلاسل؛ على سبيل المثال، يمكن أن تكون المدينة "باريس" أو "نيويورك".
تمثيل JSON |
---|
{
"name": string,
"dimensionExpression": {
object ( |
الحقول | |
---|---|
name |
اسم السمة. اطّلِع على سمات واجهة برمجة التطبيقات للحصول على قائمة بأسماء السمات المتوافقة مع طرق إعداد التقارير الأساسية مثل إذا تم تحديد تتم الإشارة إلى السمات من قِبل |
dimensionExpression |
يمكن أن تكون سمة واحدة نتيجة تعبير سمات متعددة. على سبيل المثال، البُعد "البلد، المدينة": concatenate(country, ", ", city). |
DimensionExpression
يتم استخدامه للتعبير عن سمة هي نتيجة صيغة سمات متعددة. أمثلة على الاستخدامات: 1) LowCase(السمة) 2) concatenate(dimension1, icon, feature2).
تمثيل 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. |
orGroup |
لـ FilterExpressions في orGroup علاقة OR. |
notExpression |
لا يعتبر FilterExpression ليس من notExpression. |
filter |
عامل تصفية أساسي. في FilterExpression نفسها، يجب أن تكون جميع أسماء حقول الفلتر إما كل السمات أو جميع المقاييس. |
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 |
عامل التشغيل "Count" (العدد). |
OrderBy
تحدد "الترتيب حسب" كيفية فرز الصفوف في الرد. على سبيل المثال، يكون ترتيب الصفوف حسب عدد الأحداث التنازلي هو ترتيب واحد، بينما يكون ترتيب الصفوف حسب سلسلة اسم الحدث ترتيبًا مختلفًا.
تمثيل JSON |
---|
{ "desc": boolean, // Union field |
الحقول | |
---|---|
desc |
إذا كانت الإجابة "صحيح"، يتم الترتيب تنازليًا. |
حقل الاتحاد 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 |
ترتيب أبجدي رقمي غير حساس لحالة الأحرف حسب نقطة رمز يونيكود الصغيرة. على سبيل المثال، "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 |
إذا كانت القيمة true، يتم تجميع النتيجة من يوم اللمس الأول حتى يوم الانتهاء. غير متاح في |
ReportMetadata
البيانات الوصفية للتقرير لمهمة تقرير محدّدة.
تمثيل JSON |
---|
{
"creationQuotaTokensCharged": integer,
"state": enum ( |
الحقول | |
---|---|
creationQuotaTokensCharged |
النتائج فقط. الرموز المميزة للحصة التي تم تحصيلها أثناء إنشاء التقرير بما أنّ عدد الرموز المميّزة هذا يعتمد على النشاط في حالة |
state |
النتائج فقط. الحالة الحالية لمهمة التقرير هذه. |
beginCreatingTime |
النتائج فقط. الوقت الذي تم فيه استدعاء " طابع زمني بتنسيق RFC3339 UTC "Zulu" ، مع دقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: |
taskRowCount |
النتائج فقط. إجمالي عدد الصفوف في نتيجة التقرير. ستتم تعبئة هذا الحقل عندما تكون الحالة نشطة. يمكنك استخدام |
errorMessage |
النتائج فقط. تتم تعبئة رسالة الخطأ في حال تعذُّر مهمة التقرير أثناء الإنشاء. |
totalRowCount |
النتائج فقط. إجمالي عدد الصفوف في مساحة تخزين "إحصاءات Google". إذا كنت تريد طلب صفوف بيانات إضافية خارج التقرير الحالي، يمكنها بدء مهمة تقرير جديدة استنادًا إلى يمثل على سبيل المثال، لنفترض أنّ قيمة |
الحالة
حالة المعالجة
عمليات التعداد | |
---|---|
STATE_UNSPECIFIED |
لن يتم استخدام الحالة غير المحدّدة أبدًا. |
CREATING |
يتم إنشاء التقرير حاليًا وسيكون متاحًا في المستقبل. يحدث الإنشاء فورًا بعد استدعاء CreateReport. |
ACTIVE |
تم إنشاء التقرير بالكامل وهو جاهز للاستعلام. |
FAILED |
تعذّر إنشاء التقرير. |
الطُرق |
|
---|---|
|
يبدأ إنشاء مهمة تقرير. |
|
عرض البيانات الوصفية للتقرير حول مهمة محددة في التقرير |
|
يسرد جميع مهام التقارير لأحد المواقع. |
|
استرداد محتوى مهمة التقرير |