Yield Management Profile サービス
Yield Management Profile Service は、パブリッシャーの動的 価格フロア、 入札バイアス、 オークションレベル を定義する利回り管理プロファイルを作成および更新するために使用されます。
具体的には、Yield Management プロファイルは、次のプロパティと動作を持つ一連のルールです。
プロファイルの ターゲット:
- 一部/すべてのインベントリ
- 一部/すべての購入者
プロファイルでは 、次を指定します。
- 0 以上のフロア ルール
- 0 個以上のバイアス ルール
- これらのフロアとバイアスに適用される 0 個以上の修飾子
- 0 つ以上のオークションレベル
REST API
| HTTP メソッド | エンドポイント | 説明 |
|---|---|---|
GET |
- https://api.appnexus.com/ym-profile?id=YMP_ID - https://api.appnexus.com/ym-profile?id=YMP_CODE |
特定のプロファイルを表示します。 |
GET |
- https://api.appnexus.com/ym-profile?publisher_id=PUBLISHER_ID - https://api.appnexus.com/ym-profile?publisher_code=PUBLISHER_CODE |
特定の発行元に関連付けられているすべてのプロファイルを表示します。 |
GET |
https://api.appnexus.com/ym-profile?id=1,2,3 | コンマ区切りリストを使用して、ID で複数のプロファイルを表示します。 |
POST |
https://api.appnexus.com/ym-profile (ym-profile JSON) |
プロファイルを追加します。 手記： プロファイルを追加した後、 Publisher Service を使用して特定の発行元にプロファイルを割り当てることができます。 |
PUT |
- https://api.appnexus.com/ym-profile?id=YMP_ID - https://api.appnexus.com/ym-profile?id=YMP_CODE (ym プロファイル JSON) |
既存のプロファイルを変更します。 |
DELETE |
https://api.appnexus.com/ym-profile?id=YMP_ID | 既存のプロファイルを削除します。 |
JSON フィールド
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | 収益管理プロファイルの一意識別子。 デフォルト： 自動インクリメントされた数値 (つまり 123)。 必須: PUT |
code |
string | yield Management プロファイルを参照するために使用される省略可能なカスタム コード。 デフォルト： NULL |
name |
string | 歩留まり管理プロファイルを記述するために使用される名前。 デフォルト： None必須: POST |
description |
string | 利回り管理プロファイルの省略可能な説明。 デフォルト： NULL |
base_ym_bias_id |
int | 他の YM バイアスを使用しない場合に適用する必要がある YM バイアスの ID。 通常、この YM バイアスには優先度 1 (最も低い優先度) があり、プロファイルはありません。 デフォルト： NULL |
base_ym_floor_id |
int | 他の YM フロアを使用しない場合に適用する必要がある YM フロアの ID。 通常、この YM フロアには優先度 1 (最も低い優先順位) があり、プロファイルはありません。 デフォルト： NULL |
publisher_id |
int | 読み取り専用です。 収益管理プロファイルが関連付けられている発行元の ID。 パブリッシャー サービスを使用して、yield management プロファイルとパブリッシャーの間で関連付けを行います。 |
modifiers |
配列 | クリエイティブの技術属性に適用される修飾子。 詳細については、以下 の修飾子に関するページを 参照してください。 デフォルト： NULL |
biases |
配列 | 需要側オブジェクトに適用されるバイアス: 購入者グループ、購入者メンバー。 詳細については、以下 の「バイアス 」を参照してください。 デフォルト： NULL |
floors |
配列 | 在庫とユーザーのターゲティングに基づいて適用されるフロア価格。 詳細については、以下の 「フロア 」を参照してください。 デフォルト： NULL |
last_modified |
timestamp | この利回り管理プロファイルの最終変更時刻。 デフォルト： N/A |
修飾子
| フィールド | 種類 | 説明 |
|---|---|---|
technical_attributes |
配列 | これは、yield 管理修飾子を適用する必要がある技術属性を指定する配列です。 デフォルト： NULL必須 On: POST、 PUT |
修飾子 - 技術属性
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | これは、修飾子を適用する必要がある技術属性 ( Technical Attribute Service で見つかった) の ID です。 デフォルト： None必須 On: POST、 PUT |
name |
name | これは技術属性の名前です。 デフォルト： N/A |
type |
列挙 ( 'bias-pct','bias-cpm','floor-pct','floor-cpm') |
これにより、パーセンテージまたはフラット CPM で表される修飾子に使用する値と、修飾子を適用する必要がある値 (入札またはフロア) が決まります。 デフォルト： NULL必須 On: POST、 PUT |
amount_pct |
double | これは、入札またはフロアを変更する必要がある%額です。
bias_pct = 5場合、純入札額は5%増加します。デフォルト： 0.00必須 On: POST、 PUT ( type が 'bias-pct' または 'floor-pct'の場合)。 |
amount_cpm |
double | これは、入札またはフロアを変更する必要がある CPM の増減です。 デフォルト： NULL必須 On: POST、 PUT ( type が 'bias-cpm' または 'floor-cpm'の場合)。 |
バイアス
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | 利回り管理バイアスの一意識別子。 デフォルト： 自動インクリメントされた数値 (つまり 123)。 必須: PUT |
code |
string | 歩留まり管理バイアスを参照するために使用されるオプションのカスタム コード。 デフォルト： NULL |
name |
string | 利回り管理バイアスを表すために使用される名前。 デフォルト： None必須: POST |
description |
string | 利回り管理バイアスの使用方法を省略可能な説明。 デフォルト： NULL |
profile_id |
int | オプションの profile_id を使用して、バイアスを適用するタイミングを決定します。 プロファイルはインベントリを対象とする一般的なルールのセットであり、特定のバイアスは特定のインベントリのスライスにのみ適用される場合があります。 詳細については、 プロファイル サービスに関するページを参照してください。デフォルト： NULL |
priority |
int | 優先度フィールド (省略可能) は、バイアスを適用する方法の階層を作成するために使用されます。 値は、優先度10が最も高い優先度の値として扱われる1-10の間である可能性があります。デフォルト： 5 |
members |
配列 | これは、利回り管理バイアスを適用する必要があるメンバーを指定する配列です。 デフォルト： NULL |
buyer_groups |
配列 | これは、利回り管理バイアスを適用する必要がある買い手グループを指定する配列です。 デフォルト： NULL |
バイアス - 購入者メンバー
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | これは、バイアスを適用する必要がある( プラットフォームメンバーサービスで見られる)バイヤーメンバーのIDです。 デフォルト： None必須 On: POST、 PUT |
name |
string | これは購入者メンバーの名前です。 デフォルト： N/A |
type |
列挙 ( 'percent','cpm') |
これにより、バイアスに使用する値が、パーセンテージまたはフラット CPM として表されます。 デフォルト： "percent"必須 On: POST、 PUT |
bias_pct |
double | これは、購入者メンバーが調整する必要がある% 金額です。
bias_pct = 5場合、純入札額は5%増加します。デフォルト： 0.00必須 On: POST、 PUT ( type が 'percent'の場合)。 |
bias_cpm |
double | これは、購入者メンバーが調整する必要がある CPM の増減です。 デフォルト： NULL必須 On: POST、 PUT ( type が 'cpm'の場合)。 |
バイアス - 購入者グループ
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | これは、バイアスを適用する必要がある買い手グループの ID です。 デフォルト： 何一つ 必須 On: POST、 PUT |
name |
string | これは購入者グループの名前です。 デフォルト： N/A |
type |
列挙 ( 'percent','cpm') |
これにより、バイアスに使用する値が、パーセンテージまたはフラット CPM として表されます。 デフォルト： "percent"必須 On: POST、 PUT |
bias_pct |
double | これは、購入者メンバーが調整する必要がある% 金額です。
bias_pct = 5場合、純入札額は5%増加します。デフォルト： 0.00必須 On: POST、 PUT ( type が 'percent'の場合)。 |
bias_cpm |
double | これは、購入者メンバーが調整する必要がある CPM の増減です。 デフォルト： NULL必須 On: POST、 PUT ( type が 'cpm'の場合)。 |
床
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | 利回り管理フロアの一意識別子。 デフォルト： 自動インクリメントされた数値 (つまり 123)。 必須: PUT |
code |
string | 歩留まり管理フロアを参照するために使用されるオプションのカスタム コード。 デフォルト： NULL |
name |
string | 利回り管理フロアの説明に使用される名前。 デフォルト： None必須: POST |
description |
string | 利回り管理フロアの使用方法の説明 (省略可能)。 デフォルト： NULL |
profile_id |
int | 省略可能な profile_id は、フロアを適用するタイミングを決定するために使用されます。 プロファイルは、インベントリを対象とする一般的なルールのセットであり、特定のフロアは特定のインベントリのスライスにのみ適用できます。 詳細については、 プロファイル サービスに関するページを参照してください。デフォルト： NULL |
priority |
int | 優先順位フィールド (省略可能) は、フロアを適用する方法の階層を作成するために使用されます。 値は、優先度10が最も高い優先度の値として扱われる1-10の間である可能性があります。デフォルト： 5 |
hard_floor |
double | このcpmフロアは適用されるハード予約価格として使用されます。 デフォルト： None必須: POST |
soft_floor |
double | この cpm フロアはソフト リザーブとして使用され、価格引き下げが発生する最低価格として定義されます。これは、設定されている場合はハード フロア >する必要があります。 デフォルト： NULL |
members |
配列 | これは、yield 管理フロアを適用する必要があるメンバーを指定する配列です。 デフォルト： NULL |
brands |
配列 | これは、利回り管理フロアを適用する必要があるブランドを指定する配列です。 デフォルト： NULL |
categories |
配列 | これは、利回り管理フロアを適用する必要があるカテゴリを指定する配列です。 デフォルト： NULL |
default_calculation_type |
列挙 ( 'gross','net') |
これは、フロアを総入札または純入札に適用する必要があるかどうかを判断するために使用されます。 デフォルト： gross |
apply_floor_to_direct |
int | これは、指定されたメンバーにのみフロアを適用するか、マネージド需要に加えてフロアを適用するかを決定するために使用されます。 デフォルト： 1 |
フロア - メンバー
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | これは、フロアを適用する必要がある ( プラットフォーム メンバー サービスに記載されている) 購入者メンバーの ID です。 必須 On: POST、 PUT |
name |
配列 | これは購入者メンバーの名前です。 |
フロア - ブランド
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | これは、フロアを適用するクリエイティブのブランドの ID です ( ブランド サービスに記載されています)。 必須 On: POST、 PUT |
name |
配列 | これはブランドの名前です。 |
Floor - カテゴリ
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | これは、フロアを適用するクリエイティブのカテゴリの ID です ( カテゴリ サービスに記載されています)。 必須 On: POST、 PUT |
name |
配列 | これはカテゴリの名前です。 |
例
特定の利回り管理プロファイルを表示する
$ curl -b cookies -c cookies "https://api.appnexus.com/ym-profile?id=8"
{
"ym-profile": {
"id": 1234,
"member_id": 3,
"active": true,
"name": "Publisher X YMP",
"description": "This profile will be used for publisher X.",
"base_ym_bias_id": 125,
"base_ym_floor_id": 1574,
"last_modified": "2010-10-02 12:00:00",
"modifiers": {
"technical_attributes": [
{
"id": 2,
"type": "bias-cpm",
"amount_pct": 0,
"amount_cpm": -1,
"name": "Flash"
},
{
"id": 3,
"type": "bias-pct",
"amount_pct": 10,
"amount_cpm": null,
"name": "Text"
}
]
},
"biases": [
{
"id": 124,
"name": "YMP Canada Bias",
"description": "This rule will used to set the bias for a set of demand attributes across Canadian inventory.",
"profile_id": 1241,
"priority": 10,
"members": [
{
"id": 100,
"name": "eBay",
"type": "percent",
"bias_pct": "9"
},
{
"id": 256,
"name": "MiG",
"type": "cpm",
"bias_cpm": -0.25
}
],
"buyer_groups": [
{
"id": 120,
"name": "Third Party Ad Networks",
"type": "percent",
"bias_pct": -5
},
{
"id": 153,
"name": "Value Ad Networks",
"type": "cpm",
"bias_cpm": 0.50
}
]
},
{
"id": 125,
"name": "Base YMP Bias",
"description": "",
"profile_id": null,
"priority": 1,
"members": null,
"buyer_groups": null
}
],
"floors": [
{
"id": 1234,
"name": "Germany Floor",
"description": "This rule will used to set the floor for a set of demand attributes across Germany inventory.",
"hard_floor": "1.20",
"soft_floor": null,
"default_calculation_type": "gross",
"apply_floor_to_direct": true,
"profile_id": 1542,
"priority": 6,
"members": [
{
"id": 100,
"name": "eBay"
},
{
"id": 256,
"name": "MiG"
}
],
"brands": [
{
"id": 102,
"name": "Netflix"
},
{
"id": 256,
"name": "Blockbuster"
}
],
"categories": [
{
"id": 2,
"name": "Apparel"
},
{
"id": 8,
"name": "Dating"
}
]
},
{
"id": 1574,
"name": "Base YM Floor",
"description": "",
"hard_floor": 1.00,
"soft_floor": 1.50,
"default_calculation_type": "gross",
"apply_floor_to_direct": true,
"profile_id": null,
"priority": 1,
"members": null,
"brands": null,
"categories": null
}
]
}
}