Tag Archives: admanager_api

Announcing v202011 of the Google Ad Manager API

We're happy to announce that v202011 of the Google Ad Manager API is available starting today. Upgrade to this version to take advantage of new functionality, like support for Ad Speed reports. Now you can programmatically monitor ad speed, because fast ads matter to both you and your users.

This release also brings a new ForecastService method to let you explore historical and future impression opportunities. This is backed by the same data as your network's Traffic Forecast.

For the full list of changes for v202011 check the release notes. Feel free to reach out to us on the Ad Manager API forum with any API-related questions.
- Chris Seeley, Ad Manager API Team

Upcoming change to the Google Ad Manager API

On Wednesday April 1st, 2020 existing metrics in the Ad Manager API's ReportService will start returning net revenue instead of gross revenue for Programmatic Guaranteed and Preferred Deals. If your application does not process Programmatic Guaranteed and Preferred Deals revenue data, no action is required.

This change will impact all API versions and reports run in the Ad Manager UI. For more information, see the Ad Manager release notes for March 9th.

To help this transition, new metrics have been added in v202002 to allow you to report on gross revenue in order to facilitate historical comparisons. These metrics are temporary and will be removed in future API versions.


Why are we making this change?

This change brings Programmatic Guaranteed and Preferred Deals into alignment with all other transaction types.

How can I tell if I am impacted?

If you use any of the below metrics and your application processes Programmatic Guaranteed and Preferred Deals values as gross revenue, you are impacted by this change:
  • AD_SERVER_ALL_REVENUE
  • AD_SERVER_CPD_REVENUE
  • AD_SERVER_CPM_AND_CPC_REVENUE
  • TOTAL_LINE_ITEM_LEVEL_ALL_REVENUE
  • TOTAL_LINE_ITEM_LEVEL_CPM_AND_CPC_REVENUE
  • TOTAL_LINE_ITEM_LEVEL_WITHOUT_CPD_AVERAGE_ECPM

What changes do I need to make?

You must update your application to process Programmatic Guaranteed and Preferred Deals values as net revenue before April 1st, 2020. If you need access to gross revenue values after April 1st, 2020, you can use temporary gross revenue metrics added in v202002. These metrics will be available until the end of February 2021.

Net revenue values starting 2020-04-01 Gross revenue values until 2021-03-01
AD_SERVER_ALL_REVENUE AD_SERVER_ALL_REVENUE_GROSS
AD_SERVER_CPM_AND_CPC_REVENUE AD_SERVER_CPM_AND_CPC_REVENUE_GROSS
AD_SERVER_CPD_REVENUE Not available
TOTAL_LINE_ITEM_LEVEL_ALL_REVENUE Not available
TOTAL_LINE_ITEM_LEVEL_CPM_AND_CPC_REVENUE Not available
TOTAL_LINE_ITEM_LEVEL_WITHOUT_CPD_AVERAGE_ECPM Not available



If you have questions about this change or are unsure if it impacts you, reach out to us on the Ad Manager API forums. We'll be happy to check if you're impacted and work with you to update your applications.
 - Chris Seeley, Ad Manager API Team

Announcing v201905 of the Google Ad Manager API

We're happy to announce that v201905 of the Google Ad Manager API is available starting today. This version introduces a long-requested feature: Targeting Presets. The new TargetingPresetService allows you to read your network's targeting presets in a familiar Targeting object that can be applied to line items, forecasts, and proposal line items.

This release also introduces support for configuring and reporting on custom dimensions, and new Programmatic features such as Pause and Resume actions for Proposals.

For a full list of API changes in v201905, see the release notes.

For questions about these or any other API changes, reach out to us on the Ad Manager API forums.
 - Chris Seeley, Ad Manager API Team

Upcoming breaking changes to the Google Ad Manager API

On Monday July 8, 2019 the Ad Manager API's ReportService will stop supporting reports that mix Ad Exchange historical reporting fields with Historical reporting fields. This change will impact all API versions.

After July 8, any API reports that use both an Ad Exchange historical Dimension or Column and a Historical Dimension or Column will fail with the following error: ReportError.REPORT_CONSTRAINT_VIOLATION

Why are we making this change?

This change is being made to ensure all API reports return accurate data. The Query Tool has never supported creating reports that mix Ad Exchange historical and Historical data, and in some cases this may lead to unexpected results. This change brings the API in line with the Query Tool.

How can I tell if I am impacted?

This change impacts approximately 2% of all reports run with the Ad Manager API. If you only run saved queries that were created with the Query Tool, this change does not impact you.

