Google Ads Developer Blog: dfa_reporting

Introducing the DCM/DFA Reporting and Trafficking API

Monday, December 15, 2014

If you programmatically manage and report on DoubleClick Campaign Manager (DCM) campaigns, you know that trafficking and reporting tasks have traditionally been handled by separate APIs. We realize that this can be inconvenient so today we're introducing a unified solution: the DCM/DFA Reporting and Trafficking API!

This release constitutes a new major version (v2.0) of what was previously known as the DFA Reporting API, adding functionality previously only available in our dedicated trafficking API. While older versions of our dedicated reporting and trafficking APIs will continue to remain available until September 30th, 2015, we recommend that you adopt this updated version as early as possible to take advantage of all of its new and enhanced features.

Unified trafficking and reporting experience

This release combines the trafficking functionality of the DFA API with the reporting functionality of the DFA Reporting API to create a simplified end-to-end experience. It's now possible to manage your DCM campaigns and report on their performance without switching APIs or reauthenticating. In addition, a unified object model allows you to pass data seamlessly between these two systems.

New trafficking functionality

This API expands the feature set of the DFA API to add new and improved trafficking functionality. A few highlights of this expanded functionality include:

Updated project quota limits

In addition to increasing the functionality of the API, we've also increased the default project quota limit. All projects can now make 50,000 requests/day (up from 10,000), to support a combined trafficking and reporting workflow. As always, requests for additional quota can be made via the Google Developers Console, should the need arise.

Learn more

This API is built on the same RESTful, standards-based technology stack previously employed by the DFA Reporting API. This means that you have access to all sorts of useful tools for trying it out, such as the APIs explorer (which is also built into the documentation for each method) and our generic, cross-API client libraries. The getting started guide is also a great reference for users who are just starting out.

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

- Jonathon Imperiosi, DFA API Team

DFA Reporting API Version 1.3 Released

Monday, July 15, 2013

We’re pleased to announce the newest DFA Reporting API release, version 1.3. This version adds an often requested feature: the ability to retrieve the dimensions and metrics that are available for selection. Compatible FieldsDoubleClick for Advertisers allows you to restrict the visibility of certain metrics and dimensions for individual users based on the permissions granted to the user role and filters applied to the user profile. Additionally, certain dimensions and/or metrics cannot be used in combination with one another. For these reasons it can be difficult to determine which metrics and dimensions are available. The new reports.compatibleFields resource allows you to programmatically tackle this problem, returning a listing of fields available to the current user based on the report being created.Additional details are available in our developer documentation release notes. We’re always available to answer your questions on our forum, or you can reach out to us on our Google+ Page.

- Joseph DiLallo, the DFA API Team

DFA Reporting API Version 1.2 Released

Thursday, May 30, 2013

We’re pleased to announce the newest DFA Reporting API release, version 1.2. This version’s main additions include paid search dimensions and a way to view all reports and files in your account, not just those that you own. Paid SearchPaid search dimensions have been added to the API with this release. We also added support for these new dimensions to version 1.1, but only version 1.2 contains the new matchType field in the DimensionValue resource allowing you to filter paid search dimensions by one of the following:

EXACT

CONTAINS

BEGINS_WITH

WILDCARD_EXPRESSION

Report SharingWe have added the ability to list all reports and files in your DFA account (in addition to those owned by you). You may also optionally list just those files that have been shared with you using the Files resource. You can find this option in the scope parameter in the input to the respective list methods.Refer to the release notes in our developer documentation for more details. We’re always available to answer your questions on our forum, or you can reach out to us on our Google+ Page.

- Joseph DiLallo, the DFA API Team

Synchronous Reporting in DFA Reporting

Wednesday, January 30, 2013

One of the more exciting features in the DFA Reporting API is synchronous reporting - the ability to run smaller reports right when you request them. Synchronous reporting is great for fetching metrics when you need them quickly, such as in a GUI environment. To help you understand how to take advantage of this feature, we’ve added a synchronous reporting guide.If you have any questions on this topic, please bring them to our forum. We’d be happy to answer them for you and add them to our guide.

- Joseph DiLallo, the DFA API Team

DFA Reporting API Version 1.1 Released

Thursday, September 27, 2012

A new release of the DFA Reporting API, version 1.1, extends the ability of your applications to tap into the power and flexibility offered by our new reporting platform. Feature Parity with ReportBuilderUsing the DFA Reporting API, you can now take advantage of all of the report types in ReportBuilder:

STANDARD

REACH

PATH_TO_CONVERSION

FLOODLIGHT

