- リソース: InsertionOrder
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- InsertionOrderType
- KPI
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- KpiType
- InsertionOrderBudget
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- InsertionOrderAutomationType
- InsertionOrderBudgetSegment
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- OptimizationObjective
- メソッド
リソース: InsertionOrder
1 つの広告掲載オーダー。
JSON 表現 |
---|
{ "name": string, "advertiserId": string, "campaignId": string, "insertionOrderId": string, "displayName": string, "insertionOrderType": enum ( |
フィールド | |
---|---|
name |
出力専用。広告掲載オーダーのリソース名。 |
advertiserId |
出力専用。広告掲載オーダーが属する広告主の一意の ID。 |
campaignId |
必須。変更不可。広告掲載オーダーが属するキャンペーンの一意の ID。 |
insertionOrderId |
出力専用。広告掲載オーダーの一意の ID。システムによって割り当てられます。 |
displayName |
必須。広告掲載オーダーの表示名。 UTF-8 でエンコードし、最大サイズを 240 バイトにする必要があります。 |
insertionOrderType |
広告掲載オーダーのタイプ。 作成時にこのフィールドを指定しなかった場合、値はデフォルトで |
entityStatus |
必須。広告掲載オーダーの予算を消化して広告枠に入札できるかどうかを制御します。
|
updateTime |
出力専用。広告掲載オーダーが最後に更新されたときのタイムスタンプ。システムによって割り当てられます。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
partnerCosts[] |
広告掲載オーダーに関連付けられたパートナー費用。
|
pacing |
必須。広告掲載オーダーの予算支出速度の設定。 |
frequencyCap |
必須。広告掲載オーダーのフリークエンシー キャップ設定。 |
integrationDetails |
広告掲載オーダーの統合に関する追加の詳細。 |
kpi |
必須。広告掲載オーダーの重要業績評価指標(KPI)。 これを「目標」と呼びます。ディスプレイ &ビデオ 360 でビデオ 360 のインターフェース。 |
budget |
必須。広告掲載オーダーの予算割り当て設定。 |
bidStrategy |
広告掲載オーダーの入札戦略。デフォルトでは |
reservationType |
出力専用。広告掲載オーダーの予約タイプ。 |
optimizationObjective |
省略可。広告掲載オーダーの最適化目標。 このフィールドは、許可リストに登録されたお客様のみが使用できます。顧客が許可リストに登録されていない場合、このフィールドは null になり、設定しようとするとエラーが返されます。 |
InsertionOrderType
広告掲載オーダーのタイプ。
広告掲載オーダーのタイプによって、適用できる設定やオプション(広告のフォーマットやターゲティング オプションなど)が決まります。
列挙型 | |
---|---|
INSERTION_ORDER_TYPE_UNSPECIFIED |
広告掲載オーダーのタイプが指定されていないか、不明です。 |
RTB |
リアルタイム ビッダー。 |
OVER_THE_TOP |
オーバー ザ トップ。 |
主要業績評価指標
広告掲載オーダーの重要業績評価指標(KPI)を制御する設定。
JSON 表現 |
---|
{ "kpiType": enum ( |
フィールド | |
---|---|
kpiType |
必須。KPI のタイプ。 |
kpiAlgorithmId |
省略可。KPI_CUSTOM_PROFILE_VALUE_OVER_COST に関連付けられているカスタム入札アルゴリズム ID。適切な KPI が選択されていない場合、このフィールドは無視されます。 |
共用体フィールド kpi_value 。必須。KPI の値。関連するフィールドが kpi_type に対応しています。kpi_value は次のいずれかになります。 |
|
kpiAmountMicros |
広告主の通貨の 100 万倍単位の目標値。
たとえば、1500000 は 1.5 標準通貨単位を表します。 |
kpiPercentageMicros |
目標の割合の小数値(マイクロ秒単位)。
たとえば、70000 は 7%(10 進数 0.07)を表します。 |
kpiString |
KPI の文字列(空でも可)。UTF-8 でエンコードし、長さを 100 文字以下にする必要があります。
|
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 |
広告掲載オーダーの入札単価と予算の管理に使用する自動化のタイプ。 作成時にこのフィールドを指定しなかった場合、値はデフォルトで |
budgetSegments[] |
必須。予算セグメントのリスト。予算セグメントを使用すると、広告掲載オーダーの一定期間における特定の予算を指定できます。 |
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 ( |
フィールド | |
---|---|
budgetAmountMicros |
必須。指定された |
description |
予算セグメントの説明。これを使用して、各予算セグメントの注文書情報を入力でき、その情報を請求書に印刷できます。 UTF-8 でエンコードする必要があります。 |
dateRange |
必須。予算セグメントの開始日と終了日の設定。親広告主のタイムゾーンを基準にして解決されます。
|
campaignBudgetId |
この広告掲載オーダーの予算セグメントが含まれているキャンペーン予算の |
OptimizationObjective
考えられる最適化目標のタイプ。
列挙型 | |
---|---|
OPTIMIZATION_OBJECTIVE_UNSPECIFIED |
タイプの値が指定されていないか、このバージョンでは不明です。 |
CONVERSION |
売り上げやコンバージョン数を増やすインプレッションを優先します。 |
CLICK |
ウェブサイト、アプリ、アプリストアのトラフィックを増やすインプレッションを優先します。 |
BRAND_AWARENESS |
特定の品質のインプレッションを優先します。 |
CUSTOM |
目標は、割り当てられたカスタム入札アルゴリズムによって定義されます。 |
NO_OBJECTIVE |
目標が定義されていない。任意の KPI または入札戦略を使用できます。 |
メソッド |
|
---|---|
|
新しい広告掲載オーダーを作成します。 |
|
広告掲載オーダーを削除します。 |
|
広告掲載オーダーを取得します。 |
|
広告主の広告掲載オーダーを一覧表示します。 |
|
さまざまなターゲティング タイプで、広告掲載オーダーに割り当てられているターゲティング オプションを一覧表示します。 |
|
既存の広告掲載オーダーを更新します。 |