Tag Archives: sunset

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.

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.

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.

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.

Sunset of the Ad Manager API v201805

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

If you’re using any of Google’s client libraries, you should allow extra time to migrate off of v201805, since it was the last version before the DFP API became the Google Ad Manager API. For details on what’s changed, each client library has a migration guide: Java, Python, .NET, PHP, and Ruby.

When you’re ready to upgrade, check the release notes to identify any breaking changes (such as the change to the capitalization of DateTime.timeZoneId in v201811). 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.

To be notified of future sunsets, join the Ad Manager API Sunset Announcements group and adjust your notification settings. If you are an administrator on your network, you can also receive notifications when an application is making requests to your network using a deprecated version, as explained in this post.

AdWords API v201806 sunset reminder

AdWords API v201806 will be sunset on April 2, 2019. After this date, all v201806 API requests will begin to fail. You have the option of migrating directly to Google Ads API v1, which is ready for your production systems. If you’re not ready for the v1 migration, then please migrate to v201809 prior to April 2, 2019 to ensure your API access is unaffected.

We've prepared various resources to help you with the migration: If you have questions while you’re upgrading, please reach out to us on the forum.

AdWords API v201802 sunset reminder

AdWords API v201802 will be sunset on January 30, 2019. After this date, all v201802 API requests will begin to fail. We recommend that you skip v201806 and migrate directly to v201809. Please migrate prior to January 30, 2019 to ensure your API access is unaffected.

We've prepared various resources to help you with the migration: If you have questions while you’re upgrading, please reach out to us on the forum.

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

DCM/DFA Reporting and Trafficking API v3.0 will be sunset on November 30th, 2018. From this date onwards, all requests made against v3.0 of this API will fail. If you're still actively working with this version, we strongly encourage you to begin migrating to the most current release to avoid an interruption in service.

For most, migrating will be as easy as adopting the latest version of your preferred client library. However, all users are advised to review the release notes to learn about important version differences you may need to be aware of.

If you have questions about this or anything else DCM API related, feel free to reach out to us on our support forum.

Upgrade to Gmail ads from Gmail template ads

On August 15, 2018, creating TemplateAds with IDs 464 (Gmail single promotion template), 466 (Gmail multi-product template), and 497 (Gmail multi-call-to-action template) will result in the error: AdError.Reason.USER_DOES_NOT_HAVE_ACCESS_TO_TEMPLATE. These template ads are now considered deprecated, but existing template ads with these IDs will continue to serve after this date.

If you would like to create a Gmail ad, use the new GmailAd introduced in v201802. Use this new entity instead of the deprecated Gmail template ads going forward.

Here are some tips to ease the transition:
  • Create new GmailAds in a paused campaign with the AdvertisingChannelType as DISPLAY and the AdvertisingChannelSubType as DISPLAY_GMAIL_AD.
  • Use MediaService to upload images or retrieve existing media IDs.
  • Enable the new campaign when the ads are ready, letting it run in parallel with the Gmail template ad campaign.
  • Pause and remove the Gmail template ad campaign when you’re comfortable with the new Gmail campaign.
For an implementation example, see the Add a Gmail ad to an ad group sample in any of our supported client libraries: Java, PHP, Python, Ruby, Perl, C#, and VB.NET.

If you have questions while you’re upgrading, please reach out to us on the AdWords API forum.

AdWords API v201710 sunset reminder

AdWords API v201710 will be sunset on July 25, 2018. After this date, all v201710 API requests will begin to fail. We recommend that you skip v201802 and migrate directly to v201806. Please migrate prior to July 25, 2018 to ensure your API access is unaffected.

We've prepared various resources to help you with the migration: As always, if you have any questions about this migration, please contact us via the forum.