Tag Archives: sunset

Reminder about sunset, creation of target spend field for Maximize Clicks strategies in Ads APIs

On July 31st, 2019 we began to sunset the target spend field for Maximize Clicks bidding strategies. At the time, the feature was only removed from the UI, and the Google Ads APIs were not impacted.

Starting on June 30th, 2020, we will continue to sunset the target spend field in the Google Ads APIs as per our original blog post. This will affect all versions of both the AdWords API and the Google Ads API. The following behaviors will be blocked:
  • Populating the target spend field on existing standard and portfolio strategies
  • Attaching portfolio strategies that have the deprecated field set to campaigns
Read on to see how this will affect your API usage:
Affected Target Spend Fields
Google Ads API campaign.target_spend.target_spend_micros
bidding_strategy.target_spend.target_spend_micros
AdWords API Campaign.BiddingStrategyConfiguration.TargetSpendBiddingScheme.spendTarget
SharedBiddingStrategy.TargetSpendBiddingScheme.spendTarget

Change Description
Any mutate operations that set a target spend field for the first time will return an error. You will be able to update a target spend field that currently contains a value, but you cannot set previously empty fields to a new value. Additionally, any operation attaching a bidding strategy to a campaign where that bidding strategy has a value set for a target spend field, will throw an error. To manage Target Spend on any new campaigns, we recommend using campaign budget. In each of these cases an error will be thrown.

Performing any of the actions listed above will generate one of the following errors:
  • OPERATION_NOT_PERMITTED_FOR_CONTEXT
  • UNSUPPORTED_FIELD_IS_SET
If you have any questions about this change or any other API feature, please contact us via the forum.
- Cory Liseno, Google Ads API Team

Postponement of DBM API v1 and SDF Download Service Sunset

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

Updates to the AdWords API and Google Ads API

As communities respond to COVID-19, we know that this time presents unique challenges for everyone. Below are updates and resources to help you navigate and plan through these challenging times.

How does this impact the APIs?
We realize you are balancing a lot in your life. Here’s what we’re doing to help:
  • Delaying the sunset of the Google Ads API v1: The Google Ads API’s v1 sunset is delayed until July 29, 2020. The AdWords API will continue to be available for production use.
  • Giving additional time: Any new changes that require updates in your AdWords API and Google Ads API code will be given additional time or will be deferred.
We will continue releasing new versions of the Google Ads API to get new features to you.

What are some customer resources?
Google Ads has provided the following resources for business and customers: Where can I get support?
The Google Ads Help Center posted a delay for non-API related support. This delay includes developer token approvals and changes.

If you have any API questions or need help, you can reach us at [email protected] or on our Google Ads API and AdWords API forum.
Nadine Wang, on behalf of the entire Google Ads 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

Sunset of the Ad Manager API v201902

On Friday, February 28, 2020, in accordance with the deprecation schedule, v201902 of the Ad Manager API will be sunset. At that time, any requests made to this version will return errors.

If you’re still using this version, now is the time to upgrade to the latest release and take advantage of new functionality like CmsMetadata reporting, the TargetingPresetService, and deal IDs on programmatic LineItems.

When you’re ready to upgrade, check the release notes to identify any breaking changes, such as the removal of the deprecated field ImageCreative.lockedOrientation.

Then, grab the latest version of your client library and update your code. As always, don't hesitate to reach out to us on the developer forum with any questions.
 - , Ad Manager API Team

Sunset of the Ad Manager API v201811

On Monday, December 2, 2019, in accordance with the deprecation schedule, v201811 of the Ad Manager API will be sunset. At that time, any requests made to this version will return errors.

If you’re still using this version, now is the time to upgrade to the latest release and take advantage of new features like the TargetingPresetService and reporting on CustomTargetingKeys.

When you’re ready to upgrade, check the release notes to identify any breaking changes. Then, grab the latest version of your client library and update your code.

We now provide a machine-readable version of our deprecation schedule, giving you more flexibility to stay up to date with the latest Ad Manager API features. You can access this CSV file at https://developers.google.com/ad-manager/downloads/api-schedule.csv.


As always, don't hesitate to reach out to us on the developer forum with any questions.
 - , Ad Manager API Team

DCM/DFA Reporting and Trafficking API v3.2 sunset reminder

In accordance with our deprecation schedule, we will be sunsetting version 3.2 of the API on August 31, 2019. Requests to version 3.2 will no longer work after this date, preventing you from updating and accessing information in Campaign Manager. To avoid an interruption in service, you must migrate to a newer API version as soon as possible.

To learn about changes between versions and get tips for migrating, visit the API developer site. Also consider subscribing to this blog to stay up to date about new releases, upcoming sunsets, and changes to the API.

If you have technical questions regarding new versions of the API, please reach out via the developer forum.

 - Jonathon Imperiosi, DCM API Team

Sunset of the Average Position Metric in AdWords and Google Ads APIs

In the week of September 30, 2019, the average position metric will be sunset. This change was announced this past February in the Google Ads Help Center. The new alternatives were described in this November 2018 blog post. Once the sunset occurs, requests for the average position (AdWords API, Google Ads API) will return NULL values.

In the AdWords API v201809, NULL values are returned as two dashes. In the Google Ads API, NULL values are returned as NullValues.

If you use ValueTrack parameters, we encourage you to remove the ValueTrack parameter {adposition} from your tracking templates. When average position is sunset, the ValueTrack parameter {adposition} will begin returning the empty string.

Note that average position has already been removed from the current beta version of the Google Ads API, but is accessible in the earlier V1_x versions.

In lieu of average position, we recommend you use the new metrics of Impression (Absolute Top) %" and "Impression (Top) %. These are the new metrics:

Absolute Top Metrics
AdWords API Google Ads API
AbsoluteTopImpressionPercentage absolute_top_impression_percentage
SearchAbsoluteTopImpressionShare search_absolute_top_impression_share
SearchBudgetLostAbsoluteTopImpressionShare search_budget_lost_absolute_top_impression_share
SearchRankLostAbsoluteTopImpressionShare search_rank_lost_absolute_top_impression_share


Top Metrics
AdWords API Google Ads API
TopImpressionPercentage top_impression_percentage
SearchTopImpressionShare search_top_impression_share
SearchBudgetLostTopImpressionShare search_budget_lost_top_impression_share
SearchRankLostTopImpressionShare search_rank_lost_top_impression_share


As always, don't hesitate to reach out to us on the developer forum with any questions.
, Google Ads API Team

Sunset of the Ad Manager API v201808

On Friday, August 30, 2019, in accordance with the deprecation schedule, v201808 of the Ad Manager API will be sunset. At that time, any requests made to this version will return errors.

If you’re still using this version, now is the time to upgrade to the latest release and take advantage of new functionality like DateTimeRangeTargeting, the TargetingPresetService, and reporting on CustomTargetingKeys.

When you’re ready to upgrade, check the release notes to identify any breaking changes. Significant changes include:
  • A change to the capitalization of DateTime.timeZoneId, which was previously DateTime.timeZoneID.
  • Removal of the ContentMetadataKeyHierarchyService. You can continue to target video content with key‑values mapped from content metadata or content bundles.

Then, grab the latest version of your client library and update your code. As always, don't hesitate to reach out to us on the developer forum with any questions.
 - , 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