مرجع Measurement Protocol

نظرة عامة

هناك جزءان لإرسال البيانات إلى "إحصاءات Google" باستخدام البروتوكول:

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

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

النقل

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

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

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" باستخدام بيانات Measurement Protocol في مهمتَين الأجزاء:

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

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

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

api_secret

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

لإنشاء مفتاح سرّي جديد، انتقِل إلى واجهة مستخدم "إحصاءات Google" من أجل:
المشرف > مصادر البيانات > اختَر البث الذي تريده &gt; Measurement Protocol > إنشاء

ننصحك بإبقاء هذه المعلومات خاصة بمؤسستك. في حال حذف نشر Measurement Protocol من جهة العميل، يمكنك تدوير api_secret بانتظام لتجنُّب الإفراط في الرسائل غير المرغوب فيها.

firebase_app_id

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

نص مشاركة JSON

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

app_instance_id

 string

يجب ملء هذا الحقل. يعرّف بشكلٍ فريد تثبيتًا معينًا لـ تطبيق Firebase. يجب استرداد هذه القيمة من خلال Firebase. SDK.

user_id

 string

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

timestamp_micros

 number

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

user_properties

 object اختياريّ. خصائص المستخدِمين للقياس مراجعة المستخدم لمزيد من المعلومات.
object اختياريّ. تضبط إعدادات الموافقة للطلب اطّلِع على قسم الموافقة للحصول على المزيد من المعلومات.

non_personalized_ads

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

events[]

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

events[].name

 string يجب ملء هذا الحقل. اسم الحدث. الاطّلاع على الفعاليات مرجع لجميع الخيارات.

events[].params

 object اختياريّ. مَعلمات الحدث عرض الفعاليات للمَعلمات المقترَحة لكل حدث

تضبط السمة consent أنواع consent وحالاتها. في حال عدم تحديد consent، ستستخدم "إحصاءات Google" حالة الموافقة الإعدادات من التفاعلات المقابلة عبر الإنترنت للعميل أو التطبيق كمثيل.

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

ad_user_data

 string

اختياري. لضبط الموافقة على إرسال بيانات المستخدمين من واجهة المستخدم في الطلب. الأحداث وخصائص المستخدمين إلى Google لأغراض إعلانية.

يجب أن تكون إما GRANTED أو DENIED.

ad_personalization

 string

اختياري. لضبط الموافقة على الإعلانات المخصّصة للمستخدِم.

يجب أن تكون إما GRANTED أو DENIED.

المعلمات المخصصة

بالإضافة إلى المعلمات الموصوفة، يمكنك تضمين المخصّص على مستوى المستخدِم وعلى مستوى الحدث وعلى مستوى المنتج أو الخدمة المَعلمات داخل حمولة في Measurement Protocol.

  • يمكن تضمين المَعلمات المخصَّصة على مستوى المستخدِم في عنصر user_properties من الحمولة.
  • يمكن تضمين المَعلمات المخصَّصة على مستوى الحدث في events[].params. كائن الحمولة.
  • يمكن تضمين المَعلمات المخصَّصة على مستوى المنتج أو الخدمة في مصفوفة items لكل حدث.

تحتوي بعض الأحداث على مَعلمات مقترَحة. يمكنك الاطّلاع على الأحداث لمعرفة المَعلمات لكل الأحداث المتوافقة

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

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

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

  • ad_activeview
  • ad_click
  • ad_exposure
  • 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
  • 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_