Method: advertisers.reachForecast.retrievePlannableProducts

ビジネスでプランニングできる商品の一覧を取得します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 Select Lineups。

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 CPV。
PLANNABLE_COST_MODEL_CPC CPC。
PLANNABLE_COST_MODEL_CPA CPA。