Yahoo Native to Yahoo DSP API Migration Guide¶
Describes the high-level code and API changes for advertisers who are migrating their accounts from Yahoo Native to Yahoo DSP.
Yahoo Native and Yahoo DSP will be merging into a single, unified demand platform.
The goal is to provide Yahoo advertisers with a unified interface that simplifies buying and optimization across all media types – for example, Video, and Yahoo Preferred Network (formerly Native Marketplace) – and across all media buy types, like RTB, Reserved, as well as across all supply sources – O&O + 3rd party.
That means, Yahoo advertisers, developers and partners will be able to buy both Yahoo O&O Native and DSP more efficiently – and with improved conversion and performance results.
This guide provides you with information about the high-level changes that you need to consider and understand when migrating from Yahoo Native to Yahoo DSP. It describes in parallel the RESTful API endpoints and methods, headers and body, Curl and JSON responses for your campaigns when you transition your code base from Native to DSP.
The goal of this migration is to provide partners with a programmatic and scalable solution to migrate Native advertiser accounts into DSP. Ultimately, that includes the migration of all Native entities, assets, targetings, exceptions, marketplace controls from a Native source account into a DSP destination account, as per the Native to DSP domain model.
The preferred and recommended migration strategy is for Native API partners to migrate to the unified demand platform and assume responsibility for the migration. The recommended migration path is for new campaigns to be created and managed in DSP while old campaigns continue to be managed via Native API until they expire.
This document will guide you through the process and enable you to make the migration as straightforward and frictionless as possible.
You should discuss all possible strategies with your Yahoo account manager and with the Yahoo DSP and Native solutions engineering teams. Reach out to the teams at email@example.com.
The best starting point for Native API partners is to understand the mappings and associations between the Native and DSP APIs at the account-level, as illustrated in the color-coded diagram shown below.
Once you’ve taken a look at these, you should navigate to the section on Understanding Domain Models. That section also provides you with a detailed diagram (again, color-coded), illustrating the object and entity type mappings from Native to DSP domain models. The differences and associations from one model to the other are described.
Next, you’ll want to explore the section on Migration scenarios, which discusses various migration scenarios, key terminology and workflows. The most common use for Native API partners is Scenario 1.
To dive deeper, you should review the section on Campaign structures, describing the Native Campaign to DSP Package and Line structure for migration.
This Campagin -> Package -> Line structure is the recommended and optimal migration path for Native API partners because the structure is similar to having one campaign with multiple ad groups in Yahoo Native. It works best because it has closer parity to the Native structure, and is most likely to have the closest performance characteristics to that of original Yahoo Native campaigns.
Other sections in the guide explain various topics such as packages, campaigns, lines, targeting, reporting and so on, which describe in parallel the code structures from the Native to DSP stack.
Finally, you’ll want to explore the Java Code Examples that describe how to read from Native and write to DSP.
Caveats & Considerations¶
Be sure to note the following:
Unified demand platform entities will have an entirely new id namespace. This is important to understand.
Historical reporting data and account history will not be migrated over.
There are three different Yahoo DSP seat types that will be made available with the new unified ad platform, described in the section Seats.
For Third-Party Integrators¶
If you’re a third-party integrator coding to our API and wish to be a Test Advertiser in DSP, reach out to your support team or solutions engineering. The team will grant you access to a Test Seat in order to validate your integration.
Note that once your final Test Seat has been assigned as an integrator, you’ll need to update your code with a new token.
If you’re working with the Yahoo DSP or Yahoo Native API, you can reach out for more information at firstname.lastname@example.org.
External API partners/developers