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)
  },
  "performanceGoal": {
    object (PerformanceGoal)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "billableOutcome": enum (BillableOutcome)
}
フィールド
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)

広告掲載オーダーのその他の統合の詳細。
performanceGoal

object (PerformanceGoal)

必須。広告掲載オーダーのパフォーマンス目標。
budget

object (InsertionOrderBudget)

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

object (BiddingStrategy)

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

enum (ReservationType)

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

enum (BillableOutcome)

変更不可。広告掲載オーダーの請求対象の結果。

成果ベースの購入はサポート終了となりました。有効な値は BILLABLE_OUTCOME_PAY_PER_IMPRESSION のみです。

InsertionOrderType

広告掲載オーダーの使用可能なタイプ。

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

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

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 予算の自動割り当てperformanceGoal で定義した掲載結果を最適化するために、システムで予算が自分の広告申込情報に自動的に移行されるようにします。入札単価設定は自動化されていません。
INSERTION_ORDER_AUTOMATION_TYPE_NONE 広告掲載オーダー単位で入札単価や予算が自動化されない。入札単価と予算は、広告申込情報レベルで手動で設定する必要があります。
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET 「performanceGoal」で定義されたパフォーマンスを最適化するために、システムで入札単価を自動的に調整して、その広告申込情報に予算をシフトすることを許可します。

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。

BillableOutcome

広告掲載オーダーで考えられる請求対象の結果。

列挙型
BILLABLE_OUTCOME_UNSPECIFIED 請求対象の結果が指定されていません。
BILLABLE_OUTCOME_PAY_PER_IMPRESSION インプレッション単価。
BILLABLE_OUTCOME_PAY_PER_CLICK

クリック課金型。
BILLABLE_OUTCOME_PAY_PER_VIEWABLE_IMPRESSION

アクティブ ビュー単価制。

Methods

bulkListInsertionOrderAssignedTargetingOptions

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

create

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

delete

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

get

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

list

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

patch

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