Yield Management Floor Service は、既存の Yield Management プロファイル内でフロアを作成および更新するために使用されます。
下限は、ネットワークまたはパブリッシャーがクリエイティブに対して受け取りたい最低価格と考えることができます。 ただし、微妙な点があります。
警告
フロア設定は、 配置サービスを介して設定された予約価格に優先します。
例: ソフト フロア設定はあるがハード フロアはなく、 プレースメント レベルで予約価格を設定しました。 ただし、 利回り管理 ツールを使用しているため、予約価格の設定は無視されます。 ここでは、ハード フロアを介して設定する必要があります。
REST API
| HTTP メソッド | エンドポイント | 説明 |
|---|---|---|
GET |
https://api.appnexus.com/ym-floor?member_id=MEMBER_ID | 特定のメンバーに関連付けられているすべての階を表示します。 |
GET |
- https://api.appnexus.com/ym-floor?ym_profile_id=YM_PROFILE_ID - https://api.appnexus.com/ym-floor?ym_profile_code=YM_PROFILE_CODE |
特定の 歩留まり管理プロファイルに関連付けられているすべてのフロアを表示します。 |
GET |
- https://api.appnexus.com/ym-floor?id=YM_FLOOR_ID - https://api.appnexus.com/ym-floor?code=YM_FLOOR_CODE |
特定のフロアを表示します。 |
GET |
https://api.appnexus.com/ym-floor?id=1,2,3 | コンマ区切りのリストを使用して、ID 別に複数の収量管理フロアを表示します。 |
POST |
- https://api.appnexus.com/ym-floor?ym_profile_id=YM_PROFILE_ID - https://api.appnexus.com/ym-floor?ym_profile_code=YM_PROFILE_CODE (ym-floor JSON) |
新しいフロアを追加します。 |
PUT |
- https://api.appnexus.com/ym-floor?member_id=MEMBER_ID - https://api.appnexus.com/ym-floor?code=YM_FLOOR_CODE (ym-floor JSON) |
既存のフロアを変更します。 |
DELETE |
- https://api.appnexus.com/ym-floor?id=YM_FLOOR_ID - https://api.appnexus.com/ym-floor?code=YM_FLOOR_CODE |
既存のフロアを削除します。 メモ: 1 つ以上の歩換管理プロファイルの基準フロアとして使用されているフロアは削除できません。 |
JSON フィールド
| フィールド | 種類 | 説明 |
|---|---|---|
member_id |
int | フロアが関連付けられているメンバーの一意の識別子。 既定値: NULLRequired On: PUT, in query string. |
id |
int | 歩留まり管理フロアの一意識別子。 既定値: 自動インクリメント番号 (例: 123)。 必須: PUT |
name |
string | 収量管理フロアを説明するために使用される名前。 既定値: None必須: POST |
code |
string | 歩留まり管理フロアを参照するために使用されるオプションのカスタム コード。 既定値: NULL |
description |
string | 歩留まり管理フロアの使用方法に関するオプションの説明。 既定値: NULL |
hard_floor |
double | 適用されるハード予約価格として使用される CPM の下限。 既定値: None必須: POST |
soft_floor |
double | ソフト予約として使用される CPM の下限。値下げが発生する最低価格として定義されます。 設定した場合、これはハード フロア以上である必要があります。 既定値: NULL |
default_calculation_type |
列挙 |
grossまたはnetの入札に適用するかどうか。 使用可能な値: gross または net。
netのdefault_calculation_typeとは、パブリッシャーに支払われるメディア コストに適用される下限です。既定値: gross |
profile_id |
int | オプションの profile_id は、フロアを適用するタイミングを決定するために使用されます。 プロファイルは、インベントリをターゲットにするための一般的なルール セットであり、特定のフロアはインベントリの特定のスライスにのみ適用される場合があります。 詳細については、 プロファイル サービスを参照してください。既定値: NULL |
priority |
int | 優先度フィールド (オプション) は、フロアをどのように適用するかの階層を作成するために使用されます。 値は 1-10 の間であり、優先度 10 は最高の優先度の値として扱われます。既定値: 5 |
ym_profile_id |
int | 歩留まり管理フロアが関連付けられている歩換管理プロファイルの ID。 詳細については、 Yield Management プロファイル サービスを参照してください。 メモ: この ID は一度設定すると変更できません。 既定値: NULL必須: POST |
floor_application_target |
列挙 | 価格下限が適用される入札の種類。 使用可能な値: - external_only: 価格下限は外部入札にのみ適用されます (購入メンバーと販売メンバーは異なります)。 学習の 1 日あたりのボリュームの最大 % (パブリッシャー サービスのmax_learn_pctフィールド) を超えてしまう場合でも、既定値を提供するよりも利用可能なマネージド学習のインプレッションを提供する場合は、このオプションを使用します。- external_non_preferred: 価格の下限は、外部入札 (購入メンバーと販売メンバーが異なります)、またはインプレッションが利用可能なマネージド Learn インプレッションであり、学習の 1 日の最大ボリュームの割合を超える場合に適用されます。 学習の 1 日の最大ボリュームの割合を超える利用可能なマネージド Learn インプレッションを提供するのではなく、既定値を提供する場合は、このオプションを使用します。- all: マネージド ラーンのインプレッションを除くすべての入札単価に、学習の 1 日のボリュームの最大の割合以内に適用されます。既定値: all |
apply_floor_to_direct |
ブール型 | 削除されます。 代わりに floor_application_target を使用してください。 |
allow_tag_reserve_override |
ブール型 |
true場合は、広告タグのクエリ文字列を介して送信される予約価格で既存のハード フロアを上書きできるようにします。 タグで指定した予約価格が最低価格より高い場合にのみ、下限が上書きされます。既定値: false |
floor_optimization_enabled |
ブール型 | 非推奨 |
members |
配列 | 利回り管理フロアを適用する必要があるメンバー。
NULL に設定したままにすると、フロアはすべてのメンバーに適用されます。 詳細については、以下の メンバーを参照してください 。既定値: NULL |
brands |
配列 | 歩留まり管理フロアを適用するブランド。 詳細については、以下の ブランドを参照してください 。 既定値: NULL |
categories |
配列 | この収益管理フロアを適用する必要があるブランドまたはクリエイティブ カテゴリ。 詳細については、以下の カテゴリ を参照してください。 既定値: NULL |
allowed_media_types |
配列 | この歩留まり管理フロアを適用する必要があるメディアの種類。 詳細については、以下の 「メディアの種類 」を参照してください。 既定値: NULL |
allowed_media_subtypes |
配列 | この収量管理フロアを適用する必要があるメディア サブタイプ。 詳細については、以下の 「メディア サブタイプ 」を参照してください。 既定値: NULL |
メンバー
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | フロアを適用する必要がある購入者メンバーの ID ( プラットフォーム メンバー サービスで確認可能)。 必須: POST/PUT |
name |
string | 購入者メンバーの名前。このフィールドは 読み取り専用です。 |
ブランド
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | フロアを適用するクリエイティブのブランド ID ( Brand Service で確認できます)。 必須: POST/PUT |
name |
string | ブランドの名前。 このフィールドは 読み取り専用です。 |
Categories
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | このフロアを適用する必要があるブランドまたはクリエイティブ カテゴリ ( 「カテゴリ サービス」で説明されている) の ID。 必須: POST/PUT |
name |
string | ブランドまたはクリエイティブ カテゴリの名前。 このフィールドは 読み取り専用です。 |
メディアの種類
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | このフロアを適用するメディア タイプの ID ( 「メディア タイプ サービス」で説明されています)。 必須: POST/PUT |
name |
string | メディアの種類の名前。 このフィールドは 読み取り専用です。 |
メディアのサブタイプ
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | このフロアを適用するメディア サブタイプの ID ( メディア サブタイプ サービスで説明を参照)。 必須: POST/PUT |
name |
string | メディア サブタイプの名前。 このフィールドは 読み取り専用です。 |
例
特定の階を表示する
$ curl -b cookies -c cookies "https://api.appnexus.com/ym-floor?id=1234"
{
"ym-floor": {
"member_id": 3,
"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,
"floor_application_target": "all",
"profile_id": 1542,
"priority": 6,
"ym_profile_id": 1234,
"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"
}],
"allowed_media_types": [{
"id": 1,
"name": "Banner"
}, {
"id": 4,
"name": "Video"
}],
"allowed_media_subtypes": [{
"id": 1,
"name": "Standard Banner"
}, {
"id": 8,
"name": "30-second VAST"
}]
}
}
歩留まり管理プロファイルに関連付けられているすべての階を表示する
次の階は、{{members}} 配列ではなく、オプションの{{profile_id}}によってターゲットとなることに注意してください。 詳細については、上記の JSON フィールド を参照してください。
$ curl -b cookies "https://api.appnexus.com/ym-floor?ym_profile_id=9999"
{
"response": {
"start_element": null,
"count": 2,
"ym-floors": [{
"priority": 5,
"last_modified": "2011-11-03 23:04:24",
"soft_floor": 0.23999999999999999,
"member_id": 123,
"name": "Placement 60 + Size 300x250 Floor",
"floor_application_target": "all",
"default_calculation_type": "gross",
"brands": null,
"ym_profile_id": 9999,
"code": "Tattooed Bikers Galore",
"hard_floor": 0,
"id": 555,
"description": null,
"profile_id": 23,
"members": null,
"categories": null,
"allowed_media_types": null,
"allowed_media_subtypes": null
}, {
"priority": 5,
"last_modified": "2011-11-04 01:18:35",
"soft_floor": 0.050000000000000003,
"member_id": 1,
"name": "Placement+Size 728x90 Floor",
"floor_application_target": "all",
"default_calculation_type": "gross",
"brands": null,
"ym_profile_id": 9999,
"code": "Tattooed Bikers Knit and Sew",
"hard_floor": 0,
"id": 4,
"description": null,
"profile_id": 9,
"members": null,
"categories": null,
"allowed_media_types": null,
"allowed_media_subtypes": null
}],
"status": "OK",
"num_elements": null
}
}