نقشه برداری های میدانی

از نگاشت‌های موجود در جداول برای نگاشت یک درخواست جمع‌آوری داده پروتکل اندازه‌گیری ( /mp/collect ) به معادل آن در IngestEventsRequest در رابط برنامه‌نویسی کاربردی مدیریت داده (Data Manager API) استفاده کنید.

فیلدهای درخواست

درخواست /mp/collect (پروتکل اندازه‌گیری) IngestEventsRequest (رابط برنامه‌نویسی کاربردی مدیریت داده) یادداشت‌ها
measurement_id (پارامتر کوئری) destinations برای رویدادهای وب، به product_destination_id نگاشت کنید. برای جزئیات بیشتر به فیلدهای مقصد مراجعه کنید.
firebase_app_id (پارامتر کوئری) destinations برای رویدادهای برنامه، به product_destination_id نگاشت کنید. برای جزئیات بیشتر به فیلدهای Destination مراجعه کنید.
api_secret (پارامتر کوئری) معادلی وجود ندارد برای آشنایی با نحوه احراز هویت درخواست‌ها در Data Manager API، به بخش تنظیم دسترسی API مراجعه کنید.
consent consent روی یک شیء Consent تنظیم شود.
events events روی فهرستی از منابع Event تنظیم کنید. برای جزئیات بیشتر به بخش فیلدهای رویداد مراجعه کنید.
client_id events.client_id برای رویدادهای وب الزامی است.
app_instance_id events.app_instance_id برای رویدادهای برنامه مورد نیاز است.
user_id events.user_id اختیاری. یک شناسه منحصر به فرد برای یک کاربر.
timestamp_micros events.event_timestamp در پروتکل اندازه‌گیری، این می‌تواند در سطح درخواست یا برای یک رویداد منفرد ارائه شود. در رابط برنامه‌نویسی کاربردی مدیریت داده، مهر زمانی در سطح درخواست وجود ندارد. برای هر رویداد، event_timestamp را برابر با زمان وقوع رویداد تنظیم کنید.
  • اگر از فرمت JSON استفاده می‌کنید، مقداری با فرمت RFC 3339 تنظیم کنید.
  • اگر از بافرهای پروتکل استفاده می‌کنید، از یک Timestamp استفاده کنید و فیلدهای seconds و (اختیاری) nanoseconds را تنظیم کنید.

برای جزئیات بیشتر به قالب مهر زمانی مراجعه کنید.
user_properties events.user_properties روی یک شیء UserProperties تنظیم شود. رابط برنامه‌نویسی کاربردی مدیریت داده از تنظیم مهر زمانی برای ویژگی‌های کاربر به صورت جداگانه پشتیبانی نمی‌کند. مهرهای زمانی مرتبط با تغییرات در ویژگی‌های کاربر از مهر زمانی رویداد ( event_timestamp ) استنباط می‌شوند.
user_data events.user_data روی یک شیء UserData تنظیم شود. برای جزئیات بیشتر به فیلدهای شناسه کاربر مراجعه کنید.
non_personalized_ads events.consent.ad_personalization اگر non_personalized_ads true است، ad_personalization را روی DENIED تنظیم کنید.
user_location events.event_location برای جزئیات بیشتر به فیلدهای موقعیت مکانی کاربر مراجعه کنید.
ip_override events.event_device_info.ip_address
device events.event_device_info برای جزئیات بیشتر به فیلدهای دستگاه مراجعه کنید.
user_agent events.event_device_info.user_agent
validation_behavior معادلی وجود ندارد از Diagnostics برای بازیابی وضعیت آپلود خود و همچنین خطاها و هشدارها برای رویدادهای جداگانه در طول پردازش پایین‌دستی استفاده کنید. اگر IngestEventsRequest با شکست مواجه شود (برای مثال، به دلیل از دست دادن فیلدهای ضروری)، هیچ رویدادی پردازش نمی‌شود و شما باید خطا را برطرف کرده و درخواست را دوباره امتحان کنید. برای اطلاعات بیشتر به بخش «درک خطاهای API» مراجعه کنید.
/debug/mp/collect validate_only برای اعتبارسنجی رویدادها بدون دریافت هیچ داده‌ای، مشابه سرور اعتبارسنجی پروتکل اندازه‌گیری، validate_only را روی true تنظیم کنید.
معادلی وجود ندارد encoding برای آپلودهای UserData الزامی است. روی Encoding مورد استفاده برای مقادیر UserIdentifier تنظیم کنید.

