يصف هذا المستند العديد من الميزات المتقدّمة في الإصدار 1 من Google Analytics Data API. للحصول على مرجع تفصيلي لواجهة برمجة التطبيقات، يُرجى الاطّلاع على مرجع واجهة برمجة التطبيقات.
إدراج التعريفات المخصّصة وإنشاء التقارير
يمكن لواجهة Data API إنشاء تقارير عن السمات المخصّصة والمقاييس المخصّصة المسجّلة. يمكن استخدام طريقة Metadata API لعرض أسماء واجهة برمجة التطبيقات للتعريفات المخصّصة المسجّلة في موقعك. يمكن استخدام أسماء واجهة برمجة التطبيقات هذه في طلبات التقارير إلى طريقة runReport على سبيل المثال.
تعرض الأقسام التالية أمثلة لكل نوع من أنواع التعريفات المخصّصة. في
هذه الأمثلة، استبدِل GA_PROPERTY_ID برقم تعريف موقعك.
السمات المخصّصة على مستوى الحدث
الخطوة 1: أرسِل طلب بحث إلى طريقة Metadata API باستخدام رقم تعريف موقعك.
GET https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/metadata
الخطوة 2: ابحث عن السمة المخصّصة على مستوى الحدث التي تريد إنشاء تقارير عنها من الردّ. إذا لم تكن السمة متوفّرة، عليك تسجيلها.
"dimensions": [
...
{
"apiName": "customEvent:achievement_id",
"uiName": "Achievement ID",
"description": "An event scoped custom dimension for your Analytics property."
},
...
],
الخطوة 3: تضمين السمة المخصّصة في طلب تقرير في ما يلي نموذج طلب لطريقة runReport.
POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
"dateRanges": [{ "startDate": "2020-09-01", "endDate": "2020-09-15" }],
"dimensions": [{ "name": "customEvent:achievement_id" }],
"metrics": [{ "name": "eventCount" }]
}
السمات المخصّصة على مستوى المستخدم
الخطوة 1: أرسِل طلب بحث إلى طريقة Metadata API باستخدام رقم تعريف موقعك.
GET https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/metadata
الخطوة 2: ابحث عن السمة المخصّصة على مستوى المستخدِم التي تريد إنشاء تقارير عنها من الردّ. إذا لم تكن السمة متوفّرة، عليك تسجيلها.
"dimensions": [
...
{
"apiName": "customUser:last_level",
"uiName": "Last level",
"description": "A user property for your Analytics property."
},
...
],
الخطوة 3: تضمين السمة المخصّصة في طلب تقرير في ما يلي نموذج طلب لطريقة runReport.
POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
"entity": { "propertyId": "GA_PROPERTY_ID" },
"dateRanges": [{ "startDate": "7daysAgo", "endDate": "yesterday" }],
"dimensions": [{ "name": "customUser:last_level" }],
"metrics": [{ "name": "activeUsers" }]
}
المقاييس المخصّصة على مستوى الحدث
الخطوة 1: أرسِل طلب بحث إلى طريقة Metadata API باستخدام رقم تعريف موقعك.
GET https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/metadata
الخطوة 2: ابحث عن المقياس المخصّص على مستوى الحدث الذي تريد إنشاء تقارير عنه من الاستجابة. إذا لم يكن المقياس متوفّرًا، عليك تسجيله.
"metrics": [
...
{
"apiName": "customEvent:credits_spent",
"uiName": "Credits Spent",
"description": "An event scoped custom metric for your Analytics property.",
"type": "TYPE_STANDARD"
},
...
],
الخطوة 3: تضمين المقياس المخصّص في طلب تقرير في ما يلي نموذج طلب لطريقة runReport.
POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
"dateRanges": [{ "startDate": "30daysAgo", "endDate": "yesterday" }],
"dimensions": [{ "name": "eventName" }],
"metrics": [{ "name": "customEvent:credits_spent" }]
}
مقاييس معدّل الأحداث الرئيسية لحدث رئيسي واحد
الخطوة 1: أرسِل طلب بحث إلى Metadata API Method باستخدام رقم تعريف موقعك.
GET https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/metadata
الخطوة 2: ابحث عن مقياس معدّل الأحداث الرئيسية لحدث رئيسي واحد تريد إنشاء تقارير عنه من الاستجابة. إذا لم يظهر الحدث الرئيسي، عليك إعداده.
"metrics": [
...
{
"apiName": "sessionKeyEventRate:add_to_cart",
"uiName": "Session key event rate for add_to_cart",
"description": "The percentage of sessions in which a specific key event was triggered",
},
...
],
الخطوة 3: أدرِج مقياس معدّل الأحداث الرئيسية في طلب تقرير. في ما يلي نموذج لطلب إلى طريقة runReport.
POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
"dateRanges": [{ "startDate": "30daysAgo", "endDate": "yesterday" }],
"dimensions": [{ "name": "eventName" }],
"metrics": [{ "name": "sessionKeyEventRate:add_to_cart" }]
}
متوسطات المقاييس المخصّصة على مستوى الحدث
الخطوة 1: أرسِل طلب بحث إلى طريقة Metadata API باستخدام رقم تعريف موقعك.
GET https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/metadata
الخطوة 2: ابحث عن متوسط المقياس المخصّص على مستوى الحدث الذي تريد إنشاء تقارير عنه من الاستجابة. إذا لم يكن المقياس متوفّرًا، عليك تسجيله.
"metrics": [
...
{
"apiName": "averageCustomEvent:credits_spent",
"uiName": "Average Credits Spent",
"description": "The average of an event scoped custom metric for your Analytics property.",
"type": "TYPE_STANDARD"
},
...
],
الخطوة 3: أدرِج متوسط المقياس المخصّص في طلب تقرير. في ما يلي نموذج طلب لطريقة runReport.
POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
"dateRanges": [{ "startDate": "2020-11-01", "endDate": "2020-11-10" }],
"dimensions": [{ "name": "eventName" }],
"metrics": [{ "name": "averageCustomEvent:credits_spent" }]
}
أمثلة على تقارير المجموعات النموذجية
تنشئ تقارير المجموعة النموذجية سلسلة زمنية للحفاظ على المستخدمين للمجموعة النموذجية. للحصول على مستندات تفصيلية لكل حقل من حقول واجهة برمجة التطبيقات، يُرجى الاطّلاع على مرجع REST لـ CohortSpec.
إنشاء تقرير مجموعة نموذجية
في ما يلي نموذج لتقرير المجموعة النموذجية حيث:
- المجموعة النموذجية هي المستخدمون الذين لديهم
firstSessionDateمن2020-12-01، ويتم ضبط ذلك من خلال الكائنcohorts. ستستند السمات والمقاييس في استجابة التقرير إلى مستخدمي المجموعة النموذجية فقط. - سيعرض تقرير المجموعة النموذجية ثلاثة أعمدة، ويتم ضبط ذلك من خلال
عناصر السمات والمقاييس.
- السمة
cohortهي اسم المجموعة النموذجية. - السمة "
cohortNthDay" هي عدد الأيام منذ2020-12-01. - يمثّل المقياس
cohortActiveUsersعدد المستخدمين الذين لا يزالون نشطين.
- السمة
- يحدّد العنصر
cohortsRangeأنّ التقرير يجب أن يحتوي على بيانات الأحداث بدءًا من2020-12-01وحتى2020-12-06لهذه المجموعة النموذجية.- عند استخدام مستوى دقة
DAILY، يُنصح باستخدام السمةcohortNthDayلضمان الاتساق.
- عند استخدام مستوى دقة
طلب التقرير للمجموعة النموذجية هو:
POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
"dimensions": [{ "name": "cohort" }, { "name": "cohortNthDay" }],
"metrics": [{ "name": "cohortActiveUsers" }],
"cohortSpec": {
"cohorts": [
{
"dimension": "firstSessionDate",
"dateRange": { "startDate": "2020-12-01", "endDate": "2020-12-01" }
}
],
"cohortsRange": {
"endOffset": 5,
"granularity": "DAILY"
}
},
}
بالنسبة إلى هذا الطلب، إليك مثال على ردّ التقرير:
{
"dimensionHeaders": [
{ "name": "cohort" }, { "name": "cohortNthDay" }
],
"metricHeaders": [
{ "name": "cohortActiveUsers", "type": "TYPE_INTEGER" }
],
"rows": [
{
"dimensionValues": [{ "value": "cohort_0" },{ "value": "0000" }],
"metricValues": [{ "value": "293" }]
},
{
"dimensionValues": [{ "value": "cohort_0" },{ "value": "0001" }],
"metricValues": [{ "value": "143" }]
},
{
"dimensionValues": [{ "value": "cohort_0" },{ "value": "0002" }],
"metricValues": [{ "value": "123" }]
},
{
"dimensionValues": [{ "value": "cohort_0" },{ "value": "0003" }],
"metricValues": [{ "value": "92" }]
},
{
"dimensionValues": [{ "value": "cohort_0" },{ "value": "0005" }],
"metricValues": [{ "value": "86" }]
},
{
"dimensionValues": [{ "value": "cohort_0" },{ "value": "0004" }],
"metricValues": [{ "value": "83" }]
}
],
"metadata": {},
"rowCount": 6
}
من ردّ التقرير هذا، يظهر رسم بياني لتقرير المجموعة النموذجية هذا. من الرؤى المستخلصة من هذا التقرير أن أكبر انخفاض في عدد المستخدمين النشطين لهذه المجموعة النموذجية يكون بين اليوم الأول والثاني.

