(Translated by https://www.hiragana.jp/)
Google Ads Developer Blog: ad_exchange_rest

The Ad Exchange Seller REST API is deprecated. Existing API clients should migrate to the DoubleClick for Publishers API before July 26, 2018. After this date, all requests to the Ad Exchange Seller REST API will return errors.

This migration guide provides instructions for getting started, as well as a mapping of each Ad Exchange reporting metric to its equivalent in the DFP API.

For more details about reporting in the DFP API, see the reporting guide.

For general assistance with the DFP API or your migration, reach out on our developer forum.

You can now access RTB Breakout metrics programmatically with new RTB troubleshooting resources added to the DoubleClick Ad Exchange Buyer REST API. These include the following:
  • filterSets
  • filterSets.bidMetrics
  • filterSets.bidResponseErrors
  • filterSets.bidResponsesWithoutBids
  • filterSets.filteredBidRequests
  • filterSets.filteredBids
  • filterSets.filteredBids.creatives
  • filterSets.filteredBids.details
  • filterSets.impressionMetrics
  • filterSets.losingBids
  • filterSets.nonBillableWinningBids
RTB troubleshooting resources are placed hierarchically under both bidders and bidders.accounts. For more information about these resources and how they differ when used at the bidder or account level see the RTB troubleshooting guide.

If you have any feedback or questions about the RTB troubleshooting resources, feel free to reach out to us via the DoubleClick Ad Exchange Buyer API support forum.

The Ad Exchange Seller REST API is being deprecated as of October 26, 2017. No new API clients will be supported after this date. Existing API clients will need to migrate to the DoubleClick for Publishers API before July 26, 2018. After this date, all requests to the Ad Exchange Seller REST API will return errors.

What action is required


Current Ad Exchange Seller REST API users will need to migrate to the DoubleClick for Publishers API before July 26, 2018. This migration guide provides a mapping of each Ad Exchange reporting metric to its equivalent in the DFP API.

For more details about reporting in the DFP API, see the reporting guide.
For general assistance with the DFP API or your migration, reach out on our developer forum.

Why this is happening


As a part of our effort to provide a unified tool to manage your ad business and monetize your inventory, the DoubleClick for Publishers API now supports all of the features of the Ad Exchange Seller REST API. The DFP API is more robust and has more frequent updates.

What isn't changing


Users will not need to create new accounts. All Ad Exchange Seller users already have a DoubleClick for Publishers account.

No data is changing. The only change is how you programmatically access that data.

We’ve just released v2beta1 of the DoubleClick Ad Exchange Buyer REST API. Unlike previous releases, this is an early access open beta that only allows three new resources—Clients, Invitations, and Users. In order to access this version, new users will need to go to the API Manager in the Google Developers Console and enable “Ad Exchange Buyer API II”; current users will have this enabled automatically. For access to existing resources such as Accounts or Creatives, you should continue using v1.4.

The new resources available in this release allow you to add and manage clients programmatically rather than through the Ad Exchange UI. A Client represents an advertiser, agency, or brand that can view, negotiate, and/or approve deals in areas of the Ad Exchange UI related to the Marketplace. You can send Invitations on behalf of a Client to add Users—the individuals accessing the UI as the Client.

To get even more familiar with these new resources, check out the Client Access Overview. There are some subtle differences when using the client libraries with this version, so we recommend that you look at our samples for guidance on initializing clients and making API calls. At this time, the Java, PHP, and Python samples have been updated for compatibility with this version and the others are planned for the near future. If you have any questions or feedback related to these changes, feel free to reach out to us at the DoubleClick Ad Exchange Buyer API forums or the Ad Developers Google+ Page.

The DoubleClick Ad Exchange (AdX) Buyer SOAP API and legacy AdX UI will be sunset in January, 2016. After the API is sunset, all static bidding campaigns will be terminated, and requests against any version of the API from AdX accounts will result in an error response. In addition, the legacy AdX UI will no longer be accessible.

As an alternative to the SOAP API, we recommend using the DoubleClick Ad Exchange Hosted Bidding solution. Similar to the static bidding functionality offered by the SOAP API and legacy UI, Hosted Bidding allows you to bid on Ad Exchange inventory without an external real-time bidding platform. At this time, Hosted Bidding is only accessible as a UI that can be found by signing in to your Ad Exchange Account and clicking the Hosted Bidding tab. To learn more, read the Hosted Bidding guide.

These sunsets will not affect real-time bidding applications. All features required to configure real-time bidding campaigns were migrated to the DoubleClick Ad Exchange Buyer REST API when we updated our pretargeting capabilities in July 2014.

If you have any comments or questions about the upcoming sunset, feel free to contact us via the forum or our Ads Developer G+ page.

We’ve just released the Budget resource for the DoubleClick Ad Exchange Buyer REST API, which can be used to set a daily budget for your real-time bidding campaigns. Each PretargetingConfig will have an associated Budget that it is mapped to via the billingId. Once a PretargetingConfig meets or exceeds the budgetAmount set by its Budget, it will no longer receive bid requests for the remainder of the day. Additional information about this resource can be found in the guide.

The Budget resource in the REST API and the BudgetService in the SOAP API can be used interchangeably; however, we recommend that you use the REST API for managing the budgets of your real-time bidding campaigns.

If you have any questions or comments about the Budget resource, please contact us via the forum or our Ads Developer G+ page.

Today we’re announcing the deprecation of v1 and v1.1 of the DoubleClick Ad Exchange Buyer REST API, both of which are scheduled to be sunset on December 1st, 2014. These versions are becoming increasingly less relevant as we expand on the latest and greatest version of the API—currently v1.3. We recommend that you migrate to v1.3 before this date in order to take advantage of the newest functionality and also to continue having uninterrupted access to the API. If you have not migrated from these deprecated versions by December 1st, calls against the API will return an error response.

The vast majority of users have already migrated to newer versions of the API, but if you’re among the few who haven’t, we expect it to be an easy upgrade because newer versions still support all of the resources you’re familiar with. The only changes that could cause a code break when migrating from v1 to v1.3 are in the Creatives resource; the adgroup_id field was removed and the disapprovalReasons field is no longer a list of strings. You can use the following resources to help you with your migration:
  • Release Notes: A listing of all changes between versions of the API.
  • Code Examples: Examples demonstrating how to use the client libraries with the most recent version of the API.
  • Developer Guides: Guides covering the most recent version of the API.
Of course, if you have any questions or need help with the migration, feel free to reach out to us via the forum or the Ads Developers G+ page.

If you are running DoubleClick Ad Exchange Real-Time Bidding campaigns, you can now use the Snippet Status Report Generator to obtain a Snippet Status Report for your creatives. The Snippet Status Report contains the approval status of your creatives, as well as the sensitive and product categorization that Ad Exchange automatically detects. The Snippet Status Report Generator produces reports using the Ad Exchange Buyer REST API.

There are three versions of this report available through the generator: a human readable text format, a binary protocol buffer format, and a spreadsheet-friendly CSV format. The text and protocol buffer version of the report can also be obtained via Google Cloud Storage. The CSV version can be used with spreadsheet programs such as Google Sheets, Microsoft Excel or LibreOffice Calc:

The Snippet Status Report Generator is available on GitHub as a python program. You are encouraged to download it and make modifications to generate reports in your desired format.

If you have any questions or feature requests for the Snippet Status Report Generator, please create an issue on the project’s issues page.

For any questions about the Ad Exchange Buyer API, visit us on the forum or our Google+ page.

DoubleClick Ad Exchange is improving its pretargeting system by creating a new user interface and API resource to configure the inventory your bidder sees. These changes will only impact your RTB campaigns; non-RTB campaigns will continue to be managed as they were before.

Upgrades will begin in mid-July 2014 and all accounts will be upgraded by the end of September 2014. The new functionality has been added to the v1.3 REST API but will be read-only until your account has been upgraded. For additional information, please review the new resource reference and pretargeting guide.

Note that once your account has been upgraded you will still have access to the SOAP API for reporting, budgeting and non-RTB campaigns, but you will no longer be able to use it for pretargeting. If you need the ability to manage your pretargeting settings via the API, then you must use the latest AdX REST API.

If you have questions about these upcoming changes please contact your account manager. For questions about the Ad Exchange Buyer API, check out the Ad Exchange Buyer API forum. Follow our Google+ page for other announcements and updates.

Whether you’re just starting out with the DoubleClick Ad Exchange Buyer REST API or are working with an unfamiliar client library, our examples will help you get started! Our examples are now on GitHub and have been expanded to cover the following languages:

Whether you’re just starting out with the DoubleClick Ad Exchange Buyer REST API or are working with an unfamiliar client library, our examples will help you get started! Our examples are now on GitHub and have been expanded to cover the following languages:

Each of these include documentation to help you get started with the corresponding client library and demonstrate how you can use the Service Account authorization flow with the DoubleClick Ad Exchange Buyer REST API.

If you have any feedback or feature requests for these examples, we’d definitely be interested in hearing about it! Feel free to contact us via the forum or our Google+ page.

The end of the year is always the busiest time for advertisers, and competition for inventory in Ad Exchange is at it’s peak. Are you doing everything you can to ensure your campaigns are delivering on time and on budget?

The end of the year is always the busiest time for advertisers, and competition for inventory in Ad Exchange is at it’s peak. Are you doing everything you can to ensure your campaigns are delivering on time and on budget?

To lighten the load this holiday season, optimize your ad serving with these simple steps:

Plan ahead for the busiest time of the year
Make a resolution to start planning your seasonal campaigns earlier. Submit your creatives for approval two days before going live and make sure you’re using only certified vendors and declaring them when necessary. The set of allowed vendors and whether they are declarable can be determined using the vendor declaration tool found in the help centre article Declaring 3rd- and 4th-party vendors in the Ad Exchange. Any vendor not on the list in the tool is prohibited As a proactive measure, buyers can use the creative REST API to submit an ad creative for review, to check its status and retrieve a list of all active ad creatives. Be sure your ads are approved before bidding to ensure your campaigns deliver.

This year, the REST API has been updated with a new method allowing creatives to be sent for re-review. Should any creatives get disapproved before the start of your seasonal campaign, it is not a requirement that the buyer creative ID change to get the creative re-reviewed. To make use of this feature, use version 1.3 of the REST API.

Make sure your ad creatives are eligible to serve
The last thing you want this time of the year is for your ad creatives to be disapproved. To make sure your campaigns aren’t delayed, make sure to avoid these common policy mistakes:

  • Declare the Correct URL/Multiple URLs: please make sure you have declared the URL that the ad leads to. If you have several URLs for the same ad, they all must be declared.
  • Creative Borders: On all .gif and .swf ads with partially black or white backgrounds, you must add a visible border of a contrasting color to the majority background color of the ad.
  • Content Violations: Remember that Ad Exchange is “family-safe” content only. Therefore, ads that are classified as “limited family safe”, “non-family safe”, and “adult” are not allowed (unless you are participating in the Restricted Category Beta for Alcohol).
  • Fourth Party Calls: if you use fourth-party vendors, please make sure they are certified by Google. You can check which vendors are certified and which need to be declared here.
  • Over-animation: Please make sure your total animation time does not exceed 30 seconds. For looping or repeating animations, the total combined interval time can not exceed 30 seconds. After an animation has stopped, it cannot restart. Read the full policy here.

Review the AdX Buyer Program Guidelines and Ad Exchange Policies and Enforcement Help Center page for additional details.

Ensure your bids make it to the auction (RTB buyers only)
Each bid response submitted to Ad Exchange undergoes a screening process before it can enter the live auction. During this process, your bid may be filtered out by Google, the publisher, or during the actual auction for many different reasons.

To ensure your bid is not filtered, remember to always review the following:

  1. Disapproved ads in the snippet status report
  2. Excluded dimensions in the publisher settings report
  3. Publisher’s min CPM requirement in the bid request

You can read more about post-filtered bids in our developer blog.

As part of your preparation for a smooth running seasonal campaign, make use of the new RTB Dashboard - a tool designed to bring greater transparency to you, as a buyer, and help you refine your bidder to produce more efficient bidding and better results for your campaigns. With RTB Dashboard, you have the ability to review the “RTB insights” section which helps you understand which bids are being filtered out and why.

Plan ahead to make the end of year a success
Nobody wants to start the new year with an unexpected surprise. So, after checking that your ad creatives are approved, make sure your campaigns continue into the new year by reviewing the items below:

  • Campaign End Date: Make sure you’ve set correct campaign end date set. You don’t want to come back from the holidays to find your campaigns switched off by mistake because the end date was set to the default date, 12/31/12.
  • Budgets: Take some time to review campaign budgets before heading out to that holiday party. CTRs remain high throughout these festive times and into the new year and it’s a good idea to plan ahead to ensure budgets don't run out early.

Need help over the holidays?
Hopefully everything goes as planned this holiday season, but if any emergencies like UI outages or major drops in RTB traffic come up, our U.S. support teams will be on hand to make sure you’re back up and running. Please note the U.S. Google offices will be closed on the following days:

  • Tuesday December 24th
  • Wednesday December 25th
  • Tuesday December 31st
  • Wednesday January 1st

If you follow these best practices, you can focus on other initiatives on your wishlist (e.g. mobile, video).

We've recently made several enhancements to version v1.3 of the DoubleClick Ad Exchange Buyer REST API. To make it even easier for buyers to work with the DoubleClick Ad Exchange, our team is improving the functionality of our APIs. Today we would like to let you know about some recent enhancements to version v1.3 of the Ad Exchange Buyer REST API. Below are the details of the new features and stay tuned for more releases over the coming year.

We've recently made several enhancements to version v1.3 of the DoubleClick Ad Exchange Buyer REST API. To make it even easier for buyers to work with the DoubleClick Ad Exchange, our team is improving the functionality of our APIs. Today we would like to let you know about some recent enhancements to version v1.3 of the Ad Exchange Buyer REST API. Below are the details of the new features and stay tuned for more releases over the coming year.

Performance Report Resource

A new resource, performanceReport, has been added. This resource is an improvement on the existing CSV performance reports. You can now use the API to view these reports in JSON format and without having to interface with Google Cloud Storage. These reports are aggregated over 5 minute intervals rather than the 1 minute intervals that the CSV reports use.

Creatives Resource

We’ve improved the creatives resource with the addition of two new sets of fields: filtering reasons and corrections. The filteringReasons are intended to give you better insight into why some snippets have been filtered out of the auction. The Buyer REST API will show you the metrics for the previous day. If you’d like to see longer term filtering metrics, they can be found in the Snippet Status Report.

The corrections field is intended to help you correctly submit creative declarations. We recommend using our corrections as feedback to update your application to submit the right attributes, ensuring your ads serve correctly and on time.

You can always find a listing of the latest updates on our release notes page. Your feedback and questions are welcome on our forum or Google+ Page. Let us know what you think!

Today we’re announcing the v1.3 release of the Ad Exchange Buyer REST API. This release improves the behavior of creative submission by allowing you to resubmit creatives with the same buyer creative ID. If you resubmit a creative with the same ID, the new creative will replace the old and will initiate a new review. Additional information about the changes implemented in v1.3 can be found in our release notes and in the reference documentation.

You can contact us on our forum to discuss these changes, and to keep informed on all of our ads-related technologies, follow the Google Ads Developers Google+ page.

We’re pleased to announce that version 1.2 of the Ad Exchange Buyer REST API is now available. This release provides one of the most requested features— detailed creative disapproval reasons. Additionally, it also provides a new field for creatives that can be used to identify the agency providing the creative and a new field for direct deals that can be used to determine whether a deal originated from a private auction. You may view a more specific listing of the changes implemented in v1.2 in our release notes.

We’re pleased to announce that version 1.2 of the Ad Exchange Buyer REST API is now available. This release provides one of the most requested features— detailed creative disapproval reasons. Additionally, it also provides a new field for creatives that can be used to identify the agency providing the creative and a new field for direct deals that can be used to determine whether a deal originated from a private auction. You may view a more specific listing of the changes implemented in v1.2 in our release notes.

Detailed Creative Disapproval Reasons

The Creatives resource now has an improved disapprovalReasons field. Previously, this field provided a list of strings that described the reason for disapproval in a broad context that may have been somewhat ambiguous. Each element of disapprovalReasons now provides two additional fields— reason and details. One can use disapprovalReasons.reason in order to access a categorized reason for disapproval, or use disapprovalReasons.details to retrieve a list of strings describing the disapproval reason in detail.

Identify Where Your Ads Came From

Publishers now have greater control over their inventory— e.g. with the new inventory management system, they may set rules that could offer special pricing or limit access to a specific set of creative agencies. With the new agencyId field, you can identify the creative agency that produced the ad with one of the IDs listed in agencies.txt, and consequently gain access to publisher inventory that utilizes these features.

Determine Your Eligibility for Private Auction Deals

We’ve given publishers the ability to create private auction deals, which you can read more about in our help center. You can now determine whether you have a fixed price deal or private auction deal by checking the private_exchange_min_cpm field— if it is set instead of the fixed_cpm field, you have a private auction deal. When you bid on ad slots from the publisher offering this deal, you are expected to offer at least the amount provided by this field.

You can read more about the new features in the Buyer REST v1.2 documentation. As always, we welcome you to join us on our forum to discuss and ask questions about these changes. To keep informed on all of our ads-related technologies, follow our Google Ads Developers Google+ page.

Update: Ad Exchange will be affected by the downtime as well. Please see below for details.

As previously mentioned, we have an upcoming AdWords, Ad Exchange, and DFP service outage. This will occur on Saturday, September 22 -- AdWords, Ad Exchange, and DFP systems will be unavailable from approximately 10:00 am to 8:00 pm Pacific Time (17:00 Saturday to 03:00 Sunday GMT) due to system maintenance.

AdWords
During this time, your campaigns will continue to run as usual (with the settings you established as of 10am PST), but you won’t be able to make SOAP API calls or download reports. Requests to the AdWords API will fail with an HTTP 50x error during the maintenance window. Please also keep in mind that any automated rules scheduled during this time will not run and AdWords scripts will not execute during this period. We encourage you to verify your campaign settings prior to the outage.

Ad Exchange
During this time, your ad serving will continue to run per changes made prior to downtime period, but you will not be able to make API calls to Ad Exchange Buyer SOAP API. On Ad Exchange Buyer REST API, only the Direct Deals related API calls will be affected. For the Ad Exchange Real-Time Bidding Protocol, you will not be able to make changes to pre-targeting settings, everything else should continue to run as usual.

DFP
As mentioned above, ad serving will continue to run per changes made prior to the downtime period. If you use the audience feature in your network, any API call to the AudienceSegmentService service will fail with a SegmentError.UNEXPECTED_ERROR error. Also, if you target any audience segments in your line items, any calls to LineItemService, ForecastService, or LineItemCreativeAssociationService that involve those line items will fail.

We apologize for any inconvenience, and appreciate your patience as our engineers work to keep AdWords, Ad Exchange, and DFP running smoothly.

Version 1.1 of the Buyer REST API has been released bringing the following changes:

  • A list method has been added for the Creatives resource. 
  • The adgroupId has been removed from the Creatives resource. 
  • A region property has been added to the bidderLocation[] object. 

Creatives.List Method added 
The list method retrieves a list of all of the authenticated user's active creatives. Optional parameters allow you to set the maximum number of Creatives resources to return each time you call the method. You can also filter the contents of the list by the status of creatives, for example to restrict the contents of the list to those ads that have been approved. Valid status values are approved, disapproved, and not_checked.

Removed adgroupId property 
Beginning with Version 1.1 of the Buyer REST API, the adgroupId will no longer be returned from method calls. In addition, passing the adgroupId value to a Creatives method will raise an error. However, a creative submitted through the API can be used to respond to a pretargeting match for any ad group. The removal of this value means that the key to uniquely identify a creative now consists of accountId + buyerCreativeId.

Added region property to bidderLocation[] 
The bidderLocation[] list in the Account resource now includes a third value. The region property describes the region for the bidder location. You can contact your customer representative to determine whether or not your account is in the new quota system.

The value of region describes the geographical region from which the Ad Exchange should send requests. This value is used by the new quota system. Allowed values:

  • ASIA 
  • EUROPE 
  • US_EAST 
  • US_WEST 
 -- Irene Smith, Ad Exchange Team

The Ad Exchange Team is excited to make this set of resources available to our developer community. Below you’ll find new and better ways to work with the Ad Exchange. If you have any questions or feedback, please contact us via the forum.

New website
  • Built on top of Google’s new developers platform developers.google.com, we’ve created a new site for our community. There you’ll find docs for the real-time bidding (RTB) protocol, the REST API and the SOAP API. Plus, we’ve revamped the docs to make them easier to use and understand. 
Access to the Ad Exchange REST API
  • This API gives you the ability to manage your RTB account configurations, submit creatives and list direct deals. Contact your technical account representative to set up access to the API. Then, try it out before you write a line of code, using the API explorer
Client library support and code examples in major programming languages 
  • Trying out the client libraries first might save you a lot of time compared to coding directly against the APIs. Also, check out our code examples in your preferred programming language for both the SOAP and REST APIs. 
Access to the Ad Exchange Buyer API’s Forum 
  • The Ad Exchange Buyer APIs Forum is a Google-monitored environment for public discussions where you can ask - and, if you like, answer - questions regarding the REST and SOAP APIs.