Release Notes

Real-time Bidding API

Version 1.0

Date Notes
October 8, 2020 Replaced fields openAuctionServingStatus, openBiddingServingStatus, dealsServingStatus, chinaServingStatus and russiaServingStatus with networkPolicyCompliance, platformPolicyCompliance, dealsPolicyCompliance, chinaPolicyCompliance and russiaPolicyCompliance respectively. June 24, 2020 Initial launch of the Real-time Bidding API, to eventually replace the Ad Exchange Buyer and Ad Exchange Buyer II APIs. Migration notes.

Legacy versions

Version 2.0

Release Date Notes
8/20/2020

Added the detail field to BidMetricsRow.

5/6/2020

Added the reachedQueries field to BidMetricsRow. Added FATAL_VAST_ERROR and LOST_IN_MEDIATION to the Status enum of NonBillableWinningBidStatusRow.

3/9/2016

Released Client Access as an open beta. You can now let your client buyers directly access the Authorized Buyers Marketplace to be able to view, negotiate, and approve deals. And, your application can programmatically perform operations that previously had to be done manually in the Clients section of the Authorized Buyers Buyer Account Settings tab.

Version 1.4

Release Date Notes
11/11/2019

Added the maximumQps field to the PretargetingConfig resource, allowing bidders to set the maximum QPS allocated to a pretargeting configuration.

1/6/2017

The Creatives resource's DisapprovalReason enum has been updated with the addition of the new value UNSUPPORTED_FLASH_CONTENT, to indicate Flash content found in an unsupported context.

10/14/2016

Added the userIdentifierDataRequired field to the PretargetingConfig resource, allowing buyers to restrict their matches to inventory where certain kinds of user-identifying data are present, without specifying what that data should be. The field takes two options:

  • Buyers with hosted match tables in Authorized Buyers can specify HOSTED_MATCH_DATA to cause that PretargetingConfig to match inventory that allows cookie targeting, and for which the cookie matches something in the buyer's hosted match table.
  • Buyers can also specify COOKIE_OR_IDFA to cause a PretargetingConfig to only match inventory where there's either a targetable cookie or an Identifier For Advertisers (which may replace the cookie in iOS).
2/22/2016

Added the bid_protocol field to the Accounts resource under bidderLocation to enable users to select the real-time bidding (RTB) protocol to be used in communicating with the bidder. The default is the Authorized Buyers real-time bidding protocol. This field is optional for most users, but it is required for OpenRTB bidders with OpenRTB endpoints.

11/9/2015

Added the impression_tracking_url field to the Authorized Buyers bid response to enable correct tracking of when an impression is actually rendered by the Google Ads SDK. This is supported for all inventory types and all formats except for VAST video.

Deprecated the native impression_tracking_url field (field 9 in the bid response). The general impression_tracking_url (field 19) should be used instead.

9/4/2015 Added support for apiUploadTimestamp to the Creatives resource. This field provides the last upload timestamp of a creative (in RFC 3339 format) if it was uploaded via API.
9/4/2015 Added the ability to submit Native Ads via the nativeAd property of the Creatives resource.
8/1/2015 Deprecated the "Direct Deals" service.
7/20/2015 Updated the Creatives resource to provide more detail about its status. Removed the status field and replaced it with dealsStatus and openAuctionStatus. Removed the disapprovalReasons field and replaced it with servingRestrictions.

Version 1.3

Release Date Notes
11/11/2019

Added the maximumQps field to the PretargetingConfig resource, allowing bidders to set the maximum QPS allocated to a pretargeting configuration.

9/4/2015 Added support for apiUploadTimestamp to the Creatives resource. This field provides the last upload timestamp of a creative (in RFC 3339 format) if it was uploaded via API.
12/2/2014 Added the Budget resource that allows you to get or update the budget of a specific ad group.
9/22/2014 Adds the new field publisherBlocksOverridden to the DirectDeals resource.
9/2/2014 Adds the new field billingId to the PretargetingConfig resource.
8/12/2014 Adds the BillingInfo resource that allows you to retrieve an account's adgroups that could show up as part of a BidRequest.
6/10/2014 Adds the PretargetingConfig resource that allows you to pre-target impressions so that Authorized Buyers will send you only the requests for impressions that match your pre-targeting criteria.
1/17/2014 Includes a new performance report API that allows you to retrieve performance metrics.
8/23/2013 Allows you to reuse buyer creative IDs. If you submit a new creative with the buyer creative ID for an existing creative, the new creative replaces the existing creative and will be reviewed.

Version 1.2

The following new features were added for Version 1.2 of the Ad Exchange Buyer API:

Detailed Creative Disapproval Reasons
Rather than returning a list of strings when a creative has been disapproved, the disapprovalReasons list will contain one or more DisapprovalReasons objects with the following fields:
FieldDescription
reasonThe categorized reason for the disapproval.
details[]Details on why this ad was disapproved for the categorized reason.
New agencyId field
The new agencyId field allows you to identify the agency that produced the ad using the IDs in the agencies.txt file.

The following feature was backported to Version 1.2 of the Ad Exchange Buyer API on 9/4/2015:

  • Added support for apiUploadTimestamp to the Creatives resource. This field provides the last upload timestamp of a creative (in RFC 3339 format) if it was uploaded via API.

Version 1.1

The following changes have been made for Version 1.1 of the Ad Exchange Buyer API:

  • A list method has been added for the Creatives resource. The new method will retrieve a list of all of the active creatives for the currently authenticated user with optional filtering by creative status.
  • The adgroupId has been removed from the Creatives resource. This value will no longer be accepted or returned from the Creatives resource's methods.
  • The bidderLocation[] list in the Account resource now includes a third value. The region property describes the region for the bidder location.

Buyer API v1.1 is deprecated on December 9, 2014.

Version 1

The initial version of the API. There are no special notes.

Buyer API v1 is deprecated on December 9, 2014.