Method: adEvents.ingest

העלאת רשימה של משאבי AdEvent ל-Google Analytics.

התכונה הזו זמינה רק לחשבונות שברשימת ההיתרים.

כותרות הרשאות:

בנוסף, בשיטה הזו צריך להגדיר את הכותרת הבאה כדי לציין איך ה-API מאשר את הגישה לבקשה:

  • ‫login-account: (חובה) שם המשאב של חשבון שותף הנתונים שבו חשבון Google של פרטי הכניסה הוא משתמש. פורמט: accountTypes/DATA_PARTNER/accounts/{loginAccountId}

בקשת HTTP

POST https://datamanager.googleapis.com/v1/adEvents:ingest

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "adEvents": [
    {
      object (AdEvent)
    }
  ],
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "validateOnly": boolean
}
שדות
adEvents[]

object (AdEvent)

חובה. חובה (לפחות 1). רשימה של אירועים שקשורים למודעות.
encryptionInfo

object (EncryptionInfo)

אופציונלי. מידע על מפתחות ההצפנה שמשמשים להצפנת הנתונים. חובה לספק את השדה הזה כשאירועים שקשורים למודעות מכילים את הערך UserData.
validateOnly
(deprecated)

boolean

אופציונלי. אם הערך הוא true, הבקשה מאומתת אבל לא מבוצעת.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יהיה ריק.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/datamanager

AdEvent

אירוע מודעה.

