Method: advertisers.reachForecast.generateReachForecast

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

בקשת HTTP

POST https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/reachForecast:generateReachForecast

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

פרמטרים של נתיב

פרמטרים
advertiserId

string (int64 format)

חובה. המזהה של המפרסם שיפעיל את הקמפיין המתוכנן.

גוף הבקשה

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

ייצוג ב-JSON 
{
  "targeting": {
    object (Targeting)
  },
  "campaignDuration": {
    object (CampaignDuration)
  },
  "currencyCode": string,
  "plannedProducts": [
    {
      object (PlannedProduct)
    }
  ],
  "minEffectiveFrequency": integer
}
שדות
targeting

object (Targeting)

חובה. פרמטרי הטירגוט של הקמפיין המתוכנן.
campaignDuration

object (CampaignDuration)

חובה. משך הקמפיין המתוכנן.
currencyCode

string

חובה. קוד המטבע של התוכנית בפורמט ISO 4217.
plannedProducts[]

object (PlannedProduct)

חובה. רשימת הפריטים להכללה בתחזית.
minEffectiveFrequency

integer

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

המספר צריך להיות בין 1 ל-10, כולל. אם לא מציינים ערך, ברירת המחדל היא 1.

גוף התשובה

הודעת תגובה ל-ReachForecastService.GenerateReachForecast.

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "onTargetAudienceMetrics": {
    object (OnTargetAudienceMetrics)
  },
  "reachCurve": {
    object (ReachCurve)
  }
}
שדות
onTargetAudienceMetrics

object (OnTargetAudienceMetrics)

הגדלים המשוערים של הקהלים במיקום הגיאוגרפי המטורגט.
reachCurve

object (ReachCurve)

עקומת התחזית שנוצרה.

היקפי הרשאות

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

  • https://www.googleapis.com/auth/display-video

ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.

טירגוט

הגדרות הטירגוט של קמפיין מתוכנן.

ייצוג ב-JSON 
{
  "plannableLocationIds": [
    string
  ],
  "ageRange": enum (PlannableAgeRange),
  "genders": [
    enum (Gender)
  ],
  "devices": [
    enum (DeviceType)
  ]
}
שדות
plannableLocationIds[]

string (int64 format)

חובה. מזהים של מיקומים שאפשר לטרגט אליהם.

אפשר לאחזר מיקומים שניתן לתכנן באמצעות ה-method‏ reachForecast.retrievePlannableLocations.
ageRange

enum (PlannableAgeRange)

אופציונלי. טווח הגילאים לטירגוט.
genders[]

enum (Gender)

אופציונלי. אפשרויות המגדר לטירגוט.
devices[]

enum (DeviceType)

אופציונלי. המכשירים שמטרגטים.

CampaignDuration

משך הזמן של תוכנית פוטנציאל החשיפה.

ייצוג ב-JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "durationDays": integer,
  "dateRange": {
    object (DateRange)
  }
  // End of mutually exclusive fields.
}
שדות
בחירת משך הזמן של הקמפיין. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
durationDays

integer

חובה. מספר הימים שהתוכנית מכסה.
dateRange

object (DateRange)

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

PlannedProduct

הגדרות למוצר ספציפי בתוכנית.

ייצוג ב-JSON 
{
  "plannableProductCode": string,
  "budgetMicros": string,
  "advancedProductTargeting": {
    object (AdvancedProductTargeting)
  }
}
שדות
plannableProductCode

string

חובה. הקוד של המוצר, למשל VIDEO_REACH_CAMPAIGN.
budgetMicros

string (int64 format)

חובה. התקציב של המוצר הזה ב-micros.
advancedProductTargeting

object (AdvancedProductTargeting)

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

AdvancedProductTargeting

שינויים בטירגוט שספציפיים למוצר.

