Method: advertisers.reachForecast.generateReachForecast

針對特定廣告主和指定目標設定產生觸及預測。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
advertiserId

string (int64 format)

必填。放送預定廣告活動的廣告主 ID。

要求主體

要求主體會包含結構如下的資料：

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 和 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)

必填。要指定的規劃地點 ID。

可規劃的地點可使用 reachForecast.retrievePlannableLocations 方法擷取。
ageRange

enum (PlannableAgeRange)

(選用步驟) 要指定的年齡層。
genders[]

enum (Gender)

(選用步驟) 要指定的性別選項。
devices[]

enum (DeviceType)

(選用步驟) 要指定的裝置。

CampaignDuration

觸及規劃的時間長度。

JSON 表示法 
{

  // Union field duration can be only one of the following:
  "durationDays": integer,
  "dateRange": {
    object (DateRange)
  }
  // End of list of possible types for union field duration.
}
欄位
聯集欄位 duration。選擇廣告活動時間長度。duration 只能是下列其中一項：
durationDays

integer

必填。方案涵蓋的天數。
dateRange

object (DateRange)

必填。方案涵蓋的日期範圍。

PlannedProduct

方案中特定產品的設定。

JSON 表示法 
{
  "plannableProductCode": string,
  "budgetMicros": string,
  "advancedProductTargeting": {
    object (AdvancedProductTargeting)
  }
}
欄位
plannableProductCode

string

必填。產品的程式碼，例如「VIDEO_REACH_CAMPAIGN」。
budgetMicros

string (int64 format)

必填。這項產品的預算 (以百萬分之一為單位)。
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

(選用步驟) 要指定的使用者興趣 ID。

您可以使用 reachForecast.retrievePlannableUserInterests 方法擷取可規劃的使用者興趣。
userListIds[]

string

(選用步驟) 要指定的使用者名單 ID。

您可以使用 reachForecast.retrievePlannableUserInterests 方法擷取可規劃的使用者名單。
youtubeSelectSettings

object (YouTubeSelectSettings)

(選用步驟) YouTube Select 設定。
dateRange

object (DateRange)

(選用步驟) 目標日期範圍。
plannableLocationIds[]

string (int64 format)

(選用步驟) 可規劃的指定地區 ID。
network

enum (PlannableNetwork)

(選用步驟) 要鎖定的網路。

SurfaceTargetingSettings

選取指定目標平台。

JSON 表示法 
{
  "surfaces": [
    enum (PlannableSurface)
  ]
}
欄位
surfaces[]

enum (PlannableSurface)

(選用步驟) 要指定的介面。

YouTubeSelectSettings

YouTube Select 首選頻道設定。

JSON 表示法 
{
  "lineupId": string
}
欄位
lineupId

string (int64 format)

(選用步驟) YouTube Select 首選頻道 ID。

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)

這項產品的費用 (以微元為單位)。
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)

TrueView 觀看數。
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)

曝光總數，包括共視觀眾。