Synchronizing Your Inventory Using the Console API
This page walks you through the process of using the Console API to map your supply to the corresponding objects within AppNexus.
Before you begin, you must meet the following criteria:
- You have received API credentials.
- You have access to the Console API wiki space.
- You have reviewed our API onboarding materials.
- You have generally familiarized yourself with how the Console API functions.
- You are familiar with the AppNexus Sell-Side Object Hierarchy.
Whether you use AppNexus Supply Integration (ASI) or OpenRTB, you'll synchronize your inventory by mapping your publisher and placement fields to Console API publisher and placement fields. You use the Console API to do the following:
- Create a new publisher, which is mapped to your existing ASI or OpenRTB publisher.
- Create a new placement group.
- Create a new placement, which is mapped to an existing ASI or OpenRTB placement.
Bid Request Fields
|Console API Field||ASI Field||OpenRTB Field|
The following steps will explain how to create publisher and placement objects with the proper configuration to accept those mappings.
Step 3. Creating a Publisher
The first thing you'll do is create a new publisher, specifying the publisher.code if you're using one.
POST: http://api.appnexus.com/publisher?member_id=XXXX&create_default_placement=false (where XXXX is your member ID)
- AAAA: set this to the name of the publisher
- BBBB: (optional) set this to the value passed in the bid request for mapping to the publisher object
- CCCC: (optional) set this to "public" or "private" based on whether you would like the publisher's name to be exposed to buyers, or not.
Once you have POST'ed successfully, the API will provide the ID of the newly-created object in its response. You'll need to store this value for further use.
Step 4. Creating a Site (a.k.a. Placement Group)
Next, we'll create one or more Sites (or Placement Groups), which are simply a grouping mechanism if you have a large number of placements within one Publisher. Using one is mandatory, multiple is optional.
POST: http://api.appnexus.com/site?member_id=XXXX&publisher_id=YYYY (where XXXX is your member ID, YYYY is the ID of the publisher you created in the previous step)
- AAAA: set a name for the site
- BBBB: allowed values are "web", "mobile_web", or "mobile_app"
- if you set "web", AppNexus will assume that all impressions for underlying placements are for desktop browser inventory (regardless of banner, video, native, etc)
- if you set "mobile_web", we will assume that all impressions are for mobile browser
- if you set "mobile_app", we will assume that all impressions are for mobile applications
Step 5. Creating a Placement
Finally, we'll create one or more Placements, which are the most granular sell-side objects.
POST: http://api.appnexus.com/placement?member_id=XXXX&publisher_id=YYYY&site_id=ZZZZ (where XXXX is your member ID, YYYY is the ID of the publisher you created earlier, ZZZZ is the ID of the site you created in the previous step)
- AAAA: set a name for the placement
- BBBB: (optional) set this to the value passed in the bid request for mapping to the placement object