調整サービス

[アーティクル]
01/16/2025

注:

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

これらのドキュメント (および関連する機能) は、クライアントのみを選択するために表示されます。アクセス権が必要であることを確認していない限り、これらのドキュメントへのリンクを送信したり、この機能をクライアントにメンションしたりしないでください。

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

調整の種類

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

広告主の調整

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

パブリッシャーの調整

"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	既定値: 既定のメンバーのタイムゾーン調整が行われるタイムゾーン。調整は、指定されたタイムゾーンの日の最初の時間に行われます。許容されるタイムゾーン値の一覧については、「 API タイムゾーン」を参照してください。
`user_id`	int	調整を行ったユーザーの ID。

広告主の調整

フィールド	種類	説明
`booked_revenue`	double	特定の調整期間 (`end_date`に`start_date`) に広告主がネットワークに支払った新しい予約収益。 `null`に設定するか空白のままにした場合、予約収益は変更されません。
`clicks`	int	調整期間のクリック数の省略可能な値。クリック単価型アイテムのクリック数を変更した場合、明細の予約収益には影響しないことに注意してください。 `null`に設定するか、空白のままにした場合、クリックは変更されません。
`delete_overlapping_adjustments`	ブール値	既定値: `true`( `adjustment_type` が `"advertiser_revenue"` `true`場合、調整が適用される前に、現在の調整の開始日/終了日内の同じ行項目に対する以前の調整が削除されます。
`imps`	int	調整期間中のインプレッション数の省略可能な値。 CPM 明細の imp の数を変更した場合、明細の予約収益には影響しないことに注意してください。広告主からネットワークに支払いを変更するには、 `booked_revenue` を個別に設定する必要があります。 `null`に設定するか、空白のままにした場合、imps は変更されません。
`line_item_id`	int	必須:`adjustment_type`が`"advertiser_revenue"`または`"advertiser_credit"`の場合は、`POST`。調整する行項目の ID。
`post_click_convs`	int	調整期間中のクリック後のコンバージョン数の省略可能な値。コンバージョン単価型広告申込情報のクリック後コンバージョンの数を変更した場合、広告申込情報の予約収益には影響しません。 `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`	お金	特定の調整期間 (`end_date`に`start_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	支払いルール	インプレッション	予約収益	メディアコスト
$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

注:

インプレッション数、クリック数、コンバージョン数に変更を加える行を追加します。この行は、Publisher でグループ化するときにネットワークレポートに表示されます。ただし、この行は広告主が実行するレポートには表示されません。これはパブリッシャーによってグループ化できないためです。
メディアコストは、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	メディアの種類	支払いの種類	メディアコスト	Imps
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 に、インプレッションを 3500 に調整するには、次の 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	メディアの種類	支払いの種類	メディアコスト	Imps
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
            },
            ...
        ]
    }
}

次の方法で共有

調整サービス

調整の種類

広告主の調整

パブリッシャーの調整

調整状態

REST API

JSON フィールド

全般

広告主の調整

パブリッシャーの調整

例

パブリッシャーへの属性を使用して広告主の収益とインプレッション数を調整する

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

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

調整の取り消し

すべての調整の表示

その他のリソース

次の方法で共有

調整サービス

調整の種類

広告主の調整

パブリッシャーの調整

調整状態

REST API

JSON フィールド

全般

広告主の調整

パブリッシャーの調整

例

パブリッシャーへの属性を使用して広告主の収益とインプレッション数を調整する

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

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

調整の取り消し

すべての調整の表示

その他のリソース

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