مجموعات نموذجية متعددة ونسبة الحفاظ على المستخدمين
يُعدّ اكتساب المستخدمين والحفاظ عليهم من طرق تطوير موقعك الإلكتروني أو تطبيقك، وتركز تقارير المجموعات النموذجية على الحفاظ على المستخدمين. في هذا المثال، يوضّح التقرير أنّ هذا الموقع الإلكتروني قد حسّن معدّل الحفاظ على المستخدمين لمدة 4 أيام بنسبة %10 على مدار أسبوعَين.
لإنشاء هذا التقرير، نحدّد ثلاث مجموعات نموذجية: الأولى بقيمة firstSessionDate تبلغ 2020-11-02، والثانية بقيمة firstSessionDate تبلغ 2020-11-09، والثالثة بقيمة firstSessionDate تبلغ 2020-11-16. بما أنّ عدد المستخدمين في موقعك سيختلف خلال هذه الأيام الثلاثة، نقارن مقياس نسبة الحفاظ على المستخدمين في المجموعة النموذجية وهو cohortActiveUsers/cohortTotalUsers بدلاً من استخدام مقياس cohortActiveUsers المباشر.
طلب التقرير لهذه المجموعات النموذجية هو:
POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
"dimensions": [{ "name": "cohort" },{ "name": "cohortNthDay" }],
"metrics": [
{
"name": "cohortRetentionFraction",
"expression": "cohortActiveUsers/cohortTotalUsers"
}
],
"cohortSpec": {
"cohorts": [
{
"dimension": "firstSessionDate",
"dateRange": { "startDate": "2020-11-02", "endDate": "2020-11-02" }
},
{
"dimension": "firstSessionDate",
"dateRange": { "startDate": "2020-11-09", "endDate": "2020-11-09" }
},
{
"dimension": "firstSessionDate",
"dateRange": { "startDate": "2020-11-16", "endDate": "2020-11-16" }
}
],
"cohortsRange": {
"endOffset": 4,
"granularity": "DAILY"
}
},
}
بالنسبة إلى هذا الطلب، إليك مثال على ردّ التقرير:
{
"dimensionHeaders": [{ "name": "cohort" },{ "name": "cohortNthDay" }],
"metricHeaders": [{
"name": "cohortRetentionFraction",
"type": "TYPE_FLOAT"
}
],
"rows": [
{
"dimensionValues": [{ "value": "cohort_0" },{ "value": "0000" }],
"metricValues": [{ "value": "1" }]
},
{
"dimensionValues": [{ "value": "cohort_1" },{ "value": "0000" }],
"metricValues": [{ "value": "1" }]
},
{
"dimensionValues": [{ "value": "cohort_2" },{ "value": "0000" }],
"metricValues": [{ "value": "1" }]
},
{
"dimensionValues": [{ "value": "cohort_2" },{ "value": "0001" }],
"metricValues": [{ "value": "0.308" }]
},
{
"dimensionValues": [{ "value": "cohort_1" },{ "value": "0001" }],
"metricValues": [{ "value": "0.272" }]
},
{
"dimensionValues": [{ "value": "cohort_2" },{ "value": "0002" }],
"metricValues": [{ "value": "0.257" }]
},
{
"dimensionValues": [{ "value": "cohort_0" },{ "value": "0001" }],
"metricValues": [{ "value": "0.248" }]
},
{
"dimensionValues": [{ "value": "cohort_2" },{ "value": "0003" }],
"metricValues": [{ "value": "0.235" }]
},
{
"dimensionValues": [{ "value": "cohort_2" },{ "value": "0004" }],
"metricValues": [{ "value": "0.211" }]
},
{
"dimensionValues": [{ "value": "cohort_1" },{ "value": "0002" }],
"metricValues": [{ "value": "0.198" }]
},
{
"dimensionValues": [{ "value": "cohort_0" },{ "value": "0002" }],
"metricValues": [{ "value": "0.172" }]
},
{
"dimensionValues": [{ "value": "cohort_1" },{ "value": "0003" }],
"metricValues": [{ "value": "0.167" }]
},
{
"dimensionValues": [{ "value": "cohort_1" },{ "value": "0004" }],
"metricValues": [{ "value": "0.155" }]
},
{
"dimensionValues": [{ "value": "cohort_0" },{ "value": "0003" }],
"metricValues": [{ "value": "0.141" }]
},
{
"dimensionValues": [{ "value": "cohort_0" },{ "value": "0004" }],
"metricValues": [{ "value": "0.118" }]
}
],
"metadata": {},
"rowCount": 15
}
من ردّ التقرير هذا، يظهر رسم بياني لتقرير المجموعة النموذجية هذا. من الإحصاءات التي يقدّمها هذا التقرير أنّ معدّل الحفاظ على المستخدمين لمدة 4 أيام قد زاد بنسبة %10 على مدار أسبوعين. تتجاوز المجموعة النموذجية اللاحقة التي تضم firstSessionDate من 2020-11-16
معدل الاحتفاظ بالمجموعة النموذجية السابقة التي تضم firstSessionDate
من 2020-11-02.

