مرجع پروتکل اندازه گیری

بررسی اجمالی

ارسال داده ها به Google Analytics با استفاده از پروتکل اندازه گیری دو بخش دارد:

1. حمل و نقل - کجا و چگونه داده ها را ارسال می کنید
2. محموله - داده هایی که ارسال می کنید

این سند نحوه قالب بندی حمل و نقل و محموله را توضیح می دهد.

حمل و نقل

نقطه پایان URL

شما داده ها را با استفاده از پروتکل اندازه گیری با درخواست HTTP POST به نقطه پایانی زیر ارسال می کنید:

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

توجه: همه داده ها باید به طور ایمن از طریق HTTPS ارسال شوند.

برای ارسال یک رویداد، درخواست POST زیر را صادر کنید:

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

• BODY درخواست. به Payload مراجعه کنید.

کدهای پاسخگویی

اگر درخواست HTTP دریافت شود، پروتکل اندازه گیری همیشه یک کد وضعیت 2xx را برمی گرداند. اگر داده‌های محموله نادرست باشد، یا اگر داده‌های موجود در بار نادرست باشد یا توسط Google Analytics پردازش نشده باشد، پروتکل اندازه‌گیری کد خطایی را باز نمی‌گرداند.

مهم: اگر کد وضعیت 2xx دریافت نکردید، نباید درخواست را دوباره امتحان کنید. درعوض، باید هرگونه خطا در درخواست HTTP خود را متوقف و تصحیح کنید.

ظرفیت ترابری

Firebase gtag.js

داده ها با استفاده از داده های پروتکل اندازه گیری در دو بخش به Google Analytics ارسال می شوند:

1. پارامترهای پرس و جو
2. یک بدنه JSON POST

پارامترهای پرس و جو

نام پارامتر

شرح

api_secret

ضروری. یک API Secret که از طریق رابط کاربری گوگل آنالیتیکس ایجاد می شود. برای ایجاد یک راز جدید، در رابط کاربری Google Analytics به مسیر زیر بروید: Admin > Data Streams > جریان خود را انتخاب کنید > Measurement Protocol > Create توصیه می کنیم این موارد را برای سازمان خود خصوصی نگه دارید. اگر پروتکل اندازه گیری را در سمت کلاینت اجرا می کنید، باید به طور منظم api_secret s را بچرخانید تا از هرزنامه های بیش از حد جلوگیری کنید.

بدنه پست JSON

کلید	تایپ کنید	شرح
user_id	string	اختیاری. یک شناسه منحصر به فرد برای یک کاربر. برای اطلاعات بیشتر در مورد این شناسه ، User-ID را برای تجزیه و تحلیل بین پلتفرمی ببینید. user_id ممکن است فقط شامل کاراکترهای utf-8 باشد.
timestamp_micros	number	اختیاری. یک مهر زمانی یونیکس (در میکروثانیه) برای زمان مرتبط با رویداد. این فقط باید برای ثبت رویدادهایی که در گذشته اتفاق افتاده تنظیم شود. این مقدار را می توان از طریق user_property یا مهرهای زمانی رویداد لغو کرد. رویدادها را می توان تا 3 روز تقویمی بر اساس منطقه زمانی ملک به عقب انداخت. این مقدار باید در میکرو ثانیه باشد نه میلی ثانیه.
user_properties	object	اختیاری. ویژگی های کاربر برای اندازه گیری برای اطلاعات بیشتر به ویژگی های کاربر مراجعه کنید.
consent	object	اختیاری. تنظیمات رضایت را برای درخواست تنظیم می کند. برای اطلاعات بیشتر به بخش رضایت مراجعه کنید.
non_personalized_ads	boolean	اختیاری. برای true دادن داده‌های کاربر نباید برای تبلیغات شخصی‌شده استفاده شود. منسوخ شده: به جای این فیلد از قسمت ad_personalization consent استفاده کنید. Google Analytics هر دو زمینه را می پذیرد، اما ad_personalization توصیه می شود.
events[]	array	ضروری. مجموعه ای از آیتم های رویداد. حداکثر 25 رویداد در هر درخواست ارسال می شود. برای همه رویدادهای معتبر به مرجع رویدادها مراجعه کنید.
events[].name	string	ضروری. نام رویداد برای همه گزینه ها به مرجع رویدادها مراجعه کنید.
events[].params	object	اختیاری. پارامترهای رویداد رویدادها را برای پارامترهای پیشنهادی برای هر رویداد مشاهده کنید.

رضایت

ویژگی consent انواع و حالات رضایت را پیکربندی می کند. اگر consent مشخص نکنید، Google Analytics از تنظیمات رضایت حاصل از تعاملات آنلاین مربوطه برای نمونه برنامه یا مشتری استفاده خواهد کرد.

کلید	تایپ کنید	شرح
ad_user_data	string	اختیاری. رضایت را برای ارسال داده‌های کاربر از رویدادهای درخواست و ویژگی‌های کاربر به Google برای اهداف تبلیغاتی تنظیم می‌کند. باید یا GRANTED یا DENIED شود.
ad_personalization	string	اختیاری. رضایت را برای تبلیغات شخصی سازی شده برای کاربر تنظیم می کند. باید یا GRANTED یا DENIED شود.

پارامترهای سفارشی

علاوه بر پارامترهای تجویز شده، می توانید پارامترهای سفارشی با محدوده کاربر، محدوده رویداد و محدوده آیتم را در یک بارگیری پروتکل اندازه گیری قرار دهید.

• پارامترهای سفارشی با محدوده کاربر را می توان در شی 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_