Today we’re pleased to announce the release of the v201605 DFP API. This release focuses on new features for reporting and sales manager.
For a full list of API changes in v201605, see the release notes.
ReportingWe’ve added two new reporting features in v201605 to bring the API closer to the UI query tool. The first is a filter for First Look rows in your report. This only applies if you’re running reports on networks that are using the First Look feature. In the API, this is available as a dimension called IS_FIRST_LOOK_DEAL.
Here is a breakdown of how this dimension behaves:
- If this dimension is not included in a report, then your report will contain First Look rows. This is the default behavior.
- If this dimension is included and set to true, then your report will contain only First Look rows to enable you to look at First Look metrics in isolation.
- If this dimension is included and set to false, then your report will not contain any First Look rows.
You can read more about DFP First Look and how it affects the query tool in our help center article.
The second reporting feature is more time zone settings in sales reports. For this, we’ve added a ReportQuery flag called useSalesLocalTimeZone. This option only applies to reports containing sales attributes and metrics. When set to true, all applicable attributes or metrics will be displayed or calculated using proposal or proposal line item time zones, instead of the network time zone.
Sales managerFor sales manager, we’ve added a field called nameSource on products to make it clear if the product’s name is the default name generated from its template, or has been overridden. This also allows you to revert an overridden product’s name to use the default name generated from the template.
We’ve also added the long awaited workflowProgress indicator to proposals. The WorkflowProgress contains information such as which step or rule a proposal’s workflow is currently on. This information is equivalent to the progress bar you see in the DFP web UI when viewing a proposal.
Finally, proposals now have a field called offlineErrors that contains errors that might have occurred in background processes. For example, if a proposal failed to reserve inventory, this field will be populated with an error. Proposal.hasOfflineErrors has been added to help you find proposals that have offline errors.
DeprecationWith each new release comes a new deprecation. If you're using v201505 or earlier, it's time to look into upgrading. API version v201502 will be sunset at the end of May 2016, and v201505 will be sunset at the end of August 2016.
Also, please remember that we are tightening our sunset schedule. DFP versions v201508 and v201511 will both be sunset at the same time at the end of November 2016.