Synchronizing Your Inventory Using the Console API
Whether you use AppNexus Supply Integration (ASI) or OpenRTB integration, 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 that's mapped to your publisher.
- Create a new placement group.
- Create a new placement that's mapped to your placement.
- Test the mapping with a debug auction. (Optional.)
Before You Begin
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.
Bid Request Fields
|Console API Service||Console Service 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 1. Create a Publisher
Use the Publisher Service to create a new publisher that's mapped to your inventory. Use the value for
BidRequest.Site.Publisher.id as the publisher code.
is_oo is an optional field that indicates the publisher is owned and operated by the network (100% of the revenue goes to the network).
reselling_exposure is an optional field that indicates whether you would like to expose the publisher's name to buyers (public or private).
The API returns the ID of the newly created object in its response. Save this value for use in the next two steps.
Step 2. Create a Site (Placement Group)
Use the Site Service to create one or more sites (or placement groups). Sites are simply a grouping mechanism for placements. At least one site is required, but you don't need to create additional ones if you don't need further granularity. The
publisher_id is the ID for the publisher you created in step 1.
Supply type options are:
web: Desktop browser inventory
mobile_web: Mobile browsers
mobile_app: Mobile applications
The API returns the ID of the newly created object in its response. Save this value for use in the next step.
Step 3. Create a Placement
Use the Placement Service to create placements, which are the most granular sell-side objects. Use the value for
BidRequest.Site.id for the placement code. The
publisher_id is the ID for the publisher you created in step 1 and the
site_id is the ID for the site you created in step 2.
Step 4. Test the Mapping Setup (Optional)
You can test that the mapping is working correctly by using a debug auction. Send a test impression to our endpoint with the debug parameters and check that the impression reaches the expected placement.
For video placements:
For all other placements: