This page provides release notes for the Google Bid Manager API.
Latest API version: v2
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_ADVERTISERMETRIC_TOTAL_MEDIACOST_ECPAPC_ADVERTISERMETRIC_TOTAL_MEDIACOST_ECPAPC_PARTNERMETRIC_TOTAL_MEDIACOST_ECPAPC_USDMETRIC_TOTAL_MEDIACOST_ECPAPV_ADVERTISERMETRIC_TOTAL_MEDIACOST_ECPAPV_PARTNERMETRIC_TOTAL_MEDIACOST_ECPAPV_USDMETRIC_TOTAL_MEDIACOST_ECPA_ADVERTISERMETRIC_TOTAL_MEDIACOST_ECPA_PARTNERMETRIC_TOTAL_MEDIACOST_ECPA_USDMETRIC_TOTAL_MEDIACOST_ECPCV_ADVERTISERMETRIC_TOTAL_MEDIACOST_ECPCV_PARTNERMETRIC_TOTAL_MEDIACOST_ECPCV_USDMETRIC_TOTAL_MEDIACOST_ECPC_ADVERTISERMETRIC_TOTAL_MEDIACOST_ECPC_PARTNERMETRIC_TOTAL_MEDIACOST_ECPC_USDMETRIC_TOTAL_MEDIACOST_ECPM_ADVERTISERMETRIC_TOTAL_MEDIACOST_ECPM_PARTNERMETRIC_TOTAL_MEDIACOST_ECPM_USDMETRIC_TOTAL_MEDIACOST_PARTNERMETRIC_TOTAL_MEDIACOST_USDMETRIC_TOTAL_MEDIACOST_VIEWABLE_ECPM_ADVERTISERMETRIC_TOTAL_MEDIACOST_VIEWABLE_ECPM_PARTNERMETRIC_TOTAL_MEDIACOST_VIEWABLE_ECPM_USDMETRIC_FEE32_ADVERTISERMETRIC_FEE32_PARTNERMETRIC_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_PATHPATH_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_ENVIRONMENTMETRIC_CM360_POST_VIEW_REVENUE_CROSS_ENVIRONMENTMETRIC_POST_CLICK_CONVERSIONS_CROSS_ENVIRONMENTMETRIC_POST_VIEW_CONVERSIONS_CROSS_ENVIRONMENTMETRIC_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.getmethod. - The addition of an
orderByquery parameter toqueries.reports.list. - The update of the
queries.runresponse body from an empty object to an instance of the generatedReportresource.
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/doubleclickbidmanagerhttps://doubleclickbidmanager.googleapis.comServices have been renamed as follows:
v1 service v2 service Queries queries Reports queries.reports Methods have been renamed as follows:
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.listResponse Bodykind
queries.reports.listResponse Bodykind
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 Report RunQueryRequest 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.