فیلدهای مقصد

پروتکل اندازه‌گیری، رویدادها را مستقیماً با استفاده از پارامتر پرس‌وجوی measurement_id یا firebase_app_id به یک جریان داده خاص ارسال می‌کند.

رابط برنامه‌نویسی کاربردی مدیریت داده (Data Manager API) از یک شیء Destination برای تعیین محل ارسال داده‌ها استفاده می‌کند. برای اطلاعات بیشتر در مورد مقصدها، به Configure destinations مراجعه کنید.

در اینجا نحوه نگاشت فیلدهای پروتکل اندازه‌گیری به فیلدهای معادل در یک Destination آورده شده است:

پروتکل اندازه‌گیری Destination (رابط برنامه‌نویسی کاربردی مدیریت داده) یادداشت‌ها
measurement_id (پارامتر کوئری) product_destination_id روی شناسه اندازه‌گیری جریان داده وب گوگل آنالیتیکس تنظیم کنید
firebase_app_id (پارامتر کوئری) product_destination_id روی شناسه برنامه Firebase مربوط به جریان داده برنامه Google Analytics تنظیم کنید.
معادلی وجود ندارد operating_account account_id برابر با شناسه ویژگی Google Analytics قرار دهید. account_type را برابر با GOOGLE_ANALYTICS_PROPERTY قرار دهید.
معادلی وجود ندارد login_account account_id برابر با شناسه ویژگی Google Analytics قرار دهید. account_type را برابر با GOOGLE_ANALYTICS_PROPERTY قرار دهید.

فیلدهای رویداد

events[] Event (رابط برنامه‌نویسی کاربردی مدیریت داده) یادداشت‌ها
name event_name اگر event_name از یک نام رزرو شده استفاده کند، API رویداد را با خطای INVALID_EVENT_NAME رد می‌کند.
معادلی وجود ندارد event_source اگر رویداد از طریق مرورگر وب ایجاد شده باشد، روی WEB و اگر از طریق برنامه ایجاد شده باشد، روی APP تنظیم کنید.
معادلی وجود ندارد destination_references اگر لیست destinations سطح درخواست شامل بیش از یک Destination گوگل آنالیتیکس باشد، الزامی است. ورودی‌ای اضافه کنید تا مشخص شود کدام مقصد باید رویداد را دریافت کند.
timestamp_micros event_timestamp
  • اگر از فرمت JSON استفاده می‌کنید، مقداری با فرمت RFC 3339 تنظیم کنید.
  • اگر از بافرهای پروتکل استفاده می‌کنید، از یک Timestamp استفاده کنید و فیلدهای seconds و (اختیاری) nanoseconds را تنظیم کنید.

برای جزئیات بیشتر به قالب مهر زمانی مراجعه کنید.
params.currency currency
params.value conversion_value
params.customer_type user_properties.customer_type در پروتکل اندازه‌گیری، پارامتر customer_type به عنوان یک پارامتر رویداد تنظیم شده است. در رابط برنامه‌نویسی کاربردی مدیریت داده، آن را در فیلد customer_type در شیء UserProperties در رویداد تنظیم کنید.
params.transaction_id transaction_id برای برخی رویدادها و موارد استفاده مورد نیاز است . برای جزئیات بیشتر به بخش تبدیل داده‌ها به اشیاء Event مراجعه کنید.
params.items cart_data.items برای جزئیات بیشتر به فیلدهای مربوط به داده‌های سبد خرید مراجعه کنید.
params.coupon cart_data.coupon_codes از فیلد coupon_codes برای ارائه کوپن‌هایی که به سبد خرید اعمال شده‌اند استفاده کنید. فقط یک کوپن برای گوگل آنالیتیکس ارائه دهید. این مستقل از کوپن‌های سطح Item است که می‌توانند با استفاده از cart_data.items.additional_item_parameters برای کالاهای تکی تنظیم شوند.
params.session_id additional_event_parameters به ورودی‌ای که parameter_name آن روی session_id تنظیم شده است، نگاشت می‌شود.
params.engagement_time_msec additional_event_parameters به ورودی با parameter_name که روی engagement_time_msec تنظیم شده است، نگاشت می‌شود.
params دیگر additional_event_parameters

