- בקשת HTTP
- גוף הבקשה
- גוף התגובה
- היקפי הרשאות
- AdEvent
- EventType
- EventSubtype
- AdType
- AdFormat
- AdPlacement
- TargetingType
- PlatformType
- פלטפורמה
- AttributionHint
- ViewabilityInfo
- ViewType
- MediaQuartile
- כדאי לנסות!
העלאת רשימה של AdEvent משאבים ל-Google Analytics.
התכונה הזו זמינה רק לחשבונות שברשימת ההיתרים.
בקשת HTTP
POST https://datamanager.googleapis.com/v1/adEvents:ingest
כתובת ה-URL כתובה בתחביר של gRPC Transcoding.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
| ייצוג ב-JSON |
|---|
{ "adEvents": [ { object ( |
| שדות | |
|---|---|
adEvents[] |
חובה. חובה (לפחות אחת). רשימה של אירועי מודעות. |
encryptionInfo |
אופציונלי. מידע על מפתחות ההצפנה שמשמשים להצפנת הנתונים. |
validateOnly |
אופציונלי. אם הערך הוא True, הבקשה מאומתת אבל לא מבוצעת. |
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יהיה ריק.
היקפי הרשאות
נדרש היקף ההרשאות הבא של OAuth:
https://www.googleapis.com/auth/datamanager
AdEvent
אירוע מודעה.
| ייצוג ב-JSON |
|---|
{ "advertiserId": string, "eventType": enum ( |
| שדות | |
|---|---|
advertiserId |
חובה. המזהה של המפרסם שמשויך לאירוע מודעה. המזהה הזה צריך להיות זהה למזהה שנשלח בתהליך הקישור. |
eventType |
חובה. סוג האירוע. |
timestamp |
חובה. השעה שבה האירוע התרחש. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. גם היסטים אחרים מלבד Z מתקבלים. דוגמאות: |
eventId |
אופציונלי. מזהה שנוצר ומנוהל על ידי המתקשר ומזהה באופן ייחודי את האירוע הזה. חובה למלא את השדה הזה אם רוצים לבטל כפילויות של אירועים שקשורים למודעות ונכללים בכמה בקשות. אחרת, השדה הזה הוא אופציונלי. |
userData |
אופציונלי. כמה פרטים שהמשתמשים סיפקו, שמייצגים את המשתמש שהאירוע משויך אליו. אפשר לספק כמה מופעים של אותו סוג נתונים (למשל, כתובת אימייל). ככל שתספקו יותר נתונים, כך גדל הסיכוי למצוא התאמה. |
deviceInfo |
אופציונלי. מידע שנאסף על המכשיר שבו נעשה שימוש כשאירוע המודעה התרחש. |
mobileDeviceId |
אופציונלי. מזהה המכשיר שאליו הוצגה המודעה. |
campaignId |
חובה. המזהה של הקמפיין המשויך. |
campaignName |
חובה. השם של הקמפיין המשויך. |
adGroupId |
אופציונלי. המזהה של קבוצת המודעות המשויכת. |
adId |
אופציונלי. המזהה של המודעה המשויכת בקבוצה. |
adHeight |
אופציונלי. גובה המודעה בפיקסלים. |
adWidth |
אופציונלי. רוחב המודעה בפיקסלים. |
regionCode |
חובה. המדינה וחלוקת המשנה שלה לפי תקן ISO 3166-2. |
source |
חובה. פלטפורמת המקור של המודעה, בדומה למקור ב-Google Analytics. |
medium |
חובה. אמצעי ההגעה לאתר של המודעה, בדומה לאמצעי ההגעה לאתר ב-Google Analytics. |
attributionHint |
אופציונלי. סטטוס השיוך המשוער של השותף לאירוע הצגת המודעה הזה. האות הזה משמש רק כדי להראות איך השותף משייך את ההמרות, והוא לא משפיע על התוצאות הסופיות בדוחות. |
viewabilityInfo |
חובה. פרטים על מידת הניראות של המודעה שהוצגה. |
שדה איחוד כדי לטפל בערכים שאינם enum טהור, אפשר להשתמש במחרוזת גולמית. אם אפשר, עדיף להשתמש ב-enum. הערך |
|
eventSubtype |
ערך enum לסוג משנה של אירוע. |
eventSubtypeString |
ערך המחרוזת של סוג המשנה של האירוע. |
שדה איחוד כדי לטפל בערכים שאינם enum טהור, אפשר להשתמש במחרוזת גולמית. אם אפשר, עדיף להשתמש ב-enum. הערך |
|
adType |
ערך טיפוס בן מנייה (enum) של סוג המודעה. |
adTypeString |
ערך מחרוזת לסוג המודעה. |
שדה איחוד כדי לטפל בערכים שאינם enum טהור, אפשר להשתמש במחרוזת גולמית. אם אפשר, עדיף להשתמש ב-enum. הערך |
|
adFormat |
ערך enum לפורמט מודעה. |
adFormatString |
ערך מחרוזת לפורמט המודעה. |
שדה איחוד כדי לטפל בערכים שאינם enum טהור, אפשר להשתמש במחרוזת גולמית. אם אפשר, עדיף להשתמש ב-enum. הערך |
|
adPlacement |
ערך enum למיקום מודעה. |
adPlacementString |
ערך מחרוזת למיקום המודעה. |
שדה איחוד כדי לטפל בערכים שאינם enum טהור, אפשר להשתמש במחרוזת גולמית. אם אפשר, עדיף להשתמש ב-enum. הערך |
|
targetingType |
ערך טיפוס בן מנייה (enum) של סוג הטירגוט. |
targetingTypeString |
ערך מחרוזת של סוג הטירגוט. |
שדה איחוד כדי לטפל בערכים שאינם enum טהור, אפשר להשתמש במחרוזת גולמית. אם אפשר, עדיף להשתמש ב-enum. הערך |
|
platformType |
ערך טיפוס בן מנייה (enum) לסוג הפלטפורמה. |
platformTypeString |
ערך המחרוזת של סוג הפלטפורמה. |
שדה איחוד כדי לטפל בערכים שאינם enum טהור, אפשר להשתמש במחרוזת גולמית. אם אפשר, עדיף להשתמש ב-enum. הערך |
|
platform |
ערך enum לפלטפורמה. |
platformString |
ערך מחרוזת לפלטפורמה. |
measurementAllowed |
אופציונלי. הערך הזה מציין אם מותר להשתמש בשורה למטרות מדידה, כפוף לדיני הפרטיות הרלוונטיים בתחום השיפוט האזורי. |
EventType
סוג האירוע.
| טיפוסים בני מנייה (enum) | |
|---|---|
EVENT_TYPE_UNSPECIFIED |
סוג האירוע לא צוין. |
EVENT_TYPE_VIEW |
צפייה באירוע. |
EVENT_TYPE_CLICK |
אירוע מסוג קליק. |
EventSubtype
סיווג נוסף של סוג אירוע המודעה.
| טיפוסים בני מנייה (enum) | |
|---|---|
EVENT_SUBTYPE_UNSPECIFIED |
לא צוין סוג משנה של אירוע. |
EVENT_SUBTYPE_IMPRESSION |
אירוע חשיפה. |
EVENT_SUBTYPE_ENGAGED_VIEW |
אירוע מסוג צפייה פעילה. |
EVENT_SUBTYPE_ONSITE_CLICK |
אירוע מסוג קליק באתר. |
EVENT_SUBTYPE_OUTBOUND_CLICK |
אירוע מסוג קליק יוצא. |
AdType
סוג המודעה שהוצגה.
| טיפוסים בני מנייה (enum) | |
|---|---|
AD_TYPE_UNSPECIFIED |
סוג המודעה לא צוין. |
AD_TYPE_DISPLAY |
מודעה לרשת המדיה. |
AD_TYPE_TEXT |
מודעת טקסט. |
AD_TYPE_IMAGE |
מודעת תמונה. |
AD_TYPE_RICH_MEDIA |
מודעת מדיה עשירה. |
AD_TYPE_HTML |
מודעת HTML. |
AD_TYPE_AUDIO |
מודעת אודיו. |
AD_TYPE_VIDEO |
מודעת וידאו. |
AdFormat
הפורמט של המודעה שהוצגה.
| טיפוסים בני מנייה (enum) | |
|---|---|
AD_FORMAT_UNSPECIFIED |
פורמט המודעה לא צוין. |
AD_FORMAT_AR |
מודעת AR. |
AD_FORMAT_AUDIO |
מודעת אודיו. |
AD_FORMAT_BANNER |
מודעת באנר. |
AD_FORMAT_BUMPER |
מודעת באמפר. |
AD_FORMAT_CAROUSEL |
מודעת קרוסלה. |
AD_FORMAT_COLLECTION |
מודעת אוסף. |
AD_FORMAT_IMAGE |
מודעת תמונה. |
AD_FORMAT_INTERACTIVE |
מודעה אינטראקטיבית. |
AD_FORMAT_INTERSTITIAL |
מודעת מעברון. |
AD_FORMAT_IN_FEED |
מודעה בגוף הפיד. |
AD_FORMAT_IN_STREAM |
מודעת וידאו In-stream. |
AD_FORMAT_IN_STREAM_SKIPPABLE |
מודעת וידאו In-stream שאפשר לדלג עליה. |
AD_FORMAT_IN_STREAM_NON_SKIPPABLE |
מודעת וידאו In-stream שלא ניתן לדלג עליה. |
AD_FORMAT_NATIVE |
מודעה מותאמת. |
AD_FORMAT_SHORTS |
מודעה ב-Shorts. |
AD_FORMAT_STORY |
מודעת קרוסלה למובייל. |
AD_FORMAT_SPONSORED |
מודעה ממומנת. |
AD_FORMAT_VIDEO |
מודעת וידאו. |
AdPlacement
מיקום המודעה שהוצגה.
| טיפוסים בני מנייה (enum) | |
|---|---|
AD_PLACEMENT_UNSPECIFIED |
מיקום המודעה לא צוין. |
AD_PLACEMENT_DISCOVER |
גילוי מיקום מודעה. |
AD_PLACEMENT_FEED |
מיקום הפיד. |
AD_PLACEMENT_FOOTER |
מיקום הכותרת התחתונה. |
AD_PLACEMENT_HEADER |
מיקום הכותרת. |
AD_PLACEMENT_HOME |
מיקום בדף הבית. |
AD_PLACEMENT_IN_CONTENT |
מיקום בתוך התוכן. |
AD_PLACEMENT_PROMOTED |
מיקום מקודם. |
AD_PLACEMENT_SEARCH |
מיקום מודעה ברשת החיפוש. |
AD_PLACEMENT_STORY |
מיקום הסטורי. |
TargetingType
סוג הטירגוט ששימש להצגת המודעה.
| טיפוסים בני מנייה (enum) | |
|---|---|
TARGETING_TYPE_UNSPECIFIED |
סוג הטירגוט לא צוין. |
TARGETING_TYPE_AUDIENCE |
טירגוט לפי קהל. |
TARGETING_TYPE_CONTEXTUAL |
טירגוט לפי הקשר. |
TARGETING_TYPE_DEMOGRAPHIC |
טירגוט דמוגרפי. |
TARGETING_TYPE_DEVICE |
טירגוט לפי מכשיר. |
TARGETING_TYPE_GEO |
טירגוט גיאוגרפי. |
TARGETING_TYPE_INTEREST |
טירגוט לפי תחומי עניין. |
TARGETING_TYPE_PURCHASE_INTENT |
טירגוט לפי כוונת רכישה. |
TARGETING_TYPE_REMARKETING |
טירגוט לרימרקטינג. |
PlatformType
סוג הפלטפורמה שבה הוצגה המודעה.
| טיפוסים בני מנייה (enum) | |
|---|---|
PLATFORM_TYPE_UNSPECIFIED |
סוג הפלטפורמה לא צוין. |
PLATFORM_TYPE_MOBILE |
פלטפורמה לנייד. |
PLATFORM_TYPE_DESKTOP |
פלטפורמת מחשב. |
PLATFORM_TYPE_CTV |
פלטפורמת CTV. |
PLATFORM_TYPE_PHONE |
פלטפורמת טלפון. |
PLATFORM_TYPE_TABLET |
פלטפורמת טאבלט. |
פלטפורמה
פרטים נוספים על הפלטפורמה שבה המודעה הוצגה.
| טיפוסים בני מנייה (enum) | |
|---|---|
PLATFORM_UNSPECIFIED |
פלטפורמה לא צוינה. |
PLATFORM_IOS |
פלטפורמת iOS. |
PLATFORM_ANDROID |
פלטפורמת Android. |
PLATFORM_WEB |
פלטפורמה לאינטרנט. |
AttributionHint
סטטוס השיוך המשוער של השותף לאירוע הצגת המודעה הזה.
| טיפוסים בני מנייה (enum) | |
|---|---|
ATTRIBUTION_HINT_UNSPECIFIED |
סטטוס השיוך לא ידוע. |
ATTRIBUTION_HINT_CONVERTED |
סטטוס ההמרה. |
ATTRIBUTION_HINT_NOT_CONVERTED |
סטטוס לא הומר. |
ViewabilityInfo
פרטים על מידת הניראות של המודעה שהוצגה.
| ייצוג ב-JSON |
|---|
{ "viewType": enum ( |
| שדות | |
|---|---|
viewType |
חובה. סוג האירוע. |
viewablePercent |
אופציונלי. האחוז המספרי (0-100) של הפיקסלים שהיו ניתנים לצפייה. |
viewableDuration |
אופציונלי. משך הזמן שבו המודעה הייתה ניתנת לצפייה. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
mediaSkippable |
אופציונלי. האם המדיה של המודעה הייתה ניתנת לדילוג או לא. |
mediaQuartile |
אופציונלי. כמות המדיה שהופעלה כרבעונים נפרדים. |
mediaDuration |
אופציונלי. משך הזמן של המדיה במודעה. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
mediaVolumePercent |
אופציונלי. האחוז המספרי (0-100) של עוצמת הקול של הפעלת המדיה. |
playbackDuration |
אופציונלי. משך ההפעלה של המדיה של המודעה, בלי קשר לשאלה אם היא הייתה גלויה או לא. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
ViewType
סוג האירוע.
| טיפוסים בני מנייה (enum) | |
|---|---|
VIEW_TYPE_UNSPECIFIED |
סוג התצוגה לא צוין. |
VIEW_TYPE_MRC_VIEWED |
צפייה שאושרה על ידי MRC. |
VIEW_TYPE_MRC_RENDERED |
הסרטון עבר עיבוד על ידי MRC. |
MediaQuartile
כמות המדיה שהופעלה כרבעונים נפרדים.
| טיפוסים בני מנייה (enum) | |
|---|---|
MEDIA_QUARTILE_UNSPECIFIED |
רבעון לא מוגדר של מדיה. |
MEDIA_QUARTILE_START |
התחלה. |
MEDIA_QUARTILE_FIRST_QUARTILE |
רבעון ראשון. |
MEDIA_QUARTILE_MIDPOINT |
נקודת אמצע. |
MEDIA_QUARTILE_THIRD_QUARTILE |
רבעון שלישי. |
MEDIA_QUARTILE_COMPLETE |
הפעולה הושלמה. |