Google Ads Developer Blog

Sunset date for deprecated DBM API services postponed to April 15, 2021

2021-02-23T12:21:00.000-08:00

The sunset of deprecated services in the DoubleClick Bid Manager (DBM) API, originally scheduled for February 26, 2021, has been postponed to April 15, 2021. The deprecated services scheduled for sunset include the entirety of DBM API v1, the DBM API v1.1 SDF Download service, and the DBM API v1.1 Line Item service.

Prior blog posts regarding this sunset give instructions on how to migrate from these deprecated services to either the DBM API v1.1 Reporting service or the Display & Video 360 (DV360) API. Consult these previous announcements for more information.

If you encounter issues with your migration or want to report a separate issue, please contact us using our support contact form.

- Trevor Mulchay, Display & Video 360 API Team

Upcoming sunset for DBM API v1, SDF Download and Line Item services

2020-11-30T11:23:00.000-08:00

As announced in August, deprecated services in the DoubleClick Bid Manager (DBM) API, comprised of DBM API v1, the DBM API v1.1 SDF Download service, and the DBM API v1.1 Line Item service, will be sunset on February 26, 2021.

If you are still using the DBM API v1 Reporting service, you must migrate to the DBM API v1.1 Reporting service before the sunset date to avoid an interruption of service. Consult the API release notes for details of the changes between v1 and v1.1. Differences to note during this migration include:

Queries created and accessed through the Reporting service require more specific filters in the params.groupBy field in v1.1. You might have to add more values to the params.groupBy field in order to create the same report structure generated in v1.
Responses from queries.listqueries and reports.listreports calls are paginated in v1.1. You have to update your implementation to traverse multiple pages if you want to consume more than the first 100 items returned.

If you are using any version of any other DBM API service, you must migrate to the Display & Video 360 (DV360) API.

The DBM API SDF Download service is being replaced by the DV360 API asynchronous SDF Download service. It features new filter options and a new download format.
The DBM API Line Item service is being replaced by the DV360 API Line Item service. This service provides create, update, and delete methods for line items using a more easily managed REST Line Item resource, separate from Entity Write File format currently used in the DBM API.

Guides are available to help you set up and start using the Display & Video 360 API to download SDFs and manage your line items.

If you encounter issues with your migration or want to report a separate issue, please contact us using our support contact form.

- Trevor Mulchay, Display & Video 360 API Team

DoubleClick Bid Manager API upgrading authorization scope to "sensitive"

2020-09-30T11:41:00.000-07:00

