メンバー契約サービス
注:
このサービスは現在、限られた一連のクライアントと Microsoft の従業員のみが利用できます。
フィールドで示される pricing_version 価格条件には、2 種類あります。
"2007.09.01": これらは"レガシ" の価格条件です。"2013.01.02": 新しい価格条件です。 2013 年以降にネゴシエートされたほとんどのクライアント 契約では、これらの新しい価格条件が使用されます。 新しい価格条件のアップショットは、クライアントがパートナーとプラットフォームの在庫の両方に対して購入側の料金を支払い、クライアントが入札者の購入者よりも Xandr プラットフォームの購入者に対して異なる売り手の再共有を支払うということです。
注:
このサービスは、フィールドが true に設定されている is_sales_ops Xandr 管理者ユーザーのみが使用できます。 フィールドは、データベースの is_sales_ops 直接更新でのみ true に設定できることに注意してください。 運用環境でフィールドを設定する is_sales_ops 有効な理由は次のとおりです。
- あなたは Sales Ops チームのメンバーであり、契約を作成して更新するのが通常の仕事です。
- あなたは、ジョブの契約を作成または更新するためにアクセスする必要があるエンジニア、製品マネージャー、またはテスト エンジニアです。
- キャサリン、ジェニファー・ヤン、アリソンが泣いているのを見たい。 (はい、実際には)。
- サービスに参加していて、砂の中で契約を作成または更新する必要がある場合は、サンド ユーザーに対して直接 DB 書き込みを要求する必要がありますが、運用環境では同じ機能を持たないことを理解する必要があります。
警告
呼び出し時に、特定の PUT コントラクトのみを含める場合、含まれていないコントラクトは 削除されます。 したがって、すべてのコントラクトを に含めるのが PUT最善です。
注:
コントラクトの更新と削除
- Sales Op では、進行中
notesのコントラクトの次のフィールド ( とend_date) のみを更新できます。 過去の契約では、 のみを更新notesできます。 将来の契約のために、彼女はすべてのフィールドを更新することができます。 - を に更新し、もう
"2007.09.01"一度 に更新pricing_typeするコントラクトpricing_type"2007.09.01"を"2013.01.02"複製すると、最小値は 0 に設定されることに注意してください。 - Sales Op では、将来の契約のみを削除できます。
REST API
| HTTP メソッド | Enpoints | 説明 |
|---|---|---|
GET |
https://api.appnexus.com/member-contract?member_id=MEMBER_ID |
特定のメンバーのすべてのコントラクトを表示する |
GET |
https://api.appnexus.com/member-contract(コントラクト JSON) |
特定のコントラクトを表示する |
POST |
https://api.appnexus.com/member-contract(コントラクト JSON) |
新しいコントラクトを追加する |
PUT |
https://api.appnexus.com/member-contract?id=CONTRACT_ID (コントラクト JSON) |
コントラクトを変更する |
DELETE |
https://api.appnexus.com/member-contract?id=CONTRACT_ID |
コントラクトを削除する |
GET |
https://api.appnexus.com/member-contract/meta |
フィルター処理および並べ替え可能なフィールドを確認する |
JSON フィールド
が (以下のようにマークされている) か "2013.01.02" (以下OLDNEWのようにマークされている) かにpricing_version"2007.09.01" 応じて、必須フィールドのセット間に大きな積集合があります。価格バージョン間で異なるフィールドのみが、[古い] 列または [新規] 列にそのようにマークされます。
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | コントラクトの ID。 [必要なオン]: PUT/DELETEクエリ文字列内の 。 |
member_id |
int | コントラクトが適用されるメンバーの ID。 |
last_activity |
timestamp | このコントラクト "object" の最終変更日。 |
start_date |
日付型 | 契約条件が開始される日付と時刻。 新しい契約は、将来、通常は 1 か月の最初の日に開始する必要があります。 必要なオン: POST |
end_date |
日付型 | 契約条件が終了する日付と時刻。 これは常に 1 か月の終わりに来る必要があります。 必要なオン: POST |
auction_revshare |
浮動小数点数 | このフィールドは使用されません。 |
auction_minimum_cpm |
浮動小数点数 | このフィールドは使用されません。 以前は、購入者がオークションサービス料金、オークションサービス控除、または直接クリア料金の支払いに同意した最小金額でした。 古いまたは新しい: OLD |
ad_serving_cpm |
浮動小数点数 | 保持されたインプレッションに対して課金されるマネージド広告配信料金 (保持、既定値、PSA を含む)。 これは、まだシステムに実装されていない販売者広告配信料金 CPM を表すものではありません。 |
auditing_fee_per_creative |
浮動小数点数 | クリエイティブごとの監査料金。 |
creative_size_minimum_bytes |
int | クリエイティブのサイズが大き過ぎと見なされる上記のサイズ。 メンバーには、オーバーサイズのクリエイティブを提供するためのクリエイティブ超過料金 (の creative_size_fee_per_gb値に基づく) が課金されます。 |
creative_size_fee_per_gb |
浮動小数点数 | を超える creative_size_minimum_bytesクリエイティブに対してギガバイトごとに課金される料金。 |
monthly_minimum_spend |
浮動小数点数 | このフィールドのラベルが正しく表示されません。 メンバーが 1 か月あたりの支払いにコミットする月単位の最小料金。 古いまたは新しい: OLD |
clearing_revshare |
浮動小数点数 | Xandr による決済収益から取り出されたフラット料金。 メンバーは、代わりにパーセンテージで課金することを選択できます (以下を参照)。clearing_revshare_pct |
auction_revshare_pct |
浮動小数点数 | 他のメンバーに在庫を販売するときに販売者に請求される割合。 警告: このフィールドは新しい auction_revshare_platform_pct フィールドに対応し、CPA/CPC 収益に関連する計算にデータ パイプラインによって使用されます。 何をしているかわからない場合は、このフィールドを削除しないでください。古いまたは新しい: OLD既定値: "0.00" |
clearing_revshare_pct |
浮動小数点数 | 消込控除の割合。 これは、メンバーが外部またはパートナーの販売者から購入した場合に課金されます。 |
auction_maximum_cpm |
浮動小数点数 | 購入者がインプレッション単位で支払うことに同意した最大金額。 このため、クライアントのオークション サービス料金と控除の合計は、その合計メディア コストに月末にオークションの再共有を掛けた金額と等しくない場合があります。 |
apply_min_cpm_to_clearing |
ブール値 | このフィールドは使用されません。 既定値: False |
auction_revshare_type |
列挙 | 購入者のオークション収益シェアの種類。 有効な値は次のとおりです。 - "deduction": 購入者には、オークション サービスの控除が請求されます。- "fee": 購入者には、オークションサービス料金が請求されます。警告: このフィールドは新しい auction_revshare_platform_inv_type フィールドに対応し、CPA/CPC 収益に関連する計算にデータ パイプラインによって使用されます。 何をしているかわからない場合は、このフィールドを削除しないでください。既定値: - "fee"古いまたは新しい: OLD |
pricing_version |
列挙 | このコントラクトに関連付けられている価格バージョン。 2013 年の価格条件では、顧客はパートナーとプラットフォームの両方のインベントリに対して購入側の料金を支払い、顧客は入札者の購入者とは異なる売り手 revshare を Xandr プラットフォーム購入者に支払います。 また、2007 年の価格条項が契約によって規定されている場合は、使用することも許容されることに注意してください。 有効な値は次のとおりです。 - "2007.09.01"- "2013.01.02"必須: POST |
seller_type |
列挙 | 販売者の種類。 有効な値は次のとおりです。 - "platform": メンバーは、Xandr が再販インプレッションから販売者控除を受けることを許可する署名付き契約を結びます。- "partner": メンバーは、Xandr が再販インプレッションから販売者控除を受け取ることを許可する署名付き契約を持っていないので、購入メンバーには代わりにオークションサービス手数料/控除が請求されます。既定値: "platform"必須: POST |
note |
string | 省略可能なメモ。 |
data_siphon_fee |
int | Xandr ログ レベルのデータ フィードを受信するための月額料金。 |
mapuid_fee |
浮動小数点数 | Xandr ユーザー ID マッピング サービスを使用するための月額料金。 既定値: "0.00" |
monthly_minimum_imps |
int | メンバーが 1 か月あたりのトランザクションにコミットするインプレッションの最小数。 |
waive_ad_serving_fees |
ブール値 | このフィールドは使用されません。 古いまたは新しい: OLD |
adx_auction_service_fee_pct |
浮動小数点数 | このフィールドは使用されません。 以前は、購入者のクライアントが Google アド マネージャーから在庫を購入したときに請求されるオークション サービス料金でした。 Google アド マネージャーは Xandr メンバー ( bidder_id の メンバー) であるため特別なケースですが、購入者の 2クライアントは Google アド マネージャーに直接支払いを行い、メディア コストに対して Xandr を支払いません。 |
direct_clear_fee_pct |
浮動小数点数 | 直接クリア料金の割合。 これは、メンバーが売り手と直接メディアのコストをクリアするアクティビティに使用されます。 |
contract_type |
列挙 | このフィールドは使用されなくなりました。 以前は、財務チームによって収益レポートに使用されていました。 許可される値は次のとおりです。 - "NIB": この頭字語は、「箱の中のネットワーク」と呼ばれる以前の製品オファリングを指します。- "XIB": この頭字語は、"ボックス内の Exchange" と呼ばれる以前の製品オファリングを指します。- "RTBX": この頭字語は、"RTB Exchange" と呼ばれる以前の製品オファリングを指します。- "MSFT": Microsoft コントラクト。- "External": ...- "Partner": ... |
creative_audit_fee |
浮動小数点数 | このフィールドは使用されません。 代わりに を使用 auditing_fee_per_creative します。 以前は、クリエイティブ監査手数料の合計を表しました。 |
creative_priority_fee_1 |
浮動小数点数 | このフィールドは使用されません。 これは、将来の開発のためのプレースホルダーです。 |
creative_priority_fee_2 |
浮動小数点数 | クリエイティブあたりの優先監査料金。 |
imptracker_cpm |
浮動小数点数 | サード パーティのインプレッションを記録するために課金される料金。 |
clicktracker_cpc |
浮動小数点数 | サード パーティのクリックを記録するために課金される料金。 |
auto_renewal_term |
int | 署名された契約にそのような用語が存在する場合は、メンバーの自動更新の用語。 現在、これは用語のプレースホルダーにすぎません。このフィールドには課金ロジックは関連付けされません。 |
seller_serving_cpm |
浮動小数点数 | インプレッションの再販ごとに請求される CPM ベースの料金。 現時点では、これは料金のプレースホルダーにすぎません。このフィールドには課金ロジックは関連付けされません。 |
monthly_spend_based_minimum |
浮動小数点数 | 特定の月に購入された買い手の総支出 (つまり、メディアのコスト) に基づく毎月の最小値。 現時点では、これはプレースホルダーにすぎません。このフィールドには課金ロジックは関連付けされません。 新規または古い: OLD |
seller_revshare_pct |
浮動小数点数 | 販売者控除率。 これは、メンバーが別のメンバーにインプレッションを販売するときに課金されます。 |
seller_revshare_minimum |
ブール値 | 販売者の再共有の最小値は、 (imps seen * seller auction request cpm) または (seller revshare) の大きい方を取ることによって計算されます。 既定値: false新規または古い: OLD |
secure_whitelabel_pixel_fee |
浮動小数点数 | Secure White Label Pixel サービスを使用するための月額料金。 現時点では、これは料金のプレースホルダーにすぎません。このフィールドには課金ロジックは関連付けされません。 |
monthly_minimum_requests |
int | Xandr によって記録されたと見なされるインプレッションの合計数に基づく、1 か月あたりの最小要求数。 現在、これは最小限のプレースホルダーにすぎません。このフィールドには課金ロジックは関連付けされません。 新規または古い: OLD |
managed_hosted_video_cpm |
浮動小数点数 | これは、将来の開発のためのプレースホルダーです。 |
cross_net_hosted_video_cpm |
浮動小数点数 | これは、将来の開発のためのプレースホルダーです。 |
seller_auction_request_cpm |
浮動小数点数 | 販売者が入札要求を送信するたびに支払う必要がある金額。 これは、落札がない場合や、入札がまったくない場合でも課金されます。 |
status |
列挙 | 読み取り専用。 有効な値は次のとおりです。 - "in_progress": 契約は現在有効です。- "in_past": 契約が終了しました。- "in_future": コントラクトは、将来開始するように設定されます。既定値: "in_future" |
member_name |
string | メンバーの名前。 |
member_is_billable |
ブール値 | メンバーが課金対象かどうか。 既定値: true |
member_note |
string | これは、カスタム契約条件やその他の請求書要件を記録するために、Finance および Sales Ops によって使用されます。 既定値: "" |
member_enable_budget_check |
ブール値 | このメンバーが意図しない過剰支出を防ぐために安全チェックを行っているかどうか。 既定値: true |
monthly_service_fee_minimum_1 |
浮動小数点数 | クライアントがコミットした最小月間支出。 この料金には、インプレッションとクリックトラッキングが含まれます。 古いまたは新しい: OLD |
monthly_service_fee_minimum_2 |
浮動小数点数 | クライアントがコミットした最小月間支出。 この料金には、インプレッションとクリックトラッキングは含まれません。 古いまたは新しい: OLD |
selling_enabled |
ブール値 | このメンバーがインベントリの販売を有効にしているかどうか。 これは、マネージド販売とクロスネットワーク販売の両方に適用されます。 既定値: true |
seller_console_buyer_revshare_pct |
浮動小数点数 | この割合は、Xandr プラットフォームで購入者に販売するときに販売者に課金されます。<Br 注: このフィールドの値は、レガシ フィールド seller_revshare_pctからコピーされます。必須: PUT 、新しいpricing_versionに更新する場合。古いまたは新しい: New |
seller_bidder_buyer_revshare_pct |
浮動小数点数 | この割合は、Xandr 以外の入札者に販売すると販売者に課金されます。 必須: PUT 、 を新しい pricing_versionに更新する場合。古いまたは新しい: New |
auction_revshare_partner_inv_pct |
浮動小数点数 | 他のメンバーから在庫を購入するときに、種類 "partner" の購入者に請求される割合。既定値: "0.00"古いまたは新しい: New |
auction_revshare_partner_inv_type |
string | で "auction_revshare_partner_inv_pct" 定義されている割合を使用してパートナー購入者に請求する方法。 有効な値は次のとおりです。- "deduction": 合意された割合は、買い手のオークション収益から直接減算されます。- "fee": この割合は、オークション後に料金として請求されます。注: と異なる auction_revshare_platform_inv_typeをauction_revshare_partner_inv_type設定することはできません。 どちらも または "deduction"である"fee"必要があります。既定値: "fee"古いまたは新しい: New |
auction_revshare_platform_inv_pct |
浮動小数点数 | 他のメンバーから在庫を購入するときに、種類 "platform" の購入者に請求される割合。注: このフィールドの値は、 フィールド auction_revshare_pctからコピーされます。既定値: "0.00"古いまたは新しい: New |
auction_revshare_platform_inv_type |
string | で定義 "auction_revshare_platform_inv_pct" されている割合を使用してプラットフォーム購入者に課金する方法。 有効な値は次のとおりです。- "deduction": 合意された割合は、買い手のオークション収益から直接減算されます。- "fee": この割合は、オークション後に料金として請求されます。注: - このフィールドの値は、 フィールド auction_revshare_typeからコピーされます。- と auction_revshare_partner_inv_type異なる をauction_revshare_platform_inv_type設定することはできません。 どちらも または "deduction"である"fee"必要があります。既定値: "fee"古いまたは新しい: New |
例
レガシ コントラクトを作成して表示する
$ cat update.json
{
"member-contract": {
"start_date": "2013-01-01 00:00:00",
"end_date": "2013-06-30 23:59:59",
"seller_type": "platform",
"pricing_version": "2007.09.01",
}
}
$ curl -b cookies -X POST -d @/tmp/legacy.json "http://68.67.148.153:16011/member-contract?member_id=1309"
{
"response": {
"": "",
"num_elements": "",
"start_element": "",
"id": 3794,
"count": "",
"status": "OK"
}
}
$ curl -b cookies "http://68.67.148.153:16011/member-contract?id=3794"
{
"response": {
"member-contract": {
"member_note": "",
"member_enable_budget_check": true,
"member_is_billable": true,
"member_name": "i8N6LZ6uN",
"auction_revshare_platform_inv_type": "fee",
"auction_revshare_platform_inv_pct": 0,
"auction_revshare_partner_inv_type": "fee",
"auction_revshare_partner_inv_pct": 0,
"seller_bidder_buyer_revshare_pct": "",
"seller_console_buyer_revshare_pct": "",
"selling_enabled": true,
"monthly_service_fee_minimum_2": "",
"monthly_service_fee_minimum_1": "",
"status": "in_future",
"seller_auction_request_cpm": "",
"cross_net_hosted_video_cpm": "",
"managed_hosted_video_cpm": "",
"monthly_minimum_requests": "",
"secure_whitelabel_pixel_fee": 0,
"seller_revshare_minimum": false,
"seller_revshare_pct": "",
"monthly_spend_based_minimum": "",
"seller_serving_cpm": 0,
"auto_renewal_term": "",
"clicktracker_cpc": "",
"imptracker_cpm": "",
"creative_priority_fee_2": 25,
"creative_priority_fee_1": 0,
"creative_audit_fee": 0,
"contract_type": "",
"direct_clear_fee_pct": "",
"adx_auction_service_fee_pct": "",
"waive_ad_serving_fees": false,
"monthly_minimum_imps": "",
"mapuid_fee": 0,
"data_siphon_fee": "",
"note": "",
"seller_type": "platform",
"pricing_version": "2007.09.01",
"auction_revshare_type": "fee",
"apply_min_cpm_to_clearing": false,
"auction_maximum_cpm": "",
"clearing_revshare_pct": "",
"auction_revshare_pct": "",
"clearing_revshare": "",
"monthly_minimum_spend": "",
"creative_size_fee_per_gb": "",
"creative_size_minimum_bytes": "",
"auditing_fee_per_creative": "",
"ad_serving_cpm": "",
"auction_minimum_cpm": "",
"auction_revshare": "",
"end_date": "2013-06-30 23:59:59",
"start_date": "2013-01-01 00:00:00",
"last_activity": "2012-12-20 16:03:38",
"member_id": 1309,
"id": 3794
},
"num_elements": "",
"start_element": "",
"count": 1,
"status": "OK"
}
}
現在の を使用してコントラクトを作成および表示する pricing_version
$ cat update.json
{
"member-contract": {
"start_date": "2013-01-01 00:00:00",
"end_date": "2013-06-30 23:59:59",
"seller_type": "platform",
"pricing_version": "2013.01.02",
"auction_revshare_partner_inv_type": "fee",
"auction_revshare_platform_inv_type": "fee"
}
}
$ curl -b cookies -c cookies -X POST -d @update.json "https://api.appnexus.com/member-contract?member_id=1309"
{"response":{"status":"OK","count":null,"id":7543,"start_element":null,"num_elements":null,"":null,}}
$ curl -b cookies "http://68.67.148.153:16011/member-contract?member_id=4"
{
"response": {
"status": "OK",
"count": 1,
"start_element": null,
"num_elements": null,
"member-contracts": [
{
"id": 7543,
"member_id": 4,
"last_activity": "2012-12-07 18:30:12",
"start_date": "2013-01-01 00:00:00",
"end_date": "2013-06-30 23:59:59",
"auction_revshare": null,
"ad_serving_cpm": null,
"auditing_fee_per_creative": null,
"creative_size_minimum_bytes": null,
"creative_size_fee_per_gb": null,
"clearing_revshare": null,
"clearing_revshare_pct": null,
"auction_maximum_cpm": null,
"apply_min_cpm_to_clearing": false,
"pricing_version": "2013.01.02",
"seller_type": "platform",
"note": null,
"data_siphon_fee": null,
"mapuid_fee": "0.00",
"waive_ad_serving_fees": false,
"adx_auction_service_fee_pct": null,
"direct_clear_fee_pct": null,
"contract_type": null,
"creative_audit_fee": "0.00",
"creative_priority_fee_1": "0.00",
"creative_priority_fee_2": "25.00",
"imptracker_cpm": null,
"clicktracker_cpc": null,
"auto_renewal_term": null,
"seller_serving_cpm": "0.0000",
"secure_whitelabel_pixel_fee": "0.00",
"managed_hosted_video_cpm": null,
"cross_net_hosted_video_cpm": null,
"seller_auction_request_cpm": null,
"status": "in_future",
"selling_enabled": true,
"seller_console_buyer_revshare_pct": null,
"seller_bidder_buyer_revshare_pct": null,
"auction_revshare_partner_inv_pct": "0.00",
"auction_revshare_partner_inv_type": "fee",
"auction_revshare_platform_inv_pct": "0.00",
"auction_revshare_platform_inv_type": "fee",
"member_name": "6Ax3NT0ST",
"member_is_billable": true,
"member_enable_budget_check": true
}
]
}
}