Splits サービス
警告
条件は segment[]
使用されなくなり、2022 年 8 月 21 日に非推奨になりました。 新しい広告申込情報のターゲティングを設定する場合は、 セグメント グループ (segment_group
) を使用します。 その代わりに。
Splits Service は、 拡張された明細のプログラミング可能な分割を作成および変更します。 広告申込情報を作成するときは、ターゲットとする在庫、フライトに費やす予算、収益の追跡方法、Xandr 最適化の使用方法を指定します。 プログラム可能な分割 を使用すると、その総在庫のサブセットをさらにターゲットにしたり、指定した予算をさまざまなターゲットに割り当てたり、入札基準を設定したり、クリエイティブを配布したりできます。 広告申込情報のターゲット設定はフィルターとして機能します。インプレッションは、分割に渡される前に、広告申込情報で指定された条件と一致している必要があります。 分割のしくみの詳細については、UI ドキュメントの 「分割 について」を参照してください。
Splits サービスを使用すると、次を指定できます。
- ターゲット条件
- 入札ルール
- 予算配分
- 分割に関連付けられているクリエイティブ。
注:
カスタム モデルでの分割の使用は現在サポートされていません。 カスタム モデルがアタッチされている行項目で分割を作成または変更しようとすると、エラーが表示されます。
REST API
Splits サービスは、Xandr の他の API サービスのほとんどとは少し異なります。 既定では、予算分割 (Splits) サービスは、1 つの分割を作成または変更するのではなく、同時に行項目のすべての分割を作成または変更します。 サービスは、1 つの分割を作成するのではなく、行項目に budget-splitter
関連付けられているオブジェクト (配列) を作成します。 配列には budget-splitter
2 つ以上の分割が含まれており、次の要件を満たす必要があります。
- 明細のすべての分割に対する予算配分の合計は、常に 100 と等しい必要があります。 これにより、広告申込情報のすべてのインプレッションが少なくとも 1 つの分割によって考慮されるようになります。
- 各分割には優先度を割り当てる必要があります。これにより、インプレッションが複数の分割のターゲット要件を満たしている場合に、受信インプレッションが割り当てられる分割が決まります。 同じ優先順位を複数の分割に使用することはできません。
- 1 つの分割を既定の分割として定義する必要があります。 これは、インプレッションが他の分割の条件を満たしていない場合に割り当てられるフォールバック分割です。 既定の分割は、UI の "行項目の剰余" と呼ばれます。
- 既定の分割には、 または
"default"
という名前"Default"
を付け、配列にリストされている最後の分割として表示するbudget-splitter
必要があります。 他の条件が適用されない場合のフォールバックとして意味するため、条件を割り当てたり、上限付き (制約付き) 割り当て戦略を割り当てることはできません。 ただし、予算の 0% を既定の分割に割り当てることができます。つまり、割り当てられません。 - 既定の分割では、 または
null
の"1"
入札修飾子のみを使用できます。 - 既定の分割には注文を割り当てる必要がありますが、割り当てられた順序に関係なく、最後に優先順位が付けられます。
メソッドは POST
Split サービスではサポートされていません。
個々の分割を変更するには、次の PATCH
例で説明するように メソッドを使用する必要があります。
注:
メソッドを PATCH
使用して分割割り当てを変更することはできません。 明細のすべての分割に対する予算配分の合計は 100 に等しい必要があるため、1 つの分割で割り当てを変更せずに、他の分割の割り当てを変更することはできません。
他の Xandr API サービスとは異なり、配列の budget-splitters
JSON は、 オブジェクトの後にという名前のラッパー内に表示されません。 名前のない配列として表示されます。 たとえば、次の 3 つの分割を含む配列を budget-splitters
作成する JSON ファイルを次に示します。
budget-splitter オブジェクトの例
[
{
"active": true,
"allocation_percent": 40,
"allocation_strategy": "unconstrained",
"bid_modifier": null,
"conditions": [
{
"field": "browser",
"operator": "in",
"value": [
8
]
}
],
"creative_macros": [],
"creatives": [],
"expected_value": 2,
"is_default": false,
"name": "Split 1",
"order": 1
},
{
"active": true,
"allocation_percent": 30,
"allocation_strategy": "unconstrained",
"bid_modifier": null,
"conditions": [
{
"field": "segment_group",
"operator": "and",
"value": [
[
{
"segment_id": 275913,
"start_minutes": 0,
"expire_minutes": 1440
}
]
]
}
],
"creative_macros": [],
"creatives": [],
"expected_value": 1,
"is_default": false,
"name": "Split 2",
"order": 2
},
{
"active": true,
"allocation_percent": 30,
"allocation_strategy": "unconstrained",
"bid_modifier": null,
"expected_value": 0.5,
"is_default": true,
"name": "Default",
"order": 3
}
HTTP メソッド | エンドポイント | 説明 |
---|---|---|
PUT |
https://api.appnexus.com/budget-splitter/LINE-ITEM-ID/splits (budget-splitter JSON) |
行項目に分割を追加します。この項目には分割はありません。 |
GET |
https://api.appnexus.com/budget-splitter/LINE-ITEM-ID/split s |
明細のすべての分割を表示します。 |
PUT |
https://api.appnexus.com/budget-splitter/LINE-ITEM-ID/splits (budget-splitter JSON) |
明細のすべての分割を更新します。 |
DELETE |
https://api.appnexus.com/budget-splitter/LINE-ITEM-ID/splits |
明細からすべての分割を削除します。 これにより、明細からすべての分割が完全に削除されます。 過去の分割トラフィックの情報は、レポートに引き続き表示されます。 |
PATCH |
https://api.appnexus.com/budget-splitter/LINE-ITEM-ID/splits (split-update JSON) 分割 ID は、分割更新 JSON に表示する必要があります。 |
1 つの分割を変更します。 |
JSON フィールド
フィールド | 種類 | 説明 |
---|---|---|
id |
int | 分割の ID。 例: "id":21197314 既定値: 自動生成された数値。 必須: PUT //PATCH DELETE JSON の 。 |
name |
string (255) | 分割を割り当てる名前。 例: "name":"Split 123" 注: 既定の分割には、 または という "default" 名前を付"Default" ける必要があります。 |
is_default |
ブール値 | これが既定の分割であるかどうかを指定します。これは、インプレッションが他の分割のターゲティング要件を満たしていない場合に使用されます。 すべての行項目には、既定の分割が 1 つだけ必要です。 既定の分割には、 または "default" という名前"Default" を付ける必要があり、条件を持つことはできません。 可能な値は、"true" と "false" です。例: "is_default":true |
conditions |
配列 | 分割のターゲット条件。 条件は、フィールド、演算子、および値を含む配列によって指定されます。 例: "conditions":[{"field":"city","operator":"in","value":[196646]}] 詳細については、以下の 「条件 」を参照してください。 |
active |
ブール値 | 分割の状態を指定します。 使用可能な値は "true" または "false" です。例: "active":true |
order |
int | 配列内のこの分割の budget_splitters 優先順位。 UI では、このフィールドは と "Priority" 呼ばれます。インプレッションが複数の分割のターゲット要件を満たしている場合、優先順位によって、インプレッションが割り当てられる分割が決まります。 たとえば、分割 A (優先度 1) がターゲット "domain=cnn.com" であり、分割 B (優先度 2) が ターゲット "city=Boston" であり、ボストンのユーザーが cnn.com にアクセスしてインプレッションを利用できる場合です。 分割 B よりも優先度が高いため、分割 A にインプレッションが割り当てられます。複数の分割に同じ優先順位を設定することはできません。 順序は、値がシーケンシャルである限り、任意の値から開始できます。 たとえば、3 つの分割の順序は 0 、4 5 1 2 です。 6 例: "order":1 |
allocation_percent |
int | この分割に割り当てられた明細予算の割合。 各分割の割り当ては、 と 100 の間0 にする必要があります。 明細内のすべての分割の割り当て割合の合計は、 と等しい 100 必要があります。例: "allocation_percent":30 |
allocation_strategy |
列挙 | 分割割り当て目標と明細配信目標の間の競合を処理する方法を指定します。 使用可能な値は次のとおりです。 - "unconstrained" - 品目の配信は、割り当てよりも優先されます。 上限のない分割を持つ明細が不足している場合、上限のない分割は割り当て目標を超えて明細配信目標に到達することが許可されます。 UI では、この状態は "uncapped" と呼ばれます。- "constrained" - 割り当ては配信よりも優先されます。 行項目の配信が不足している場合でも、上限分割は割り当て目標を超えて配信目標に到達するのを支援することはできません。 これにより、分割での過剰な支出は防ぐことができますが、行項目が不足する可能性があります。 UI では、この状態は "capped" と呼ばれます。詳細については、UI ドキュメントの 「分割 について」を参照してください。 例: "allocation_strategy":"unconstrained" 既定値: "unconstrained" |
bid_modifier |
浮動小数点数 | この分割の入札を変更するために使用される番号。 入札修飾子は、品目の予約収益タイプが CPM で最適化が有効になっていない場合にのみ、分割に適用できます。 入札修飾子の値に CPM 予約収益が乗算され、分割で入札できる最大 CPM として機能します。 例: "bid_modifier":1.25 注: - 既定の分割では、 または null の"1" 入札修飾子のみを使用できます。 非アクティブな分割には、 の "0" 入札修飾子を割り当てる必要があります。bid_modifier - このフィールドは GDALI では使用されません。 |
expected_value |
浮動小数点数 | この分割のインプレッションの期待値。 明細の予約収益タイプがコストプラスまたは dCPM であり、最適化が有効になっていない場合は、分割ごとに期待値を含める必要があります。 予想される値は、分割で入札できる最大 CPM として機能します。 例: "expected_value":10.50 注: この expected_value フィールドは GDALI では使用されません。 |
creatives |
配列 | オプション。 この分割で提供されるクリエイティブの ID。 例: "creatives":[{"creative_id":123},{"creative_id":456}] |
creative_macros |
文字列の配列 | オプション。 配信されたクリエイティブに追加されるクリエイティブ マクロ。 詳細については、「 クリエイティブ マクロ チェック サービス」を参照してください。 注: この creative_macros フィールドは GDALI では使用されません。 |
user_test_group_percent |
int | オプション。 A/B テストのために、分割ごとにユーザーの個別のグループをターゲットにします。 注: 広告申込情報の残余分割が に "active" 設定されている場合、または予算配分が 0% を超える場合、広告申込情報の残りの部分には、他の分割の対象ではないユーザーの残りのプールが常に含まれます。 さらに、行項目の剰余分割には、常に Cookie レス ユーザーが含まれます。Cookie レス ユーザーにサービスを提供しない場合: - 割り当てを使用している場合は、既定の分割で を に "0" 設定allocation_percent します。- 割り当てを使用していない場合は、既定の分割で を に "false" 設定active します。 |
条件
条件は、フィールド、演算子、および値を含む配列によって指定されます。 たとえば、米国からのインプレッションを対象とする条件を作成するには、次の条件を使用します。
"conditions": [
{
"field": "country",
"operator": "=",
"value": [
233
]
}
]
カスタム カテゴリ
表示される特定のカスタム カテゴリに基づいてインプレッションを評価します。
フィールド | オペレーター | 値 |
---|---|---|
content_category |
= , in , not_in |
カスタム カテゴリ ID。 コンテンツ カテゴリ サービスを使用して、カスタム カテゴリ ID を取得します。 警告: カスタム カテゴリは、マネージド インベントリのみを対象とする必要があります。 |
Key-value
存在する特定のキー値に基づいてインプレッションを評価します。
フィールド | オペレーター | 値 |
---|---|---|
key_group |
and , or |
キー グループを指定する入れ子になった条件配列。 各キー グループ配列には、キー ID、アクション ("include" または "exclude" )、値が含まれます。警告: キー値は、マネージド インベントリのみを対象とする必要があります。 - key_id - キーの ID。 Targeting Key Service を使用してキー ID を取得します。 - action - または を指定"include" "exclude" できます。 - value_equals は、割り当てが提供される資格を得るためにオークションで一致する必要がある値 ID の配列です。 Targeting Key Service を使用して値 ID を取得します。 1 つの値が渡された場合、そのキーと値の組み合わせは、分割が提供される資格を持つ要求に存在する必要があります。 配列に複数の値が定義されている場合は、キーと値の組み合わせのいずれかが存在する必要があります。 - value_less は、許可される値の範囲の上端であり、排他的です。 - value_greater は、許可される値の範囲の下限であり、排他的です。キー値は、インプレッション要求で渡される場合があります。 詳細については、「Xandr の 販売者タグ (AST)」 を参照してください。 |
次の Key-Value 例 (以下の JSON を参照) は、
[ [include Key ID 123: value ID: [1 OR 2 OR 9] ] AND [exclude Key ID 234: value ID: [20] ] ] OR [include Key ID 789: value ID: [15] ]
{
"conditions": [{
"field": "key_group",
"operator": "or",
"value": [
[{
"key_id": 123,
"action": "include",
"value_equals": [1, 2, 9]
},
{
"key_id": 234,
"action": "exclude",
"value_equals": [20]
}
],
[{
"key_id": 789,
"action": "include",
"value_equals": [15]
}]
]
}]
}
国
ユーザーの国に基づいてインプレッションを評価します。
フィールド | オペレーター | 値 |
---|---|---|
country |
= , in , not_in |
または などの233 "US" 国 ID またはコード。Country Service を使用して、これらの ID またはコードを取得します。 |
Region
ユーザーの地理的リージョンに基づいてインプレッションを評価します。
フィールド | オペレーター | 値 |
---|---|---|
region |
= , in , not_in |
リージョン ID または国/地域コードの組み合わせ (など "US:NY" )。リージョン サービスを使用して、これらの ID とコードを取得します。 |
市区町村
ユーザーの都市に基づいてインプレッションを評価します。
フィールド | オペレーター | 値 |
---|---|---|
city |
= , in , not_in |
市区町村 ID または国/地域/市区町村コードの組み合わせ (など "US:NY:New York" )。City Service を使用して、これらの ID とコードを取得します。 |
Dma
ユーザーの DMA (指定された市場領域) に基づいてインプレッションを評価します。
フィールド | オペレーター | 値 |
---|---|---|
dma |
= , in , not_in |
DMA 602 ID (シカゴの地下鉄エリアの場合)。シティ サービスを使用して DMA ID を取得します。 |
郵便番号
ユーザーの郵便番号に基づいてインプレッションを評価します。 郵便番号は、外部供給パートナーからの一部のモバイルインプレッションとインプレッションにのみ使用できます。
フィールド | オペレーター | 値 |
---|---|---|
postal_code |
= , in , not_in |
郵便番号 ID (整数) または国/郵便番号の組み合わせ (または "US:10010" などの"CA:J0K 1B0" 文字列)。 米国の郵便番号が含まれます。郵便番号サービス ( プロファイル サービスに記載されている) を使用して、郵便番号 ID を取得します。 |
郵便番号一覧
郵便番号一覧のユーザーの郵便番号に基づいてインプレッションを評価します。
フィールド | オペレーター | 値 |
---|---|---|
postal_code_list |
in , not_in |
郵便番号一覧 ID (整数)。 郵便番号一覧サービス (郵便番号一覧サービスに記載) を使用して、郵便番号 一覧 ID を取得します。 |
Size
配置サイズに基づいてインプレッションを評価します。 広告呼び出しで渡された場合 promo_sizes
、評価はプライマリ サイズのみを使用して実行されることに注意してください。
フィールド | オペレーター | 値 |
---|---|---|
size |
= , in , not_in |
配置ディメンションを表す文字列。形式は です "WIDTHxHEIGHT" 。 |
インベントリ URL ID
特定のインベントリ URL ID に基づいてインプレッションを評価します。
注:
GDALI ではサポートされていません。
フィールド | オペレーター | 値 |
---|---|---|
inventory_url_id |
= , in , not_in |
インベントリ URL ID。 インベントリ項目サービスの検証を使用して、これらの ID を取得します。 |
ドメイン
ドメインに基づいてインプレッションを評価します。
注:
- GDALI ではサポートされていません。
- この機能は、Microsoft Invest ではサポートされていません。 また、UI を使用して分割を管理する場合は、代わりにインベントリ URL ID 機能 (このサービス内) を使用します。
フィールド | オペレーター | 値 |
---|---|---|
domain |
= , in , not_in |
または "books" など"food.com" 、最上位のドメイン名を表す文字列。 |
モバイル アプリ
特定のモバイル アプリに基づいてインプレッションを評価します。
注:
GDALI ではサポートされていません。
フィールド | オペレーター | 値 |
---|---|---|
mobile_app_bundle |
= , in , not_in |
モバイル アプリ ID または名前。 Mobile App Serviceを使用して、これらの ID または名前を取得します。 |
Placement
特定の配置に基づいてインプレッションを評価します。
フィールド | オペレーター | 値 |
---|---|---|
placement |
= , in , not_in |
配置 ID。 配置 ID は、ログ レベルのデータのように tag_id 一覧表示されます。 |
Publisher
特定のパブリッシャーに基づいてインプレッションを評価します。
フィールド | オペレーター | 値 |
---|---|---|
publisher |
= , in , not_in |
パブリッシャー ID。 ヒント: パブリッシャー ID は、ログ レベルのデータのように publisher_id 一覧表示されます。 |
販売者メンバー
特定の販売者メンバーに基づいてインプレッションを評価します。
注:
GDALI ではサポートされていません。
フィールド | オペレーター | 値 |
---|---|---|
seller_member_id |
= , in , not_in |
販売者のメンバー ID。 |
取引 ID
目標取引在庫。
注:
GDALI ではサポートされていません。
フィールド | オペレーター | 値 |
---|---|---|
deal_id |
= , in , not_in |
取引 ID。 |
取引リスト ID
目標取引一覧のインベントリ。
注:
GDALI ではサポートされていません。
フィールド | オペレーター | 値 |
---|---|---|
deal_list |
in , not_in |
取引リスト ID。 |
オペレーティング システム ファミリ
ユーザーのオペレーティング システムに基づいてインプレッションを評価します。
フィールド | オペレーター | 値 |
---|---|---|
os_family |
= , in , not_in |
オペレーティング システム ファミリ ID または 名前 (または など2 "Android" )。オペレーティング システム ファミリ サービスを使用して、これらの ID と名前を取得します。 |
オペレーティング システムのバージョン
ユーザーのオペレーティング システムの特定の バージョン に基づいてインプレッションを評価します。
フィールド | オペレーター | 値 |
---|---|---|
os_extended |
= , in , not_in |
オペレーティング システムの拡張 ID (など81 "10.8 Mountain Lion" )。オペレーティング システム拡張サービスを使用して、これらの ID を取得します。 注: オペレーティング システム ID は、ログ レベルのデータのように operating_system 一覧表示されます。 |
ブラウザー
ユーザーのブラウザーに基づいてインプレッションを評価します。
フィールド | オペレーター | 値 |
---|---|---|
browser |
= , in , not_in |
ブラウザー ID または名前 (または "Chrome (all versions)" など8 )。ブラウザー サービスを使用して、これらの ID と名前を取得します。 |
ブラウザー言語
ブラウザーの言語に基づいてインプレッションを評価します。
フィールド | オペレーター | 値 |
---|---|---|
language |
= , in , not_in |
言語 ID。 Language Service を使用して、これらの ID を取得します。 |
デバイスのタイプ
特定の種類の物理デバイスに基づいてインプレッションを評価します。
フィールド | オペレーター | 値 |
---|---|---|
device_type |
= , in , not_in |
デバイスの種類名。 使用可能な値: - "pc & other devices" - デスクトップとノート PC をターゲットにするには、この値を使用します。- "phone" - 携帯電話をターゲットにするには、この値を使用します。- "tablet" - モバイル タブレットをターゲットにするには、この値を使用します。 |
デバイス モデル
物理デバイスの特定のモデルに基づいてインプレッションを評価します。
フィールド | オペレーター | 値 |
---|---|---|
device_model |
= , in , not_in |
デバイス モデル ID。 デバイス モデル サービスを使用して、これらの ID を取得します。 デバイス モデル ID は、ログ レベルのデータのように device_id 一覧表示されます。 |
キャリア
特定の携帯電話会社に基づいてインプレッションを評価します。
フィールド | オペレーター | 値 |
---|---|---|
carrier |
= , in , not_in |
携帯電話会社の ID または名前 (または "Verizon" など14 )。Carrier Service を使用して、これらの ID と名前を取得します。 |
予測 IAB の視認性率
以前は "推定 IAB 視認性率" と呼ばられていました。 最適化ガイド (UI ドキュメントで利用可能) によって決定された、IAB 標準で表示可能として測定される可能性によって Web 表示インプレッションを評価します。
注:
GDALI ではサポートされていません。
フィールド | オペレーター | 値 |
---|---|---|
predicted_iab_view_rate |
< , <= , = , > , >= |
と の間 0 の 1 10 進数。パーセンテージを表します。 |
予測 IAB ビデオの表示率
最適化 ガイド (UI ドキュメントで利用可能) によって決定された、IAB 標準で表示可能として測定される可能性によって Web ビデオのインプレッションを評価します。
注:
GDALI ではサポートされていません。
フィールド | オペレーター | 値 |
---|---|---|
predicted_iab_video_view_rate |
< , <= , = , > , >= |
と の間 0 の 1 10 進数。パーセンテージを表します。 |
予測されるビデオ完了率
最適化ガイド (UI ドキュメントで利用可能) によって決定された、完了する可能性によって Web ビデオのインプレッションを評価します。
注:
GDALI ではサポートされていません。
フィールド | オペレーター | 値 |
---|---|---|
estimated_video_completion_rate |
< , <= , = , > , >= |
と の間 0 の 1 10 進数。パーセンテージを表します。 0 は、非ビデオ インベントリを表します。 |
クリエイティブ
この分割で配信するクリエイティブ。
フィールド | オペレーター | 値 |
---|---|---|
creative |
in |
クリエイティブ ID の一覧。 クリエイティブ サービスを使用して、これらの ID を取得します。 |
セグメント グループ
フィールド | オペレーター | 値 |
---|---|---|
segment_group セグメント ID を取得するには、 セグメント サービス を使用します。 |
and , or |
セグメント グループを指定する入れ子になった条件配列。 各segment_group 配列には、、age 、、value および action ("include" または "exclude" ) が含まれますsegment_ID 。- action または を指定できます"include" "exclude" 。- start_minutes は、ユーザーがこのセグメントに追加されてからの下限 (分) です。 "start_minutes": 5 には、5 分のマーク (5:00 を含む) からセグメントに追加されたユーザーが含まれます。- expire_minutes は、ユーザーがこのセグメントに追加されてからの上限 (分) です。 "expire_minutes": 10 には、10:00 を含む 10 分のマークまでセグメントに追加されたユーザーが含まれます。- value_less は、許可される値の範囲の下限であり、排他的です。 "value_less" : 5 には、5 より大きい値のみが含まれますが、含まれません。- value_greater は、許可される値の範囲の上端であり、排他的です。 "value_greater" : 10 には、 までの値のみが含まれますが、 10 は含まれません。- value_equals は、許可される値と完全に一致します。 “value_equals” : 5 には、 と 5 等しい値のみが含まれます。- プロファイル サービスとは異なり、Splits サービスを使用すると、0 (0) のセグメント値をターゲットにすることができます。 以下の 例 を value_equals 参照してください。 セグメント値は、Batch Segment Service やファースト パーティまたはサード パーティのセグメント クエリ文字列を使用して、さまざまな方法で渡すことができます。 |
フィールドの value_equals
例
"conditions": [
{
"field": "segment_group",
"operator": "and",
"value": [
[
{
"segment_ID": SEGMENT_ID,
"action": SEGMENT_ACTION,
"start_minutes": YOUNGEST_SEGMENT_AGE,
"expire_minutes": OLDEST_SEGMENT_AGE,
"value_less": LOWER_BOUND_SEGMENT_VALUE,
"value_greater": UPPER_BOUND_SEGMENT_VALUE,
"value_equals": EXACT_SEGMENT_VALUE
}
]
]
}
]
セグメント
警告
条件は segment[]
使用されなくなり、2022 年 8 月 21 日に非推奨になりました。 新しい広告申込情報のターゲティングを設定する場合は、代わりに セグメント グループ (segment_group
) を使用します。
フィールド | オペレーター | 値 |
---|---|---|
segment[SEGMENTID,...] は SEGMENTID 、セグメント ID の省略可能なリストです。セグメント ID を取得するには、 セグメント サービス を使用します。 |
< , <= , = , > , >= , present , absent |
セグメントの年齢、値、または存在を指定する入れ子になった条件配列。 - セグメントプレゼンスは "present" または "absent" です。- セグメントの年齢は分単位で測定され、正の整数である必要があります。 - セグメント値は、ユーザー定義値を表す 0 以外の正の整数です。 以下の 例 を value 参照してください。セグメント値は、 Batch Segment Service やファースト パーティまたはサード パーティのセグメント クエリ文字列を使用して、さまざまな方法で渡すことができます。 |
フィールドの value
例
ファースト パーティまたはサード パーティのセグメントのユーザーの有無、不在、価値、またはセグメントの年齢に基づいてインプレッションを評価します。
"conditions": [
{
"field": "segment[]",
"operator": "any",
"value": [
{
"conditions": [
{
"field": "age",
"operator": "<=",
"value": 1440
}
],
"id": 275913
}
]
}
],
毎日の頻度
広告主、広告申込情報、または現在の日に分割されたユーザーが見た広告の数。
フィールド | オペレーター | 値 |
---|---|---|
OBJECT[ID].day_frequency オブジェクトが advertiser 、、 line_item または campaign (分割を表す) で、ID がオブジェクト ID です。 広告主サービス、広告申込情報サービス、または Splits サービスを使用して ID を取得します。 |
> , => , < , =< , = 重要: 演算子 = は頻度とレジェンシーに対してサポートされていますが、不足分を引き起こす傾向があるため、使用しないことを 強くお勧めします 。 これは、 でインプレッションfrequency=5 をターゲットにした場合、または 4 と等しい頻度のインプレッションを2 0 1 3 除外するためです。 |
正の整数。 0 は、使用可能な頻度情報がないことを示します (ユーザーはこのオブジェクトを現在の日に表示していません)。 |
有効期間の頻度
広告主、広告申込情報、または分割の有効期間中にユーザーが見た広告の数。
フィールド | オペレーター | 値 |
---|---|---|
OBJECT[ID].lifetime_frequency オブジェクトが advertiser 、、 line_item または campaign (分割を表す) で、ID がオブジェクト ID です。 広告主サービス、広告申込情報サービス、または Splits サービスを使用して ID を取得します。注意: 演算子 = は頻度とレジェンシーに対してサポートされていますが、不足分の原因となる傾向があるため、使用しないことを強くお勧めします。 これは、 でインプレッションfrequency=5 をターゲットにした場合、または 4 と等しい頻度のインプレッションを2 0 1 3 除外するためです。 |
> , => , < , =< , = |
正の整数。 0 は、使用可能な頻度情報がないことを示します (ユーザーはこのオブジェクトを見たことがありません)。 |
頻度
ユーザーが広告を表示してからの分数。 これは、広告主、広告申込情報、または分割のすべての広告のユーザーに対して決定できます。
フィールド | オペレーター | 値 |
---|---|---|
OBJECT[ID].recency オブジェクトが advertiser 、、 line_item または campaign (分割を表す) で、ID がオブジェクト ID です。 広告主サービス、広告申込情報サービス、または Splits サービスを使用して ID を取得します。 |
> , => , < , =< , = 重要: 演算子 = は頻度とレジェンシーに対してサポートされていますが、不足分を引き起こす傾向があるため、使用しないことを強くお勧めします。 これは、 でインプレッションfrequency=5 をターゲットにした場合、または 4 と等しい頻度のインプレッションを2 0 1 3 除外するためです。 |
ユーザーがインプレッションを見た後の分数を示す正の整数を切り捨てます。 59 秒が に 0 評価され、61 秒が に 1 評価されます。 0 は、最近印象が見られたということです。 Null は、利用できるレジェンシー データがないことを意味します (ユーザーはこの印象を以前に見たことがありません)。 |
インベントリの種類
分割の対象となるインベントリ ("app" または "web") の種類。 "App" はモバイル アプリ インベントリをターゲットとし、"web" は Web インベントリ (モバイル Web ブラウザーに表示されるページを含む) をターゲットにします。
フィールド | オペレーター | 値 |
---|---|---|
inventory_type |
= , in , not_in |
"web" , "app" 「 例」を参照してください。 |
フィールドの inventory_type
例
"conditions": [
{
"field": "inventory_type",
"operator": "in",
"value": [
"app",
"web"
]
}
]
インベントリ URL リスト
ネットワーク レベルで確立された許可リストまたはブロックリストをターゲットにします。 対象となるリストは 1 つだけです。
注:
GDALI ではサポートされていません。
フィールド | オペレーター | 値 |
---|---|---|
inventory_url_list |
all , not in |
インベントリ リスト ID。"conditions":[{"field":"inventory_url_list","operator":"not in","value":[12345]}] 在庫リストを作成するか、分割ターゲットで使用するリスト ID を取得するには、 インベントリ リスト サービスを使用します。 |
例
コストプラスの予約収益と最適化が無効になっている明細の分割を作成する
次の使用例は、行項目に対して 3 つの分割を作成します 6377624
。
- 分割 1 - ユーザーは Chrome ブラウザーを使用している必要があります。 インプレッションには、 の期待値
2
が割り当てられます。 この分割には、行項目のトラフィックの 40% が割り当てられます。これは優先されます。 割り当てが制約されていません。 - 分割 2 - インプレッションはセグメント
275913
に属している必要があり、過去 1440 分以内に追加されている必要があります。 予期される値 ''1 が割り当てられます。 この分割には、行項目のトラフィックの 30% が割り当てられます。これは優先順位が 2 番目です。 割り当てが制約されていません。 - 分割 3 (名前なし) - 既定の分割。 インプレッションには、 の期待値
0.5
が割り当てられます。 この分割には、行項目のトラフィックの 30% が割り当てられます。これは優先度が 3 番目です。 割り当てが制約されていません。
最適化が無効になっているので、分割の予期される値を設定しています。
$ cat ali_cost_plus_ev.json
[
{
"active": true,
"allocation_percent": 40,
"allocation_strategy": "unconstrained",
"bid_modifier": null,
"conditions": [
{
"field": "browser",
"operator": "in",
"value": [
8
]
}
],
"creative_macros": [],
"creatives": [],
"expected_value": 2,
"is_default": false,
"name": "Split 1",
"order": 1
},
{
"active": true,
"allocation_percent": 30,
"allocation_strategy": "unconstrained",
"bid_modifier": null,
"conditions": [
{
"field": "segment_group",
"operator": "and",
"value": [
[
{
"segment_id": 275913,
"start_minutes": 0,
"expire_minutes": 1440
}
]
]
}
],
"creative_macros": [],
"creatives": [],
"expected_value": 1,
"is_default": false,
"name": "Split 2",
"order": 2
},
{
"active": true,
"allocation_percent": 30,
"allocation_strategy": "unconstrained",
"bid_modifier": null,
"expected_value": 0.5,
"is_default": true,
"name": "Default",
"order": 3
}
$ curl -b cookies -X PUT -s -d '@ali_cost_plus_ev.json' "https://api.appnexus.com/budget-splitter/6377624/splits"
[
{
"active": true,
"allocation_percent": 40,
"allocation_strategy": "unconstrained",
"bid_modifier": null,
"conditions": [
{
"field": "browser",
"operator": "in",
"value": [
8
]
}
],
"creative_macros": [],
"creatives": [],
"expected_value": 2,
"id": 24025228,
"is_default": false,
"name": "Split 1",
"order": 1
},
{
"active": true,
"allocation_percent": 30,
"allocation_strategy": "unconstrained",
"bid_modifier": null,
"conditions": [
{
"field": "segment_group",
"operator": "and",
"value": [
[
{
"segment_id": 275913,
"start_minutes": 0,
"expire_minutes": 1440
}
]
]
}
],
"creative_macros": [],
"creatives": [],
"expected_value": 1,
"id": 24025229,
"is_default": false,
"name": "Split 2",
"order": 2
},
{
"active": true,
"allocation_percent": 30,
"allocation_strategy": "unconstrained",
"bid_modifier": null,
"expected_value": 0.5,
"id": 24025230,
"is_default": true,
"name": "Default",
"order": 3
}
]
コストプラスの予約済み収益と最適化が有効になっている明細の分割を作成する
次の使用例は、行項目に対して 3 つの分割を作成します 6377631
。
- 分割 1 - ユーザーは Chrome ブラウザーを使用している必要があります。 インプレッションには、 の期待値
2
が割り当てられます。 この分割には、行項目のトラフィックの 40% が割り当てられます。これは優先されます。 割り当てが制約されていません。 - 分割 2 - インプレッションはセグメント
275913
に属している必要があり、過去 1440 分以内に追加されている必要があります。 予期される 値1
が割り当てられます。 この分割には、行項目のトラフィックの 30% が割り当てられます。これは優先順位が 2 番目です。 割り当てが制約されていません。 - 分割 3 (名前なし) - 既定の分割。 インプレッションには、 の期待値
0.5
が割り当てられます。 この分割には、行項目のトラフィックの 30% が割り当てられます。これは優先度が 3 番目です。 割り当てが制約されていません。
$ cat ali_cost_plus_opt.json
[
{
"active": true,
"allocation_percent": 40,
"allocation_strategy": "unconstrained",
"bid_modifier": null,
"conditions": [
{
"field": "browser",
"operator": "in",
"value": [
8
]
}
],
"creative_macros": [],
"creatives": [],
"expected_value": null,
"is_default": false,
"name": "Split 1",
"order": 1
},
{
"active": true,
"allocation_percent": 30,
"allocation_strategy": "unconstrained",
"bid_modifier": null,
"conditions": [
{
"field": "segment_group",
"operator": "and",
"value": [
[
{
"segment_id": 275913,
"start_minutes": 0,
"expire_minutes": 1440
}
]
]
}
],
"creative_macros": [],
"creatives": [],
"expected_value": null,
"is_default": false,
"name": "Split 2",
"order": 2
},
{
"active": true,
"allocation_percent": 30,
"allocation_strategy": "unconstrained",
"bid_modifier": null,
"expected_value": null,
"is_default": true,
"name": "Default",
"order": 3
}
$ curl -b cookies -X PUT -s -d '@ali_cost_plus_opt.json' "https://api.appnexus.com/budget-splitter/6377631/splits"
[
{
"active": true,
"allocation_percent": 40,
"allocation_strategy": "unconstrained",
"bid_modifier": null,
"conditions": [
{
"field": "browser",
"operator": "in",
"value": [
8
]
}
],
"creative_macros": [],
"creatives": [],
"expected_value": null,
"id": 24025315,
"is_default": false,
"name": "Split 1",
"order": 1
},
{
"active": true,
"allocation_percent": 30,
"allocation_strategy": "unconstrained",
"bid_modifier": null,
"conditions": [
{
"field": "segment_group",
"operator": "and",
"value": [
[
{
"segment_id": 275913,
"start_minutes": 0,
"expire_minutes": 1440
}
]
]
}
],
"creative_macros": [],
"creatives": [],
"expected_value": null,
"id": 24025316,
"is_default": false,
"name": "Split 2",
"order": 2
},
{
"active": true,
"allocation_percent": 30,
"allocation_strategy": "unconstrained",
"bid_modifier": null,
"expected_value": null,
"id": 24025317,
"is_default": true,
"name": "Default",
"order": 3
CPM 予約収益と最適化が無効になっている明細の分割を作成する
次の使用例は、行項目に対して 3 つの分割を作成します 6377633
。
- 分割 1 - ユーザーは Chrome ブラウザーを使用している必要があります。 入札には が乗算されます
0.5
。 この分割には、行項目のトラフィックの 40% が割り当てられます。これは優先されます。 割り当てが制約されていません。 - 分割 2 - インプレッションはセグメント
275913
に属している必要があり、過去 1440 分以内に追加されている必要があります。 入札には が乗算されます0.4
。 この分割には、行項目のトラフィックの 30% が割り当てられます。これは優先順位が 2 番目です。 割り当てが制約されていません。 - 分割 3 (名前なし) - 既定の分割。 入札は乗算されます
1
(引き続き同じです)。 この分割には、行項目のトラフィックの 30% が割り当てられます。これは優先度が 3 番目です。 割り当てが制約されていません。
最適化は無効になっているため、分割ごとに入札条件を設定しています。
$ cat ali_cpm_bid_modifier.json
[
{
"active": true,
"allocation_percent": 40,
"allocation_strategy": "unconstrained",
"bid_modifier": 0.5,
"conditions": [
{
"field": "browser",
"operator": "in",
"value": [
8
]
}
],
"creative_macros": [],
"creatives": [],
"expected_value": null,
"is_default": false,
"name": "Split 1",
"order": 1
},
{
"active": true,
"allocation_percent": 30,
"allocation_strategy": "unconstrained",
"bid_modifier": 0.4,
"conditions": [
{
"field": "segment_group",
"operator": "and",
"value": [
[
{
"segment_id": 275913,
"start_minutes": 0,
"expire_minutes": 1440
}
]
]
}
],
"creative_macros": [],
"creatives": [],
"expected_value": null,
"is_default": false,
"name": "Split 2",
"order": 2
},
{
"active": true,
"allocation_percent": 30,
"allocation_strategy": "unconstrained",
"bid_modifier": 1,
"expected_value": null,
"is_default": true,
"name": "Default",
"order": 3
}
$ curl -b cookies -X PUT -s -d '@ali_cpm_bid_modifier.json' "https://api.appnexus.com/budget-splitter/6377633/splits"
[
{
"active": true,
"allocation_percent": 40,
"allocation_strategy": "unconstrained",
"bid_modifier": 0.5,
"conditions": [
{
"field": "browser",
"operator": "in",
"value": [
8
]
}
],
"creative_macros": [],
"creatives": [],
"expected_value": null,
"id": 24025342,
"is_default": false,
"name": "Split 1",
"order": 1
},
{
"active": true,
"allocation_percent": 30,
"allocation_strategy": "unconstrained",
"bid_modifier": 0.4,
"conditions": [
{
"field": "segment_group",
"operator": "and",
"value": [
[
{
"segment_id": 275913,
"start_minutes": 0,
"expire_minutes": 1440
}
]
]
}
],
"creative_macros": [],
"creatives": [],
"expected_value": null,
"id": 24025343,
"is_default": false,
"name": "Split 2",
"order": 2
},
{
"active": true,
"allocation_percent": 30,
"allocation_strategy": "unconstrained",
"bid_modifier": 1,
"expected_value": null,
"id": 24025344,
"is_default": true,
"name": "Default",
"order": 3
}
]
明細の分割を 1 つ更新する
この例では、明細には 5200075
既に 3 つの分割があり、すべて制約のない割り当て戦略があります。 制約付き割り当て戦略を使用するように更新 Split 1
します。
# View the current splits
$ curl -b cookies 'https://api.appnexus.com/budget-splitter/5200075/splits'
{
"id": 24025093,
"name": "Split 1",
"is_default": false,
"active": true,
"bid_modifier": null,
"expected_value": 2,
"allocation_percent": 40,
"allocation_strategy": "unconstrained",
"order": 1,
"conditions": [
{
"field": "browser",
"operator": "in",
"value": [
8
]
}
],
"creatives": [
],
"creative_macros": [
]
},
{
"id": 24025094,
"name": "Split 2",
"is_default": false,
"active": true,
"bid_modifier": null,
"expected_value": 1,
"allocation_percent": 30,
"allocation_strategy": "unconstrained",
"order": 2,
"conditions": [
{
"field": "segment_group",
"operator": "and",
"value": [
[
{
"segment_id": 275913,
"start_minutes": 0,
"expire_minutes": 1440
}
]
]
}
],
"creatives": [
],
"creative_macros": [
]
},
{
"id": 24025096,
"name": "Default",
"is_default": true,
"active": true,
"bid_modifier": null,
"expected_value": 0.5,
"allocation_percent": 30,
"allocation_strategy": "unconstrained",
"order": 3
}
]
# View the split1-update JSON
$ cat split1-update.json
[
{
"id": 24025093,
"name": "Split 1",
"is_default": false,
"active": true,
"bid_modifier": null,
"expected_value": 2,
"allocation_percent": 40,
"allocation_strategy": "constrained",
"order": 1,
"conditions": [
{
"field": "browser",
"operator": "in",
"value": [
8
]
}
],
"creatives": [
],
"creative_macros": [
]
}
]
# Update Split 1
$ curl -b cookies -X PATCH -d @split1_update.json 'https://api.appnexus.com/budget-splitter/5200075/splits'
[
{
"id": 24025093,
"name": "Split 1",
"is_default": false,
"active": true,
"bid_modifier": null,
"expected_value": 2,
"allocation_percent": 40,
"allocation_strategy": "constrained",
"order": 1,
"conditions": [
{
"field": "browser",
"operator": "in",
"value": [
8
]
}
],
"creatives": [
],
"creative_macros": [
]
},
{
"id": 24025094,
"name": "Split 2",
"is_default": false,
"active": true,
"bid_modifier": null,
"expected_value": 1,
"allocation_percent": 30,
"allocation_strategy": "unconstrained",
"order": 2,
"conditions": [
{
"field": "segment_group",
"operator": "and",
"value": [
[
{
"segment_id": 275913,
"start_minutes": 0,
"expire_minutes": 1440
}
]
]
}
],
"creatives": [
],
"creative_macros": [
]
},
{
"id": 24025096,
"name": "Default",
"is_default": true,
"active": true,
"bid_modifier": null,
"expected_value": 0.5,
"allocation_percent": 30,
"allocation_strategy": "unconstrained",
"order": 3
}
]