Release notes

This page provides release notes for the Google Bid Manager API.

Latest API version: v2

November 20, 2024

New features

The FILTER_UNIQUE_REACH_SAMPLE_SIZE_ID is launched. This allows the inclusion of lower confidence data for metrics with the following prefixes:

• METRIC_UNIQUE_REACH_
• METRIC_VIRTUAL_PEOPLE_DUPLICATE_
• METRIC_VIRTUAL_PEOPLE_EXCLUSIVE_
• METRIC_VIRTUAL_PEOPLE_OVERLAP_

One of the relevant metrics must be included when using this filter.

Upon launch, queries that don't include this filter will default to the previous default behavior of only including high-confidence data. On and after February 4, 2025, queries that do not include this filter will default to include lower-confidence data.

v2

• The following filters have been added:

  Filter Type	Available values
  FILTER_UNIQUE_REACH_SAMPLE_SIZE_ID	0: Include lower-confidence data. (Default after February 4, 2025) 1: Only include high-confidence data. (Default before February 4, 2025)

October 1, 2024

New features

None.

Known issues

v2

Sunset of Anonymous Inventory Modeling (AIM) reporting dimension

The FILTER_ANONYMOUS_INVENTORY_MODELING dimension is sunset.

Creating or running Query resources using sunset values in params.groupBy returns a 400 error.

DST/ROC (Regulatory Operating Costs) and Total Media Cost metrics made incompatible with YOUTUBE reports.

The following metric values can no longer be used in YOUTUBE reports:

• METRIC_TOTAL_MEDIACOST_ADVERTISER
• METRIC_TOTAL_MEDIACOST_ECPAPC_ADVERTISER
• METRIC_TOTAL_MEDIACOST_ECPAPC_PARTNER
• METRIC_TOTAL_MEDIACOST_ECPAPC_USD
• METRIC_TOTAL_MEDIACOST_ECPAPV_ADVERTISER
• METRIC_TOTAL_MEDIACOST_ECPAPV_PARTNER
• METRIC_TOTAL_MEDIACOST_ECPAPV_USD
• METRIC_TOTAL_MEDIACOST_ECPA_ADVERTISER
• METRIC_TOTAL_MEDIACOST_ECPA_PARTNER
• METRIC_TOTAL_MEDIACOST_ECPA_USD
• METRIC_TOTAL_MEDIACOST_ECPCV_ADVERTISER
• METRIC_TOTAL_MEDIACOST_ECPCV_PARTNER
• METRIC_TOTAL_MEDIACOST_ECPCV_USD
• METRIC_TOTAL_MEDIACOST_ECPC_ADVERTISER
• METRIC_TOTAL_MEDIACOST_ECPC_PARTNER
• METRIC_TOTAL_MEDIACOST_ECPC_USD
• METRIC_TOTAL_MEDIACOST_ECPM_ADVERTISER
• METRIC_TOTAL_MEDIACOST_ECPM_PARTNER
• METRIC_TOTAL_MEDIACOST_ECPM_USD
• METRIC_TOTAL_MEDIACOST_PARTNER
• METRIC_TOTAL_MEDIACOST_USD
• METRIC_TOTAL_MEDIACOST_VIEWABLE_ECPM_ADVERTISER
• METRIC_TOTAL_MEDIACOST_VIEWABLE_ECPM_PARTNER
• METRIC_TOTAL_MEDIACOST_VIEWABLE_ECPM_USD
• METRIC_FEE32_ADVERTISER
• METRIC_FEE32_PARTNER
• METRIC_FEE32_USD

Creating or running Query resources with a params.type of YOUTUBE and a relevant metric value in params.metrics returns a 400 error.

May 1, 2024

New features

None.

Known issues

v2

Sunset of Full Path and Path Attribution Reports

Full Path and Path Attribution reports are sunset. Retrieving or creating these types of Query and Report resources results in an error.

The following ReportType values are sunset:

• FULL_PATH
• PATH_ATTRIBUTION

The pathQueryOptions field of the Options object is also sunset.

February 28, 2024

New features

None.

Known issues

v2

Sunset of cross-device conversion metric values

Cross-device conversion metrics are sunset. The following Bid Manager API metric values are included:

