An API is only as good as its documentation, which is why we’re pleased to announce some exciting improvements to the DFP API documentation based on user feedback. We hope these changes will make your workflow a little easier.

Additional information on report entities. We have added documentation for each Dimension, DimensionAttribute, and Column that states its UI name. This mapping from API entity names to UI entity names should make it easier to mimic report queries from the UI. Also, each of these report entities now has a list of compatible report types to help you determine which entities can be used with each other before running a report query.

Filtering report entity tables. There are a large number of Dimensions, DimensionAttributes, and Columns over which you can query a report. Also, as mentioned, we have added even more useful information to these entities. In order to better navigate this large body of documentation, you can now filter these entities on their name or description by entering keywords in the textbox that appears above each table.



Overall DFP documentation search. In addition to the reporting documentation improvements, we have also improved the overall search functionality on the DFP API documentation site. When you type a query into the search bar at the top of each page, the list of suggested results are now pulled only from the latest version, which allows more results to be shown instead of showing the same result across multiple versions.


As always, if you have any questions or suggestions, feel free to reach out to us on our forum.

On Thursday, May 31, 2018, in accordance with the deprecation schedule, v201705 of the DFP API will be sunset. At that time, any requests made to this version will return errors.

If you’re still using this version, now’s the time to upgrade to the latest release and take advantage of new features such as Preferred Deal support, reporting time zone configuration, and reporting currency configuration.

In order to upgrade, check the release notes to identify any breaking changes, grab the latest version of your client library, and update your code.

Significant changes include:

• Support for Preferred Deal line items.
• Editing AdUnit assignments to Placements now happens in the Placement Service.
• AdUnit.inheritedAdSenseSettings has been replaced with AdUnit.adSenseSettings and AdUnit.adSenseSettingsSource.
• Old partner metrics have been replaced by new PARTNER_MANAGEMENT fields.

This is not an exhaustive list, so as always, don't hesitate to reach out to us with any questions. To be notified of future deprecations and sunsets, join the DFP API Sunset Announcements group and adjust your notification settings.

On Friday, March 30, 2018, which is a one-month extension from the traditional deprecation schedule, v201702 of the DFP API will be sunset. At that time, any requests made to this version will return errors.

If you’re still using this version, now’s the time to upgrade to the latest release and take advantage of new features such as support for creating ImageOverlayCreatives, and new Ad Exchange reporting dimensions and columns. In order to upgrade, check the release notes to identify any breaking changes, grab the latest version of your client library, and update your code.

Significant changes include:

• Reporting dimensions and columns are now at parity with Ad Exchange.
• Editing AdUnit assignments to Placements now happens in the Placement service.
• AdUnit.inheritedAdSenseSettings has been replaced with AdUnit.adSenseSettings and AdUnit.adSenseSettingsSource.
• The AdUnit fields mobilePlatform, partnerId, isSharedByDistributor, and crossSellingDistributor have been removed.
• Placement fields adSenseTargetingLocale, isAdsenseTargetingEnabled, targetingDescription, targetingSiteName, and targetingAdLocation have been removed to align with the UI.
• Company.Type enumerations AFFILIATE_DISTRIBUTION_PARTNER and CONTENT_PARTNER have been removed. 
• CrossSellingDistributor has been removed.
• Old partner metrics have been replaced by new PARTNER_MANAGEMENT fields.

This is not an exhaustive list, so as always, don't hesitate to reach out to us with any questions. To be notified of future deprecations and sunsets, join the DFP API Sunset Announcements group and adjust your notification settings.

On Thursday, November 30th, 2017, in accordance with the deprecation schedule, v201611 of the DFP API will be sunset. At that time, any requests made to this version will return errors.

If you’re still using this version, now’s the time to upgrade to the latest release and take advantage of new features like support for creating ImageOverlayCreatives, new Ad Exchange reporting dimensions and columns, and the change history table. In order to upgrade, check the release notes to identify any breaking changes, grab the latest version of your client library, and update your code.

Significant changes include:

• Reporting dimensions and columns are now at parity with Ad Exchange.
• Editing AdUnit assignments to Placements now happens in the Placement service.
• AdUnit.inheritedAdSenseSettings has been replaced with AdUnit.adSenseSettings and AdUnit.adSenseSettingsSource.
• The AdUnit fields mobilePlatform, partnerId, isSharedByDistributor, and crossSellingDistributor have been removed.
• Placement fields adSenseTargetingLocale, isAdsenseTargetingEnabled, targetingDescription, targetingSiteName, and targetingAdLocation have been removed to align with the UI.
• Company.Type enumerations AFFILIATE_DISTRIBUTION_PARTNER and CONTENT_PARTNER have been removed.
• CrossSellingDistributor has been removed.
• Old partner metrics have been replaced by new PARTNER_MANAGEMENT fields.

This is not an exhaustive list, so as always, don't hesitate to reach out to us with any questions. To be notified of future deprecations and sunsets, join the DFP API Sunset Announcements group and adjust your notification settings.