Google Ads Developer Blog: dfa

Subscribe to our RSS feed to get blog posts via email

Friday, February 8, 2019

(If you want to continue getting email updates about our blog posts, read on. If you don't want email updates from this blog, you can skip this post.)

For some products, the Google Ads Developer team has used Google groups as a way to allow API users to subscribe and get new relevant blog posts delivered to their email address. Starting now, the way you can get email updates about blog posts is changing. We will no longer send an email to the Google group for each new blog post. We will continue to use the Google groups for other important updates, however.

For users who still want email updates, we've introduced new FeedBurner links on the right-hand panel of our blog homepage. You can subscribe to the RSS feed by clicking on the link for the product you're interested in, or subscribe by email by clicking on the [+] link to the right of the product name.

If you use any of the APIs that we discuss on this blog, make sure you subscribe to the feed to keep up with the latest news and updates:

- Mike Cloonan, Ads Developer Relations Team

Announcing v3.3 of the DCM/DFA Reporting and Trafficking API

Friday, February 8, 2019

Today we're releasing v3.3 of the DCM/DFA Reporting and Trafficking API. Highlights of this release include:

Site-level video creative settings
Additional audio and video creative fields
Support for custom Active View video viewability metrics

Details of these and all other changes are covered in our release notes.

Deprecation and sunset reminder

In accordance with our deprecation schedule, this release marks the beginning of the deprecation period for v3.2, which will sunset on August 31, 2019. After this date, any requests made against v3.2 will begin returning errors.

As a final reminder, API version 3.1 will be sunset on February 28, 2019. To avoid an interruption in service, all users are required to migrate to a newer version before the sunset date.

Learn More

As with every new version of the DCM/DFA Reporting and Trafficking API, we encourage you to carefully review all changes in the release notes. For those of you looking to get going right away, updated client libraries are now available. If you're just starting out, the Get Started guide is a great reference to help you get up and running quickly.

Give it a try and let us know if you have any questions!

- Jonathon Imperiosi, DCM API Team

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

Friday, November 2, 2018

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.

- Jonathon Imperiosi, DCM API Team

Announcing v3.2 of the DCM/DFA Reporting and Trafficking API

Tuesday, August 14, 2018

Today we're releasing v3.2 of the DCM/DFA Reporting and Trafficking API. Highlights of this release include:

Support for responsive creatives and placements
Additional signal fields for offline conversions

Details of these and all other changes are covered in our release notes.

Deprecation and sunset reminder
In accordance with our deprecation schedule, this release marks the beginning of the deprecation period for v3.1, which will sunset on February 28, 2019. After this date, any requests made against v3.1 will begin returning errors.

As a final reminder, API version 2.8 will be sunset on August 31, 2018. To avoid an interruption in service, all users are required to migrate to a newer version before the sunset date.

Learn More
As with every new version of the DCM/DFA Reporting and Trafficking API, we encourage you to carefully review all changes in the release notes. For those of you looking to get going right away, updated client libraries are now available. If you're just starting out, the Get Started guide is a great reference to help you get up and running quickly.

Give it a try and let us know if you have any questions!

- Jonathon Imperiosi, DCM API Team

Announcing v3.1 of the DCM/DFA Reporting and Trafficking API

Thursday, May 24, 2018

Today we're releasing v3.1 of the DCM/DFA Reporting and Trafficking API. Highlights of this release include:

Support for in-stream audio creatives
Landing page mobile deep link management

Details of these and all other changes are covered in our release notes.

Deprecation and sunset reminder

In accordance with our deprecation schedule, this release marks the beginning of the deprecation period for v3.0, which will sunset on November 30, 2018. After this date, any requests made against v3.0 will begin returning errors.

As a reminder, API version 2.8 will be sunset on August 31, 2018. To avoid an interruption in service, all users are required to migrate to a newer version before the sunset date.

Learn More

- Jonathon Imperiosi, DCM API Team

Upcoming changes to reach report metrics in DCM

Wednesday, February 7, 2018

Beginning the week of February 20, a number of reach report metrics in DCM will be renamed. This renaming will modify both API names and column header names in generated report files. These changes are being made to prevent confusion as new reach reports and metrics are developed. The changes are as follows:

Reach Metrics

Old API name	Old column header	New API name	New column header
dfa:activeViewViewableImpressionReach	Active View: Viewable Impression Reach	dfa:activeViewViewableImpressionCookieReach	Active View: Viewable Impression Cookie Reach
dfa:averageImpressionFrequency	Average Impression Frequency	dfa:cookieReachAverageImpressionFrequency	Cookie Reach: Average Impression Frequency
dfa:clickReach	Click Reach	dfa:cookieReachClickReach	Cookie Reach: Click Reach
dfa:impressionReach	Impression Reach	dfa:cookieReachImpressionReach	Cookie Reach: Impression Reach
dfa:incrementalImpressionReach	Incremental Impression Reach	dfa:cookieReachIncrementalImpressionReach	Cookie Reach: Incremental Impression Reach
dfa:incrementalClickReach	Incremental Click Reach	dfa:cookieReachIncrementalClickReach	Cookie Reach: Incremental Click Reach
dfa:incrementalTotalReach	Incremental Total Reach	dfa:cookieReachIncrementalTotalReach	Cookie Reach: Incremental Total Reach
dfa:totalReach	Total Reach	dfa:cookieReachTotalReach	Cookie Reach: Total Reach
dfa:duplicateClickReach	Duplicate Click Reach	dfa:cookieReachDuplicateClickReach	Cookie Reach: Duplicate Click Reach
dfa:duplicateClickReachPercent	Duplicate Click Reach Percent	dfa:cookieReachDuplicateClickReachPercent	Cookie Reach: Duplicate Click Reach %
dfa:duplicateImpressionReach	Duplicate Impression Reach	dfa:cookieReachDuplicateImpressionReach	Cookie Reach: Duplicate Impression Reach
dfa:duplicateImpressionReachPercent	Duplicate Impression Reach Percent	dfa:cookieReachDuplicateImpressionReachPercent	Cookie Reach: Duplicate Impression Reach %
dfa:duplicateTotalReach	Duplicate Total Reach	dfa:cookieReachDuplicateTotalReach	Cookie Reach: Duplicate Total Reach
dfa:duplicateTotalReachPercent	Duplicate Total Reach Percent	dfa:cookieReachDuplicateTotalReachPercent	Cookie Reach: Duplicate Total Reach %
dfa:exclusiveClickReach	Exclusive Click Reach	dfa:cookieReachExclusiveClickReach	Cookie Reach: Exclusive Click Reach
dfa:exclusiveClickReachPercent	Exclusive Click Reach Percent	dfa:cookieReachExclusiveClickReachPercent	Cookie Reach: Exclusive Click Reach %
dfa:exclusiveImpressionReach	Exclusive Impression Reach	dfa:cookieReachExclusiveImpressionReach	Cookie Reach: Exclusive Impression Reach
dfa:exclusiveImpressionReachPercent	Exclusive Impression Reach Percent	dfa:cookieReachExclusiveImpressionReachPercent	Cookie Reach: Exclusive Impression Reach %
dfa:exclusiveTotalReach	Exclusive Total Reach	dfa:cookieReachExclusiveTotalReach	Cookie Reach: Exclusive Total Reach
dfa:exclusiveTotalReachPercent	Exclusive Total Reach Percent	dfa:cookieReachExclusiveTotalReachPercent	Cookie Reach: Exclusive Total Reach %
dfa:overlapClickReach	Overlap Click Reach	dfa:cookieReachOverlapClickReach	Cookie Reach: Overlap Click Reach
dfa:overlapClickReachPercent	Overlap Click Reach Percent	dfa:cookieReachOverlapClickReachPercent	Cookie Reach: Overlap Click Reach %
dfa:overlapImpressionReach	Overlap Impression Reach	dfa:cookieReachOverlapImpressionReach	Cookie Reach: Overlap Impression Reach
dfa:overlapImpressionReachPercent	Overlap Impression Reach Percent	dfa:cookieReachOverlapImpressionReachPercent	Cookie Reach: Overlap Impression Reach %
dfa:overlapTotalReach	Overlap Total Reach	dfa:cookieReachOverlapTotalReach	Cookie Reach: Overlap Total Reach
dfa:overlapTotalReachPercent	Overlap Total Reach Percent	dfa:cookieReachOverlapTotalReachPercent	Cookie Reach: Overlap Total Reach %

Unique Reach (Beta) Metrics

Old API name	Old column header	New API name	New column header
dfa:uniqueReachClick	Unique Reach: Click	dfa:uniqueReachClickReach	Unique Reach: Click Reach
dfa:uniqueReachImpression	Unique Reach: Impression	dfa:uniqueReachImpressionReach	Unique Reach: Impression Reach
dfa:uniqueReachTotal	Unique Reach: Total	dfa:uniqueReachTotalReach	Unique Reach: Total Reach

Questions about this or anything else DCM API related? Contact us via our support forum.

- Jonathon Imperiosi, DCM API Team

Announcing v3.0 of the DCM/DFA Reporting and Trafficking API

Thursday, November 16, 2017

Today we're releasing v3.0 of the DCM/DFA Reporting and Trafficking API. Highlights of this major version release include:

Although we strive to maintain backwards compatibility between releases, a number of enhancements in this release necessitated breaking changes to existing API workflows. Details of these and all other changes are covered in our release notes.

Deprecation and sunset reminder
In accordance with our deprecation schedule, this release marks the beginning of the deprecation period for v2.8, which will sunset on August 31st, 2018. After this date, any requests made against v2.8 will begin returning errors.

As a final reminder, API version 2.7 will be sunset on December 7th, 2017. To avoid an interruption in service, all users are required to migrate to a newer version before the sunset date.

Learn More
As with every new version of the DCM/DFA Reporting and Trafficking API, we encourage you to carefully review all changes in the release notes. For those of you looking to get going right away, updated client libraries are now available. If you're just starting out, the Get Started guide is a great reference to help you get up and running quickly.

Give it a try and let us know if you have any questions!

- Jonathon Imperiosi, DCM API Team

DCM/DFA Reporting and Trafficking API v2.7 sunset reminder

Wednesday, November 8, 2017

DCM/DFA Reporting and Trafficking API v2.7 will be sunset on December 7th, 2017. From this date onwards, all requests made against v2.7 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.

- Jonathon Imperiosi, DCM API Team

Upcoming changes to standard placement tags in DCM

Monday, July 31, 2017

Beginning in August 2017, DoubleClick Campaign Manager (DCM) will no longer export standard tags for placements larger than 1x1. This is the next step in a phased rollout of changes aimed at aligning DCM's impression counting methodology with the latest Interactive Advertising Bureau and Media Rating Council guidelines. A full overview of these changes can be found in the DCM partner help center.

How will this affect DCM/DFA Reporting and Trafficking API users?

On August 22, 2017, the API's placements.generatetags endpoint will stop returning standard tags (PLACEMENT_TAG_STANDARD) for non-1x1 placements. Users will still be allowed to include this tag format in all generatetag requests without error, however responses will only contain standard tag data for 1x1 placements. This will be a retroactive change affecting all API versions.

What can API users do to prepare?

Users should begin updating their API workflows to request alternative tag formats, such as PLACEMENT_TAG_JAVASCRIPT or PLACEMENT_TAG_IFRAME_JAVASCRIPT, for all non-1x1 placements. Although standard tags will still be returned for 1x1 placements after August 2017, users leveraging pixels for impression tracking are encouraged to use tracking ads for this purpose, instead.

Existing non-1x1 placements trafficked using standard tags will continue to serve until October 2017. Any such placements which are part of a campaign ending later than this must be re-trafficked using an alternative tag format. Instructions for identifying these placements can be found in the DCM partner help center.

Questions about this or anything else DCM API related? Contact us via our support forum.

- Jonathon Imperiosi, DCM API Team

Announcing v2.8 of the DCM/DFA Reporting and Trafficking API

Monday, May 8, 2017

Today we're releasing v2.8 of the DCM/DFA Reporting and Trafficking API. Highlights of this release include:

Details of these and all other changes are covered in our release notes.

Deprecation and sunset reminder

In accordance with our deprecation schedule, this release marks the beginning of the deprecation period for v2.7, which will sunset on November 30th, 2017. After this date, any requests made against v2.7 will begin returning errors.

As a final reminder, API version 2.6 will be sunset on May 31st, 2017. To avoid an interruption in service, all users are required to migrate to a newer version before the sunset date.

Learn More

As with every new version of the DCM/DFA Reporting and Trafficking API, we encourage you to carefully review all changes in the release notes. For those of you looking to get going right away, updated client libraries are now available. If you're just starting out, the Get Started guide is a great reference to help you get up and running quickly.

Give it a try and let us know if you have any questions!

- Jonathon Imperiosi, DCM API Team

Upcoming DCM/DFA Reporting and Trafficking API system maintenance

Tuesday, February 21, 2017

Starting in March, DoubleClick Campaign Manager (DCM) will be undergoing scheduled maintenance to make important updates to our systems. Every DCM account will be assigned a single maintenance window. However, these windows may be on different days for different accounts. More information about how this will affect the DCM product can be found in our help center. How will this affect API users?deleteinsertpatchupdateScheduled Maintenance page What can API users do to prepare?If your application accesses multiple DCM accounts, you may be subject to multiple maintenance windows. If it's not possible to plan around these windows, you should prepare your application to catch and handle maintenance related errors. Recommended error handling strategies include:

For user initiated requests, return an error to the user along with instructions to wait up to 8 hours before retrying the request.

For server initiated requests, retry automatically using an exponential backoff strategy. For example: pause 30 seconds before the first retry, 1 minute before the second, 2 minutes before the third, and so on up to a maximum of 8 hours. This strategy helps ensure you're not calling the API too aggressively and that your request quota is not being wasted.

Questions about this or anything else DCM API related? Contact us via our support forum.

- Jonathon Imperiosi, DCM API Team

DCM/DFA Reporting and Trafficking API sunset reminder

Friday, February 3, 2017

In accordance with our deprecation schedule, we'll be sunsetting versions 2.5 and 2.5beta1 of the DCM/DFA Reporting and Trafficking API on February 28th, 2017. On this date, all requests made against these versions will begin returning HTTP 403 errors. If you're still working with these versions, we strongly encourage you to begin migrating to the most recent release to avoid an interruption in service. If you're not sure, or would like to know more about the migration process, refer to the migration guide. As always, feel free to reach out to us with any questions that you have.

- Jonathon Imperiosi, DCM API Team

DCM display ads go 100% HTML5 on January 2, 2017

Tuesday, December 13, 2016

As you've probably heard, DCM will stop serving Flash display ads on January 2nd, 2017. This is part of a wider initiative to go 100% HTML5, which you can learn more about in the DCM help center. What does this mean for DCM/DFA Reporting and Trafficking API users?Beginning on January 2, 2017, the following changes will take effect:

Flash uploads will be disabled in API v2.5. Beginning with v2.6, the DCM API stopped supporting uploads of Flash assets and prevented users from creating new Flash In-page creatives. These same restrictions will be applied to v2.5.

Active Flash creatives with no HTML5 equivalent will be deactivated. Existing creatives that have not been converted to HTML5 will have their active field set to FALSE. Users will not be allowed to reactivate these creatives.

What can API users do to prepare?Users are strongly encouraged to review their active creatives and take immediate action to replace those that will be affected by this change. We've created code samples in Java and Python to help API users identify creatives in their accounts that will be deactivated if no action is taken. See this article for links to tools to help you transition your creatives to HTML5. Users of DCM API v2.5 are also encouraged to begin migrating to a newer API version immediately. Be aware that this version is already scheduled to sunset on February 28th, 2017. Questions about this or anything else DCM API related? Contact us via our support forum.

- Jonathon Imperiosi, DCM API Team

Announcing v2.7 of the DCM/DFA Reporting and Trafficking API

Tuesday, November 8, 2016

New configuration options for in-stream video creatives.

Placement-level controls for companion creatives, skip buttons, and transcodes.

Site-level video settings, which automatically apply to new placements.

Details of these and other improvements are covered in our release notes. Deprecation and sunset reminderdeprecation scheduleMay 31st, 2017As a final reminder, API v2.4 will be sunset on November 30th, 2016. To avoid an interruption in service, all users are required to migrate off of this version by the sunset date. Learn Morerelease notesclient librariesGet Started guideGive it a try and let us know if you have any questions!

- Jonathon Imperiosi, DCM API Team

DCM/DFA Reporting and Trafficking API sunset reminder

Friday, October 14, 2016

deprecation scheduleNovember 30th, 2016If you're still working with this version, we strongly encourage you to begin migrating to the most recent release to avoid an interruption in service. If you're not sure, or would like to know more about the migration process, refer to the migration guide. As always, feel free to reach out to us with any questions that you have. To receive future updates like this directly in your inbox, join the DCM API Announcements group and adjust your notification settings.

- Jonathon Imperiosi, DCM API Team

Announcing v2.6 of the DCM/DFA Reporting and Trafficking API

Tuesday, August 9, 2016

Today we're releasing v2.6 of the DCM/DFA Reporting and Trafficking API. This release includes a number of highly anticipated features, such as:

We've also improved click-through URL management for Display creatives, expanded custom floodlight variable support, and much more. See our release notes for full details.

Retiring legacy creative types

Beginning with this release, the DCM API no longer supports creating legacy HTML5 Banner and Image creatives. As previously announced, these legacy types have been replaced by the new streamlined Display creative.

Additionally, the ability to upload Flash assets into DCM was disabled back in June. Accordingly, this functionality is also being removed from the API beginning with this release. Previous API versions will continue to support uploading Flash assets until their respective sunset dates, but users are strongly encouraged to begin transitioning to HTML5 now.

Deprecation and sunset reminder

In accordance with our deprecation schedule, this release marks the beginning of the deprecation period for v2.5, which will sunset on February 28th, 2017. After this date, any requests made against v2.5 will begin returning errors.

As a reminder, API v2.3 will be sunset on August 31st, 2016. To avoid an interruption in service, all users are required to migrate off of this version by the sunset date.

Learn More

As with every new version of the DCM/DFA Reporting and Trafficking API, we encourage you to carefully review all changes in the release notes. For those of you looking to get going right away, updated client libraries are now available. If you're just starting out, the Get Started guide is a great reference to help you get up and running quickly.

Give it a try and let us know if you have any questions!

- Jonathon Imperiosi, DCM API Team

Improving the DCM API sunset process

Thursday, July 21, 2016

One year ago we introduced a regular deprecation schedule for the DCM API. Since then, we've been listening closely to your feedback and looking for ways to improve. Today we're acting on this feedback and making a change to our announcement process, to address a common developer pain point. Starting with the next release, we'll begin announcing sunset dates for the previous version, rather than the oldest version. This means that when v2.6 is released, a sunset date will be announced for v2.5. This small change means that the deprecation period for our releases will increase from 4 to 7 months, allowing developers more time to plan their migrations. In order to transition to this new schedule, we're also announcing that the current previous version (v2.4) will sunset on November 30, 2016. Note that this version will be the last to provide a deprecation period shorter than 7 months. As always, we look forward to hearing your feedback. If you think there's something we could do to make this process even better, please let us know on our developer forum.

- Jonathon Imperiosi, DCM API Team

Announcing v2.5 of the DCM/DFA Reporting and Trafficking API

Wednesday, May 11, 2016

Today we're releasing v2.5 of the DCM/DFA Reporting and Trafficking API. This release includes some exciting enhancements and functionality promoted from our previous open beta, such as:

Updated display creative types.

Dynamic targeting key support.

Offline conversion upload capabilities.

Details of these and other improvements are covered in our release notes. Deprecation and sunset reminderdeprecation scheduleAugust 31st, 2016Also be aware that the v2.2 deprecation period has been extended slightly to allow users more time to migrate. The new sunset date for v2.2 is June 7th, 2016. To avoid an interruption in service, all users must migrate off of this version by the new sunset date. Learn Morerelease notesclient librariesGet Started guideGive it a try and let us know if you have any questions!

- Jonathon Imperiosi, DCM API Team

Preparing for display creatives in DCM

Tuesday, May 3, 2016

As you may have heard, streamlined creative types are coming to DCM. The centerpiece of this effort is the new display creative, which supports HTML5, images, and Flash. To learn more, visit our DCM user support site. How does this affect DCM/DFA Reporting and Trafficking API users?will notCreatives service types

API type

Old UI & Report type

New UI & Report type

CUSTOM_INPAGE

Custom in-page

Custom display

CUSTOM_INTERSTITIAL

Custom interstitial

Custom display interstitial

ENHANCED_BANNER

Enhanced banner

Display

ENHANCED_IMAGE

Enhanced image

Display image gallery

REDIRECT

Redirect

Display redirect

RICH_MEDIA_EXPANDING

Rich media expanding

Rich media display expanding

RICH_MEDIA_INPAGE

Rich media in-page

Rich media display banner

RICH_MEDIA_INPAGE_FLOATING

Rich media in-page with floating

Rich media display banner with floating

RICH_MEDIA_INTERSTITIAL_FLOAT

Rich media floating

Rich media display interstitial

RICH_MEDIA_MULTI_FLOATING

Rich media multi-floating

Rich media display multi-floating interstitial

VPAID_LINEAR

Rich media VPAID linear

VPAID linear video

VPAID_NON_LINEAR

Rich media VPAID non-linear

VPAID non-linear video

What can API users do now to prepare?full supportAs display creatives replace the need to use HTML5 banner, Image, and Flash in-page creative types, support for inserting these legacy types will be removed in an upcoming API release. To prepare for this, API users are strongly encouraged to begin transitioning to the new display type now. We've updated our code examples to illustrate how current API versions can use display creatives to begin replacing these legacy types today:

Language

Examples

.NET

Java

PHP

Python

Ruby

Questions about this or anything else DCM API related? Contact us via our support forum.

- Jonathon Imperiosi, DCM API Team

Preview new DCM API functionality with the v2.5 open beta

Monday, April 4, 2016

Today we're releasing v2.5beta1 of the DCM/DFA Reporting and Trafficking API. This release provides a preview of features we're working on for future versions of the API. Experimental functionality being showcased includes:

Dynamic targeting key support.
Offline conversion upload capabilities.

Details of these and all other changes are covered in our release notes.

Be aware that the functionality being previewed here is subject to change and may not appear in subsequent releases. For these reasons, this API version is not recommended for production usage. We do however welcome you to test out these new features and let us know what you think!

- Jonathon Imperiosi, DCM API Team

Ads Developer Blog

Subscribe to our RSS feed to get blog posts via email

Announcing v3.3 of the DCM/DFA Reporting and Trafficking API

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

Announcing v3.2 of the DCM/DFA Reporting and Trafficking API

Announcing v3.1 of the DCM/DFA Reporting and Trafficking API

Upcoming changes to reach report metrics in DCM

Announcing v3.0 of the DCM/DFA Reporting and Trafficking API

DCM/DFA Reporting and Trafficking API v2.7 sunset reminder

Upcoming changes to standard placement tags in DCM

Announcing v2.8 of the DCM/DFA Reporting and Trafficking API

Upcoming DCM/DFA Reporting and Trafficking API system maintenance

DCM/DFA Reporting and Trafficking API sunset reminder

DCM display ads go 100% HTML5 on January 2, 2017

Announcing v2.7 of the DCM/DFA Reporting and Trafficking API

DCM/DFA Reporting and Trafficking API sunset reminder

Announcing v2.6 of the DCM/DFA Reporting and Trafficking API

Improving the DCM API sunset process

Announcing v2.5 of the DCM/DFA Reporting and Trafficking API

Preparing for display creatives in DCM

Preview new DCM API functionality with the v2.5 open beta

Labels

Archive

Feeds

Google Ads API [+]

AdWords API [+]

Google Ads scripts [+]

Content API for Shopping [+]

Google Ad Manager API [+]

DCM API [+]

Mobile Ads [+]

IMA SDK [+]

More Google blogs