משתמשים במיפויים שבטבלאות כדי למפות בקשה לאיסוף נתונים של Measurement Protocol (/mp/collect) למקבילה שלה ב-IngestEventsRequest Data Manager API.
אימות
ה-Data Manager API דורש פרטי כניסה של OAuth במקום 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 |
מוגדר לאובייקט ב-Data Manager API אין תמיכה בהגדרת חותמות זמן למאפייני משתמשים ספציפיים. חותמות הזמן שמשויכות לשינויים במאפייני המשתמשים נגזרות מחותמת הזמן של האירוע ( |
user_data |
events.user_data |
מוגדר לאובייקט UserData. פרטים נוספים זמינים בקטע שדות של מזהי משתמשים. |
non_personalized_ads |
events.consent.ad_personalization |
אם non_personalized_ads הוא true, צריך להגדיר את ad_personalization לערך CONSENT_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 ברמת הבקשה מכילה יותר מDestination אחד של Google Analytics. מוסיפים רשומה כדי לציין לאיזה יעד האירוע צריך להישלח. |
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. פועלים לפי ההנחיות בנושא פורמט וגיבוב (hash). |
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 |
מוגדר לאזור המנהלי (מדינה או מחוז) הנורמלי. אין לבצע גיבוב (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 |
מגדירים את קוד האזור בן 2 האותיות במאגר 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 |
ב-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 |