Method: advertisers.reachForecast.retrievePlannableProducts

检索可针对某个位置规划的产品列表。

HTTP 请求

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/reachForecast:retrievePlannableProducts

网址采用 gRPC 转码语法。

路径参数

参数
advertiserId

string (int64 format)

必需。要列出可规划产品的广告客户的 ID。

查询参数

参数
plannableLocationId

string

必需。可规划位置的 ID。

请求正文

请求正文必须为空。

响应正文

reachForecast.retrievePlannableProducts 的响应

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "productMetadata": [
    {
      object (ProductMetadata)
    }
  ]
}
字段
productMetadata[]

object (ProductMetadata)

仅限输出。显示定位可能性的产品元数据列表。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅 OAuth 2.0 Overview。

ProductMetadata

可规划产品的元数据。

JSON 表示法 
{
  "plannableProductDescription": string,
  "plannableProductCode": string,
  "plannableTargeting": {
    object (PlannableTargeting)
  },
  "displayName": string,
  "plannableProductCoreAttributes": {
    object (PlannableProductCoreAttributes)
  }
}
字段
plannableProductDescription

string

仅限输出。广告产品的纯文本说明。
plannableProductCode

string

仅限输出。可规划产品代码（例如“YOUTUBE_REACH_MIX”）。
plannableTargeting

object (PlannableTargeting)

仅限输出。此产品可用的定位功能。
displayName

string

仅限输出。与广告产品关联的名称。例如：“视频观看广告系列”。
plannableProductCoreAttributes

object (PlannableProductCoreAttributes)

仅限输出。此产品的核心属性。

PlannableTargeting

给定产品的定位功能。

JSON 表示法 
{
  "ageRanges": [
    enum (PlannableAgeRange)
  ],
  "surfaceTargetingCombinations": {
    object (SurfaceTargetingCombinations)
  },
  "genders": [
    enum (Gender)
  ],
  "networks": [
    enum (PlannableNetwork)
  ],
  "devices": [
    enum (DeviceType)
  ],
  "youtubeSelectLineups": [
    {
      object (YouTubeSelectLineUp)
    }
  ],
  "defaultYoutubeSelectLineup": {
    object (YouTubeSelectLineUp)
  }
}
字段
ageRanges[]

enum (PlannableAgeRange)

仅限输出。产品允许的可规划年龄范围。实际定位是通过将此年龄段映射到标准 Google 年龄定位来计算的。
surfaceTargetingCombinations

object (SurfaceTargetingCombinations)

仅限输出。广告产品可定位的平台组合。
genders[]

enum (Gender)

仅限输出。广告产品可定位的性别。
networks[]

enum (PlannableNetwork)

仅限输出。广告产品可定位的广告联盟。
devices[]

enum (DeviceType)

仅限输出。广告产品可定位的设备。
youtubeSelectLineups[]

object (YouTubeSelectLineUp)

仅限输出。广告产品可定位的 YouTube 优选频道组。
defaultYoutubeSelectLineup

object (YouTubeSelectLineUp)

仅限输出。此产品的默认 YouTube 优选频道组（如果适用）。

SurfaceTargetingCombinations

平台定位规则。

JSON 表示法 
{
  "availableSurfaceTypes": [
    enum (PlannableSurface)
  ],
  "validSurfaceCombinations": [
    {
      object (SurfaceTargetingCombination)
    }
  ],
  "defaultSurfaceTypes": [
    enum (PlannableSurface)
  ]
}
字段
availableSurfaceTypes[]

enum (PlannableSurface)

仅限输出。可用的平台类型。
validSurfaceCombinations[]

object (SurfaceTargetingCombination)

仅限输出。可一起选择的有效平台组合。
defaultSurfaceTypes[]

enum (PlannableSurface)

仅限输出。此产品的默认平台类型。

SurfaceTargetingCombination

有效的平台组合。

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

enum (PlannableSurface)

仅限输出。平台组合。

YouTubeSelectLineUp

用于产品定位的可规划 YouTube 优选频道组。

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

string (int64 format)

仅限输出。YouTube 优选频道组的 ID。
displayName

string

仅限输出。YouTube 优选频道组的显示名称。

PlannableProductCoreAttributes

可规划产品的核心属性。

JSON 表示法 
{
  "productCategory": enum (PlannableProductCategory),
  "buyingMethod": enum (PlannableBuyingMethod),
  "costModel": enum (PlannableCostModel)
}
字段
productCategory

enum (PlannableProductCategory)

仅限输出。商品类别。
buyingMethod

enum (PlannableBuyingMethod)

仅限输出。购买方式。
costModel

enum (PlannableCostModel)

仅限输出。费用模式。

PlannableBuyingMethod

可规划产品的购买方式。

枚举
PLANNABLE_BUYING_METHOD_UNSPECIFIED 未指定。
PLANNABLE_BUYING_METHOD_AUCTION 竞价。
PLANNABLE_BUYING_METHOD_RESERVATION 预订。

PlannableCostModel

可规划产品的费用模式。

枚举
PLANNABLE_COST_MODEL_UNSPECIFIED 未指定。
PLANNABLE_COST_MODEL_CPM 每千次展示费用。
PLANNABLE_COST_MODEL_CPV 每次观看费用。
PLANNABLE_COST_MODEL_CPC 每次点击费用。
PLANNABLE_COST_MODEL_CPA 每次转化费用。