調整サービス

注:

このサービスは現在、一部のクライアントと Microsoft の従業員のみが利用できます。

これらのドキュメント (および関連する機能) は、一部のクライアントにのみ表示されます。クライアントにアクセスできることが確認されている場合を除き、これらのドキュメントへのリンクを送信したり、この機能についてクライアントにメンションしたりしないでください。

調整サービスは、レポートで予約収益とメディアコストの値を変更するために使用されます。

調整の種類

現在、次の 3 種類のレポート調整を実行できます。

広告主の調整

advertiser_revenue - この調整タイプでは、広告主のレポートに表示される予約収益やインプレッション、クリック、コンバージョンが変更 され、 収益シェアパブリッシャーに対するメディア費用の支払いが調整されます。 Revshare パブリッシャーへの支払いの調整方法の詳細については、以下の最初の例を参照してください。
advertiser_credit - この調整タイプでは、広告主のレポートに表示される予約収益やインプレッション数、クリック数、コンバージョン数が変更されます。 revshare パブリッシャーに対するメディア費用の支払いは調整 されません 。

パブリッシャーの調整

"publisher" - この調整タイプは、パブリッシャーのレポートに表示されるメディア費用やインプレッション、クリック、コンバージョンを変更します。

調整の状態

調整はレポートに非同期で適用され、作成時から数時間表示されます。調整サービスは、調整の現在のステータスをチェックするためのインターフェースを提供します。

注:

調整を処理するには、関連付けられているオブジェクトがアクティブである必要があります。たとえば、明細行品目が非アクティブの場合、関連付けられている調整ジョブは実行されません。

状態には、次のいずれかの値を指定できます。

状態	説明
`new`	調整がシステムに入力されました。
`pending`	調整は処理のためにピックアップされました。
`processing`	調整処理中です。
`propagating`	調整は完了し、レポートキャッシュに伝達中です。
`completed`	調整が完了したため、レポートで参照できるようになります。
`failed`	調整の処理中にエラーが発生しました。
`cancelled`	ユーザーが調整を取り消しました。

REST API

HTTP メソッド	エンドポイント	説明
`POST`	`https://api.appnexus.com/adjustment`	新しい調整を追加するには
`PUT`	`https://api.appnexus.com/adjustment?id=ADJUSTMENT_ID`	既存の調整を変更またはキャンセルするには:
`GET`	`https://api.appnexus.com/adjustment`	すべての調整を表示するには:
`GET`	`https://api.appnexus.com/adjustment?advertiser_id=ADVERTISER_ID`	広告主のすべての調整を表示するには:
`GET`	`https://api.appnexus.com/adjustment?id=ADJUSTMENT_ID`	特定の調整を表示するには:
`GET`	`https://api.appnexus.com/adjustment?state=new,processing,propagating,pending,completed,failed,cancelled`	特定の状態のすべての調整を表示するには:
`GET`	`https://api.appnexus.com/adjustment?like_start_date=START_DATE&like_end_date=END_DATE`	指定した期間内のすべての調整を表示するには:

JSON フィールド

全般

フィールド	種類	説明
`adjustment_type`	列挙	既定値: `"advertiser_revenue"` 調整の種類。使用可能な値: - `"advertiser_revenue"` - 広告主からネットワークへの収益額を調整し、レブシェアの支払いをパブリッシャーに再帰属させます。 - `"advertiser_credit"` - 広告主からの収益額のみを変更しますが、パブリッシャーの支払いは再帰属しません。 - `"publisher"` - ネットワークがパブリッシャーに支払うメディアコストを調整します。
`created_on`	日付型	調整要求が作成された日時。
`end_date`	日付型	既定値: `Yesterday` 調整期間の終了日。これは少なくとも 24 時間前である必要があります。
`id`	int	既定値: 自動インクリメント数 (例: 123) 必須:`PUT`、クエリ文字列内。調整の一意識別子。
`last_modified`	日付型	調整要求が最後に変更された日時。
`member_id`	int	調整を所有するメンバーの ID。
`notes`	string	この調整に関連付けるオプションのメモ。
`start_date`	日付型	必須:`POST` 調整の開始日。調整は、 `start_date` と `end_date` によって定義される時間範囲にわたって均等に適用されます。調整の実行を試みた時点から 90 日以内に `start_date` がある場合にのみ、調整が処理の対象となります。
`status`	列挙	既定値: `"new"` 調整の現在の処理状態。使用可能な値: - `"new"` - `"processing"` - `"propagating"` - `"pending"` - `"completed"` - `"failed"` - `"cancelled"`.
`timezone`	string	既定値: 既定のメンバーのタイムゾーン調整が行われるタイムゾーン。特定のタイムゾーンの日の最初の 1 時間に調整が行われます。受け入れ可能なタイムゾーン値の一覧については、「 API タイムゾーン」を参照してください。
`user_id`	int	調整を行ったユーザーの ID。

