Documentation

Oath: Ad Platforms Native and Search is a service that provides qualifying developers with RESTful access to mobile search and native advertising results with a simple pricing scheme based on usage.

The service enables you to programmatically buy, manage and optimize mobile search and native advertising for campaigns across Oath’s mobile inventory.

As an Oath API developer or partner, you’ll be able to work with a set of RESTful objects to create, manage and retrieve advertiser data for your ads, ad groups and campaigns.

Introducing the Native & Search API

Gemini has now been rebranded as Oath: Ad Platforms Native & Search. The new product brand represents Oath’s full suite of technology solutions for advertisers, agencies and publishers. The new brand (shown below with this logo) replaces BrightRoll, Gemini, ONE by AOL, and Yahoo for Publishers.


name rebranded

Oath: Ad Platforms is connected to the consolidation work completed by the Oath product and engineering teams in September 2018.

Now a global brand, Oath: Ad Platforms will be a visible part of the Oath family of brands in all Oath markets.

Important

All previous references in this documentation suite to the Gemini API will now be designated as Oath: Ad Platforms Native & Search API, or simply Native & Search API.

All endpoints (Resource URIs) will stay the same as in the v2 and v3 Gemini API, and not change. For example, this stays as is, even with the rebranding:

https://api.gemini.yahoo.com/v3/rest/advertiser/

Key Benefits

The Native & Search API lets you:

  • read data for filtered lists of ads
  • specify objects that you can use for targeting
  • customize mobile search ads by using text variables
  • retrieve ad extensions that are grouped by type for a specific parent
  • query reporting at different entity levels and fetch reports in CSV format
  • work with a sandbox environment to test campaigns you’ve created and managed

With the Native & Search API through Oath: Ad Platforms, you are empowered with insightful data, brand safe content and advanced technologies.

How To Navigate The API

The Native & Search API documentation is organized around the topics listed in the Table of Contents.

  1. To begin, explore the section on Navigating the API, which describes topics dealing with Authentication, Creating a Sandbox Account for API testing, Versioning and API v1 Deprecation.
  2. Next, you’ll want to study and understand the Native & Search RESTful objects – Ad, Ad Extensions, Ad Group, Advertisers, Campaigns, Keyword, Shared Site Link and Targeting Attribute – and their relationships in the v2 Native & Search API data model.
  3. Drill down to topics like Audience Management, which enables you to better target your ads by creating audiences from your website, from your mobile app, from your email lists or from your customer lists, and Reporting, which allows you to query cubes, or pre-defined collections of fields that let you define the context of your report.
  4. If you need to work with Bulk operations, for example, the Native & Search API lets you download and edit all the objects in your advertiser account using a spreadsheet in CSV format and provides you with a Bulk schema for working with bulk files.

Best Practices

To learn about tips and techniques for working with the Native & Search API, check out Best Practices. The best practices are grouped into categories that are intended to optimize and advance your efforts in working with the Native & Search API.

Most Frequently Asked Questions

The FAQs are grouped into multiple categories for easier navigation and retrieval of topic-specific information. You’ll find them in various sections dedicated to a particular topic.

What’s New

To track the latest changes, updates and enhancements to the Native & Search API, you’ll want to read the What’s New section. The What’s New section is updated on a weekly cadence.

Partner Support

The Native & Search API Partner Support page provides you with a quick snapshot of recent and upcoming releases, and is focused on features supported by the API. You’ll also find a summary of supported functionality.

Partner Support includes product bulletins updated on a monthly cadence for Native & Search API partners, account managers and developers.