ディスプレイとVideo 360 API v2 は廃止されます。[ディスプレイとVideo 360 API v3 を使用してください。v2 から v3 への移行手順については、移行ガイドをご覧ください。

このページは Cloud Translation API によって翻訳されました。

REST Resource: advertisers.insertionOrders

リソース: InsertionOrder
- JSON 表現
InsertionOrderType
KPI
- JSON 表現
KpiType
InsertionOrderBudget
- JSON 表現
InsertionOrderAutomationType
InsertionOrderBudgetSegment
- JSON 表現
OptimizationObjective
メソッド

リソース: InsertionOrder

1 つの広告掲載オーダー。

JSON 表現

JSON 表現
{ "name": string, "advertiserId": string, "campaignId": string, "insertionOrderId": string, "displayName": string, "insertionOrderType": enum (`InsertionOrderType`), "entityStatus": enum (`EntityStatus`), "updateTime": string, "partnerCosts": [ { object (`PartnerCost`) } ], "pacing": { object (`Pacing`) }, "frequencyCap": { object (`FrequencyCap`) }, "integrationDetails": { object (`IntegrationDetails`) }, "kpi": { object (`Kpi`) }, "budget": { object (`InsertionOrderBudget`) }, "bidStrategy": { object (`BiddingStrategy`) }, "reservationType": enum (`ReservationType`), "optimizationObjective": enum (`OptimizationObjective`) }

{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "insertionOrderId": string,
  "displayName": string,
  "insertionOrderType": enum (InsertionOrderType),
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "partnerCosts": [
    {
      object (PartnerCost)
    }
  ],
  "pacing": {
    object (Pacing)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "kpi": {
    object (Kpi)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "optimizationObjective": enum (OptimizationObjective)
}

フィールド
`name`	`string` 出力専用。広告掲載オーダーのリソース名。
`advertiserId`	`string (int64 format)` 出力専用。広告掲載オーダーが属する広告主の一意の ID。
`campaignId`	`string (int64 format)` 必須。変更不可。広告掲載オーダーが属するキャンペーンの一意の ID。
`insertionOrderId`	`string (int64 format)` 出力専用。広告掲載オーダーの一意の ID。システムによって割り当てられます。
`displayName`	`string` 必須。広告掲載オーダーの表示名。 UTF-8 でエンコードし、最大サイズは 240 バイトにする必要があります。
`insertionOrderType`	`enum (InsertionOrderType)` 広告掲載オーダーのタイプ。作成時にこのフィールドを指定しない場合は、デフォルトで `RTB` になります。
`entityStatus`	`enum (EntityStatus)` 必須。広告掲載オーダーの予算を消化して広告枠に入札できるかどうかを制御します。 `insertionOrders.create` メソッドの場合、`ENTITY_STATUS_DRAFT` のみが許可されます。広告掲載オーダーを有効にするには、`insertionOrders.patch` メソッドを使用して、作成後にステータスを `ENTITY_STATUS_ACTIVE` に更新します。広告掲載オーダーのステータスを他のステータスから `ENTITY_STATUS_DRAFT` に戻すことはできません。親キャンペーンが有効でない場合、広告掲載オーダーを `ENTITY_STATUS_ACTIVE` に設定することはできません。
`updateTime`	`string (Timestamp format)` 出力専用。広告掲載オーダーが最後に更新されたときのタイムスタンプ。システムによって割り当てられます。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: `"2014-10-02T15:01:23Z"`、`"2014-10-02T15:01:23.045123456Z"`。
`partnerCosts[]`	`object (PartnerCost)` 広告掲載オーダーに関連付けられたパートナー費用。 `insertionOrders.create` メソッドに存在しない場合、または空の場合、新しく作成された広告掲載オーダーは、パートナー設定からパートナー費用を継承します。
`pacing`	`object (Pacing)` 必須。広告掲載オーダーの予算支出速度の設定。警告: 2024 年 11 月 5 日より、`pacingType` `PACING_TYPE_ASAP` は `pacingPeriod` `PACING_PERIOD_FLIGHT` との互換性を失います。この変更について詳しくはこちらをご覧ください。
`frequencyCap`	`object (FrequencyCap)` 必須。広告掲載オーダーのフリークエンシーキャップの設定。
`integrationDetails`	`object (IntegrationDetails)` 広告掲載オーダーの追加の統合の詳細。
`kpi`	`object (Kpi)` 必須。広告掲載オーダーの重要業績評価指標（KPI）。これは、ディスプレイ＆ビデオ 360 の管理画面では「目標」と呼ばれます。
`budget`	`object (InsertionOrderBudget)` 必須。広告掲載オーダーの予算割り当て設定。
`bidStrategy`	`object (BiddingStrategy)` 広告掲載オーダーの入札戦略。デフォルトでは `fixedBid` が設定されています。
`reservationType`	`enum (ReservationType)` 出力専用。広告掲載オーダーの予約タイプ。
`optimizationObjective`	`enum (OptimizationObjective)` 省略可。広告掲載オーダーの最適化の目標。このフィールドは、許可リストに登録されたお客様のみご利用いただけます。お客様が許可リストに登録されていない場合、このフィールドは null になり、設定しようとするとエラーが返されます。

InsertionOrderType

広告掲載オーダーのタイプ。

広告掲載オーダーのタイプによって、適用できる設定やオプション（広告のフォーマットやターゲティングオプションなど）が決まります。

列挙型
`INSERTION_ORDER_TYPE_UNSPECIFIED`	広告掲載オーダーのタイプが指定されていないか、不明です。
`RTB`	リアルタイムビッダー。
`OVER_THE_TOP`	過剰。

主要業績評価指標

広告掲載オーダーの重要業績評価指標（KPI）を管理する設定です。

JSON 表現

JSON 表現
{ "kpiType": enum (`KpiType`), "kpiAlgorithmId": string, // Union field `kpi_value` can be only one of the following: "kpiAmountMicros": string, "kpiPercentageMicros": string, "kpiString": string // End of list of possible types for union field `kpi_value`. }

{
  "kpiType": enum (KpiType),
  "kpiAlgorithmId": string,

  // Union field kpi_value can be only one of the following:
  "kpiAmountMicros": string,
  "kpiPercentageMicros": string,
  "kpiString": string
  // End of list of possible types for union field kpi_value.
}

フィールド
`kpiType`	`enum (KpiType)` 必須。KPI のタイプ。
`kpiAlgorithmId`	`string (int64 format)` 省略可。KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST に関連付けられているカスタム入札アルゴリズム ID。適切な KPI が選択されていない場合、このフィールドは無視されます。
共用体フィールド `kpi_value`。必須。KPI の値。関連するフィールドは `kpi_type` に対応します。`kpi_value` は次のいずれかになります。
`kpiAmountMicros`	`string (int64 format)` 目標金額（広告主の通貨のマイクロ単位）。 `kpiType` が次のいずれかの場合に有効です。 `KPI_TYPE_CPM` `KPI_TYPE_CPC` `KPI_TYPE_CPA` `KPI_TYPE_CPIAVC` `KPI_TYPE_VCPM` たとえば、1500000 は、通貨の 1.5 標準単位を表します。
`kpiPercentageMicros`	`string (int64 format)` 目標の割合をマイクロ単位で表した小数値。 `kpiType` が次のいずれかの場合に有効です。 `KPI_TYPE_CTR` `KPI_TYPE_VIEWABILITY` `KPI_TYPE_CLICK_CVR` `KPI_TYPE_IMPRESSION_CVR` `KPI_TYPE_VTR` `KPI_TYPE_AUDIO_COMPLETION_RATE` `KPI_TYPE_VIDEO_COMPLETION_RATE` たとえば、70000 は 7%（小数点以下 0.07）を表します。
`kpiString`	`string` KPI 文字列。空にすることもできます。UTF-8 でエンコードし、長さを 100 文字以下にする必要があります。 `kpiType` が `KPI_TYPE_OTHER` の場合に有効です。

KpiType

使用できる主要業績評価指標（KPI）の種類。

列挙型
`KPI_TYPE_UNSPECIFIED`	このバージョンでは、KPI のタイプが指定されていないか不明です。
`KPI_TYPE_CPM`	KPI は CPM（インプレッション単価）です。
`KPI_TYPE_CPC`	KPI は CPC（クリック単価）です。
`KPI_TYPE_CPA`	KPI は CPA（アクション単価）です。
`KPI_TYPE_CTR`	KPI は CTR（クリック率）の割合です。
`KPI_TYPE_VIEWABILITY`	KPI は視認可能率です。
`KPI_TYPE_CPIAVC`	KPI は CPIAVC（再生完了時に聴取可能かつ視認可能なインプレッション単価）です。
`KPI_TYPE_CPE`	KPI は CPE（エンゲージメント単価）です。
`KPI_TYPE_CPV`	KPI は広告視聴単価（CPV）で設定されます。
`KPI_TYPE_CLICK_CVR`	KPI は、クリックコンバージョン率（クリックあたりのコンバージョン数）の割合です。
`KPI_TYPE_IMPRESSION_CVR`	KPI は、インプレッションコンバージョン率（インプレッションあたりのコンバージョン数）の割合です。
`KPI_TYPE_VCPM`	KPI は VCPM（視認範囲のインプレッション単価）です。
`KPI_TYPE_VTR`	KPI は、YouTube 視聴率（インプレッションあたりの YouTube 視聴回数）の割合です。
`KPI_TYPE_AUDIO_COMPLETION_RATE`	KPI は、音声視聴完了率（インプレッションあたりの音声視聴完了数）の割合です。
`KPI_TYPE_VIDEO_COMPLETION_RATE`	KPI は動画視聴完了率（インプレッションあたりの動画視聴完了数）の割合です。
`KPI_TYPE_CPCL`	KPI は CPCL（音声の再生完了単価）で設定されます。
`KPI_TYPE_CPCV`	KPI は動画の再生完了単価（CPCV）で設定されます。
`KPI_TYPE_TOS10`	この目標指標は、画面に 10 秒以上表示されたインプレッションの割合（測定可能でスキップ不可のインプレッションのうち、画面に 10 秒以上表示されたインプレッションの割合）で設定されます。
`KPI_TYPE_MAXIMIZE_PACING`	KPI は、予算を使い切ることを優先しながらブランドの影響力を最大化するように設定されています。
`KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST`	KPI は、カスタムインプレッション値を費用で割った値で設定されます。
`KPI_TYPE_OTHER`	KPI が他の値である。

InsertionOrderBudget

広告掲載オーダーの予算の割り当て方法を制御する設定。

JSON 表現
{ "budgetUnit": enum (`BudgetUnit`), "automationType": enum (`InsertionOrderAutomationType`), "budgetSegments": [ { object (`InsertionOrderBudgetSegment`) } ] }

フィールド

フィールド
`budgetUnit`	`enum (BudgetUnit)` 必須。変更不可。予算単位は、予算が通貨ベースかインプレッション数ベースかを示します。
`automationType`	`enum (InsertionOrderAutomationType)` 広告掲載オーダーの入札単価と予算の管理に使用される自動化のタイプ。作成時にこのフィールドを指定しない場合は、デフォルト値の `INSERTION_ORDER_AUTOMATION_TYPE_NONE` が使用されます。
`budgetSegments[]`	`object (InsertionOrderBudgetSegment)` 必須。予算セグメントのリスト。予算セグメントを使用して、広告掲載オーダーの一定期間における特定の予算を指定します。

budgetUnit

enum (BudgetUnit)

必須。変更不可。予算単位は、予算が通貨ベースかインプレッション数ベースかを示します。

automationType

enum (InsertionOrderAutomationType)

広告掲載オーダーの入札単価と予算の管理に使用される自動化のタイプ。

作成時にこのフィールドを指定しない場合は、デフォルト値の INSERTION_ORDER_AUTOMATION_TYPE_NONE が使用されます。

budgetSegments[]

object (InsertionOrderBudgetSegment)

必須。予算セグメントのリスト。予算セグメントを使用して、広告掲載オーダーの一定期間における特定の予算を指定します。

InsertionOrderAutomationType

広告掲載オーダーの入札単価と予算を自動化するためのオプション。

列挙型
`INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED`	このバージョンでは、広告掲載オーダーの自動化オプションが指定されていないか、不明です。
`INSERTION_ORDER_AUTOMATION_TYPE_BUDGET`	予算の自動割り当て。`kpi` で定義されたパフォーマンスを最適化するために、システムが所有する広告申込情報に予算を自動的に移行できるようにします。入札単価の設定は自動化されません。
`INSERTION_ORDER_AUTOMATION_TYPE_NONE`	広告掲載オーダー単位での入札単価や予算の自動化は行われません。入札単価と予算は、広告申込情報単位で手動で設定する必要があります。
`INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`	システムが入札単価を自動的に調整し、独自の広告申込情報に予算をシフトして、`kpi` で定義されたパフォーマンスを最適化できるようにします。

InsertionOrderBudgetSegment

単一の予算セグメントの予算を管理する設定。

JSON 表現
{ "budgetAmountMicros": string, "description": string, "dateRange": { object (`DateRange`) }, "campaignBudgetId": string }

フィールド
`budgetAmountMicros`	`string (int64 format)` 必須。特定の `dateRange` に対して広告掲載オーダーで使用される予算額。金額はマイクロ秒単位です。0 より大きくする必要があります。たとえば、500000000 は、通貨の 500 標準単位を表します。
`description`	`string` 予算セグメントの説明。予算セグメントごとに購入注文情報を入力し、その情報を請求書に印刷できます。 UTF-8 でエンコードする必要があります。
`dateRange`	`object (DateRange)` 必須。予算セグメントの開始日と終了日の設定。親広告主のタイムゾーンを基準に解決されます。新しい予算セグメントを作成する場合は、`startDate` と `endDate` の両方が将来の日付である必要があります。過去に `startDate` が設定されている既存の予算セグメントには、`endDate` は変更可能ですが、`startDate` は変更できません。 `endDate` は `startDate` 以降で、2037 年より前である必要があります。
`campaignBudgetId`	`string (int64 format)` この広告掲載オーダーの予算セグメントが属するキャンペーン予算の `budgetId`。

OptimizationObjective

考えられる最適化目標のタイプ。

列挙型
`OPTIMIZATION_OBJECTIVE_UNSPECIFIED`	このバージョンでタイプ値が指定されていないか、不明です。
`CONVERSION`	売り上げとコンバージョンを増やすインプレッションを優先します。
`CLICK`	ウェブサイト、アプリ、アプリストアのトラフィックを増やすインプレッションを優先します。
`BRAND_AWARENESS`	特定の品質のインプレッションを優先します。
`CUSTOM`	目標は、割り当てられたカスタム入札アルゴリズムによって定義されます。
`NO_OBJECTIVE`	目標が定義されていません。任意の KPI または入札戦略を使用できます。

メソッド
`create`	新しい広告掲載オーダーを作成します。
`delete`	広告掲載オーダーを削除します。
`get`	広告掲載オーダーを取得します。
`list`	広告主の広告掲載オーダーを一覧表示します。
`listAssignedTargetingOptions`	さまざまなターゲティングタイプで、広告掲載オーダーに割り当てられているターゲティングオプションを一覧表示します。
`patch`	既存の広告掲載オーダーを更新します。

REST Resource: advertisers.insertionOrders

リソース: InsertionOrder

InsertionOrderType

主要業績評価指標

KpiType

InsertionOrderBudget

InsertionOrderAutomationType

InsertionOrderBudgetSegment

OptimizationObjective

メソッド

`create`

`delete`

`get`

`list`

`listAssignedTargetingOptions`

`patch`