広告主の調整

フィールド	種類	説明
`booked_revenue`	double	指定された調整期間 (`start_date` から `end_date`) にわたって広告主がネットワークに支払った新しい予約収益。 `null` に設定するか、空白のままにすると、予約収益は変更されません。
`clicks`	int	調整期間内のクリック数の省略可能な値。ただし、CPC 広告申込情報のクリック数を変更しても、その広告申込情報の予約収益には影響しません。 `null` に設定するか空白のままにすると、クリック数は変更されません。
`delete_overlapping_adjustments`	ブール値	既定値: `true` ( `adjustment_type` が `"advertiser_revenue"` `true`場合、現在の調整の開始日/終了日内の同じ品目に対する以前の調整は、調整が適用される前に削除されます。
`imps`	int	調整期間内のインプレッション数のオプションの値。 CPM ラインアイテムの imp 数を変更しても、そのラインアイテムの予約収益には影響しません。広告主からネットワークへのお支払いを変更するには、 `booked_revenue` 別途設定する必要があります。 `null`に設定するか空白のままにすると、インプは変更されません。
`line_item_id`	int	必須:`adjustment_type`が`"advertiser_revenue"`または`"advertiser_credit"`の場合は`POST`。調整する品目の ID。
`post_click_convs`	int	調整期間中のポストクリックコンバージョン数のオプションの値。 CPA ラインアイテムのポストクリックコンバージョン数を変更しても、そのラインアイテムの予約収益には影響しません。 `null` に設定するか空白のままにすると、クリック後のコンバージョンは変更されません。
`post_view_convs`	int	調整期間中のポストビューのコンバージョン数のオプションの値。 CPA ラインアイテムのポストビューコンバージョン数を変更しても、ラインアイテムの予約収益には影響しません。 `null` に設定するか空白のままにすると、ビュー後のコンバージョンは変更されません。

パブリッシャーの調整

フィールド	種類	説明
`clicks`	int	調整期間内のクリック数の省略可能な値。
`country`	string	インプレッションデータを調整する国または地域の 2 文字コード。
`height`	int	データを調整する配置の高さ。
`imp_types`	string	既定値: `"kept"` データを調整するインプレッションの種類。使用可能な値: - `"default"`: キャンペーンの入札がなかったか、対象となる他のクリエイティブがなかったために、提供された既定のクリエイティブ。 - `"kept"`: 管理対象広告主の 1 つがクリエイティブを配信しました。 - `"resold"`: インプレッションがサードパーティの購入者に販売されました。
`imps`	int	調整期間内のインプレッション数のオプションの値。
`media_cost`	金銭	特定の調整期間 (`start_date` から `end_date`) にわたってネットワークがパブリッシャーに支払う新しいメディアコスト。 `null` に設定するか、空白のままにすると、メディアコストは変更されません。
`media_type`	object	データを調整するメディアの種類。使用可能な値: - `"banner"` - `"pop"` - `"text"` - `"interstitial"` - `"expandable"` - `"video"`.
`placement_id`	int	必須:`adjustment_type`が`"publisher"`の場合は`POST`。データを調整するプレースメントの ID。
`post_click_convs`	int	調整期間中のポストクリックコンバージョン数のオプションの値。
`post_view_convs`	int	調整期間中のポストビューのコンバージョン数のオプションの値。
`publisher_id`	int	データを調整する発行元の ID。
`site_id`	int	データを調整するサイトの ID。
`width`	int	データを調整する配置の幅。

例

パブリッシャーへの属性による広告主の収益とインプレッション数の調整

"advertiser_revenue"調整の場合、予約収益調整をレブシェアパブリッシャーに割り当てるには、パブリッシャーが提供したインプレッション数に比例して行われます。

注:

広告主は 1 CPM の広告申込情報を実施しています。
Xandr は、この明細行品目で 10,000 回のインプレッションと $10 の予約収益を記録し、3 つのパブリッシャーでサービスを受け取りました。
広告主が 9,000 回のインプレッションを記録し、9 ドルの支払いを申し出た。

調整前のレポート

広告主ライン項目	Publisher	支払ルール	インプレッション	Booked Revenue	メディアコスト
$1 CPM ライン項目	Publisher 1	60% Revshare 支払いルール	1,000	$1.00	$0.60
$1 CPM ライン項目	Publisher 2	60% Revshare 支払いルール	5,000	$5.00	$3.00
$1 CPM ライン項目	Publisher 3	$0.50 CPM 支払いルール	1,000	$1.00	$0.50
$1 CPM ライン項目	Publisher 4	70% Revshare 支払いルール	3,000	$3.00	$2.10

ラインアイテムの収益を $9 に、インプレッションを 9,000 に下げるには、次の JSON 形式のファイルを作成して POST します。

$ cat adjustment
  
{
   "adjustment": {
      "adjustment_type": "advertiser_revenue",
      "line_item_id": 4243,
      "booked_revenue": 9.00,
      "imps": 9000
      "start_date": "2011-01-01 00:00:00",
      "end_date": "2011-01-01 23:59:59",
      "note": "This is a note..."
   }
}
  
$ curl -b cookies -c cookies -X POST -d @adjustment 'https://api.appnexus.com/adjustment'

調整後のレポート

広告主ライン項目	Publisher	支払ルール	調整済みインプレッション数	調整済み予約収益	調整済みメディアコスト
$1 CPM ライン項目	Publisher 1	60% Revshare 支払いルール	1,000	$0.90	$0.54
$1 CPM ライン項目	Publisher 2	60% Revshare 支払いルール	5,000	$4.50	$2.70
$1 CPM ライン項目	Publisher 2	$0.50 CPM 支払いルール	1,000	$0.90	$0.50
$1 CPM ライン項目	Publisher 3	70% Revshare 支払いルール	3,000	$2.70	$1.89
$1 CPM ライン項目	-	-	-1,000	$0.00	$0.00

注:

インプレッション数、クリック数、またはコンバージョン数の変更のために追加の行を挿入します。この行は、発行元別にグループ化すると、ネットワークレポートに表示されます。ただし、広告主は発行元別にグループ化できないため、この行は広告主が実行するレポートには表示されません。
メディアコストは、CPM ベースで支払われるパブリッシャーや、他のプラットフォームメンバーへの支払いに対して調整 されません 。

広告収益とインプレッション数、クリック数、コンバージョン数を、パブリッシャーに帰属させることなく調整する

$ cat adjustment
  
{
   "adjustment": {
      "adjustment_type": "advertiser_credit",
      "line_item_id": 4321,
      "booked_revenue": 100.00,
      "imps": 10000,
      "clicks": 10,
      "conversions": 1,
      "start_date": "2011-01-01 00:00:00",
      "end_date": "2011-01-01 23:59:59",
      "note": "This is a note..."
   }
}

クリエイティブで配信されるプレースメントのパブリッシャーメディアコストとインプレッション数の調整

調整前のレポート

Publisher	サイト	Placement	支払ルール	国/地域設定	Size	Media Type	支払いの種類	メディアコスト	インプ
NY Post	Business	ホームページ	$1 CPM	US	728x90	バナー	オーナー CPM	1	1000
NY Post	Business	ホームページ	$1 CPM	CA	728x90	バナー	オーナー CPM	0.5	500
NY Post	Business	ホームページポップ	$10 CPM	US	0x0	ポップアップ	オーナー CPM	10	1000
NY Post	Business	ホームページ	$2 CPM	US	300x250	バナー	オーナー CPM	2	1000
NY Post	Business	ホームページ	60% Revshare	GB	300x250	バナー	所有者 Revshare	1.25	500

メディアコストを $10 に、インプレッションを 3,500 ドルに調整するには、次の JSON 形式ファイルを作成して POST します。

$ cat adjustment
  
{
   "adjustment": {
      "adjustment_type": "publisher",
      "publisher_id": 23,
      "media_cost": 10.00,
      "imps": 3500,
      "start_date": "2011-01-01 00:00:00",
      "end_date": "2011-01-01 23:59:59",
      "note": "This is a note...",
      "imp_types": [
         "resold"
      ]
   }
}
  
$ curl -b cookies -c cookies -X POST -d @adjustment 'https://api.appnexus.com/adjustment'

調整後のレポート

調整 ID	Publisher	サイト	Placement	支払ルール	国/地域設定	Size	Media Type	支払いの種類	メディアコスト	インプ
0	NY Post	Business	ホームページ	$1 CPM	US	728x90	バナー	オーナー CPM	1	1000
1	NY Post	Business	ホームページ	$1 CPM	US	728x90	バナー	オーナー CPM	-0.322033898305085	-125
0	NY Post	Business	ホームページ	$1 CPM	CA	728x90	バナー	オーナー CPM	0.5	500
1	NY Post	Business	ホームページ	$1 CPM	CA	728x90	バナー	オーナー CPM	-0.161016949152542	-62.5
0	NY Post	Business	ホームページポップ	$10 CPM	US	0x0	ポップアップ	オーナー CPM	10	1000
1	NY Post	Business	ホームページポップ	$10 CPM	US	0x0	ポップアップ	オーナー CPM	3.22033898305085	-125
0	NY Post	Business	ホームページ	$2 CPM	US	300x250	バナー	オーナー CPM	2	1000
1	NY Post	Business	ホームページ	$2 CPM	US	300x250	バナー	オーナー CPM	-0.64406779661017	-125
0	NY Post	Business	ホームページ	60% Revshare	GB	300x250	バナー	所有者 Revshare	1.25	500
1	NY Post	Business	ホームページ	60% Revshare	GB	300x250	バナー	所有者 Revshare	-0.402542372881356	-62.5

調整のキャンセル

状態が "new" または "pending" の調整を取り消すことができます。

$ cat modify_adjustment
  
{
   "adjustment": {
      "id": 5,
      "status": "cancelled"
   }
}
  
$ curl -b cookies -c cookies -X PUT -d @modify_adjustment 'https://api.appnexus.com/adjustment'

すべての調整を表示

$ curl -b cookies -c cookies 'https://api.appnexus.com/adjustment'
  
{
    "response": {
        "status": "OK",
        "count": 2,
        "start_element": 0,
        "num_elements": 100,
        "adjustments": [
            {
                "id": 5,
                "member_id": 294,
                "line_item_id": 2725,
                "timezone": "EST5EDT",
                "start_date": "2011-03-02 00:00:00",
                "end_date": "2011-03-04 23:59:59",
                "status": "completed",
                "adjustment_type": "advertiser_revenue",
                "booked_revenue": 100,
                "imps": 2000,
                "clicks": null,
                "post_click_convs": null,
                "post_view_convs": null,
                "notes": null,
                "created_on": "0000-00-00 00:00:00",
                "last_modified": "2011-03-15 17:56:40",
                "publisher_id": null,
                "site_id": null,
                "placement_id": null,
                "payment_rule_id": null,
                "width": null,
                "height": null,
                "country": null,
                "imp_type_kept": false,
                "imp_type_resold": false,
                "imp_type_default": false,
                "media_cost": null,
                "delete_overlapping_adjustments": false,
                "media_type": null,
                "user": null,
                "imp_types": null
            },
            {
                "id": 6,
                "member_id": 294,
                "line_item_id": 2725,
                "timezone": "EST5EDT",
                "start_date": "2011-03-02 00:00:00",
                "end_date": "2011-03-04 23:59:59",
                "status": "completed",
                "adjustment_type": "advertiser_revenue",
                "booked_revenue": 200,
                "imps": 1000,
                "clicks": null,
                "post_click_convs": null,
                "post_view_convs": null,
                "notes": null,
                "created_on": "0000-00-00 00:00:00",
                "last_modified": "2011-03-16 22:56:29",
                "publisher_id": null,
                "site_id": null,
                "placement_id": null,
                "payment_rule_id": null,
                "width": null,
                "height": null,
                "country": null,
                "imp_type_kept": false,
                "imp_type_resold": false,
                "imp_type_default": false,
                "media_cost": null,
                "delete_overlapping_adjustments": false,
                "media_type": null,
                "user": null,
                "imp_types": null
            },
            ...
        ]
    }
}

Last updated on 2026-08-18

調整サービス

調整の種類

広告主の調整

パブリッシャーの調整

調整の状態

REST API

JSON フィールド

全般

広告主の調整

パブリッシャーの調整

例

パブリッシャーへの属性による広告主の収益とインプレッション数の調整

広告収益とインプレッション数、クリック数、コンバージョン数を、パブリッシャーに帰属させることなく調整する

クリエイティブで配信されるプレースメントのパブリッシャー メディア コストとインプレッション数の調整

調整のキャンセル

すべての調整を表示

その他のリソース

クリエイティブで配信されるプレースメントのパブリッシャーメディアコストとインプレッション数の調整