Method: advertisers.reachForecast.generateReachForecast

为给定广告客户和定位配置生成覆盖面预测。

HTTP 请求

POST https://displayvideo.googleapis.com/v5/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 表示法 
{

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

必需。此产品的预算（以微单位表示）。
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 优选设置。
dateRange

object (DateRange)

可选。要定位的日期范围。
plannableLocationIds[]

string (int64 format)

可选。要定位的可规划地理位置 ID。
network

enum (PlannableNetwork)

可选。要定位到的广告网络。

SurfaceTargetingSettings

Surface 定位选择。

JSON 表示法 
{
  "surfaces": [
    enum (PlannableSurface)
  ]
}
字段
surfaces[]

enum (PlannableSurface)

可选。要定位到的平台。

YouTubeSelectSettings

YouTube 优选频道组的设置。

JSON 表示法 
{
  "lineupId": string
}
字段
lineupId

string (int64 format)

可选。YouTube 优选频道组的 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)

总展示次数（包括同看者）。