Yield Management Bias サービス

Yield Management Bias Service は、既存の Yield Management プロファイル内でバイアスを作成および更新するために使用されます。 バイアスは、特定の買い手または買い手のグループからの入札を、オークションを実行するために実際よりも高くまたは低く表示されるように変更する方法です。

REST API

HTTP メソッド	エンドポイント	説明
POST	- https://api.appnexus.com/ym-bias?ym_profile_id=YM_PROFILE_ID - https://api.appnexus.com/ym-bias?ym_profile_code=YM_PROFILE_CODE (ym-bias JSON)	バイアスを追加します。
PUT	- https://api.appnexus.com/ym-bias?id=YM_BIAS_ID - https://api.appnexus.com/ym-bias?code=YM_BIAS_CODE (ym-bias JSON)	既存のバイアスを変更します。
GET	- https://api.appnexus.com/ym-bias?ym_profile_id=YM_PROFILE_ID - https://api.appnexus.com/ym-bias?ym_profile_code=YM_PROFILE_CODE	特定 の歩留まり管理プロファイルに関連付けられているすべてのバイアスを表示します。
GET	- https://api.appnexus.com/ym-bias?id=YM_BIAS_ID - https://api.appnexus.com/ym-bias?code=YM_BIAS_CODE	特定のバイアスを表示します。
GET	https://api.appnexus.com/ym-bias?id=1,2,3	コンマ区切りリストを使用して、ID で複数のバイアスを表示します。

JSON フィールド

フィールド	種類	説明
id	int	利回り管理バイアスの一意識別子。 デフォルト： 自動インクリメントされた数値 (つまり 123)。 必須:PUT
code	string	歩留まり管理バイアスを参照するために使用されるオプションのカスタム コード。 デフォルト：NULL
name	string	利回り管理バイアスを表すために使用される名前。 デフォルト：None 必須:POST
description	string	利回り管理バイアスの使用方法を省略可能な説明。 デフォルト：NULL
ym_profile_id	int	利回り管理バイアスが関連付けられている利回り管理プロファイルの ID。 詳細については、 Yield Management Profile Service を参照してください。 手記： この ID は、設定後は変更できません。 デフォルト：NULL 必須:POST
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	配列	これは購入者メンバーの名前です。 デフォルト： 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 です。 デフォルト：None 必須 On:POST、 PUT
name	配列	これは購入者グループの名前です。 デフォルト： 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'の場合)。

例

特定のバイアスを表示する

$ curl -b cookies -c cookies  "https://api.appnexus.com/ym-bias?id=1234"
{
    "ym-bias": {
        "member_id": 3,
        "id": 124,
        "name": "Canada Bias",
        "description": "This rule will used to set the bias for a set of demand attributes across Canadian inventory.",
        "profile_id": 1241,
        "priority": 5,
        "ym_profile_id": 1234
        "members": [
                    {
                        "id": 100,
                        "name": "eBay",
                        "type": "percent",
                        "bias_pct": 10
                    },
                    {
                        "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
                    }
                ]
    }
}

特定の利回り管理プロファイルに関連付けられているすべてのバイアスを表示する

注:

以下の配列の最初のバイアスは、 {{members}} または {{buyer_groups}}に関連付けるのではなく、 {{profile_id}} に関連付けられています (詳細については、上記の JSON フィールド を参照してください)。

$ curl -b cookies "https://api.appnexus.com/ym-bias?ym_profile_id=123"
{
 "response": {
  "status": "OK",
  "ym-biases": [
   {
    "priority": 10,
    "member_id": 999,
    "members": null,
    "name": "Low Frequency Bias",
    "last_modified": "2011-02-22 19:26:32",
    "code": null,
    "id": 4,
    "description": null,
    "profile_id": 456,
    "ym_profile_id": 123,
    "buyer_groups": null
   },
   {
    "priority": 5,
    "member_id": 999,
    "members": [
               {
        "id": 890,
        "name": "The one I'm biased slightly against",
        "type": "percent",
        "bias_pct": -5
           }
    ],
    "name": "A secret bias only I can see",
    "last_modified": "2011-07-05 23:32:46",
    "code": null,
    "id": 1575,
    "description": null,
    "profile_id": null,
    "ym_profile_id": 123,
    "buyer_groups": null
   }
  ],
  "start_element": null,
  "count": 2,
  "num_elements": null
 }
}