支払いルールサービス

支払いルールは、ネットワークが管理対象パブリッシャーの 1 つに支払う条件を定義します。ネットワークには、パブリッシャーとの支払条件が複数設定されている場合があります。たとえば、特定の地域から発信されるトラフィックには、異なる収益分配契約の条件が適用される場合があります。

注:

プレースメントサービスを介した広告主または品目のターゲティングは、このサービスのオプションのprofile_idを介したそれらのオブジェクトのターゲティングをオーバーライドします。

REST API

注:

publisher_code は publisher_id の代わりに使用できます。また、以下のすべての呼び出しについて、 payment_rule_code を publisher_rule_id の代わりに使用できます。

HTTP メソッド	エンドポイント	説明
`POST`	`https://api.appnexus.com/payment-rule?publisher_id=PUBLISHER_ID` (payment-rule JSON)	新しい支払いルールを追加します。
`PUT`	`https://api.appnexus.com/payment-rule?id=PAYMENT_RULE_ID&publisher_id=PUBLISHER_ID` (payment-rule JSON)	既存の支払いルールを変更します。
`GET`	`https://api.appnexus.com/payment-rule?publisher_id=PUBLISHER_ID`	パブリッシャーのすべての支払いルールを表示します。
`GET`	`https://api.appnexus.com/payment-rule?id=PAYMENT_RULE_ID`	パブリッシャーの特定の支払いルールを表示します。
`GET`	`https://api.appnexus.com/payment-rule?id=1,2,3`	コンマ区切りのリストを使用して、ID 別に複数の支払いルールを表示します。
`DELETE`	`https://api.appnexus.com/payment-rule?id=PAYMENT_RULE_ID`	支払いルールを削除します。

JSON フィールド