• METRIC_CM360_POST_CLICK_REVENUE_CROSS_ENVIRONMENT
• METRIC_CM360_POST_VIEW_REVENUE_CROSS_ENVIRONMENT
• METRIC_POST_CLICK_CONVERSIONS_CROSS_ENVIRONMENT
• METRIC_POST_VIEW_CONVERSIONS_CROSS_ENVIRONMENT
• METRIC_TOTAL_CONVERSIONS_CROSS_ENVIRONMENT

July 6, 2022

New features

Released Bid Manager API v2.

Made structural changes to the API, including updating the service endpoint and renaming services and methods.

Significantly updated Query and Report resources by removing unnecessary fields, reorganizing existing fields, and changing field types. This includes changing field types to use named objects instead of a general "nested object" definition.

Required running ad-hoc queries using the queries.run method instead of having them run automatically after creation.

Replaced the queries.run query parameter asynchronous with synchronous.

Simplified report retrieval through the following changes:

• The addition of a queries.reports.get method.
• The addition of an orderBy query parameter to queries.reports.list.
• The update of the queries.run response body from an empty object to an instance of the generated Report resource.

Updated error messages returned by the API to be more specific and provide more prescriptive solutions.

Follow the instructions presented in the v2 Migration Guide to migrate from v1.1 to v2.

v2

• The service endpoint has been changed:

  v1 service endpoint	v2 service endpoint
  https://www.googleapis.com/doubleclickbidmanager	https://doubleclickbidmanager.googleapis.com

• Services have been renamed as follows:

  v1 service	v2 service
  Queries	queries
  Reports	queries.reports

• Methods have been renamed as follows:

  v1 method	v2 method
  Queries.createquery	queries.create
  Queries.deletequery	queries.delete
  Queries.getquery	queries.get
  Queries.listqueries	queries.list
  Queries.runquery	queries.run
  Reports.listreports	queries.reports.list

• The following methods have been added:

  Service	Method(s)
  queries.reports	get

• The following methods have a new response body:

  Method	New response body object
  queries.run	Report

• The following fields have been removed:

  Resource	Field(s)
  queries.list Response Body	kind
  queries.reports.list Response Body	kind
  Query	kind reportDataEndTimeMs reportDataStartTimeMs timezoneCode
  RunQueryRequest	reportDataEndTimeMs reportDataStartTimeMs timezoneCode

• The object type of the following fields have been changed to the following:

  Resource	Field(s)	Object Type
  Query	metadata params schedule	QueryMetadata Parameters QuerySchedule
  Report	key metadata params	ReportKey ReportMetadata Parameters
  RunQueryRequest	dataRange	DataRange

• The following method query parameters have been added:

  Method	Query Parameter(s)
  queries.list	orderBy
  queries.reports.list	orderBy
  queries.run	synchronous

• The following method query parameters have been removed:

  Method	Query Parameter(s)
  queries.create	asynchronous
  queries.run	asynchronous

• The following Filter values have been added:

  Filter value
  FILTER_INVENTORY_MEDIA_COST_TYPE
  FILTER_TARGETING_EXPANSION

• The following Filter values have been removed:

  Filter value
  FILTER_TRUEVIEW_IAR_REGION

• The following Metric values have been added:

  Metric value
  METRIC_STORE_VISIT_VIEW_THROUGH_CONVERSIONS
  METRIC_UNIQUE_REACH_AVERAGE_VIEWABLE_IMPRESSION_FREQUENCY
  METRIC_UNIQUE_REACH_IMPRESSION_REACH_ADDED_WITH_CROSS_STACK_FCAP
  METRIC_UNIQUE_REACH_IMPRESSION_REACH_ADDED_WITH_PG_FMGMT
  METRIC_UNIQUE_REACH_INCREMENTAL_CLICK_REACH
  METRIC_UNIQUE_REACH_INCREMENTAL_IMPRESSION_REACH
  METRIC_UNIQUE_REACH_INCREMENTAL_TOTAL_REACH
  METRIC_UNIQUE_REACH_INCREMENTAL_VIEWABLE_IMPRESSION_REACH
  METRIC_UNIQUE_REACH_VIEWABLE_IMPRESSION_REACH

Known issues

None.

Previous releases

To read about previous Bid Manager API releases for sunset versions, see our archived release notes.