المجموعات النموذجية الأسبوعية واستخدام المجموعات النموذجية مع ميزات أخرى في واجهة برمجة التطبيقات
لإزالة التباين اليومي في سلوك المستخدمين، استخدِم المجموعات النموذجية الأسبوعية. في تقارير المجموعات النموذجية الأسبوعية، يشكّل جميع المستخدمين الذين لديهم firstSessionDate في الأسبوع نفسه المجموعة النموذجية. تبدأ الأسابيع يوم الأحد وتنتهي يوم السبت. في هذا التقرير أيضًا، نقسّم المجموعة النموذجية لمقارنة المستخدمين الذين لديهم نشاط في روسيا بالمستخدمين الذين لديهم نشاط في المكسيك. يستخدم هذا التقسيم السمة country و
dimensionFilter لمراعاة البلدَين فقط.
طلب التقرير لهذه المجموعات النموذجية هو:
POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
"dimensions": [
{ "name": "cohort" },
{ "name": "cohortNthWeek" },
{ "name": "country" }
],
"metrics": [{ "name": "cohortActiveUsers" }],
"dimensionFilter": {
"filter": {
"fieldName": "country",
"inListFilter": {
"values": [ "Russia", "Mexico" ]
}
}
},
"cohortSpec": {
"cohorts": [
{
"dimension": "firstSessionDate",
"dateRange": {
"startDate": "2020-10-04",
"endDate": "2020-10-10"
}
}
],
"cohortsRange": {
"endOffset": 5,
"granularity": "WEEKLY"
}
},
}
بالنسبة إلى هذا الطلب، إليك مثال على ردّ التقرير:
{
"dimensionHeaders": [
{ "name": "cohort" },
{ "name": "cohortNthWeek" },
{ "name": "country" }
],
"metricHeaders": [
{ "name": "cohortActiveUsers", "type": "TYPE_INTEGER" }
],
"rows": [
{
"dimensionValues": [
{ "value": "cohort_0" },{ "value": "0000" },{ "value": "Russia" }
],
"metricValues": [{ "value": "105" }]
},
{
"dimensionValues": [
{ "value": "cohort_0" },{ "value": "0000" },{ "value": "Mexico" }
],
"metricValues": [{ "value": "98" }]
},
{
"dimensionValues": [
{ "value": "cohort_0" },{ "value": "0001" },{ "value": "Mexico" }
],
"metricValues": [{ "value": "35" }]
},
{
"dimensionValues": [
{ "value": "cohort_0" },{ "value": "0002" },{ "value": "Mexico" }
],
"metricValues": [{ "value": "24" }]
},
{
"dimensionValues": [
{ "value": "cohort_0" },{ "value": "0001" },{ "value": "Russia" }
],
"metricValues": [{ "value": "23" }]
},
{
"dimensionValues": [
{ "value": "cohort_0" },{ "value": "0004" },{ "value": "Mexico" }
],
"metricValues": [{ "value": "17" }]
},
{
"dimensionValues": [
{ "value": "cohort_0" },{ "value": "0003" },{ "value": "Mexico" }
],
"metricValues": [{ "value": "15" }]
},
{
"dimensionValues": [
{ "value": "cohort_0" },{ "value": "0005" },{ "value": "Mexico" }
],
"metricValues": [{ "value": "15" }]
},
{
"dimensionValues": [
{ "value": "cohort_0" },{ "value": "0002" },{ "value": "Russia" }
],
"metricValues": [{ "value": "3" }]
},
{
"dimensionValues": [
{ "value": "cohort_0" },{ "value": "0003" },{ "value": "Russia" }
],
"metricValues": [{ "value": "1" }]
},
{
"dimensionValues": [
{ "value": "cohort_0" },{ "value": "0004" },{ "value": "Russia" }
],
"metricValues": [{ "value": "1" }]
}
],
"metadata": {},
"rowCount": 11
}
من ردّ التقرير هذا، يظهر رسم بياني لتقرير المجموعة النموذجية هذا. استنادًا إلى هذا التقرير، يحقّق هذا الموقع أداءً أفضل في الاحتفاظ بالمستخدمين الذين لديهم نشاط في المكسيك مقارنةً بالمستخدمين الذين لديهم نشاط في روسيا.

