Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 26 Next »

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:

  1. Create a new publisher that's mapped to your publisher.
  2. Create a new placement group.
  3. Create a new placement that's mapped to your placement.
  4. Test the mapping with a debug auction. (Optional.)

You need to map either the publisher or a placement, but you don't necessarily need to map both. You  If the publisher is already mapped, all inventory will flow through the default placement for that publisher. 

If you use custom integration types, you can contact AppNexus Support to learn how your bid requests map to AppNexus publishers and placements.
On This Page

Before You Begin

Before you begin, you must meet the following criteria:

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. Your JSON must include the following fields:

FieldTypeDescriptionDefault
namestring (255)  
is_ooboolean

If true, the publisher is owned and operated by the network, meaning the network gets 100% of the revenue.   Setting this to true also enables you to skip setting up payment rules.

"false"
codestring (100)  
reselling_exposureenumThe publisher's exposure for reselling to other members of the platform. Possible values: "public" or "private.""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) associated with the publisher you created in step 1. 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.  

FieldTypeDescriptionDefault
namestring (255) Name associated with the site. 
supply_typeenum

Specifies whether this is a site viewed on a desktop browser ("web"), a site viewed on a mobile browser ("mobile_web"), or an app run on a mobile device ("mobile_app"). This distinction allows the buyer to target campaigns to the particular supply type where they want to advertise, for example, an advertiser may upload creatives optimized for mobile browsers with mobile landing pages.

"web"

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 ext_placement_code or 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:

 

 

  • No labels