次の方法で共有

支払ルール サービス

  • [アーティクル]

支払いルールは、ネットワークがマネージド パブリッシャーの 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
(支払ルール JSON)		 新しい支払いルールを追加します。
PUT https://api.appnexus.com/payment-rule?id=PAYMENT_RULE_ID&publisher_id=PUBLISHER_ID
(支払ルール 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" - 支払条件は、最小および最大 revshare とターゲット eCPM によって定義されます。

既定値: "revshare"
必須:POST
cost_cpm double が の"cpm"場合pricing_type、発行元が支払う CPM 料金です。

必須:POST が の場合pricing_typeは 。"cpm"
revshare double が の"revshare"場合pricing_type、これはパブリッシャーに支払われる割合です。 価格の種類が の場合、 "dynamic"これはパブリッシャーに支払われる最小再共有率で、最大値は で定義されます max_revshare。 パーセンテージは、0 ~ 1 (包括) の数値で表す必要があります。1 は 100% です。

必須:POST 、 が または の"revshare"場合pricing_type"dynamic"
profile_id int オプション profile_id を使用して、支払いルールを適用するタイミングを決定します。 プロファイルは在庫を対象とする一般的なルールのセットであり、特定の支払いルールは特定の在庫のスライスにのみ適用できます。 詳細については、 プロファイル サービス を参照してください。
priority int 必要に応じて、他の支払ルールに対してこのルールを適用する必要があるレベルを定義する優先順位を指定できます。

既定値: 5
timezone string 価格データの計算に使用されるタイムゾーン。 タイムゾーンの一覧については、「 API タイムゾーン」を参照してください。

既定値: 'EST5EDT'
last_modified timestamp この支払規則の最後の変更時刻。
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 が の"dynamic"場合pricing_type、パブリッシャーに支払われる最大再共有率です。

必須:POST が の場合pricing_typeは "dynamic"。
apply_cost_on_default ブール値 オークションの既定値が設定されている場合でも、発行元が支払われるかどうか。
demand_filter_action 列挙 、、または 配列に一覧表示されているfiltered_advertisersfiltered_line_items広告主、広告申込情報、キャンペーンを含めるか除外するかをfiltered_campaigns決定します。
使用可能な値:
- "include"
- "exclude"
- "default"

フィルター処理された広告主

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

フィルター処理された行項目

フィールド 種類 説明
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,
        "filtered_campaigns": 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,
        "filtered_campaigns": 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,
        "filtered_campaigns": 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,
        "filtered_campaigns": 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"
  }
}