Yahoo developer network
Native
Yahoo developer network logo
  • Open Source
  • APIs
  • Advertising
  • Blog
  • Events
  • Podcasts
  • Apps
  • Native
  • Documentation

    • Yahoo Native to Yahoo DSP API Migration Guide
      • Understanding Domain Models
      • Migration scenarios
      • Campaign package structure
      • Understanding DSP packages
      • Seat types
      • Authorization
      • Advertiser
      • Campaigns
      • Lines
      • Blocked cases
      • Pixels
      • Reporting
      • Targeting
      • Postman toolkit
      • Appendix
      • Sample code
        • Create DSP shell
        • Create DSP creative
        • Flatten & Filter Targeting attributes
    • What’s New
    • Latest Updates
    • Get Started - API Endpoints
    • Navigating the API
      • Authentication
      • Testing - Sandbox
      • Versioning
      • API v1 Deprecation & v2 Changes
      • FAQs
    • Objects
      • Advertisers
      • Campaigns
      • Ad Group
      • Ad
      • Keyword
      • Targeting Attribute
      • Ad Extensions
      • Shared Sitelink
      • Shared Sitelink Setting
      • Ad Site Setting
    • Matrix View of Ad Types
    • Postman API Toolkit
    • Upgraded URLs
      • Migration path
    • Yahoo Native Ads
      • Native Ad Matrix View
      • Moments Ads
      • Search Ads
      • Image Ads
      • Mail Ads
      • Carousel Ads
      • Tiles Ads
      • Native Video Ads
      • App Install Ads
    • Frequency Cap
    • Reach and Performance
    • Dynamic Product Ads
    • Enhanced Attribution
    • Account Change History
    • Bulk Operations
      • Bulk File Schema & Fields
      • Bulk Upload API
      • Bulk Download API
      • Best Practices
    • Shared Set Libraries
      • Create shared sets
      • Populate shared sets
      • Associate shared sets
    • Audience Management
      • Audiences from websites
      • Audiences from customer lists
      • Audiences from your app
      • Audiences from email lists
      • Lookalike audiences
      • Conversion rule audiences
      • Dot tags
      • Conversion rules
      • Utilize Dot tags & conversion rules
      • Custom audience strategies
    • Reporting
      • Cubes
      • Dimensions
      • FAQs
    • Reseller Management API
    • Resources
      • Dynamic Parameters
      • Data Dictionary
      • Best Practices
      • Error Codes and Responses
      • Release Notes - Archived
    • Glossary
      • Glossary of Yahoo Native Terms
    • Partner Support
      • Product bulletin 2023 February
      • Product bulletin 2023 January
      • Product bulletin 2022 December
      • Product bulletin 2022 November
      • Product bulletin 2022 October
      • Product bulletin 2022 September
    • Policies
    • Advertiser Guide - UI
    • Technical Notes
      • Search on native
      • Create, serve & filter shared sitelinks
    • Server-to-Server Specifications
      • App Install Spec
      • In-app Events Spec
      • Post-install Spec
  • Sign In
  • Language:
    • English (U.S.)
    • 中文(香港)
    • 中文(台灣)

Navigating the API¶

The Yahoo Native 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 the API as mobile traffic continues to increase rapidly, with the majority of ads on Yahoo mobile search inventory being served by Yahoo Native. Native advertising across Yahoo Native mobile inventory is only available.

The sooner you participate in the Yahoo Native 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 Yahoo Native content and search infrastructure. A prerequisite for working with the Yahoo Native API is an understanding of HTTP, XML, JSON, and a cursory knowledge of query languages.

Yahoo Native v3 API Roadmap¶

The roadmap for taking advantage of the Yahoo Native v3 API is straightforward and easy to navigate.

Follow These Paths If You’re New to Yahoo Native¶

  1. Apply for Access, if you haven’t already, so you can get your API key, copy the PHP example code and build and launch your code.

  2. Establish Authentication using the OAuth 2.0 protocol as your Yahoo Native authorization model.

  3. Set up your Sandbox environment for Testing the creation and management of your advertising campaigns.

  1. Understand the set of Yahoo Native 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.

  2. Check out the What’s New section and Product Bulletins to keep up to date with the latest features, product enhancements, and API changes.

  3. Tap into these resources dedicated to working with Yahoo Native and the API:

  • Yahoo Native API Access Request Form on the Yahoo Developer Network

  • Yahoo Native Advertiser Guide

  • Bulk File Management

If You Already Have an Yahoo Native Account & Need to Migrate From v1 to v2 and to v3¶

Explore these topics that describe using the new Yahoo Native v3 of the API.

Using the v3 API

Topic

Versioning

Why versioning is important for enabling smoother transitions to support v1 functionalities.

API v1 Deprecation & v2 Changes

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

v2 api gemini data model

v2 Objects¶

The v2 API includes the following objects, described in the table below:

Objects

Description

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¶

Important

The v1 API will be supported for 90 days beyond the June 1, 2016 deprecation date. After that date, starting on September 1, 2016, the 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.

Support
Terms and Privacy Policy
Your Privacy Choices
About Us Jobs Developer Privacy Developer Terms Developer Policies Site Feedback
Brands Yahoo Developer Yahoo Ads SDK Analytics Reporting Yahoo Edgecast Developer Ad Platform Help Center
Group 5 Group 7 Group 4 Group 3 Group 14
Yahoo Logo