Navigating the API¶
The Native & Search API provides you with the tools and resources you need to create, manage and retrieve advertiser data for your ads, ad groups and campaigns programmatically.
Developers are encouraged to take advantage of Native & Search Platforms API as mobile traffic continues to increase rapidly, with the majority of ads on Yahoo mobile search inventory being served by Native & Search. Native advertising across Oath mobile inventory is only available.
The sooner you participate in the Native & Search API, the sooner the system can begin to build a performance history for your ad, so that your ad can earn better ranking and start getting you the clicks it deserves. As traffic ramps, your ad is then in the best position for cost-effective delivery and performance.
Who Should Read This Document¶
This documentation is intended for programmers who are developing apps to access Oath content and search infrastructure. A prerequisite for working with the Native & Search API is an understanding of HTTP, XML, JSON, and a cursory knowledge of query languages.
Native & Search v3 API Roadmap¶
The roadmap for taking advantage of the Native & Search v3 API is straightforward and easy to navigate.
Follow These Paths If You’re New to Oath¶
- Apply for Native & Search API access, if you haven’t already, so you can get your API key, copy the PHP example code and build and launch your code.
- Establish Authentication using the OAuth 2.0 protocol as your Oath authorization model.
- Set up your Sandbox environment for Testing the creation and management of your advertising campaigns.
- Understand the set of Native & Search RESTful Objects that you can use to create, manage and retrieve advertiser data for your ads, ad groups and campaigns programmatically. Learn about the data model for the API, which is based on calling the same RESTful object with a different HTTP method.
- Check out the What’s New section and Product Bulletins to keep up to date with the latest features, product enhancements, and API changes.
- Tap into these resources dedicated to working with Oath and the Native & Search API:
If You Already Have an Oath Account & Need to Migrate From v1 to v2 and to v3¶
Explore these topics that describe using the new v3 Native & Search API.
|Using the v3 API||Topic|
|Versioning||Why versioning is important for enabling smoother transitions to support v1 functionalities.|
|API v1 Deprecation||Details of v1 deprecation and what you need to know to migrate from v1 to v2 and integrate your app.|
|FAQs||Frequently asked questions about issues when working with the v2 and v3 API.|
v3 Data Model¶
The v3 Native & Search API data model, shown in the diagram, is similar to the v2 data model, with objects created on the advertiser account level for shared sitelinks and shared sets:
The v2 Native & Search API includes the following objects, described in the table below:
|Shared Sitelinks||Provides methods for creating, updating and retrieving shared sitelinks. Once created, you can share and link these objects to any campaign or adgroup, using the shared sitelinks endpoint.|
|Shared Set Libraries||Provides an overview of the new library of shared sets you can use at the advertiser account level.|
|Create Shared Sets||How to create shared sets.|
|Populate Shared Sets||How to populate shared sets with negative keywords.|
|Associate Shared Sets with Campaigns||How to associate shared sets with campaigns.|
v1 API Support¶
The Native & Search v1 API will be supported for 90 days beyond the June 1, 2016 deprecation date. After that date, starting on September 1, 2016, the Native & Search v1 API will be available for one year. After that time, it will be relegated to End of Life (EOL) status. In addition, please note the following: New features will not be added to v1. Non-critical bugs will not be fixed outside of the 90-day window. Any significant, revenue-impacting bugs will continue to be addressed.