API v1 Deprecation & v2 Changes

Beginning on June 1, 2016, Yahoo migrated the programmatic Native API from v1 to v2.

Developers are encouraged to migrate to the new v2 API in order to maintain access to the latest features and functionality. Note that new features are only added to the current version. In the event of a special situation that would require a fundamental change across all versions, a migration path will be provided. For any migration, you will have at least a 90-day window to migrate and integrate your app.

Important

The Yahoo Native v1 API was supported for 90 days beyond the June 1, 2016 deprecation date. After that date, starting on September 1, 2016, the Native v1 API will be available for one year. After that time, it will be relegated to End of Life (EOL) status. In addition, 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.

v2 Changes

The following describes v2 changes for the Native Ad Platform API:

Service Name

v2 Changes

AdGroup

For install app campaigns, the ecpa goal is required. The bidding strategy is always set to OPT_CONVERSION.

AdExtension

Sitelink removed.

Shared Sitelinks

New in v2. Use these 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

New in v2. Use this new library of shared sets at the advertiser account level to create, update and retrieve shared sets.

Create Shared Sets

New in v2. Enables you to create shared sets.

Populate Shared Sets

New in v2. Populate shared sets with negative keywords.

Associate Shared Sets with Campaigns

New in v2. Enables you to associate shared sets with campaigns.

Keyword

New status and editorialStatus fields added in v2. The status of the keyword includes these values: ACTIVE, PAUSED, DELETED and REJECTED. The editorialStatus field includes these values: NOT_REVIEWED, PENDING_REVIEW, APPROVED, and REJECTED. This field is reserved for read-only system transitions. See the diagram below for an illustration of how this works.

Ad

New status and editorialStatus fields added in v2. The status of the keyword includes these values: ACTIVE, PAUSED, DELETED and REJECTED. The editorialStatus field includes these values: NOT_REVIEWED, PENDING_REVIEW, APPROVED, and REJECTED. This field is reserved for read-only system transitions. See the diagram below for an illustration of how this works.

Bulk schema uploads and downloads

Provides partners and developers with a unified format for bulk operations and data representation. To consolidate all targeting attributes in bulk files to a single, unified standard, as well as expose targeting attribute entity IDs for all objects, the v2 Oath AP includes a number of changes.


The Entity Status and Editorial Status

entity v2 status and editorial status

v1 Deprecation

The v1 Yahoo Native API is now deprecated for the following reasons:

  • Changes in the data model for AdExtensions and removal of Sitelinks.

  • New object types, shared set libraries and shared sitelinks.

  • Improved support for backward-incompatible features.


Keep in mind that if you make a call to the Native API without specifying the version, it returns a 404 error.