ייצוג ב-JSON 
{
  "advertiserId": string,
  "eventType": enum (EventType),
  "timestamp": string,
  "eventId": string,
  "userData": {
    object (UserData)
  },
  "deviceInfo": {
    object (DeviceInfo)
  },
  "ipAddress": string,
  "mobileDeviceId": string,
  "campaignId": string,
  "campaignName": string,
  "adGroupId": string,
  "adId": string,
  "adHeight": integer,
  "adWidth": integer,
  "regionCode": string,
  "source": string,
  "medium": string,
  "attributionHint": enum (AttributionHint),
  "viewabilityInfo": {
    object (ViewabilityInfo)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "eventSubtype": enum (EventSubtype),
  "eventSubtypeString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "adType": enum (AdType),
  "adTypeString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "adFormat": enum (AdFormat),
  "adFormatString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "adPlacement": enum (AdPlacement),
  "adPlacementString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "targetingType": enum (TargetingType),
  "targetingTypeString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "platformType": enum (PlatformType),
  "platformTypeString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "platform": enum (Platform),
  "platformString": string
  // End of mutually exclusive fields.
  "measurementAllowed": boolean
}
שדות
advertiserId

string

חובה. המזהה של המפרסם שמשויך לאירוע מודעה.

המזהה הזה צריך להיות זהה למזהה שנשלח בתהליך הקישור.
eventType

enum (EventType)

חובה. סוג האירוע.
timestamp

string (Timestamp format)

חובה. השעה שבה האירוע התרחש.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
eventId

string

אופציונלי. מזהה שנוצר ומנוהל על ידי המתקשר ומזהה באופן ייחודי את האירוע הזה.

חובה אם רוצים לבטל כפילויות של אירועים שקשורים למודעות ונכללים בכמה בקשות. בכל שאר המקרים, השדה הזה הוא אופציונלי.
userData

object (UserData)

אופציונלי. כמה פרטים שהמשתמשים סיפקו, שמייצגים את המשתמש שהאירוע משויך אליו.

אפשר לספק כמה מופעים של אותו סוג נתונים (למשל כתובת אימייל). ככל שתספקו יותר נתונים, כך גדל הסיכוי למצוא התאמה.
deviceInfo

object (DeviceInfo)

חובה. מידע שנאסף על המכשיר שבו נעשה שימוש כשאירוע שקשור למודעה התרחש.
ipAddress

string

אופציונלי. כתובת ה-IP שמשמשת למדידה. הערך הזה חייב להיות זהה לערך של DeviceInfo.ip_address. אם לא רוצים לשתף את כתובת ה-IP לצורך מדידה, משאירים את השדה ריק.
mobileDeviceId

string

אופציונלי. מזהה המכשיר שהמודעה הוצגה בו.
campaignId

string

חובה. המזהה של הקמפיין המשויך.
campaignName

string

חובה. השם של הקמפיין המשויך.
adGroupId

string

אופציונלי. המזהה של קבוצת המודעות המשויכת.
adId

string

אופציונלי. המזהה של המודעה המשויכת בקבוצה.
adHeight

integer

אופציונלי. גובה המודעה בפיקסלים.
adWidth

integer

אופציונלי. רוחב המודעה בפיקסלים.
regionCode

string

אופציונלי. המדינה בפורמט ISO 3166-2 בתוספת חלוקת משנה.
source

string

חובה. מקור הפלטפורמה של המודעה, בדומה למקור ב-Google Analytics.
medium

string

חובה. אמצעי ההגעה לאתר של המודעה, בדומה לאמצעי ההגעה לאתר ב-Google Analytics.
attributionHint

enum (AttributionHint)

אופציונלי. סטטוס השיוך המשוער של השותף לאירוע הזה שקשור למודעה.

הנתונים האלה משמשים רק כסיגנל לגבי השיוך שהשותף הניח שהתרחש, והם לא מחייבים תוצאה סופית בדוחות.
viewabilityInfo

object (ViewabilityInfo)

חובה. פרטים על מידת הניראות של המודעה שהוצגה.

אופציונלי. סיווג נוסף לגבי סוג אירוע המודעה.

כדי לטפל בערכים שאינם enum טהור, אפשר להשתמש במחרוזת גולמית. אם אפשר, עדיף להשתמש ב-enum. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
eventSubtype

enum (EventSubtype)

ערך enum לסוג משנה של אירוע.
eventSubtypeString

string

ערך המחרוזת של סוג המשנה של האירוע.
סוף השדות הבלעדיים.

אופציונלי. סוג המודעה שהוצגה.

כדי לטפל בערכים שאינם enum טהור, אפשר להשתמש במחרוזת גולמית. אם אפשר, עדיף להשתמש ב-enum. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
adType

enum (AdType)

ערך טיפוס בן מנייה (enum) של סוג המודעה.
adTypeString

string

ערך מחרוזת לסוג המודעה.
סוף השדות הבלעדיים.

אופציונלי. סוג המודעה שהוצגה.

כדי לטפל בערכים שאינם enum טהור, אפשר להשתמש במחרוזת גולמית. אם אפשר, עדיף להשתמש ב-enum. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
adFormat

enum (AdFormat)

ערך enum לפורמט המודעה.
adFormatString

string

ערך מחרוזת לפורמט המודעה.
סוף השדות הבלעדיים.

אופציונלי. מיקום המודעה שהוצגה.

כדי לטפל בערכים שאינם enum טהור, אפשר להשתמש במחרוזת גולמית. אם אפשר, עדיף להשתמש ב-enum. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
adPlacement

enum (AdPlacement)

ערך enum למיקום מודעה.
adPlacementString

string

ערך מחרוזת למיקום המודעה.
סוף השדות הבלעדיים.

אופציונלי. סוג הטירגוט ששימש להצגת המודעה.

כדי לטפל בערכים שאינם enum טהור, אפשר להשתמש במחרוזת גולמית. אם אפשר, עדיף להשתמש ב-enum. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
targetingType

enum (TargetingType)

ערך טיפוסים בני מנייה (enum) לסוג הטירגוט.
targetingTypeString

string

ערך מחרוזת לסוג הטירגוט.
סוף השדות הבלעדיים.

אופציונלי. סוג הפלטפורמה שבה הוצגה המודעה.

כדי לטפל בערכים שאינם enum טהור, אפשר להשתמש במחרוזת גולמית. אם אפשר, עדיף להשתמש ב-enum. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
platformType

enum (PlatformType)

ערך enum לסוג הפלטפורמה.
platformTypeString

string

ערך המחרוזת של סוג הפלטפורמה.
סוף השדות הבלעדיים.

אופציונלי. פרטים נוספים על הפלטפורמה שבה המודעה הוצגה.

כדי לטפל בערכים שאינם enum טהור, אפשר להשתמש במחרוזת גולמית. אם אפשר, עדיף להשתמש ב-enum. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
platform

enum (Platform)

ערך enum של פלטפורמה.
platformString

string

ערך מחרוזת לפלטפורמה.
סוף השדות הבלעדיים.
measurementAllowed

boolean

אופציונלי. הערך מציין אם מותר להשתמש בשורה למטרות מדידה, כפוף לחוקי הפרטיות הרלוונטיים בתחום השיפוט האזורי.

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_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_HEADER מיקום בכותרת.
AD_PLACEMENT_HOME מיקום מודעה בדף הבית.
AD_PLACEMENT_IN_CONTENT מיקום בתוך התוכן.
AD_PLACEMENT_PROMOTED מיקום מקודם.
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": integer,
  "viewableDuration": string,
  "mediaSkippable": boolean,
  "mediaQuartile": enum (MediaQuartile),
  "mediaDuration": string,
  "mediaVolumePercent": integer,
  "playbackDuration": string
}
שדות
viewType

enum (ViewType)

חובה. סוג האירוע.
viewablePercent

integer

אופציונלי. האחוז המספרי (0-100) של הפיקסלים שהיו ניתנים לצפייה.
viewableDuration

string (Duration format)

אופציונלי. משך הזמן שבו המודעה הייתה גלויה.

משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-s. דוגמה: "3.5s".
mediaSkippable

boolean

אופציונלי. האם אפשר היה לדלג על המדיה של המודעה.
mediaQuartile

enum (MediaQuartile)

אופציונלי. כמות המדיה שהופעלה כרבעונים נפרדים.
mediaDuration

string (Duration format)

אופציונלי. משך הזמן של המדיה במודעה.

משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-s. דוגמה: "3.5s".
mediaVolumePercent

integer

אופציונלי. האחוז המספרי (0-100) של עוצמת הקול של הפעלת המדיה.
playbackDuration

string (Duration format)

אופציונלי. משך ההפעלה של המדיה של המודעה, בלי קשר לשאלה אם היא הייתה גלויה או לא.

משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-s. דוגמה: "3.5s".

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 הפעולה הושלמה.