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 54 Next »

Use the Console API to Synchronize Your Inventory Structure

This page shows you how to use the Console API to map your supply to the corresponding objects within AppNexus and test the mapping with a debug auction. Please follow these instructions for each publisher you work with.

To map your supply using the Console UI, see Use the UI to Synchronize Your Inventory Structure.

On This Page

Before You Begin

Before you begin, you must meet the following criteria:

Step 1. Create a Publisher

Use the Publisher Service to create a new publisher that's mapped to your inventory.

The code field is required for all external sellers at both the publisher and placement levels and is highly recommended for all other sellers to ensure that your inventory is as granular as possible so that it can be investigated accurately for quality issues, and specifically for domain detectability. While not required, this step will help you to split your inventory into highly detectable and less detectable tags, allowing you to isolate the impacts of non-detectable domains on the rest of your inventory's viability.

Your JSON must include the following fields:

FieldTypeDescriptionDefault
namestring (255)Name of the legal entity of the company you pay money to. For instance, if you buy from espn.com, the publisher should be named as the legal entity for ESPN. 
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)The code that identifies the publisher from your inventory.  Use the value of the BidRequest.Site.Publisher.id or BidRequest.App.Publisher.id  fields. 
reselling_exposureenumThe publisher's exposure for reselling to other members of the platform. Possible values: "public" or "private.""private"
stateenumThe state of the publisher. Possible values: "active" or "inactive.""inactive"

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. 
Each site should represent a grouping of placements that:

  1.  Are associated with the same domain (both mobile and standard web)
  2. Or are associated with the same mobile app

Your JSON must include the following fields:

FieldTypeDescriptionDefault
namestring (255) Domain or app bundle ID passed through this 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"

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 associated with the publisher and site you created in steps 1 and 2.   

The code field is required for all external sellers at both the publisher and placement levels and is highly recommended for all other sellers to ensure that your inventory is as granular as possible so that it can be investigated accurately for quality issues, and specifically for domain detectability. While not required, this step will help you to split your inventory into highly detectable and less detectable tags, allowing you to isolate the impacts of non-detectable domains on the rest of your inventory's viability.

Your JSON must include the following fields:

FieldTypeDescriptionDefault
namestring (255)Name associated with the publisher. 
codestring (100)The code that identifies the placement from your inventory.  Use the value of the BidRequest.Site.id or BidRequest.App.id field. 

Example

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.

Example debug auction for a video impression using the OpenRTB protocol  Expand source

In the example above, <GEO> has potential values: "useast","uswest","apac","emea"

Related Topics

  • No labels