מיפוי שדות

אתם יכולים להיעזר במיפויים שבטבלאות כדי למפות בקשה (/mp/collect) לאיסוף נתונים ב-Measurement Protocol למקבילה שלה ב-IngestEventsRequest ב-Data Manager API.

שדות של בקשה

בקשת /mp/collect (Measurement Protocol) IngestEventsRequest (Data Manager API) הערות
measurement_id (פרמטר של שאילתה) destinations מיפוי לproduct_destination_id עבור אירועים באתר. פרטים נוספים זמינים במאמר בנושא שדות יעד.
firebase_app_id (פרמטר של שאילתה) destinations מיפוי לproduct_destination_id עבור אירועים באפליקציה. פרטים נוספים זמינים במאמר בנושא שדות יעד.
api_secret (פרמטר של שאילתה) אין דוח מקביל במאמר הגדרת גישה ל-API מוסבר איך לאמת בקשות ב-Data Manager 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 ב-Measurement Protocol, אפשר לספק את הערך הזה ברמת הבקשה או ברמת אירוע ספציפי. ב-API של המרכז לניהול נתונים, אין חותמת זמן ברמת הבקשה. מגדירים את הערך event_timestamp בכל אירוע לזמן שבו האירוע התרחש.
  • אם משתמשים בפורמט JSON, צריך להגדיר ערך בפורמט RFC 3339.
  • אם משתמשים ב-protocol buffers, צריך להשתמש ב-Timestamp ולהגדיר את השדות seconds ו-(אופציונלית) nanoseconds.

פרטים נוספים מופיעים בקטע פורמט של חותמות זמן.
user_properties events.user_properties מוגדר לאובייקט UserProperties. ב-Data Manager API אין תמיכה בהגדרת חותמות זמן למאפייני משתמש ספציפיים. חותמות הזמן שמשויכות לשינויים במאפייני המשתמשים נגזרות מחותמת הזמן של האירוע (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 כדי לאמת אירועים בלי להטמיע נתונים, בדומה לשרת האימות של Measurement Protocol.
אין דוח מקביל encoding שדה חובה להעלאות של UserData. מגדירים את הערך Encoding שמשמש לערכי UserIdentifier.

שדות יעד

‫Measurement Protocol שולח אירועים ישירות למקור נתונים ספציפי באמצעות פרמטר השאילתה measurement_id או firebase_app_id.

ב-Data Manager API נעשה שימוש באובייקט Destination כדי לציין לאן לשלוח את הנתונים. מידע נוסף על יעדים זמין במאמר הגדרת יעדים.

כך ממפים את השדות של Measurement Protocol לשדות המקבילים ב-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.
  • אם משתמשים ב-protocol buffers, צריך להשתמש ב-Timestamp ולהגדיר את השדות seconds ו-(אופציונלית) nanoseconds.

פרטים נוספים מופיעים בקטע פורמט של חותמות זמן.
params.currency currency
params.value conversion_value
params.customer_type user_properties.customer_type ב-Measurement Protocol, הפרמטר 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 אין דוח מקביל אין תמיכה בגרסה הנוכחית של Data Manager API.
address[].region אין דוח מקביל אין תמיכה בגרסה הנוכחית של Data Manager API.
address[].sha256_street אין דוח מקביל אין תמיכה בגרסה הנוכחית של Data Manager API.

שדות פריטים של נתוני עגלות הקניות

‫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 בן 2 אותיות.
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 ב-Measurement Protocol, הערך 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