Adjustment service

Adjustment types

You can currently make three types of reporting adjustments:

Advertiser adjustments

• advertiser_revenue - This adjustment type changes the booked revenue and/or impressions, clicks, and conversions you see in reporting for an advertiser and adjusts your media cost payout to revshare publishers. See the first example below for more details about how payout to revshare publishers is adjusted.
• advertiser_credit - This adjustment type changes the booked revenue and/or impressions, clicks, and conversions you see in reporting for an advertiser. It does not adjust your media cost payout to revshare publishers.

Publisher adjustments

"publisher" - This adjustment type changes the media cost and/or impressions, clicks, and conversions you see in reporting for a publisher.

Adjustment status

Adjustments are applied asynchronously to reporting and will appear several hours from the time they are created. The Adjustment Service provides an interface to check the current status of an adjustment.

Status can be one of the following values:

REST API

JSON fields

General

Advertiser adjustments

Publisher adjustments

Examples

Adjusting advertiser revenue and impression count with attribution to publishers

For "advertiser_revenue" adjustments, attribution of booked revenue adjustments to revshare publishers is done proportionally based on the number of impressions served by a publisher.

Report before adjustment

To adjust revenue down to $9 and impressions to 9,000 for the line item, you create and POST the following JSON-formatted file:

$ 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'

Report after adjustment

Adjusting advertising revenue and impression, click, and conversion count without attribution to publishers

$ 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..."
   }
}

Adjusting publisher media cost and impression count for placements served with creatives

Report before adjustment

To adjust media cost down to $10 and impressions to 3500, you create and POST the following JSON-formatted file:

$ 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'

Report after adjustment

Canceling an adjustment

You can cancel adjustments that have the status "new" or "pending".

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

Viewing all adjustments

$ 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
            },
            ...
        ]
    }
}