Skip to end of metadata
Go to start of metadata

Broker Service

The Broker service has been replaced by the Partner Fee Service for augmented line items (ALIs). If you have used broker fees in the past, please consult the Partner Fees Breaking Change Notice for details.

The Broker Service can only be used with standard or legacy line items. Broker fees do not apply to augmented line items.


The Broker Service allows users of standard or legacy line items to define brokers. Brokers collect fees from networks when serving an impression. The actual fees are defined through the Campaign Service, the Line Item Service, or the Insertion Order Service.

If a broker fee is applied to an insertion order, the fee will not apply to any augmented line items associated with the insertion order. It will apply only to the insertion order's standard line items.

On This Page

REST API

Add a broker:
POST https://api.appnexus.com/broker
(add-broker JSON)

Modify a broker:
PUT https://api.appnexus.com/modify-broker?id=BROKER_ID
(modify-broker JSON)

View all brokers:
GET https://api.appnexus.com/broker

View a specific broker:
GET https://api.appnexus.com/broker?id=BROKER_ID

JSON Fields

Parameter

Type

Description

Default

Required On

id

int

The unique identifier for a broker.

Auto-incremented Number (i.e. 123)

PUT

name

string

The unique name used to describe a broker.

 

POST

state

string

The state of the broker. Possible values: active or inactive.

active

 

member_id

int

The unique identification number of the broker's member. When creating a broker, the member of the user is assigned.

 

 

last_modified

timestamp

Read-Only. Time of last modification to this broker in the format YYYY-MM-DD HH:MM:SS.

 

 

broker_fees

array of objects

An array of broker fees associated with the broker. Refer to the Broker Fees section.

null

 

Broker Fees Applied to Other Objects

Broker fees are created through the Campaign Service, the Line Item Service, or the Insertion Order Service. They can be viewed here, but cannot be created or edited through this service. Refer to the Broker Fees section in each of the above-referenced services for details on how to apply fees to brokers.

If a broker fee is applied to an insertion order, the fee will not apply to any augmented line items associated with the insertion order. It will apply only to the insertion order's standard line items.


Each object in the broker_fees array contains the following fields:

Field

Type

Description

object_type

string

Read-Only. Indicates whether this fee is assocated to one campaign or a group of campaigns. Possible values: campaign or campaign-group.

object_id

int

Read-Only. The unique identification number of the fee.

description

string

Read-Only. Text that provides information about the fee.

fee_type

string

Read-Only. The Possible values: commission or serving:

  • Commission - These are Line Item or Insertion Order broker fees, and are deducted from the booked revenue given from the advertiser to the network. Commission is always in the currency of the associated Insertion Order, Line Item or Campaign.
  • Serving - These are Campaign broker fees, and are in addition to the inventory cost that the network paid the publisher. Serving fees are in US Dollars.

payment_type

string

Read-Only. Payment type: cpm or revshare.

value

double

Read-Only. The value of the fee

Examples

Add a broker
Modify a broker
View all brokers
View a specific broker
  • No labels