The API contains support for CROSS_DIMENSION_REACH reports, but the backend currently does not. Support for these reports will be turned on at a later date and will be accessible through version 1.1. Additionally, you may now set a list of recipients to be emailed when a scheduled report runs. We have paved the way for downloading reports in different formats, though currently CSV is the only available option. A Few Backwards Incompatible ChangesWe have taken the opportunity to make a few backwards incompatible changes to the API. It will not be standard procedure to make changes like this in minor version releases, but since the API is still relatively new, locking down the final structure of our API now will reduce changes later and ease development. These changes include:

Report files and report criteria now share the same dateRange kind.

The urls object in the File resource has changed to support report formats other than CSV.

A customRichMediaEvents and an activities kind have been added, both of which are reused between different report types.

Our updated release notes page has a full list of changes for your reference. As always, we highly value your feedback and questions. Please join us on our forum whenever you’d like to reach us.

- Joseph DiLallo, the DFA API Team

New Developments for the DFA API

Monday, August 20, 2012

We have some exciting changes and important announcements for the DoubleClick for Advertisers community as we begin to improve our overall approach to APIs for the product. This is just the first of many improvements that will come over the next several quarters.

DFA API v1.19 - Security at the Forefront

The newest release of the DFA API, v1.19, is now available. This release brings two major security enhancements. SSL encryption, a feature we originally slated for v1.18, is now mandatory on all API requests. This is in line with a Google-wide effort to leverage HTTPS connections for greater security.

Secondly, this release of the DFA API supports OAuth2 authentication in addition to the API passwords tied to your DFA user profiles. We recommend using this new approach. In time, we plan to phase out the profile-specific passwords in favor of making OAuth2 the single, standard way to authenticate against our API. Please see our documentation for more information on how OAuth2 is integrated with the DFA API and reference our client libraries, all of which will soon be updated with examples of using OAuth2 instead of an API password.

Our release notes page has been updated with complete notes on v1.19.

DFA Reporting Gets an API

Less than a year ago, we announced the availability of the new DFA Reporting system. This new system offers the power, flexibility and data access required to keep up with today’s always-connected, multi-device consumer. Compared to Report Central, data in the new DFA Reporting system is fresher, can be segmented by the hour, and includes a host of new features including geographic reporting for all ads. Today, we are pleased to launch an API for the new DFA Reporting system.

The DFA Reporting API is a language-neutral REST API that offers programmatic access to the same reports as can be generated through the DFA Reporting user interface. Along with improved speed and performance, the new API will allow you to create, edit, and schedule Standard reports. We will continue to launch additional features to the new DFA Reporting API over the next few months. Support for this API has been added to the Google APIs Client Libraries. The Java library currently has the most complete example set.

Version Enforcement on the Java DART API

The Java DART API, long the bread and butter of integrating with our ReportCentral service, has a large range of versions currently in use. We are going to begin enforcing a minimum version requirement on this API on November 3rd, 2012. At this time, clients will be must be using one of the newest versions of the Java DART API -- version 13.4, version 13.6, or version 13.8. We recommend you take the opportunity to consider the new DFA Reporting API. Come enjoy the benefits of its newer technology.

Changes to Our Deprecation Policy

This past April, Google announced changes to the deprecation policies surrounding our APIs to help keep our products moving and innovating quickly. DFA is joining this overall Google effort. As such, as of November 3rd, 2012, DFA will remove the depreciation policy for all of our APIs.

The removal of the deprecation policy doesn't mean we have changed the way we think about our APIs. As signaled by the launch of the new DFA Reporting API, we are more committed than ever to offering stable and relevant APIs to our developer community. We will continue to work very hard to communicate any changes to our APIs well in advance, regardless of the APIs' deprecation policy. Our commitment to our clients and to the API remains unchanged.

Until November 3,2012 we will continue the deprecation policy we currently have in place. With the the release of v1.19, version v1.17 is now deprecated. Version v1.17 will continue to be supported until September 8th, 2012, when it will be entirely removed from service, as previously announced. Meanwhile, version v1.18 will be deprecated in November and sunset in early December, 2012.

As always, we highly value your feedback and questions. Please join us on our forumwhenever you’d like to reach us.

- Joseph DiLallo, the DFA API Team

Ads Developer Blog

Introducing the DCM/DFA Reporting and Trafficking API

DFA Reporting API Version 1.3 Released

DFA Reporting API Version 1.2 Released

Synchronous Reporting in DFA Reporting

DFA Reporting API Version 1.1 Released

New Developments for the DFA API

Labels

Archive