If you use any of the following columns, your report will be considered an Ad Exchange historical report, and you may only use either Dimensions prefixed with AD_EXCHANGE or date Dimensions including DATE, WEEK, DAY, HOUR or MONTH_AND_YEAR:
  • Column.AD_EXCHANGE_ACTIVE_VIEW_ENABLED_IMPRESSIONS
  • Column.AD_EXCHANGE_ACTIVE_VIEW_MEASURED_IMPRESSIONS
  • Column.AD_EXCHANGE_ACTIVE_VIEW_VIEWED_IMPRESSIONS
  • Column.AD_EXCHANGE_AD_CTR
  • Column.AD_EXCHANGE_AD_ECPM
  • Column.AD_EXCHANGE_AD_REQUEST_CTR
  • Column.AD_EXCHANGE_AD_REQUEST_ECPM
  • Column.AD_EXCHANGE_AD_REQUESTS
  • Column.AD_EXCHANGE_AVERAGE_VIEWABLE_TIME
  • Column.AD_EXCHANGE_CLICKS
  • Column.AD_EXCHANGE_COVERAGE
  • Column.AD_EXCHANGE_CPC
  • Column.AD_EXCHANGE_CTR
  • Column.AD_EXCHANGE_DEALS_AD_REQUESTS
  • Column.AD_EXCHANGE_DEALS_BID_RESPONSES
  • Column.AD_EXCHANGE_DEALS_MATCH_RATE
  • Column.AD_EXCHANGE_DEALS_MATCHED_REQUESTS
  • Column.AD_EXCHANGE_ESTIMATED_REVENUE
  • Column.AD_EXCHANGE_IMPRESSIONS
  • Column.AD_EXCHANGE_LIFT
  • Column.AD_EXCHANGE_MATCHED_ECPM
  • Column.AD_EXCHANGE_MATCHED_REQUESTS
  • Column.AD_EXCHANGE_VIDEO_ABANDONMENT_RATE
  • Column.AD_EXCHANGE_VIDEO_DROPOFF_RATE
  • Column.AD_EXCHANGE_VIDEO_QUARTILE_1
  • Column.AD_EXCHANGE_VIDEO_QUARTILE_3
  • Column.AD_EXCHANGE_VIDEO_TRUEVIEW_SKIP_RATE
  • Column.AD_EXCHANGE_VIDEO_TRUEVIEW_VIEWS
  • Column.AD_EXCHANGE_VIDEO_TRUEVIEW_VTR

What changes do I need to make?

To prevent your reports from failing, you must convert your report to be either an Ad Exchange historical report or a Historical report.

To convert the report to an Ad Exchange historical report:
  1. Remove any Columns not in the list above.
  2. Remove any Dimensions that are not prefixed with AD_EXCHANGE, with the exception of the following Dimensions:
    1. DATE
    2. WEEK
    3. DAY
    4. HOUR
    5. MONTH_AND_YEAR
  3. Remove any DimensionAttributes for dimensions you removed.
  4. Remove any PQL filters that applied to fields you removed.

To convert the report to a Historical report:
  1. Remove any of the Columns in the list above.
  2. Remove any Dimensions that are prefixed with AD_EXCHANGE.
  3. Remove any PQL filters that applied to fields you removed.
If you have questions about this change or are unsure if it impacts you, reach out to us on the Ad Manager API forums. We'll be happy to check if you're impacted and work with you to update your applications.
 - Chris Seeley, Ad Manager API Team

Announcing v201811 of the Google Ad Manager API

We're happy to announce that v201811 of the Google Ad Manager API is available starting today. This version brings support for date range targeting which affords the same functionality as blackout periods in the UI. It also removes the deprecated ContentMetadataKeyHierarchyService. For video targeting, use ContentBundles or key-values mapped from content metadata.

For a full list of API changes in v201811, see the release notes.

For questions about this or any other API changes, reach out to us on the Ad Manager API forum.
 - , Ad Manager API Team

Announcing v201808 of the Google Ad Manager API

We're happy to announce that v201808 of the Google Ad Manager API is available starting today. This version brings several new forecasting features, including forecast breakdowns by date and targeting. You can also forecast for AMP-only traffic and Proposal Line Items.

For video users, note that the new requestPlatformTargeting field is required when creating video line items.

For a full list of API changes in v201808, see the release notes.

If you're using one of our client libraries, you'll notice they've been updated to reflect our new name, so allow extra time for upgrading. A migration guide for each client library is available on GitHub: For questions about this or any other API changes, reach out to us on the Ad Manager API forums.
 - , DFP API Team