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)
}
フィールド
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)

必須。広告掲載オーダーの予算支出速度の設定。
frequencyCap

object (FrequencyCap)

必須。広告掲載オーダーのフリークエンシー キャップ設定。
integrationDetails

object (IntegrationDetails)

広告掲載オーダーの統合に関する追加情報。
kpi

object (Kpi)

必須。広告掲載オーダーの重要業績評価指標（KPI）

目標は、ディスプレイ&ビデオ 360 のインターフェースでは「目標」と呼ばれます。
budget

object (InsertionOrderBudget)

必須。広告掲載オーダーの予算割り当て設定。
bidStrategy

object (BiddingStrategy)

広告掲載オーダーの入札戦略。デフォルトでは、fixedBid が設定されています。
reservationType

enum (ReservationType)

出力専用。広告掲載オーダーの予約タイプ。

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_impressions_VALUE_OVER_COST に関連付けられたカスタム入札アルゴリズム ID。適切な KPI が選択されていない場合、このフィールドは無視されます。
共用体フィールド kpi_value。必須。KPI の値。対応するフィールドは kpi_type に対応しています。kpi_value は次のいずれかになります。
kpiAmountMicros

string (int64 format)

目標金額（広告主の通貨の 100 万倍単位）。

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（視認範囲のインプレッション単価）です。
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

1 つの予算セグメントの予算を管理する設定です。

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。

方法

create

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

delete

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

get

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

list

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

listAssignedTargetingOptions

 さまざまなターゲティング タイプで広告掲載オーダーに割り当てられているターゲティング オプションを一覧表示します。

patch

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