משתמשים במיפויים שבטבלאות כדי למפות בקשה לאיסוף נתונים של Measurement Protocol (/mp/collect) למקבילה שלה ב-IngestEventsRequest Data Manager API.
אימות
כדי להשתמש ב-Data Manager API, צריך פרטי כניסה של OAuth ולא מפתח API api_secret. פועלים לפי השלבים במאמר הגדרת גישה ל-API כדי ליצור פרטי כניסה חדשים שכוללים את היקף הגישה של 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, אפשר לספק את הערך הזה ברמת הבקשה או ברמה של אירוע ספציפי. ב-Data Manager API אין חותמת זמן ברמת הבקשה. מגדירים את הערך event_timestamp בכל אירוע לזמן שבו האירוע התרחש.
מידע נוסף מופיע בקטע פורמטים של חותמות זמן. |
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 |
מידע נוסף מופיע בקטע פורמטים של חותמות זמן. |
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 |
מיפוי פרמטרים אחרים כרשימה של אובייקטים עם |
שדות של מזהי משתמשים
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 |
הערך שהוגדר הוא העיר הנורמלית. אין לבצע גיבוב (hash) של השדה הזה. |
address[].region |
address.administrative_area |
הערך שמוגדר הוא האזור המנהלי המנורמל (מדינה או מחוז). אין לבצע גיבוב (hash) של השדה הזה. |
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 |
ממפים פרמטרים אחרים של פריטים (כמו |
שדות של מיקומי משתמשים
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 |