پارامترهای دیگر را به عنوان لیستی از اشیاء با parameter_name و value نگاشت کنید.

توجه: ورودی‌هایی برای transaction_id ، currency یا value اینجا اضافه نکنید؛ در عوض از فیلدهای سطح بالا در Event استفاده کنید.

فیلدهای شناسه کاربر

Measurement Protocol user_data UserIdentifier (رابط برنامه‌نویسی کاربردی مدیریت داده) یادداشت‌ها
sha256_email_address[] email_address روی آدرس ایمیل قالب‌بندی و هش‌شده تنظیم کنید. همچنین می‌توانید آدرس ایمیل هش‌شده را رمزگذاری کنید .
sha256_phone_number[] phone_number روی شماره تلفن فرمت شده و هش شده تنظیم کنید. همچنین می‌توانید شماره تلفن هش شده را رمزگذاری کنید .
address[] address روی یک شیء AddressInfo تنظیم کنید. دستورالعمل‌های قالب‌بندی و هش کردن را دنبال کنید.
address[].sha256_first_name address.given_name روی نام داده شده‌ی قالب‌بندی شده و هش شده تنظیم کنید. همچنین می‌توانید نام داده شده‌ی هش شده را رمزگذاری کنید .
address[].sha256_last_name address.family_name روی نام خانوادگی قالب‌بندی و هش‌شده تنظیم کنید. همچنین می‌توانید نام خانوادگی هش‌شده را رمزگذاری کنید .
address[].country address.region_code
address[].postal_code address.postal_code
address[].city معادلی وجود ندارد در نسخه فعلی رابط برنامه‌نویسی کاربردی مدیریت داده پشتیبانی نمی‌شود.
address[].region معادلی وجود ندارد در نسخه فعلی رابط برنامه‌نویسی کاربردی مدیریت داده پشتیبانی نمی‌شود.
address[].sha256_street معادلی وجود ندارد در نسخه فعلی رابط برنامه‌نویسی کاربردی مدیریت داده پشتیبانی نمی‌شود.

فیلدهای کالا برای داده‌های سبد خرید

items[] Item (API مدیریت داده) یادداشت‌ها
item_id item_id الزامی است.
item_name additional_item_parameters به ورودی‌ای که parameter_name آن روی item_name تنظیم شده است، نگاشت می‌شود.
quantity quantity الزامی است.
price unit_price الزامی است.
فیلدهای مورد دیگر additional_item_parameters

پارامترهای دیگر آیتم (مانند discount ، affiliation ، item_brand و غیره) را به عنوان لیستی از اشیاء با parameter_name و value نگاشت کنید.

توجه: ورودی‌هایی برای quantity ، price یا item_id اینجا اضافه نکنید؛ در عوض از فیلدهای سطح بالای Item استفاده کنید.

فیلدهای موقعیت مکانی کاربر

Measurement Protocol user_location EventLocation (رابط برنامه‌نویسی کاربردی مدیریت داده) یادداشت‌ها
city city نام شهری که این رویداد در آن رخ داده است.
country_id region_code روی کد منطقه CLDR دو حرفی تنظیم کنید.
region_id subdivision_code روی کد تقسیم‌بندی ISO 3166-2 تنظیم شود.
continent_id continent_code روی کد قاره با فرمت UN M49 تنظیم کنید.
subcontinent_id subcontinent_code روی کد شبه قاره با فرمت UN M49 تنظیم شود.

فیلدهای دستگاه

Measurement Protocol device DeviceInfo (رابط برنامه‌نویسی مدیریت داده) یادداشت‌ها
category category
language language_code
screen_resolution screen_height و screen_width در پروتکل اندازه‌گیری، screen_resolution به صورت یک رشته ( "1280x720" ) ارائه می‌شود. در رابط برنامه‌نویسی کاربردی مدیریت داده، screen_height و screen_width را به صورت مقادیر صحیح جداگانه ارسال کنید.
operating_system operating_system
operating_system_version operating_system_version
model model
brand brand
browser browser
browser_version browser_version