REST Resource: advertisers.insertionOrders

リソース: InsertionOrder

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

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

出力専用。挿入オーダーが最後に更新されたときのタイムスタンプ。システムによって割り当てられます。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
partnerCosts[]

object (PartnerCost)

省略可。純広告オーダーに関連付けられたパートナー費用。

insertionOrders.create メソッドで指定されていない場合、または空の場合、新しく作成された広告掲載オーダーはパートナー設定からパートナー費用を継承します。
pacing

object (Pacing)

必須。広告掲載オーダーの予算消化速度の設定。

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)

必須。広告掲載オーダーの最適化目標。

InsertionOrderType

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

広告のフォーマットやターゲティング オプションなど、適用される設定やオプションは、広告申込情報のタイプによって決まります。

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

主要業績評価指標

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

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)

必須。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)

目標の割合をマイクロ単位で表した 10 進数。

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%（10 進数 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（視認可能なインプレッション 1,000 回あたりの費用）です。
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 KPI は、画面に 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)

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

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

メソッド

create

 新しい広告掲載オーダーを作成します。

delete

 広告掲載オーダーを削除します。

get

 広告掲載オーダーを取得します。

list

 広告主の広告掲載オーダーを一覧表示します。

listAssignedTargetingOptions

 ターゲティング タイプ全体で、広告掲載オーダーに割り当てられたターゲティング オプションを一覧表示します。

patch

 既存の広告掲載オーダーを更新します。