パートナー料金サービス
注:
パートナー手数料は、 拡張品目 (ALI) のブローカー手数料の強化と代替です。
サード パーティのコスト (発行元以外の関係者に対するコスト) の予算の一部を予約する必要がある場合は、パートナー料金サービスでこの情報を定義できます。 料金は、CPM、コストシェア、または収益シェアベースで追跡でき、必要に応じて複数の広告主や広告申込情報に適用できます。 1 つの広告主または広告申込情報に複数の料金を適用できます。
予算を設定する必要がある場合がある一般的な料金は次のとおりです。
- 広告 配信料 と クリエイティブ ホスティング料金。広告申込情報のクリエイティブアセットの配信に対して課金されます。
- Data Marketplace の一部として Xandr によってクリアされないデータ料金。
- 入札後 のレポート料金 - たとえば、ピクセルを使用してインプレッションが配信される場所を追跡し、ブランドの安全基準に違反したトランザクションの数をさかのぼって監査します。
- 他の広告技術パートナーとのレベニューシェア契約。
- 管理されたサービス料金やコンサルティング料金など、広告主への仲介によって請求される増分料金。
REST API
HTTP メソッド | エンドポイント | 説明 |
---|---|---|
GET |
https://api.appnexus.com/partner-fee?advertiser_id=ADVERTISER_ID |
広告主のすべてのパートナー料金を表示します。 |
GET |
https://api.appnexus.com/partner-fee?id=PARTNER_FEE_ID |
特定のパートナー料金を表示します。 |
POST |
https://api.appnexus.com/partner-fee |
新しいパートナー料金を作成します。 |
PUT |
https://api.appnexus.com/partner-fee?id=PARTNER_FEE_ID |
パートナー料金を変更します。 |
DELETE |
https://api.appnexus.com/partner-fee?id=PARTNER_FEE_ID |
パートナー料金を削除します。 注: 削除できるのは、明細に適用されていない料金のみです。 |
JSON フィールド
フィールド | 種類 | 説明 |
---|---|---|
advertisers |
マッピング | この料金が適用される広告主。 このフィールドは、次の形式の オブジェクトの配列として渡す必要があります。[{'id':ADVERTISER_ID_1},{'id'}:ADVERTISER_ID_2}] |
apply_to_deals |
bool | この料金が取引に適用されるかどうかを決定します。 必須: POST 既定値: true |
apply_to_managed |
bool | この料金がマネージド インベントリに適用されるかどうかを決定します。 必須: POST 既定値: true |
apply_to_rtb |
bool | この料金が RTB インベントリに適用されるかどうかを決定します。 必須: POST 既定値: true |
available_for_all_advertisers |
bool | の場合 true 、この料金は、このメンバーのすべての広告主に適用される資格があります。 これは、 メンバー レベルのアクセス権を持つユーザーのみが使用できます。既定値: false |
description |
テキスト | オプション。 料金のユーザー指定の説明。 |
currency |
char(3) | 料金が計算される通貨。 - が cpm の場合 partner_fee_payment_type_id は、値が必要です。- が の場合 partner_fee_payment_type_id 、 revshare このフィールドは である null 必要があります。通貨サービスを使用して、使用可能な通貨の一覧を表示します。 |
id |
int | 料金の一意識別子。 必須: PUT およびDELETE 既定値: 自動生成された数値。 |
name |
varchar(255) | 料金名。 必須: POST |
partner_fee_payment_type_id |
int | この料金の支払いタイプを決定します。 - "1" cpm の場合。 cpm が選択されている場合は、通貨を使用して通貨を指定する必要があります。- "2" 収益の共有のために。必須: POST |
partner_fee_basis_id |
int | パーセンテージ料金の派生元となる基準を決定します。 - "1" ネット メディア コストの場合。- "2" 総メディア コスト ( BASC を含むメディア コスト)。- "3" ネット メディア コスト (BASC なしのメディア コスト) + データ コストの場合。- "4" 総メディア コスト (BASC を含むメディア コスト) + データ コストの場合。- "5" 収益に対する。CPM 手数料は、(収益) にのみ "5" 設定できます。必須: POST |
partner_fee_type_id |
int | 料金の種類を定義します。 サポートされている値は次のとおりです。 - "1" 広告配信用- "2" アルゴリズムの場合- "3" データの場合- "4" レポート用- "5" サービス用- "6" テクノロジ用- "7" 視認性を高める- "8" その他の必須: POST |
partner_fee_vendor_id |
int | 料金を請求するベンダーの ID。 サポートされている値は次のとおりです。 - "1" Adloox の場合- "2" ComScore の場合- "3" DoubleClick の場合- "4" DoubleVerify の場合- "5" Evidon の場合- "6" Flashtalking の場合- "7" ゴーストリー用- "8" 溝入れ用Ads- "9" 整数広告科学 (IAS) 用- "10" MOAT 用- "11" 第 9 10 進数の場合- "12" Sizmek 用- "13" TrustArc の場合- "14" カスタム ベンダー 1 の場合- "15" カスタム ベンダー 2 の場合- "16" カスタム ベンダー 3 用- "17" カスタム ベンダー 4 の場合- "18" カスタム ベンダー 5 の場合カスタム ベンダーは、レポートにカスタム ベンダー 1、カスタム ベンダー 2 などとして表示されます。 簡単に識別できるように、手数料の名前フィールドにパートナー名を含めてお勧めします。 必須: POST |
required |
bool | の場合 true 、この料金は対象となる広告主のすべての新しい広告申込情報に必要となり、適用されます。 既存の明細に遡って自動的に適用されることはありません。注: が true の場合required 、明細から手数料を削除することはできません。 最初に を にfalse 設定required してから、明細から料金を削除する必要があります。既定値: false |
value |
decimal(15,5) | 課金される料金。 - 支払いの種類が の場合、 cpm この値は定義 currency された になります。- 支払の種類が収益の共有の場合、値は と 1 の間0 の端数である必要があります。 たとえば、10% の revshare 手数料は 0.1 で指定されます。必須: POST |
例
パートナー料金を作成する
$ cat partner-fee.json
{
"partner_fee": {
"name" : "Test1",
"apply_to_managed" : true,
"apply_to_rtb" : true,
"apply_to_deals" : true,
"value" : .5,
"partner_fee_vendor_id" : 3,
"partner_fee_payment_type_id" : 2,
"partner_fee_basis_id" : 2,
"partner_fee_type_id" : 1,
"required" : true,
"advertisers" : [
{
"id" : 1
}
]
}
}
$curl -b cookie -X POST -d @partner-fee.json "https://api.appnexus.com/partner-fee"
{
"response": {
"status" : "OK",
"id": 4401
}
}
パートナー料金の詳細を表示する
$ curl -b cookie "https://api.appnexus.com/partner-fee?id=4401"
{
"response": {
"status": "OK",
"partner_fees": [
{
"name" : "Test1",
"apply_to_managed" : true,
"apply_to_rtb" : true,
"apply_to_deals" : true,
"currency" : null,
"value" : .5,
"partner_fee_vendor_id" : 3,
"partner_fee_payment_type_id" : 2,
"partner_fee_basis_id" : 2,
"partner_fee_type_id" : 1,
"required" : true,
"advertisers" : [
{
"id" : 1
}
]
}
]
}
}
管理されたインベントリの収益共有パートナーの料金を表示する
$ curl -b cookie "https://api.appnexus.com/partner-fee?apply_to_managed=true&partner_fee_payment_type_id=2"
{
"response": {
"count": "2",
"partner_fees": [
{
"id" : 4401,
"name" : "Test1",
"apply_to_managed" : true,
"apply_to_rtb" : true,
"apply_to_deals" : true,
"value" : .1,
"partner_fee_vendor_id" : 3,
"partner_fee_payment_type_id" : 2,
"partner_fee_basis_id" : 2,
"partner_fee_type_id" : 1,
"required" : true,
"available_for_all_advertisers": true,
"advertisers" : [
]
},
{
"id" : 4402,
"name" : "Test2",
"apply_to_managed" : true,
"apply_to_rtb" : false,
"apply_to_deals" : false,
"currency" : "null",
"value" : .5,
"partner_fee_vendor_id" : 14,
"partner_fee_payment_type_id" : 2,
"partner_fee_basis_id" : 2,
"partner_fee_type_id" : 6,
"required" : false,
"available_for_all_advertiser" : true,
"advertisers" : [
]
}
]
}
}
パートナー料金の支払いタイプを変更する
$ cat partner-fee.json
{
"partner_fee": {
"currency" : USD,
"value" : 1.2,
"partner_fee_payment_type_id" : 1,
"partner_fee_basis_id": 5
}
}
$ curl -b cookie -X PUT -d @partner-fee.json "https://api.appnexus.com/partner-fee?id=4401"
{
"response": {
"status" : "OK",
"id": 4401
}
}
パートナー料金を明細に適用する
$ cat LI-update.json
{
"line-item": {
"partner_fees": [
{
"id": 4401
},
{
"id": 4402
}
]
}
}
$ curl -b cookie -X PUT -d @LI-update.json "https://api.appnexus.com/line-item?id=2345432"
{
"response": {
"status" : "OK",
"id": 2345432
}
}
明細から手数料を削除する
$ curl -b cookie -x GET "https://api.appnexus.com/line-item?id=1234"
{
"line-item": {
...,
"partner_fees": [
{
"id": 1
},
{
"id": 2
},
{
"id": 3
}
],
...
}
}
$ cat LI-update.json
{
"line-item": {
"partner_fees": [
{
"id": 1
},
{
"id": 3
}
]
}
}
$ curl -b cookie -X PUT "https://api.appnexus.com/line-item?id=1234"
{
"line-item": {
...,
"partner_fees": [
{
"id": 1
},
{
"id": 3
}
],
...
}
}
$ curl -b cookie -x GET "https://api.appnexus.com/line-item?id=1234"
{
"line-item": {
...,
"partner_fees": [
{
"id": 1
},
{
"id": 3
}
],
...
}
}
注:
が true
の場合required
、明細から手数料を削除することはできません。 最初に を にfalse
設定required
してから、明細から料金を削除する必要があります。
広告主から料金を削除する
$ curl -b cookie -x GET "https://api.appnexus.com/advertiser?id=5678"
{
"advertiser": {
...,
"partner_fees": [
{
"id": 1
},
{
"id": 2
},
{
"id": 3
}
],
...
}
}
$ cat partner-fee-update.json
{
"partner-fee": {
"advertisers": [
{
"id": 5677
},
{
"id": 5679
}
]
}
}
$ curl -b cookie -X PUT -d @partner-fee-update.json "https://api.appnexus.com/partner-fee?id=1"
{
"response": {
"status" : "OK",
"id": 1
}
}
広告主の広告申込情報に現在料金が適用されている場合、広告主から料金を削除することはできません。 最初に広告申込情報から料金を削除してから、広告主から料金を削除する必要があります。