ייצוג ב-JSON 
{
  "surfaceTargetingSettings": {
    object (SurfaceTargetingSettings)
  },
  "targetFrequency": {
    object (TargetFrequency)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "ageRange": enum (PlannableAgeRange),
  "genders": [
    enum (Gender)
  ],
  "devices": [
    enum (DeviceType)
  ],
  "userInterestIds": [
    string
  ],
  "userListIds": [
    string
  ],
  "youtubeSelectSettings": {
    object (YouTubeSelectSettings)
  },
  "dateRange": {
    object (DateRange)
  },
  "plannableLocationIds": [
    string
  ],
  "network": enum (PlannableNetwork)
}
שדות
surfaceTargetingSettings

object (SurfaceTargetingSettings)

אופציונלי. פלטפורמות שניתן לטרגט בהן.
targetFrequency

object (TargetFrequency)

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

object (FrequencyCap)

אופציונלי. מכסת התדירות של המוצר הספציפי.
ageRange

enum (PlannableAgeRange)

אופציונלי. טווח הגילאים לטירגוט.
genders[]

enum (Gender)

אופציונלי. אפשרויות המגדר לטירגוט.
devices[]

enum (DeviceType)

אופציונלי. המכשירים שמטרגטים.
userInterestIds[]

string

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

אפשר לאחזר תחומי עניין של משתמשים שאפשר לתכנן לגביהם באמצעות השיטה reachForecast.retrievePlannableUserInterests.
userListIds[]

string

אופציונלי. מזהי רשימות המשתמשים לטירגוט.

אפשר לאחזר רשימות משתמשים שניתן לתכנן באמצעות method‏ reachForecast.retrievePlannableUserInterests.
youtubeSelectSettings

object (YouTubeSelectSettings)

אופציונלי. הגדרות של YouTube Select.
dateRange

object (DateRange)

אופציונלי. טווח התאריכים לטירגוט.
plannableLocationIds[]

string (int64 format)

אופציונלי. מזהי מיקומים גיאוגרפיים שאפשר לטרגט.
network

enum (PlannableNetwork)

אופציונלי. הרשת לטירגוט.

SurfaceTargetingSettings

בחירה של טירגוט לפי פלטפורמה.

ייצוג ב-JSON 
{
  "surfaces": [
    enum (PlannableSurface)
  ]
}
שדות
surfaces[]

enum (PlannableSurface)

אופציונלי. הפלטפורמות לטירגוט.

YouTubeSelectSettings

הגדרות של חבילות ערוצים של YouTube Select.

ייצוג ב-JSON 
{
  "lineupId": string
}
שדות
lineupId

string (int64 format)

אופציונלי. המזהה של חבילת הערוצים של YouTube Select.

OnTargetAudienceMetrics

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

ייצוג ב-JSON 
{
  "youtubeAudienceSize": string,
  "censusAudienceSize": string
}
שדות
youtubeAudienceSize

string (int64 format)

הגודל המשוער של הקהל ב-YouTube.
censusAudienceSize

string (int64 format)

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

ReachCurve

עקומת פוטנציאל החשיפה שנוצרה.

ייצוג ב-JSON 
{
  "reachForecasts": [
    {
      object (ReachForecast)
    }
  ]
}
שדות
reachForecasts[]

object (ReachForecast)

נקודות לאורך העקומה, מסודרות לפי עלות.

ReachForecast

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

ייצוג ב-JSON 
{
  "costMicros": string,
  "plannedProductReachForecasts": [
    {
      object (PlannedProductReachForecast)
    }
  ],
  "forecast": {
    object (PlannedProductForecast)
  }
}
שדות
costMicros

string (int64 format)

העלות הכוללת בנקודה הזו במיקרו.
plannedProductReachForecasts[]

object (PlannedProductReachForecast)

פירוט של מוצרים ספציפיים בנקודת העלות הזו.
forecast

object (PlannedProductForecast)

תחזית מצטברת לכל התוכנית.

PlannedProductReachForecast

תחזית ביצועים למוצר ספציפי.

ייצוג ב-JSON 
{
  "costMicros": string,
  "plannableProductCode": string,
  "plannedProductForecast": {
    object (PlannedProductForecast)
  }
}
שדות
costMicros

string (int64 format)

העלות ב-micros של המוצר הזה.
plannableProductCode

string

הקוד של המוצר.
plannedProductForecast

object (PlannedProductForecast)

מדדי ביצועים של המוצר.

PlannedProductForecast

מדדי ביצועים לנקודת תחזית.

ייצוג ב-JSON 
{
  "onTargetReach": string,
  "onTargetImpressions": string,
  "trueviewViews": string,
  "totalReach": string,
  "totalImpressions": string,
  "viewableImpressions": string,
  "onTargetCoviewReach": string,
  "totalCoviewReach": string,
  "onTargetCoviewImpressions": string,
  "totalCoviewImpressions": string
}
שדות
onTargetReach

string (int64 format)

מספר המשתמשים הייחודיים שנחשפו למודעות שתואמים להגדרה של קהל היעד לטירגוט.
onTargetImpressions

string (int64 format)

מספר החשיפות בקהל היעד.
trueviewViews

string (int64 format)

מספר הצפיות התקפות.
totalReach

string (int64 format)

המספר הכולל של משתמשים ייחודיים שנחשפו למודעות.
totalImpressions

string (int64 format)

מספר החשיפות הכולל.
viewableImpressions

string (int64 format)

מספר חשיפות הניתנות לצפייה.
onTargetCoviewReach

string (int64 format)

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

string (int64 format)

המספר הכולל של אנשים ייחודיים שנחשפו למודעות, כולל צופים בצפייה משותפת.
onTargetCoviewImpressions

string (int64 format)

מספר החשיפות בקהל היעד, כולל צופים בצפייה משותפת.
totalCoviewImpressions

string (int64 format)

המספר הכולל של החשיפות, כולל צופים בצפייה משותפת.