نگاشت‌های فیلد

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

اصالت‌سنجی

«میانای برنامه‌سازی کاربردی مدیر داده» به‌جای api_secret به اعتبارنامه‌های OAuth نیاز دارد. مراحل راه‌اندازی دسترسی به میانای برنامه‌سازی کاربردی را دنبال کنید تا اعتبارنامه جدیدی تولید کنید که شامل حوزه Data Manager API باشد.

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

‫/mp/collect درخواست (پروتکل اندازه‌گیری) IngestEventsRequest (Data Manager API) یادداشت‌ها
‫measurement_id (پارامتر پُرسمان) destinations نقشه product_destination_id برای رویدادهای وب. برای جزئیات، فیلدهای مقصد را ببینید.
‫firebase_app_id (پارامتر پُرسمان) destinations نقشه به product_destination_id برای رویدادهای برنامه. برای جزئیات، فیلدهای مقصد را ببینید.
‫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 تنظیم کنید. اگر نوع یا مقدار دسته‌بندی کاربر را ارسال می‌کنید، به‌ترتیب از فیلد customer_type یا customer_value_bucket در UserProperties استفاده کنید. برای دیگر مشخصه‌های کاربر، شیء UserProperty جداگانه‌ای ایجاد کنید، فیلدهای property_name و value آن را تنظیم کنید، و آن را به فهرست additional_user_properties اضافه کنید.

«میانای برنامه‌سازی کاربردی مدیر داده» از تنظیم مُهر زمان برای دارایی‌های کاربر فردی پشتیبانی نمی‌کند. مُهرهای زمان مرتبط با تغییرات دارایی‌های کاربر از مُهر زمان رویداد (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 معادل ندارد از تشخیص خرابی برای بازیابی وضعیت بارگذاری و همچنین خطاها و هشدارهای مربوط به رویدادهای فردی درطول پردازش پایین‌دستی استفاده کنید. اگر IngestEventsRequest ناموفق باشد (برای مثال، به‌دلیل وجود فیلدهای الزامی)، هیچ رویدادی پردازش نمی‌شود و باید خطا را برطرف کنید و درخواست را دوباره امتحان کنید. برای اطلاعات بیشتر، درک خطاهای API را ببینید.
/debug/mp/collect validate_only validate_only را روی true تنظیم کنید تا رویدادها را بدون انتقال هیچ داده‌ای درستی‌سنجی کنید، مشابه سرور درستی‌سنجی «پروتکل اندازه‌گیری».
معادل ندارد encoding برای بارگذاری‌های UserData الزامی است. روی Encoding استفاده‌شده برای مقادیر UserIdentifier تنظیم کنید.

فیلدهای مقصد

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

«میانای برنامه‌سازی کاربردی مدیر داده‌ها» از یک شیء Destination برای مشخص کردن مکان ارسال داده‌ها استفاده می‌کند. برای اطلاعات بیشتر درباره مقصدها، پیکربندی مقصدها را بررسی کنید.

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

Measurement Protocol Destination (Data Manager API) یادداشت‌ها
‫measurement_id (پارامتر پُرسمان) product_destination_id روی شناسه اندازه‌گیری جریان داده‌های وب Google Analytics تنظیم کنید
‫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 تنظیم کنید.

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

‫Measurement Protocol events[] Event (Data Manager API) یادداشت‌ها
name event_name اگر event_name از نام رزروشده استفاده کند، API رویداد را با خطای INVALID_EVENT_NAME رد می‌کند.
معادل ندارد event_source اگر رویداد از مرورگر وب تولید شده است، روی WEB تنظیم کنید و اگر رویداد از برنامه تولید شده است، روی APP تنظیم کنید.
معادل ندارد destination_references اگر فهرست destinations سطح درخواست حاوی بیش‌از یک Google Analytics 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 به‌عنوان پارامتر رویداد تنظیم می‌شود. در Data Manager API، آن را در فیلد customer_type در شیء UserProperties در رویداد تنظیم کنید.
params.transaction_id transaction_id برای برخی رویدادها و موارد استفاده الزامی است. برای جزئیات بیشتر، تبدیل داده‌ها به Event شیء را ببینید.
params.items cart_data.items برای جزئیات، فیلدهای مورد برای داده‌های سبد خرید را ببینید.
params.coupon cart_data.coupon_codes از فیلد coupon_codes برای ارائه کردن کوپن‌هایی که روی سبد خرید اعمال شده است استفاده کنید. فقط یک کوپن برای Google Analytics ارائه دهید. این مستقل از کوپن‌های سطح 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 (Data Manager API) یادداشت‌ها
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.city روی شهر به‌هنجارشده تنظیم کنید. این فیلد را درهم‌ریزی نکنید.
address[].region address.administrative_area روی منطقه اداری به‌هنجارشده (ایالت یا استان) تنظیم کنید. این فیلد را درهم‌ریزی نکنید.
address[].sha256_street address.address_line روی نشانی خیابان قالب‌بندی‌شده و درهم‌سازی‌شده تنظیم کنید. همچنین می‌توانید نشانی خیابان درهم‌سازی‌شده را رمزگذاری کنید.

فیلدهای مورد برای داده‌های سبد خرید

‫Measurement Protocol items[] Item (Data Manager 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 (Data Manager API) یادداشت‌ها
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 (Data Manager API) یادداشت‌ها
category category
language language_code
screen_resolution ‫screen_height و screen_width در «پروتکل اندازه‌گیری»، screen_resolution به‌عنوان رشته ("1280x720") ارائه می‌شود. در Data Manager API،‏ screen_height و screen_width را به‌عنوان مقادیر صحیح جداگانه ارسال کنید.
operating_system operating_system
operating_system_version operating_system_version
model model
brand brand
browser browser
browser_version browser_version