مرجع Measurement Protocol

نظرة عامة

هناك جزءان لإرسال البيانات إلى Google Analytics باستخدام نموذج القياس:

  1. وسيلة النقل - مكان إرسال البيانات وكيفية إرسالها
  2. الحمولة - البيانات التي ترسلها

يصف هذا المستند كيفية تنسيق النقل والحمولة.

خدمة نقل

نقطة نهاية عنوان URL

يمكنك إرسال البيانات باستخدام Measurement Protocol من خلال إرسال طلبات POST لبروتوكول HTTP إلى نقطة النهاية التالية:

https://www.google-analytics.com/mp/collect

لإرسال حدث، عليك إصدار طلب POST التالي:

POST /mp/collect HTTP/1.1
HOST: www.google-analytics.com
Content-Type: application/json
<payload_data>

  • تمثل هذه الخاصية BODY للطلب. راجع الحمولة.

رموز الاستجابة

يعرض Measurement Protocol دائمًا رمز حالة 2xx في حال استلام الطلب HTTP. لا يعرض Measurement Protocol رمز خطأ إذا كانت بيانات الحمولة غير صحيحة أو إذا كانت البيانات في الحمولة غير صحيحة أو لم تتم معالجتها بواسطة "إحصاءات Google".

المحتوى

يتم إرسال البيانات إلى Google Analytics باستخدام بيانات Measurement Protocol في جزأين:

  1. معامِلات طلب البحث
  2. نص JSON POST

معامِلات طلب البحث

اسم المعلّمة الوصف

api_secret

مطلوبة. تمثّل هذه الخاصية API Secret الذي يتم إنشاؤه من خلال واجهة مستخدم "إحصاءات Google".

لإنشاء سر جديد، انتقل في واجهة مستخدم Google Analytics إلى:
المسؤول > مصادر البيانات > اختيار مصدر البيانات > بروتوكول القياس > إنشاء

ننصحك بالحفاظ على خصوصية هذه العناصر لمؤسستك. في حال نشر بروتوكول القياس من جهة العميل، عليك تدوير api_secret دوريًا لتجنب الرسائل غير المرغوب فيها بشكلٍ مفرط.

firebase_app_id

 مطلوبة. رقم تعريف تطبيق Firebase. معرّف تطبيق Firebase. يمكن العثور عليه في وحدة تحكم Firebase ضمن:
إعدادات المشروع > عام > تطبيقاتك > رقم تعريف التطبيق

measurement_id

 رقم تعريف القياس. رقم تعريف مصدر البيانات. ويمكن العثور عليها في واجهة مستخدم "إحصاءات Google" ضمن:
المشرف > مصادر البيانات > اختيار مصدر البيانات > رقم تعريف القياس

نص مشاركة JSON

المفتاح النوع الوصف

app_instance_id

 string

مطلوبة. تحدّد هذه الخاصية عملية تثبيت معيّنة لأحد تطبيقات Firebase بشكل فريد. يجب استرداد هذه القيمة من خلال حزمة تطوير البرامج (SDK) لبرنامج Firebase.

client_id

 string

مطلوبة. يحدد بشكل فريد مثيل مستخدم برنامج ويب. راجِع إرسال الحدث إلى Measurement Protocol.

user_id

 string

اختياريّ. معرّف فريد للمستخدم. اطّلِع على User-ID للتحليل من عدّة منصات للحصول على مزيد من المعلومات عن هذا المعرّف.

timestamp_micros

 number

اختياريّ. طابع زمني لنظام التشغيل Unix (بالملّي ثانية) لتحديد الوقت المطلوب لربطه بالفعالية ويجب ضبط ذلك على تسجيل الأحداث التي وقعت في الماضي فقط. يمكن إلغاء هذه القيمة من خلال user_property أو الطوابع الزمنية للأحداث. يمكن أن تكون الأحداث مؤخّرة حتى 3 أيام تقويمية حسب المنطقة الزمنية للموقع.

user_properties

 object اختياريّ. خصائص المستخدِم للقياس. اطّلِع على خصائص المستخدمين للحصول على مزيد من المعلومات.

non_personalized_ads

 boolean اختياريّ. يمكنك ضبط القيمة على true للإشارة إلى عدم استخدام هذه الأحداث للإعلانات المخصّصة.

events[]

 array مطلوبة. مصفوفة من عناصر الحدث. ويمكن إرسال ما يصل إلى 25 حدثًا لكل طلب. اطّلِع على مرجع الأحداث لمعرفة جميع الأحداث الصالحة.

events[].name

 string مطلوبة. اسم الحدث. اطّلع على مرجع الأحداث لمعرفة جميع الخيارات.

events[].params

 object اختياريّ. معلمات الحدث. راجِع الأحداث للاطّلاع على المعلّمات المقترحة لكل حدث.

تحتوي بعض الأحداث على معلمات مقترحة. اطّلع على الأحداث للحصول على المعلمات المقترحة لجميع الأحداث المدعومة.

الأسماء المحجوزة

أسماء الأحداث المحجوزة

أسماء الأحداث التالية محجوزة ولا يمكن استخدامها:

  • ad_activeview
  • ad_click
  • ad_exposure
  • ad_impression
  • ad_query
  • ad_reward
  • adunit_exposure
  • app_clear_data
  • app_exception
  • app_install
  • app_remove
  • app_store_refund
  • app_update
  • app_upgrade
  • dynamic_link_app_open
  • dynamic_link_app_update
  • dynamic_link_first_open
  • error
  • firebase_campaign
  • firebase_in_app_message_action
  • firebase_in_app_message_dismiss
  • firebase_in_app_message_impression
  • first_open
  • first_visit
  • in_app_purchase
  • notification_dismiss
  • notification_foreground
  • notification_open
  • notification_receive
  • notification_send
  • os_update
  • screen_view
  • session_start
  • user_engagement

أسماء المعلمات المحجوزة

أسماء المعلمات التالية محجوزة ولا يمكن استخدامها:

  • firebase_conversion

بالإضافة إلى ذلك، لا يمكن أن تبدأ أسماء المعلّمات بما يلي:

  • _ (underscore)
  • firebase_
  • ga_
  • google_
  • gtag.

أسماء خصائص المستخدمين المحجوزة

أسماء خصائص المستخدمين التالية محجوزة ولا يمكن استخدامها:

  • first_open_time
  • first_visit_time
  • last_deep_link_referrer
  • user_id
  • first_open_after_install

بالإضافة إلى ذلك، لا يمكن أن تبدأ أسماء خصائص المستخدمين بما يلي:

  • _ (underscore)
  • firebase_
  • ga_
  • google_