- בקשת HTTP
- גוף הבקשה
- גוף התשובה
- היקפי הרשאות
- אירוע
- AdIdentifiers
- DeviceInfo
- EncryptedUserId
- EncryptionEntityType
- EncryptionSource
- EventSource
- CartData
- פריט
- ItemParameter
- ItemCustomVariable
- CustomVariable
- ExperimentalField
- UserProperties
- CustomerType
- CustomerValueBucket
- UserProperty
- EventParameter
- EventLocation
- כדאי לנסות!
העלאה של רשימת משאבים מסוג Event מהקובץ Destination שסופק.
בקשת HTTP
POST https://datamanager.googleapis.com/v1/events:ingest
כתובת ה-URL כתובה בתחביר של gRPC Transcoding.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
| ייצוג ב-JSON |
|---|
{ "destinations": [ { object ( |
| שדות | |
|---|---|
destinations[] |
חובה. רשימת היעדים שאליהם יישלחו האירועים. |
events[] |
חובה. רשימת האירועים שיישלחו ליעדים שצוינו. אפשר לשלוח עד 2,000 משאבים מסוג |
consent |
אופציונלי. הסכמה ברמת הבקשה תחול על כל המשתמשים בבקשה. הסכמה ברמת המשתמש מבטלת את ההסכמה ברמת הבקשה, ואפשר לציין אותה בכל |
validateOnly |
אופציונלי. למטרות בדיקה. אם הערך הוא |
encoding |
אופציונלי. השדה נדרש להעלאת קובצי |
encryptionInfo |
אופציונלי. מידע על ההצפנה של העלאות ב- |
גוף התשובה
תגובה מIngestEventsRequest.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
| ייצוג ב-JSON |
|---|
{ "requestId": string } |
| שדות | |
|---|---|
requestId |
המזהה שנוצר אוטומטית של הבקשה. |
היקפי הרשאות
נדרש היקף ההרשאות הבא של OAuth:
https://www.googleapis.com/auth/datamanager
אירוע
אירוע שמייצג אינטראקציה של משתמש עם האתר או האפליקציה של מפרסם.
| ייצוג ב-JSON |
|---|
{ "destinationReferences": [ string ], "transactionId": string, "eventTimestamp": string, "lastUpdatedTimestamp": string, "userData": { object ( |
| שדות | |
|---|---|
destinationReferences[] |
אופציונלי. מחרוזת הפניה שמשמשת לקביעת היעד. אם השדה ריק, האירוע יישלח לכל |
transactionId |
אופציונלי. המזהה הייחודי של האירוע. חובה לאירועים שנשלחים כמקור נתונים נוסף להמרות של התג. |
eventTimestamp |
חובה. השעה שבה האירוע התרחש. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים מלבד Z. דוגמאות: |
lastUpdatedTimestamp |
אופציונלי. הפעם האחרונה שבה האירוע עודכן. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים מלבד Z. דוגמאות: |
userData |
אופציונלי. חלקים מפרטים שהמשתמשים סיפקו, שמייצגים את המשתמש שהאירוע משויך אליו. |
consent |
אופציונלי. מידע על כך שהמשתמש המשויך סיפק סוגים שונים של הסכמה. |
adIdentifiers |
אופציונלי. מזהים ומידע אחר שמשמשים להתאמה של אירוע ההמרה לפעילות אונליין אחרת (כמו קליקים על מודעות). |
currency |
אופציונלי. קוד המטבע שמשויך לכל הערכים הכספיים באירוע הזה. |
eventSource |
אופציונלי. אות שמציין איפה האירוע התרחש (באינטרנט, באפליקציה, בחנות וכו'). |
eventDeviceInfo |
אופציונלי. מידע שנאסף על המכשיר שבו נעשה שימוש (אם יש כזה) כשהאירוע קרה. |
cartData |
אופציונלי. מידע על העסקה ועל הפריטים שמשויכים לאירוע. |
customVariables[] |
אופציונלי. מידע נוסף על זוגות של מפתח/ערך לשליחה למאגרי התגים של ההמרות (פעולת המרה או פעילות FL). |
experimentalFields[] |
אופציונלי. רשימה של צמדי מפתח/ערך לשדות ניסיוניים שעשויים בסופו של דבר להיכלל ב-API. |
userProperties |
אופציונלי. מידע שהמפרסם מעריך לגבי המשתמש בזמן שהאירוע התרחש. |
eventName |
אופציונלי. שם האירוע. חובה לאירועים ב-GA4. |
clientId |
אופציונלי. מזהה ייחודי של מופע המשתמש של לקוח אינטרנט במקור נתונים לאתר ב-GA4. |
userId |
אופציונלי. מזהה ייחודי של משתמש, כפי שהוגדר על ידי המפרסם. |
additionalEventParameters[] |
אופציונלי. מאגר של פרמטרים של אירועים שרוצים לכלול באירוע, שלא צוינו כבר באמצעות שדות מובנים אחרים. |
thirdPartyUserData |
אופציונלי. אותו סוג של נתונים שמועבר ב-userData, אבל מסומן במפורש כנתונים שסופקו על ידי צד שלישי ולא כנתונים של מפרסם מאינטראקציה ישירה. |
eventLocation |
אופציונלי. מידע שנאסף על מיקום המשתמש בזמן שהאירוע הזה התרחש. |
appInstanceId |
אופציונלי. מזהה ייחודי של מופע המשתמש של לקוח אפליקציה במקור הנתונים הזה של האפליקציה ב-GA4. |
conversionValue |
אופציונלי. ערך ההמרה שמשויך לאירוע, להמרות מבוססות-ערך. |
conversionCount |
אופציונלי. כמות ההמרות שמשויכת לאירוע, במקרה של המרות שמבוססות על ספירה. |
AdIdentifiers
מזהים ומידע אחר שמשמשים להתאמה של אירוע ההמרה לפעילות אונליין אחרת (כמו קליקים על מודעות).
| ייצוג ב-JSON |
|---|
{ "sessionAttributes": string, "gclid": string, "gbraid": string, "wbraid": string, "landingPageDeviceInfo": { object ( |
| שדות | |
|---|---|
sessionAttributes |
אופציונלי. מאפייני סשן לשיוך אירועים ולבניית מודלים. |
gclid |
אופציונלי. מספר הקליק ב-Google (gclid) שמשויך לאירוע הזה. |
gbraid |
אופציונלי. המזהה של קליקים שמשויכים לאירועים באפליקציה ומגיעים ממכשירי iOS בגרסה 14 ואילך. |
wbraid |
אופציונלי. המזהה של קליקים שמשויכים לאירועים באתר ומגיעים ממכשירי iOS בגרסה 14 ואילך. |
landingPageDeviceInfo |
אופציונלי. המידע שנאסף על המכשיר שבו נעשה שימוש (אם יש כזה) בזמן הנחיתה באתר של המפרסם אחרי אינטראקציה עם המודעה. |
mobileDeviceId |
אופציונלי. המזהה לצורכי פרסום במובייל. המזהה הזה הוא IDFA ב-iOS, AdID ב-Android או מזהים אחרים למפרסמים בפלטפורמות אחרות. |
dclid |
אופציונלי. מספר הקליק ברשת המדיה שמשויך לאירוע הזה. |
impressionId |
אופציונלי. מזהה החשיפה שמשויך לאירוע הזה. |
matchId |
אופציונלי. השדה של מזהה ההתאמה שמשמש לצירוף האירוע הזה לאירוע קודם. |
encryptedUserIds[] |
אופציונלי. מספר כלשהו של מזהי משתמשים מוצפנים. |
DeviceInfo
מידע על המכשיר שבו נעשה שימוש (אם יש כזה) כשהאירוע קרה.
| ייצוג ב-JSON |
|---|
{ "userAgent": string, "ipAddress": string, "category": string, "languageCode": string, "screenHeight": integer, "screenWidth": integer, "operatingSystem": string, "operatingSystemVersion": string, "model": string, "brand": string, "browser": string, "browserVersion": string } |
| שדות | |
|---|---|
userAgent |
אופציונלי. מחרוזת סוכן המשתמש של המכשיר בהקשר הנתון. |
ipAddress |
אופציונלי. כתובת ה-IP של המכשיר בהקשר הנתון. הערה: מערכת Google Ads לא תומכת בהתאמת כתובות IP של משתמשי קצה באזור הכלכלי האירופי (EEA), בבריטניה (UK) או בשווייץ (CH). אתם צריכים להוסיף לוגיקה כדי להחריג באופן מותנה שיתוף כתובות IP של משתמשים מהאזורים האלה. בנוסף, הקפידו לספק למשתמשים מידע ברור ומקיף על הנתונים שאתם אוספים באתרים, באפליקציות ובנכסים אחרים שלכם, ולקבל מהם הסכמה במקרים שבהם הדבר נדרש על פי חוק או על פי מדיניות רלוונטית של Google. פרטים נוספים זמינים במאמר מידע על ייבוא של נתוני המרות אופליין (OCI). |
category |
אופציונלי. קטגוריית המכשיר. לדוגמה, 'מחשב', 'טאבלט', 'נייד', 'טלוויזיה חכמה'. |
languageCode |
אופציונלי. השפה שבה המכשיר משתמש בפורמט ISO 639-1. |
screenHeight |
אופציונלי. גובה המסך בפיקסלים. |
screenWidth |
אופציונלי. רוחב המסך בפיקסלים. |
operatingSystem |
אופציונלי. מערכת ההפעלה או הפלטפורמה של המכשיר. |
operatingSystemVersion |
אופציונלי. הגרסה של מערכת ההפעלה או הפלטפורמה. |
model |
אופציונלי. הדגם של המכשיר. |
brand |
אופציונלי. המותג של המכשיר. |
browser |
אופציונלי. המותג או הסוג של הדפדפן. |
browserVersion |
אופציונלי. גרסת הדפדפן. |
EncryptedUserId
מזהה משתמש שמונפק לשימוש לצורך שיוך (Attribution). אם משתמשים בשדה הזה, חובה למלא את כל השדות.
| ייצוג ב-JSON |
|---|
{ "encryptedId": string, "entityType": enum ( |
| שדות | |
|---|---|
encryptedId |
חובה. המזהה המוצפן האלפאנומרי. |
entityType |
חובה. סוג ישות ההצפנה. ההגדרה הזו צריכה להיות זהה להגדרת ההצפנה של הצגת המודעות או של העברת הנתונים. |
entityId |
חובה. מזהה הישות של ההצפנה. ההגדרה הזו צריכה להיות זהה להגדרת ההצפנה של הצגת המודעות או של העברת הנתונים. |
source |
חובה. התיאור קובע אם קובץ ה-Cookie המוצפן התקבל מפרסום מודעות (פקודת המאקרו %m) או מ-Data Transfer. |
EncryptionEntityType
סוג ישות ההצפנה.
| טיפוסים בני מנייה (enum) | |
|---|---|
ENCRYPTION_ENTITY_TYPE_UNSPECIFIED |
סוג ישות ההצפנה לא צוין. |
CAMPAIGN_MANAGER_ACCOUNT |
חשבון Campaign Manager 360. |
CAMPAIGN_MANAGER_ADVERTISER |
מפרסם ב-Campaign Manager 360. |
DISPLAY_VIDEO_PARTNER |
שותף ב-Display & Video 360. |
DISPLAY_VIDEO_ADVERTISER |
מפרסם ב-Display & Video 360. |
GOOGLE_ADS_CUSTOMER |
לקוח של Google Ads. |
GOOGLE_AD_MANAGER_NETWORK_CODE |
קוד הרשת של Google Ad Manager. |
EncryptionSource
מקור ההצפנה.
| טיפוסים בני מנייה (enum) | |
|---|---|
ENCRYPTION_SOURCE_UNSPECIFIED |
מקור ההצפנה לא צוין. |
AD_SERVING |
מקור ההצפנה של הצגת המודעות. |
DATA_TRANSFER |
מקור ההצפנה של העברת הנתונים. |
EventSource
מקור האירוע.
| טיפוסים בני מנייה (enum) | |
|---|---|
EVENT_SOURCE_UNSPECIFIED |
מקור האירוע לא צוין. אסור להשתמש בו אף פעם. |
WEB |
האירוע נוצר מדפדפן אינטרנט. |
APP |
האירוע נוצר מאפליקציה. |
IN_STORE |
האירוע נוצר מעסקה בחנות. |
PHONE |
האירוע נוצר משיחה טלפונית. |
MESSAGE |
האירוע נוצר מהודעה. |
OTHER |
האירוע נוצר ממקורות אחרים. |
CartData
נתוני עגלת הקניות שמשויכים לאירוע.
| ייצוג ב-JSON |
|---|
{
"merchantId": string,
"merchantFeedLabel": string,
"merchantFeedLanguageCode": string,
"transactionDiscount": number,
"items": [
{
object ( |
| שדות | |
|---|---|
merchantId |
אופציונלי. מספר חשבון Merchant Center שמשויך לפריטים. |
merchantFeedLabel |
אופציונלי. תווית הפיד ב-Merchant Center שמשויכת לפיד הפריטים. |
merchantFeedLanguageCode |
אופציונלי. קוד השפה לפי תקן ISO 639-1 שמשויך לפיד ב-Merchant Center שאליו מועלים הפריטים. |
transactionDiscount |
אופציונלי. סכום כל ההנחות שמשויכות לעסקה. |
items[] |
אופציונלי. רשימת הפריטים שמשויכים לאירוע. |
couponCodes[] |
אופציונלי. רשימת קודי השוברים שהוחלו על עגלת הקניות. קודי שוברים ברמת העגלה וברמת הפריט הם נפרדים. אם האירוע מיועד ליעד ב-Google Analytics, צריך לספק רק קוד שובר אחד. מערכת Google Analytics מתעלמת מקודי שוברים נוספים. |
פריט
מייצג פריט בעגלת הקניות שמשויך לאירוע.
| ייצוג ב-JSON |
|---|
{ "merchantProductId": string, "quantity": string, "unitPrice": number, "itemId": string, "additionalItemParameters": [ { object ( |
| שדות | |
|---|---|
merchantProductId |
אופציונלי. מזהה המוצר בחשבון Merchant Center. |
quantity |
אופציונלי. מספר הפריט שמשויך לאירוע. |
unitPrice |
אופציונלי. המחיר ליחידה, לא כולל מס, משלוח והנחות ברמת העסקה. |
itemId |
אופציונלי. מזהה ייחודי שאפשר להשתמש בו כדי להתייחס לפריט. |
additionalItemParameters[] |
אופציונלי. מאגר של פרמטרים של אירועים שקשורים לפריט שרוצים לכלול באירוע, שלא צוינו כבר באמצעות שדות מובנים אחרים. |
merchantId |
אופציונלי. מספר חשבון Merchant Center שמשויך לפריט. באירועים של מכירות בחנות פיזית, הערך הזה יבטל את הערך שהוגדר ברמת עגלת הקניות. המערכת מתעלמת מהשדה הזה באירועים אחרים. |
merchantFeedLabel |
אופציונלי. תווית הפיד של פיד Merchant Center. אם עדיין נעשה שימוש במדינות, אפשר להשתמש במקום זאת בקוד המדינה בן 2 האותיות לפי תקן ISO-3166-1 alpha-2. באירועים של מכירות בחנות פיזית, הערך הזה יבטל את הערך שהוגדר ברמת עגלת הקניות. המערכת מתעלמת מהשדה הזה באירועים אחרים. |
merchantFeedLanguageCode |
אופציונלי. קוד השפה לפי תקן ISO 639-1 שמשויך לפיד ב-Merchant Center שאליו מועלים הפריטים. |
customVariables[] |
אופציונלי. מידע נוסף על צמדי מפתח/ערך לשליחה למאגרי התגים של ההמרות (פעולת המרה או פעילות ב-Floodlight), כשעוקבים אחרי המרות ברמת הפריט. |
conversionValue |
אופציונלי. ערך ההמרה שמשויך לפריט הזה באירוע, במקרים שבהם ערך ההמרה שונה לכל פריט. |
ItemParameter
מאגר של פרמטרים של אירועים שקשורים לפריט שרוצים לכלול באירוע, שלא צוינו כבר באמצעות שדות מובנים אחרים.
| ייצוג ב-JSON |
|---|
{ "parameterName": string, "value": string } |
| שדות | |
|---|---|
parameterName |
חובה. שם הפרמטר שבו רוצים להשתמש. |
value |
חובה. הייצוג של ערך הפרמטר שרוצים להגדיר כמחרוזת. |
ItemCustomVariable
משתנה מותאם אישית ברמת הפריט להמרות ממודעות.
| ייצוג ב-JSON |
|---|
{ "variable": string, "value": string, "destinationReferences": [ string ] } |
| שדות | |
|---|---|
variable |
אופציונלי. השם של המשתנה המותאם אישית שרוצים להגדיר. אם המשתנה לא נמצא ביעד שצוין, המערכת תתעלם ממנו. |
value |
אופציונלי. הערך שרוצים לאחסן עבור המשתנה המותאם אישית. |
destinationReferences[] |
אופציונלי. מחרוזת הפניה שמשמשת לקביעה לאיזה מבין |
CustomVariable
משתנה מותאם אישית להמרות ממודעות.
| ייצוג ב-JSON |
|---|
{ "variable": string, "value": string, "destinationReferences": [ string ] } |
| שדות | |
|---|---|
variable |
אופציונלי. השם של המשתנה המותאם אישית שרוצים להגדיר. אם המשתנה לא נמצא ביעד שצוין, המערכת תתעלם ממנו. |
value |
אופציונלי. הערך שרוצים לאחסן עבור המשתנה המותאם אישית. |
destinationReferences[] |
אופציונלי. מחרוזת הפניה שמשמשת לקביעה לאיזה מבין |
ExperimentalField
שדה ניסיוני שמייצג שדות לא רשמיים.
| ייצוג ב-JSON |
|---|
{ "field": string, "value": string } |
| שדות | |
|---|---|
field |
אופציונלי. שם השדה שבו רוצים להשתמש. |
value |
אופציונלי. הערך של השדה שרוצים להגדיר. |
UserProperties
מידע שהמפרסם מעריך לגבי המשתמש בזמן שהאירוע התרחש. פרטים נוספים זמינים בכתובת https://support.google.com/google-ads/answer/14007601.
| ייצוג ב-JSON |
|---|
{ "customerType": enum ( |
| שדות | |
|---|---|
customerType |
אופציונלי. סוג הלקוח שמשויך לאירוע. |
customerValueBucket |
אופציונלי. הערך של הלקוח לפי הערכת המפרסם. |
additionalUserProperties[] |
אופציונלי. מאגר של מאפייני משתמש נוספים שמשויכים למשתמש שקשור לאירוע הזה. |
CustomerType
סוג הלקוח שמשויך לאירוע.
| טיפוסים בני מנייה (enum) | |
|---|---|
CUSTOMER_TYPE_UNSPECIFIED |
סוג הלקוח לא צוין. אסור להשתמש בו אף פעם. |
NEW |
הלקוח חדש למפרסם. |
RETURNING |
הלקוח חוזר אל המפרסם. |
REENGAGED |
הלקוח יצר אינטראקציה חוזרת עם המפרסם. |
CustomerValueBucket
הערך של הלקוח לפי הערכת המפרסם.
| טיפוסים בני מנייה (enum) | |
|---|---|
CUSTOMER_VALUE_BUCKET_UNSPECIFIED |
Unspecified CustomerValueBucket. אסור להשתמש בו אף פעם. |
LOW |
הלקוח הוא בעל ערך נמוך. |
MEDIUM |
הלקוח הוא בעל ערך בינוני. |
HIGH |
הלקוח רווחי. |
UserProperty
מאגר של מאפייני משתמש נוספים שמשויכים למשתמש שקשור לאירוע הזה.
| ייצוג ב-JSON |
|---|
{ "propertyName": string, "value": string } |
| שדות | |
|---|---|
propertyName |
חובה. השם של מאפיין המשתמש שבו רוצים להשתמש. |
value |
חובה. ייצוג המחרוזת של הערך של מאפיין המשתמש שבו רוצים להשתמש. |
EventParameter
פרמטר של אירוע לאירועים ב-GA4.
| ייצוג ב-JSON |
|---|
{ "parameterName": string, "value": string } |
| שדות | |
|---|---|
parameterName |
חובה. שם הפרמטר שבו רוצים להשתמש. |
value |
חובה. הייצוג של ערך הפרמטר שרוצים להגדיר כמחרוזת. |
EventLocation
המיקום שבו התרחש האירוע.
| ייצוג ב-JSON |
|---|
{ "storeId": string, "city": string, "subdivisionCode": string, "regionCode": string, "subcontinentCode": string, "continentCode": string } |
| שדות | |
|---|---|
storeId |
אופציונלי. חובה לדיווח על מכירות בחנות. המזהה שמייצג חנות פיזית שבה התרחש האירוע. |
city |
אופציונלי. שם העיר שבה התרחש האירוע. |
subdivisionCode |
אופציונלי. קוד חלוקת המשנה לפי תקן ISO 3166-2 שבו התרחש האירוע. |
regionCode |
אופציונלי. קוד האזור בן 2 האותיות של כתובת המשתמש במאגר CLDR. |
subcontinentCode |
אופציונלי. קוד תת-היבשת בפורמט UN M49 שבה התרחש האירוע. |
continentCode |
אופציונלי. קוד היבשת בפורמט UN M49 שבה התרחש האירוע. |