フィールド	種類	説明
`id`	int	この支払いルールの ID。必須:`PUT`、クエリ文字列内
`code`	string	この支払いルールを参照するために使用できるオプションのカスタムコード。既定値: `Null`
`name`	string	この支払いルールを説明するために使用される名前。既定値: `None` 必須:`POST`
`state`	列挙	この支払いルールの状態。使用可能な値: `"active"` または `"inactive"`。既定値: `"active"`
`description`	string	任意の説明。
`start_date`	timestamp	このルールの開始日。既定値: `Immediately`
`end_date`	timestamp	このルールの終了日。既定値: `Indefinitely`
`pricing_type`	列挙	使用可能な値: - `"revshare"` - パブリッシャーは広告収益の一定割合を支払われます。 - `"cpm"` - パブリッシャーには、配信される広告ごとに定額料金が支払われます。 - `"dynamic"` - 支払条件は、最小および最大収益シェアと目標 eCPM によって定義されます。既定値: `"revshare"` 必須:`POST`
`cost_cpm`	double	`pricing_type`が`"cpm"`の場合、これはパブリッシャーに支払われる CPM 料金です。必須:`POST` ( `pricing_type` が `"cpm"`
`revshare`	double	`pricing_type`が`"revshare"`の場合、これはパブリッシャーに支払われる割合です。価格設定の種類が `"dynamic"` の場合、これはパブリッシャーに支払われる最小収益共有の割合であり、最大値は `max_revshare` で定義されています。パーセンテージは 0 から 1 (両端を含む) の数値で表す必要があります。ここで、1 は 100% を意味します。必須:`POST` ( `pricing_type` が `"revshare"` または `"dynamic"`
`profile_id`	int	オプションの `profile_id` は、支払いルールをいつ適用するかを決定するために使用されます。プロファイルは、在庫を対象とするための一般的なルールセットであり、特定の支払いルールは特定のスライスインベントリにのみ適用される場合があります。詳細については、プロファイルサービスを参照してください。
`priority`	int	必要に応じて、他の支払いルールと比較してこのルールを適用するレベルを定義する優先度を指定できます。既定値: `5`
`timezone`	string	価格データの計算に使用されるタイムゾーン。タイムゾーンのリストについては、「 API タイムゾーン」を参照してください。既定値: `'EST5EDT'`
`last_modified`	timestamp	この支払規則に対する最終変更時刻。
`demand_filter_action`	列挙	`filtered_advertisers`または`filtered_line_items`配列にリストされている広告主や広告申込情報を含めるか除外するかを決定します。使用可能な値: - `"include"` - `"exclude"` - `"default"`. 詳細については、以下の「デマンドフィルタリング」を参照してください。
`filtered_advertisers`	オブジェクトの配列	`demand_filter_action`で指定されたアクションを適用する広告主のリスト。以下の「フィルター処理された広告主」を参照してください。
`filtered_line_items`	オブジェクトの配列	`demand_filter_action` で指定されたアクションを適用する品目の一覧。以下のフィルターされた項目を参照してください。
`filtered_campaigns`	オブジェクトの配列	非推奨。 `demand_filter_action` で指定されたアクションを適用するキャンペーンのリスト。
`buyer_type`	列挙	この支払いルールを適用する購入者の種類。使用可能な値: - `"direct"`: 独自の管理されたインベントリ - `"external"`: サードパーティの管理対象インベントリ - `"both"` 既定値: `"both"`
`max_revshare`	double	`pricing_type`が`"dynamic"`の場合、これはパブリッシャーに支払われる最大収益シェアの割合です。必須:`pricing_type`が`"dynamic"`の場合は`POST`。
`apply_cost_on_default`	ブール値	オークションが不履行となった場合でもパブリッシャーに支払いが行われるかどうか。

デマンドフィルタリング

デマンドフィルタリングは便利なターゲティング機能ですが、支払いルールや配置で使用する前に、そのしくみを理解しておくことが重要です。

主な考慮事項

マネージドデマンドにのみ適用: 支払いルールまたはプレースメントでのデマンドフィルタリングは、マネージドデマンドにのみ適用されます。プレースメントで再販が有効になっている場合、サードパーティのデマンドソースからのキャンペーンはデマンドフィルタリングの影響を受けません。
インプレッションごとに 1 つの支払いルールが適用されます: 各インプレッションには、オークションの開始時に選択される 1 つの支払いルールが使用されます。選択すると、支払ルールによって、参加資格のあるデマンドが決定されます。この動作のため、支払いルールのデマンドフィルタリングを使用して、オークションで勝ったデマンドソースに基づいてパブリッシャーの支払いを調整することはできません。特に次のような場合です。

明細行品目を含める: 支払ルールに特定の明細行品目 が含まれている 場合、支払ルールが適用されると、その明細行品目はオークションから除外されます。他のマネージドラインアイテムと RTB 需要のみがサービスを受ける資格があります。たとえば、filtered_line_items = 1234 および demand_filter_action = include の場合、この支払いルールが選択されている場合、 1234 品目は入札できません。
ラインアイテムの除外: 支払いルールで特定のラインアイテムが除外されている場合、そのラインアイテムのみが管理された需要から入札できます。他のすべてのマネージドラインアイテムは除外されますが、RTB 需要は引き続き対象となります。たとえば、filtered_line_items = 1234 および demand_filter_action = exclude の場合、この支払いルールが選択されている場合、管理された需要から入札できるのは広告申込品目 1234 のみです。その品目がフリークエンシーキャップに達した場合、ペーシング中、またはその他不適格な場合、支払いルールが選択されている間は、マネージドデマンドは配信されません。

配置レベルのフィルター処理が優先されます。配置レベルで構成された要求フィルター処理は、支払ルールレベルで構成された需要フィルター処理を上書きします。配置に需要の包含または除外が設定されている場合、すべての支払ルールレベルの需要フィルター処理は無視されます。詳細については、「配置需要フィルター処理」を参照してください。

フィルターされた広告主

フィールド	種類	説明
`id`	int	広告主の ID。
`name`	string	広告主の名前。

フィルターされた広告申込情報

フィールド	種類	説明
`id`	int	品目の ID。
`name`	string	明細行品目の名前。

例

支払いルールを作成する

$ cat payment_rule.json

{
    "payment-rule":{
        "name": "France - 1/24 - $.40 CPM",
        "code": "france_payment_rule",
        "pricing_type": "cpm",
        "cost_cpm": "0.4",
        "state": "active",
        "start_date": "2010-01-01 00:00:00",
        "end_date": "2010-03-31 11:59:59",
        "priority": 8,
        "profile_id": 12345
    }
}

$ curl -c cookies -b cookies -X POST -d @payment_rule.json 'https://api.appnexus.com/payment-rule?publisher_id=65103'

{
  "response": {
    "status": "OK",
    "count": 1,
    "id": 66323,
    "start_element": 0,
    "num_elements": 100,
    "payment-rule": {
      "id": 66323,
      "code": "france_payment_rule",
      "name": "France - 1/24 - $.40 CPM",
      "description": "",
      "pricing_type": "cpm",
      "cost_cpm": 0.4,
      "revshare": null,
      "state": "active",
      "start_date": "2010-01-01 00:00:00",
      "end_date": "2010-03-31 11:59:59",
      "profile_id": 12345,
      "timezone": "EST5EDT",
      "priority": 8,
      "last_modified": "2011-02-18 21:19:52"
    }
  }
}

1 つの支払いルールを読む

$ curl -b cookies 'https://api.appnexus.com/payment-rule?id=92873'

{
    "payment-rule": {
    "apply_cost_on_default": true,
    "target_ecpm": 0.8,
    "max_revshare": 0.8,
    "buyer_type": "both",
    "last_modified": "2012-08-02 19:04:00",
    "priority": 10,
    "timezone": "EST5EDT",
    "profile_id": null,
    "end_date": null,
    "start_date": "2013-01-01 00:00:00",
    "state": "active",
    "revshare": 0.67,
    "cost_cpm": 40,
    "pricing_type": "dynamic",
    "description": "A payment rule for targeting USA users",
    "name": "USA",
    "code": "usa_payment_rule",
    "id": 98273
    }
}

発行元のすべての支払いルールを読む

$ curl -c cookies -b cookies 'https://api.appnexus.com/payment-rule?publisher_id=65103'

{
  "response": {
    "status": "OK",
    "count": 4,
    "start_element": null,
    "num_elements": null,
    "payment-rules": [
      {
        "id": 95479,
        "code": null,
        "name": "Base Payment Rule",
        "description": "",
        "pricing_type": "revshare",
        "cost_cpm": null,
        "revshare": 0.6,
        "state": "active",
        "start_date": null,
        "end_date": null,
        "profile_id": null,
        "timezone": "EST5EDT",
        "priority": 1,
        "last_modified": "2012-04-09 11:40:54",
        "buyer_type": "both",
        "max_revshare": null,
        "target_ecpm": null,
        "apply_cost_on_default": false,
        "demand_filter_action": "default",
        "lifetime_budget": null,
        "lifetime_budget_imps": null,
        "daily_budget": null,
        "daily_budget_imps": null,
        "filtered_advertisers": null,
        "filtered_line_items": null
      },
      {
        "id": 95480,
        "code": null,
        "name": "AbenBog Unique Impressions",
        "description": "",
        "pricing_type": "revshare",
        "cost_cpm": null,
        "revshare": 0.7,
        "state": "active",
        "start_date": "2012-04-09 00:00:00",
        "end_date": null,
        "profile_id": 142958,
        "timezone": "EST5EDT",
        "priority": 5,
        "last_modified": "2012-04-09 11:46:32",
        "buyer_type": "both",
        "max_revshare": null,
        "target_ecpm": null,
        "apply_cost_on_default": false,
        "demand_filter_action": "exclude",
        "lifetime_budget": null,
        "lifetime_budget_imps": null,
        "daily_budget": null,
        "daily_budget_imps": null,
        "filtered_advertisers": null,
        "filtered_line_items": null
      },
      {
        "id": 98434,
        "code": null,
        "name": "Rich's cool payment rule",
        "description": "",
        "pricing_type": "revshare",
        "cost_cpm": null,
        "revshare": 0.7,
        "state": "active",
        "start_date": null,
        "end_date": null,
        "profile_id": null,
        "timezone": "EST5EDT",
        "priority": 5,
        "last_modified": "2012-08-03 17:37:17",
        "buyer_type": "both",
        "max_revshare": null,
        "target_ecpm": null,
        "apply_cost_on_default": true,
        "demand_filter_action": "default",
        "lifetime_budget": null,
        "lifetime_budget_imps": null,
        "daily_budget": null,
        "daily_budget_imps": null,
        "filtered_advertisers": null,
        "filtered_line_items": null
      },
      {
        "id": 98435,
        "code": "this_is_a_test",
        "name": "Rich's other cool payment rule",
        "description": "",
        "pricing_type": "revshare",
        "cost_cpm": null,
        "revshare": 0.7,
        "state": "active",
        "start_date": null,
        "end_date": null,
        "profile_id": null,
        "timezone": "EST5EDT",
        "priority": 5,
        "last_modified": "2012-08-03 17:57:27",
        "buyer_type": "both",
        "max_revshare": null,
        "target_ecpm": null,
        "apply_cost_on_default": true,
        "demand_filter_action": "default",
        "lifetime_budget": null,
        "lifetime_budget_imps": null,
        "daily_budget": null,
        "daily_budget_imps": null,
        "filtered_advertisers": null,
        "filtered_line_items": null
      }
    ]
  }
}

支払いルールを更新する

$ cat payment_rule.json

{
    "payment-rule": {
    "apply_cost_on_default": true,
    "target_ecpm": 0.8,
    "max_revshare": 0.8,
    "priority": 10,
    "timezone": "EST5EDT",
    "revshare": 0.67,
    "cost_cpm": 40,
    "pricing_type": "dynamic",
    "description": "A payment rule for targeting USA users"
    }
}

$ curl -b cookies -X PUT -d @payment_rule.json
'https://api.appnexus.com/payment-rule?publisher_id=65103&id=98273'

{
    "payment-rule": {
    "apply_cost_on_default": true,
    "target_ecpm": 0.8,
    "max_revshare": 0.8,
    "buyer_type": "both",
    "last_modified": "2012-08-02 19:04:00",
    "priority": 10,
    "timezone": "EST5EDT",
    "profile_id": null,
    "end_date": null,
    "start_date": "2013-01-01 00:00:00",
    "state": "active",
    "revshare": 0.67,
    "cost_cpm": 40,
    "pricing_type": "dynamic",
    "description": "A payment rule for targeting USA users",
    "name": "USA",
    "code": "usa_payment_rule",
    "id": 98273
    }
}

支払いルールを削除する

$ curl -b cookies -X DELETE "https://api.appnexus.com/payment-rule?id=98384"

{
  "response": {
    "status": "OK"
  }
}

Last updated on 2026-08-18