Welcome to the Yahoo Gemini API Product Bulletin. This update includes a quick snapshot of recent and upcoming releases and is focused on features supported by the API. A summary of supported functionality is also included.
Product Bulletins are updated on a monthly cadence for Gemini API partners, account managers and developers.
- March, 2017
- Shared Sitelink Service Resources
- Carousel Ads Resources
- Search on Native Bid Modifier Attribute Resources
- Reminder: Budget to Bid Ratio: Native vs. Search Campaigns
- Gemini API Video Tutorials
- Reminder: Gemini v2 API Resources and v1 Deprecation Timeline
- Reminder: Deprecated Reporting Endpoint
- Getting Started Guide: OAuth 2.0 Authentication Steps
- New Glossary of Gemini Terms
- Check Out What’s New
- Using the Gemini Sandbox Environment
- Required Fields by Ad Type Matrix
Carousel Ads Resources¶
- Gemini carousel ads allow you to take advantage of powerful storytelling techniques to deliver impactful messages that drive greater user engagement, interest and demand. With carousel ads, you can highlight your product features, its benefits and attributes by using a sequence of image panels that serve to tell a compelling story. See the overview in the Advertiser Guide for more details on how to use Carousel Ads.
- For API documentation, you can find ad assets and JSON representations described in Ad Object.
- Support for bulk objects & types is provided with the addition of the new bulk object:
Ad Assets. For more information, refer to Bulk Ad Assets.
Search on Native Bid Modifier Attribute Resources¶
- New Search on Native bid modifier attribute was introduced in January 2017. The bid is controlled via the bid modifier on the campaign object. By default, Gemini will set the Search on Native bid modifier (to -70%). To manage bids via the API, you will need to support the new
subChannelModifierthat was added to the campaign object. For a campaign to be eligible to run on Search on Native, the campaign channel must be set to Search_ONLY and the subchannel may be set to either SRN_and_Search or SRN_ONLY. The attribute will accept a decimal value from .1 to 2 (displayed in UI as -90% to 200%). See Campaigns for more details. Also see the Technical Note for reporting and tracking process considerations to maintain proper ROI when bidding on conversions.
Reminder: Budget to Bid Ratio: Native vs. Search Campaigns¶
Gemini API Video Tutorials¶
- In this series of introductory videos, the Gemini Development Team will walk you through some of the basic steps you’ll need to follow before you first begin making API calls and leveraging the Gemini platform for programmatic ad buying.
- Get Started with Programmatic Gemini API - Episode 1
- Working with RESTful Objects in Programmatic Gemini API - Episode 2
- How to set up your Sandbox Environment in the Programmatic Gemini API - Episode 3
Reminder: Gemini v2 API Resources and v1 Deprecation Timeline¶
- New Gemini v2 API has been released. Starting on June 1, 2016, Yahoo Gemini migrated the programmatic Gemini API from v1 to v2; the current version of the Gemini API is v2. Be sure to read the sections on Versioning and API v1 Deprecation, plus the FAQs for details.
The Gemini v1 API was supported for 90 days beyond the June 1, 2016 deprecation date. After that date, starting on September 1, 2016, the Gemini v1 API will be available for one year. After that time, it will be relegated to End of Life (EOL) status.
- See the What’s New section for more information about the new Gemini v2 API.
Reminder: Deprecated Reporting Endpoint¶
- Update: Please be aware that action may be required for the following deprecated reporting endpoint.
Old: https://api.gemini.yahoo.com/v1/rest/reports New: https://api.gemini.yahoo.com/v2/rest/reports/custom
- If you currently make calls only to /v2/rest/reports/custom for both POST and GET, there is no action required.
- If you currently make POST calls to /v1/rest/reports then you need to migrate to the /v2/rest/reports/custom endpoint ASAP.
- If you currently make POST calls to /v1/rest/reports/custom and GET calls to /v1/rest/reports, then you need to migrate to v2 before v1 EOL NEXT year Sept 1, 2017.
- Please see documentation for the new reporting endpoint for more information.
- For additional reference, please see Gemini API documentation: Navigating the API and Reporting.
Getting Started Guide: OAuth 2.0 Authentication Steps¶
- New, detailed explanation of steps to follow before you begin OAuth 2.0 authentication. If you’re new to the Gemini API, you should read the section and follow the steps listed. Note also in the section on OAuth refresh tokens that access tokens will expire after 60 minutes.
New Glossary of Gemini Terms¶
Check Out What’s New¶
Using the Gemini Sandbox Environment¶
- The Gemini API lets you work with a sandbox environment to test campaigns you’ve created and managed. You use the same consumer key and consumer secret you obtained when you set up your OAuth to access the sandbox.
- The Gemini sandbox serves as a modified version of the production environment. While all operations are designed to function the same in the sandbox as in the production environment, the campaigns and ads you create in this environment do not actually serve. The sandbox environment is completely separate from your production environment.
- All campaigns, ads, and keywords you create in the sandbox are available in the sandbox environment only. There is no possibility that the ads you create in the sandbox will be accidentally served. Nor will your production accounts be charged for any mock transactions in the sandbox environment.
- You will need to create a sandbox account in order to test in this environment. You can do this by making a POST call to the sandbox signup endpoint and passing in the name you wish to call your test advertiser. The response will be a test advertiser object that will only be available in the sandbox environment. For more details, see Testing - Sandbox.
- Be sure to check out the new video tutorial describing How to set up your Sandbox Environment in the Programmatic Gemini API - Episode 3.
Required Fields by Ad Type Matrix¶
- We’ve added a new matrix which details the required fields when serving different ad types. For more information, see Ad documentation > Matrix view of required fields.