On October 1, 2020, we are upgrading the classification of the authorization scope used for the DoubleClick Bid Manager API ( https://www.googleapis.com/auth/doubleclickbidmanager ) to “sensitive”. This upgrade is taking place to better secure the DBM API and the data retrieved from it.

Starting on October 1st, all unverified apps that are using the DBM API for the first time will encounter an “unverified app screen” upon attempted authentication. This screen can be removed by submitting your app to our verification process. This process usually takes about 3 to 5 business days. Information on how this process fits in the larger task of authorizing requests can be found in our guide.

Existing apps that began using the DBM API scope before October 1st will not see the “unverified app screen” and will not immediately need to go through the verification process. However, all apps accessing sensitive scopes will require explicit verification before the end of 2021. In anticipation of this requirement, it is recommended that existing apps complete the verification process at their earliest convenience.

If you run into issues or need help with this process, please contact us using our support contact form.

- Trevor Mulchay, Display & Video 360 API Team

Sunset of DBM API v1, SDF Download and Line Item services

2020-08-27T10:59:00.000-07:00

Today we’re announcing the deprecation of the Doubleclick Bid Manager (DBM) API v1.1 Line Item service and the sunset of all deprecated DBM API services on February 26, 2021. Deprecated DBM API services include the entirety of DBM API v1 and DBM API v1.1 Structured Data File (SDF) Download service. This sunset was originally scheduled for June 15, 2020, but was postponed due to COVID-19.

Refer to the table below to verify if the methods you are currently using will be available in v1.1 after February 26, 2021:

Service	Methods	Available in v1.1 after February 26, 2021?
Reporting	queries.createquery queries.deletequery queries.getquery queries.listqueries queries.runquery reports.listreports	Yes
Line Item	lineitems.downloadlineitems lineitems.uploadlineitems	No. Use the new Display & Video 360 API instead.
SDF Download	sdf.download	No. Use the new Display & Video 360 API instead.

If you are still using the DBM API v1 Reporting service, you must migrate to v1.1 by the sunset date to avoid an interruption of service. Consult the API release notes for the finer details of the changes between v1 and v1.1. Differences to note during this migration include:

Queries created and accessed through the Reporting service require more specific filters in the params.groupBy field in v1.1. You might have to add more values to the params.groupBy field in order to create the same report structure generated in v1.
Responses from queries.listqueries and reports.listreports calls are paginated in v1.1. Users have to update their implementation to traverse multiple pages if they wish to consume more than the first 100 items returned.

If you are using any version of any other DBM API service, you must migrate to the Display & Video 360 (DV360) API.

The DBM API SDF Download service is being replaced by the DV360 API asynchronous SDF Download service. It features new filter options and a new download format.
The DBM API Line Item service is being replaced by the DV360 API Line Item service. This service provides create, update, and delete methods for line items using a more easily managed REST Line Item resource separate from Entity Write File format currently used in the DBM API.

Guides are available to help you set up the Display & Video 360 API and get started using it to download SDFs and manage your line items.

If you encounter issues with your migration or want to report a separate issue, please contact us using our support contact form.

- Trevor Mulchay, Display & Video 360 API Team

Stricter field validation implemented for Doubleclick Bid Manager API

2020-08-24T10:13:00.000-07:00

Beginning in June 2020, we rolled out stricter validation of long and integer request fields in the Doubleclick Bid Manager (DBM) API. This rollout finished in early August and now applies to all traffic.

This new request validation no longer allows the use of decimals in string values submitted for long and integer field types. Previously, an integer field in a request body would accept, for example, “123.0” as a permissible value. Now, identical requests will return an HTTP 400 error with status INVALID_ARGUMENT.

Before the implementation of this validation, the API truncated invalid values at the decimal point and the digits after it were ignored. You can replicate this previous behavior by truncating values at the decimal place before making a request.

Verify that your code converts values with decimals to longs and integers. If you receive an INVALID_ARGUMENT error, make sure your numbers are actual longs or integers.

If you need help adjusting for this new validation or want to report a separate issue, please contact us using our support contact form.

- Trevor Mulchay, Display & Video 360 API Team

Postponement of DBM API v1 and SDF Download Service Sunset

2020-05-15T12:06:00.000-07:00

We’re officially postponing the planned sunset of the Doubleclick Bid Manager (DBM) API v1 and the DBM API v1.1 Structured Data File (SDF) Download service.

Originally scheduled for June 15, 2020, we are delaying the sunset indefinitely in order to account for the difficulties many users are facing due to COVID-19. We’re hoping that this postponement frees up room for users to address more immediately pressing issues. An updated sunset schedule will be announced at a later date.

Although a sunset date is no longer scheduled, these services are still deprecated and migrations to DBM API v1.1 and the Display & Video 360 (DV360) API are recommended.
- Trevor Mulchay, Display & Video 360 API Team

Deprecation of DBM API v1 and SDF Download Service

2020-03-18T13:56:00.000-07:00

Today we’re announcing the deprecation of the Doubleclick Bid Manager (DBM) API v1 and the DBM API v1.1 Structured Data File (SDF) Download service. These services will no longer be supported and will be fully sunset on June 15, 2020. Refer to the table below to verify if methods you’re using will be available in v1.1 after June 15, 2020:

Service	Methods	Available in v1.1 after June 15, 2020?
Reporting	queries.createquery queries.deletequery queries.getquery queries.listqueries queries.runquery reports.listreports	Yes
Line Item Settings	lineitems.downloadlineitems lineitems.uploadlineitems	Yes
SDF Download	sdf.download	No. Use the new Display & Video 360 API instead.

If you are using the DBM API v1 Line Item Settings service or Reporting service, you must migrate to v1.1 by the sunset date to avoid an interruption of service. Consult the API release notes for the finer details of the changes between v1 and v1.1. Important things to know are:

Queries created and accessed through the Reporting service require more specific filters in the params.groupBy field in v1.1. You might have to add more values to the params.groupBy field in order to create the same report structure they generated in v1.
Responses from listqueries and listreports calls are paginated in v1.1. Users have to update their implementation to traverse multiple pages if they wish to consume more than the first 100 items returned.
The Line Item Settings service had no changes between v1 and v1.1. Users only have to update the version they are using.

The SDF Download service is deprecated in DBM API v1 and v1.1. Users should immediately migrate to the new Display & Video 360 API, which was released earlier this week. The Display & Video 360 API offers a new asynchronous SDF Download Service featuring new filter options and a new download format compared to its DBM API counterpart.

Guides are available to help you set up the new Display & Video 360 API, as well as use it to get started downloading SDFs.

- Trevor Mulchay, Display & Video 360 API Team

Introducing Display & Video 360 API v1

2020-03-09T10:04:00.000-07:00

Today we’re releasing the Display & Video 360 API v1. It offers a new, improved way to interact with your Display & Video 360 resources programmatically.

This initial API release includes new asynchronous Structured Data File (SDF) download functionality. This allows for the generation and downloading of large SDFs without worrying about individual API requests timing out. This is a change compared to the existing DoubleClick Bid Manager (DBM) API SDF Download service. Along with this change, other major changes include:

New default version logic that utilizes the default version of the partner or advertiser specified by the user.
New filter capabilities, including the ability to specify the exact resources to include in the generated files.
New response format that returns the generated SDFs as a .zip file to download, rather than JSON.

The Display Video 360 API SDF Download service will be replacing the DBM API SDF Download service. The deprecation of that service will be announced soon, and an immediate migration to the new API is advised. You can get started setting up the Display & Video 360 API here, and downloading Structured Data Files here.

More functionality will be coming to the Display & Video 360 API in the coming months, including line item management and targeting. Keep an eye out for future announcements!

- Trevor Mulchay, Display & Video 360 API Team

Announcing v1.1 of the DoubleClick Bid Manager API

2019-11-19T11:23:00.000-08:00

We are pleased to announce the release of version 1.1 of the DoubleClick Bid Manager API. The full v1.1 API documentation can be found here.

Major changes

This release contains two major changes that affect the API methods queries.createquery, queries.getquery, queries.listqueries, and reports.listreports. All other API methods remain unchanged.

One-to-one API filters to report column mappings

In v1, some report columns were not mapped to any API filters and could only be included indirectly by adding related API filters in createquery. For example, in v1, report column “Advertiser Integration Code” could only be accessed by including API filter FILTER_ADVERTISER in calls to createquery.

Starting with v1.1, a new API filter FILTER_ADVERTISER_INTEGRATION_CODE maps to report column “Advertiser Integration Code”, and it is no longer automatically included when using FILTER_ADVERTISER. Instead, this new filter needs to be added to the report explicitly.
Refer to the v1.1 API filter documentation for a full list of the new API filters.

Pagination support

In v1, listqueries and listreports attempted to retrieve all Queries and Reports and would time out if there were too many resources to return. Starting with v1.1, responses from these two methods are paginated, making all resources retrievable.

Refer to the v1.1 API release notes for more details.

- DBM API Team

Structured Data Files v5 now available in the DoubleClick Bid Manager API

2019-09-03T10:01:00.000-07:00

Today we're announcing the general availability of Structured Data Files (SDF) v5 in the DoubleClick Bid Manager API. Highlights of this release include:

Updates to environment targeting
TrueView for action
Regional location list targeting
Deal simplification updates
IO-level budget optimization

As previously announced, this release introduces a number of breaking changes to SDF v3.1, v4, v4.1, and v4.2. All existing SDF users who rely on legacy targeting fields must now migrate in order to make use of the new, enhanced targeting fields in SDF v5.

Retiring older API versions

We're also introducing a new deprecation schedule and announcing the deprecation of all SDF versions prior to v5. Moving forward, we will generally only support 3 versions of SDF at a time and sunset the oldest version 4 months after a new release. In order to help developers adjust to this new schedule, we're providing an extended migration period for these newly deprecated versions and announcing a sunset date of February 28, 2020 for SDF v3.1, v4, v4.1, and v4.2.

These versions will remain active and supported until the sunset date, and we encourage you to use this time to update your applications. After the sunset date, requests to these versions will no longer work, preventing you from accessing SDF.

Get started with SDF v5

All SDF users are encouraged to begin requesting v5 files in order to take advantage of the new features listed above. To do so, simply pass 5 as the value of version when calling Sdf.download. For workflows that are dependent on older SDF formats, you can find additional details about the file format changes in the release notes.

Questions about this or anything else DV360 related? Contact our support team.

- Jonathon Imperiosi, DBM API Team

Upcoming changes to environment and position targeting in DV360

2019-07-01T05:13:00.001-07:00

Update (Aug 8, 2019): Replacement field mappings have been updated to align with changes to the SDF v5 release notes.

On August 26, 2019, we'll be introducing a number of changes to environment and position targeting in Display & Video 360. These changes are being made to allow you to target your ads with increased accuracy and granularity. To learn more about these changes and how they will affect various parts of the Display & Video 360 product, visit the help center.

How will this affect API users?

A new version of Structured Data Files (SDF) will launch alongside these changes, containing new fields that allow you to retrieve and set all of the new targeting options. At the same time, existing SDF versions will be updated to disallow retrieving and setting legacy environment and position targeting options.

The following legacy fields will no longer be populated on download and will return errors on upload for SDF v3.1, v4, v4.1, and v4.2. Suggested SDF v5 replacement fields are provided where applicable.

SDF Entity	Legacy Field	New SDF v5 Field(s)
Campaign	Environment Targeting	Environment Targeting
	Viewability Targeting Ad Position - Exclude	No longer supported
	Viewability Targeting Ad Position - Include	Position Targeting - Display On Screen
Insertion Order	Environment Targeting	Environment Targeting
	Video Ad Position Targeting	Position Targeting - Video Position In Content
	Viewability Targeting Ad Position - Exclude	No longer supported
	Viewability Targeting Ad Position - Include	Position Targeting - Display On Screen
Line Item	Environment Targeting	Environment Targeting
	Video Ad Position Targeting	Position Targeting - Video Position In Content
	Viewability Targeting Ad Position - Exclude	No longer supported
	Viewability Targeting Ad Position - Include	Position Targeting - On Screen

If you are a current user of SDF and rely on any of the legacy fields listed above, you will need to migrate to SDF v5 in order to make use of the new targeting fields. While this SDF version will not be available until August 26, we are providing a preview of the documentation that you can use to prepare.

Questions about this or anything else DV360 related? Contact our support team.

- Jonathon Imperiosi, DBM API Team

Structured Data Files v4.2 now available in the DoubleClick Bid Manager API

2019-03-21T06:05:00.000-07:00

Today we're announcing the general availability of Structured Data Files (SDF) v4.2 in the DoubleClick Bid Manager API. Highlights of this release include:

Support for TrueView connected TV bid adjustments
Ability to inherit Insertion Order start and end dates at the Line Item level
Renaming changes to better align SDF with the Display & Video 360 UI

All SDF users are encouraged to begin requesting v4.2 files to take advantage of these new features. To do so, simply pass 4.2 as the value of version when calling Sdf.download. For users with workflows that are dependent on older SDF formats, details of the file format changes between versions can be found in the release notes.

- Jonathon Imperiosi, DBM API Team

Structured Data Files v4.1 now available in the DoubleClick Bid Manager API

2018-09-18T12:21:00.000-07:00

Today we're announcing the general availability of Structured Data Files (SDF) v4.1 in the DoubleClick Bid Manager API. Highlights of this release include:

Enhanced support for inventory source targeting
Renaming changes to better align SDF with the Display & Video 360 UI

All SDF users are encouraged to begin requesting v4.1 files to take advantage of these new features. To do so, simply pass 4.1 as the value of version when calling Sdf.download. For users with workflows that are dependent on older SDF formats, details of the file format changes between versions can be found in the release notes.

- Jonathon Imperiosi, DBM API Team

Upcoming changes to DBM API reporting

2018-08-22T05:13:00.001-07:00

The week of September 17, 2018, a number of DoubleClick Bid Manager API reporting dimensions and metrics will be renamed. This renaming will modify both API names and column header names in generated report files. These changes are being made to more closely align API field names with their UI counterparts after the recent launch of the Google Display & Video 360 brand. The changes are as follows:

Dimensions

Old API name	Old column header	New API name	New column header
FILTER_ACTIVITY_ID	Conversion Pixel DCM ID	FILTER_FLOODLIGHT_ACTIVITY_ID	Floodlight Activity ID
FILTER_FLOODLIGHT_PIXEL_ID	Conversion Pixel ID	FILTER_DV360_ACTIVITY_ID	DV360 Activity ID
FILTER_MOBILE_DEVICE_MAKE	Mobile Make	FILTER_DEVICE_MAKE	Device Make
FILTER_MOBILE_DEVICE_MAKE_MODEL	Mobile Make and Model	FILTER_DEVICE_MODEL	Device Model
FILTER_MOBILE_DEVICE_TYPE	Device Type	FILTER_DEVICE_TYPE	Device Type

Metrics

Old API name	Old column header	New API name	New column header
METRIC_POST_CLICK_DFA_REVENUE	DCM Post-Click Revenue	METRIC_CM_POST_CLICK_REVENUE	CM Post-Click Revenue
METRIC_POST_VIEW_DFA_REVENUE	DCM Post-View Revenue	METRIC_CM_POST_VIEW_REVENUE	CM Post-View Revenue
METRIC_PIXEL_LOADS	Pixel Load Count	METRIC_FLOODLIGHT_IMPRESSIONS	Floodlight Impressions

To allow users time to prepare for these changes, the new API names listed above will be made available the week of September 3, 2018. Both old and new API names will be supported until October 1, 2018, at which point the old API names will be disabled. Users are advised to use this transitional period to update workflows impacted by this change, to avoid an interruption in service.

If you have questions regarding these changes, please reach out to your Display & Video 360 account team.

- Jonathon Imperiosi, DBM API Team

Structured Data Files v4 now available in the DoubleClick Bid Manager API

2018-04-19T06:24:00.000-07:00

Today we're announcing the general availability of Structured Data Files (SDF) v4 in the DoubleClick Bid Manager API. Highlights of this release include support for:

Bid Multipliers
TrueView bumper ads
Enhanced YouTube tracking
Exchange Targeting settings inheritance

Details of these features and all other changes can be found in the release notes.

All SDF users are encouraged to begin requesting v4 files to take advantage of these new features. To do so, simply pass 4 as the value of version when calling Sdf.download. For users with workflows that are dependent on older SDF formats, details of the file format changes between versions can be found in the release notes.

- Jonathon Imperiosi, DBM API Team

Upcoming changes to DBM report access

2017-07-27T14:41:00.001-07:00

Back in March, we launched the new Report Builder in DoubleClick Bid Manager (DBM). Over the coming months, we'll be migrating all reports from the legacy reporting platform (v1) to Report Builder (v2). This migration will complete on September 25, 2017, at which point access to v1 reporting will be removed. We'll also be disabling access to the Google Cloud Storage buckets used by v1 reporting on that date.

Once the migration to v2 reporting is complete, the only way to access reports programmatically will be via the DBM API. Users who currently access reports through Google Cloud Storage must migrate to using the API before September 25, 2017 to avoid an interruption in service. To learn more and quickly get started with the API, visit our getting started guide.

If you have questions regarding these changes, please reach out to your DoubleClick account team.
- Jonathon Imperiosi, DBM API Team