المقارنات
تساعدك المقارنات على تقييم مجموعات فرعية من البيانات جنبًا إلى جنب. يمكنك تحديد المقارنات من خلال تحديد الحقل comparisons في تعريف التقرير. تتشابه ميزة "المقارنات" في Data API مع "المقارنات" في واجهة "إحصاءات Google" الأمامية.
للحصول على مستندات تفصيلية لكل حقل في واجهة برمجة التطبيقات، يُرجى الاطّلاع على مرجع REST لـ Comparison.
إنشاء مقارنة
يمكنك إنشاء مقارنة منفصلة لكل مجموعة بيانات تريد مقارنتها. على سبيل المثال، للمقارنة بين بيانات التطبيقات والمواقع الإلكترونية، يمكنك إنشاء مقارنة لبيانات Android وiOS ومقارنة أخرى لبيانات المواقع الإلكترونية.
في ما يلي نموذج تقرير يحدّد مقارنتَين ويعرض المستخدمين النشطين مقسَّمين حسب البلد.
تستخدم المقارنة الأولى التي تحمل الاسم "زيارات التطبيق" inListFilter لمطابقة السمة platform مع القيمتَين "iOS" و "Android". تستخدم المقارنة الثانية التي تحمل اسم "حركة المرور على الموقع الإلكتروني" stringFilter لمطابقة سمة platform مع "الويب".
POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
"comparisons": [
{
"name": "App traffic",
"dimensionFilter": {
"filter": {
"fieldName": "platform",
"inListFilter": {
"values": [
"iOS",
"Android"
]
}
}
}
},
{
"name": "Web traffic",
"dimensionFilter": {
"filter": {
"fieldName": "platform",
"stringFilter": {
"matchType": "EXACT",
"value": "web"
}
}
}
}
],
"dateRanges": [
{
"startDate": "2024-05-01",
"endDate": "2024-05-15"
}
],
"dimensions": [
{
"name": "country"
}
],
"metrics": [
{
"name": "activeUsers"
}
]
}
بالنسبة إلى جميع الطلبات التي تستخدم ميزة المقارنات، تتم إضافة الحقل comparison تلقائيًا إلى التقرير الذي يتم إنشاؤه. يحتوي هذا الحقل على اسم
المقارنة المقدَّمة في الطلب.
في ما يلي نموذج مقتطف لردّ يتضمّن مقارنات:
{
"dimensionHeaders": [
{
"name": "comparison"
},
{
"name": "country"
}
],
"metricHeaders": [
{
"name": "activeUsers",
"type": "TYPE_INTEGER"
}
],
"rows": [
{
"dimensionValues": [
{
"value": "Web traffic"
},
{
"value": "United States"
}
],
"metricValues": [
{
"value": "638572"
}
]
},
{
"dimensionValues": [
{
"value": "Web traffic"
},
{
"value": "Japan"
}
],
"metricValues": [
{
"value": "376578"
}
]
},
{
"dimensionValues": [
{
"value": "App traffic"
},
{
"value": "United States"
}
],
"metricValues": [
{
"value": "79527"
}
]
},
...
],
...
}