Tag Archives: reporting

AwReporting: Importing offline reports and AdWords video campaign performance reports

This release of AwReporting introduces new command-line arguments that can be used to import CSV files into AwReporting without using the AdWords API. So you can download reports from the AdWords user interface, even reports not available via the AdWords API like the Video Campaign Report, and import them into your database.

Offline reports

The command-line arguments that allow the tool to import reports directly from downloaded files are:
  • onFileReport, where you specify the Report Type (same ones used in the API).
  • csvReportFile, where you specify the absolute path of the CSV file that will be imported to the database.
Here is a command-line example including the new arguments:

$ java -Xmx1G -jar aw-reporting/target/aw-reporting.jar
-startDate YYYYMMDD -endDate YYYYMMDD
-file aw-reporting/src/main/resources/aw-report-sample.properties
-onFileReport CAMPAIGN_PERFORMANCE_REPORT
-csvReportFile
Keep in mind that AwReporting will only be able to import reports that are mapped in the aw-reporting-model module. You can check out the supported types on the project's GitHub source code page.

The CSV files must be in the same format as the ones downloaded by AwReporting via the API:
  • The first line of the file must contain a string with the file description.
  • The second line must contain the column headers with the field names.
  • The remaining lines contain the report data.
  • The last line will be ignored if it's a Total line.
Here is an example:


"ACCOUNT_PERFORMANCE_REPORT (May 1, 2015-May 10, 2015)"
Customer ID,Day,Account,Cost,Clicks,Impressions
1234,2015-05-01,Test Account,1420000,10,1978
1234,2015-05-02,Test Account,550000,4,2209
1234,2015-05-03,Test Account,1290000,6,3458
1234,2015-05-04,Test Account,320000,2,714
1234,2015-05-08,Test Account,1380000,5,2955
1234,2015-05-09,Test Account,1200000,6,2602
1234,2015-05-10,Test Account,750000,4,2793
Total, --, --,6.91,37,16709
Video Campaign Performance Reports

The AdWords API doesn't support video campaign performance reports, but you can still access the web interface and download the CSV files manually.

With the new offline import feature described above, we have added support for video campaign reports in AwReporting, allowing you to import all available fields in the web interface to the same database where the other reports are stored. We hope that this feature will make it easier to integrate systems and dashboards to the database, including video campaign performance data of clients.

To import a video campaign report CSV file, you just need to specify the report type in the onFileReport property as VIDEO_CAMPAIGN_REPORT, and point to the absolute path of the file in the csvReportFile property. The properties can be found in the source code of the project, in the ReportVideoCampaign.java entity.

Before importing the CSV files downloaded from the web interface, you will need to make sure that they are following the format described above, so AwReporting can understand it. You can find an example that we used on our unit tests in the project's source code.

You can check out these new features and the latest released version on the project's main GitHub page. And because AwReporting is open source, you can experiment with the code itself, by adding new types of reports as you need them. The project's GitHub page also includes the complete installation instructions.

If you have any questions about the tool, have ideas for new features, or find any bugs, you can post them as issues in GitHub. We maintain the tool, and the list of issues on GitHub is our first option when planning for next releases.

And of course, make sure to check out our Google+ page for client library and Ads APIs updates.

Change to default filters within AdWords API Reporting

Starting this week AdWords API reports will by default return all objects regardless of their status. API users will need to specify a custom predicate in order to filter out removed entries.

With AdWords API v201502 we made the handling of removed items consistent across services by changing the default filter of all services to exclude all removed entries.

We also included a few reports in this change, but based on your feedback, we’re reverting back to the old behavior. The new filters proved to be confusing and caused discrepancies between reports on different levels. In practice, most API users like to see historical stats of all objects regardless of their current status, so we are making it the default.

As of this week, we’ll start returning all entries in AdWords API Reports regardless of their status by default. This fully matches the old v201409 behavior. You can still filter out removed entries by specifying a custom predicate. Note that non-reporting services will still filter out removed entries by default in v201502 and later, as they do now.

If you have any questions or need help with the migration, please post on the forum or the Ads Developers Plus Page.

AwReporting: Upgraded to use AdWords API v201502

We’ve upgraded the AwReporting tool to use the latest AdWords API version, v201502. The code changes were made according to the migration guide.

Note that besides code changes, the database tables’ column names have also been updated to reflect the new report field names. Since these changes are scattered around many tables, you can run this version of AwReporting on a new database schema, then use the schema generation command to generate both database schemas and compare them. You can also create SQL scripts to import data from old database tables to new ones with updated column names.

We’ve put the code changes in the v201502_upgrade branch. Please feel free to pull this branch and give it a try. Remember to update the properties file to use the new report field names. This upgrade branch will be merged into the master branch at the end of May.

If you have any questions or feedback regarding this upgrade, let us know via the project’s issue tracker.

New features in AdWords Scripts

We are excited to announce two new features for AdWords scripts:

AdWords API v201502 reports

AdWords scripts now support AdWords API v201502 reports. The new version introduces two new reports: USER_AD_DISTANCE_PERFORMANCE_REPORT and LABEL_REPORT. We also introduced several new columns, renamed some columns to make them consistent with the AdWords UI, and removed some duplicate columns. See the AdWords API release notes for more details.

If you use API versioning in your reports, you’ll need to modify your code to use v201502 as shown:

var report = AdWordsApp.report(query, {
apiVersion: 'v201502'
});
If you don’t use API versioning, your scripts will now default to v201502 reports. If your scripts access one of the removed or renamed columns, you may need to fix that column name in your scripts.

JDBC

JDBC allows your scripts to connect to external databases through the JDBC service, a wrapper around the standard Java Database Connectivity technology. In Apps Script, the JDBC service supports Google Cloud SQL, MySQL, Microsoft SQL Server, and Oracle databases. See our guide for more details.

If you have any questions about these features or AdWords scripts in general, you can post them on our developer forum.

Support for v201409 Reports in AdWords Scripts

We are announcing support for AdWords API v201409 reports in AdWords scripts. The new version introduces PLACEHOLDER_REPORT, a new report type that allows for retrieval of extension stats.

If you use API versioning in your reports, then you need to modify your code to use v201409 as shown below. If you don’t use API versioning, no code changes are required.

var report = AdWordsApp.report(query, {
apiVersion: 'v201409'
});
If you have any questions about this feature or AdWords Scripts in general, you can post them on our developer forum.

New to the AdWords API: excluding headers and summary data from reports

Do you save your AdWords API reports to a database? Do you have code that detects and skips header and summary rows? If the answer to these questions is "why yes, I do!", then you'll be happy to hear that in AdWords API v201409 you can modify your report requests so that the returned results will not include these rows.

Excluding the report header

Prior to v201409, the output of each AdWords report included a header that gave the name of the report and the date range in your predicates:

"KEYWORDS_PERFORMANCE_REPORT (Sep 21, 2014-Sep 27, 2014)"

If you do not want this row in your report results, include the new skipReportHeader HTTP header with a value of true.

Excluding the report summary

Similar to the header, each AdWords report for versions prior to v201409 returned a summary row with totals in its final row of output:

Total, --, --,44700

If you don't want this row in your report results, include the new skipReportSummary HTTP header with a value of true.

Note: If you do not include these headers or specify a value of false for both headers, your report results will include the header and summary rows, just as they did for prior versions of the AdWords API.

For more details, check out our updated Reporting Basics guide. Still have questions? Feel free to visit us on the AdWords API Forum or our Google+ page.

Announcing report download limits for the AdWords API

Starting October 8th, 2014, if you're using the AdWords API without a Standard Access developer token, you will be limited to 1,000 report downloads per day. Previously, there were no daily operational limits applied to report downloads for the Basic Access level. The new limit is being introduced to ensure consistency and high-quality AdWords API platforms for advertisers.

If your developer token already has the Standard Access level, then this limit will not be applied.

If your developer token has the Basic Access level and you currently download more than 1,000 reports per day, then you'll be impacted. To minimize the impact:

  1. The AdWords API Compliance Team has already temporarily upgraded your developer token to Standard Access level.
  2. The AdWords API compliance team contacted you on September 24th, 2014 asking you to apply for permanent Standard Access prior to the temporary Standard Access level expiration on October 24th, 2014.

Important: The AdWords API compliance team will contact you using the developer contact email on file in your MCC's API Center. It's important to ensure the email is up-to-date.

If you currently have Basic Access, but at a later time feel you will need more than 1,000 report downloads per day, feel free to apply for Standard access.

AdWords API: Changes to how we report mobile click-to-call data

Starting the week of September 29, 2014, we’re changing the way we report mobile click-to-call data in AdWords API reports.

Currently, when you download a CAMPAIGN_PERFORMANCE_REPORT or ADGROUP_PERFORMANCE_REPORT with ClickType segmentation, mobile click-to-call data is reported as two separate click types:
  • A row with ClickType = CALL contains all the stats related to clicks, like Clicks, Impressions, Cost, etc.
  • A row with ClickType = MOBILE_CALL_TRACKING contains all the corresponding stats related to phone calls, like NumOfflineInteractions, NumOfflineImpressions etc, OfflineInteractionCost, etc.
Based on your feedback, we will combine these two click types into a single click type starting the week of September 29, 2014. The combined data will now show up on a single row: ClickType = CALL. As a result, you’ll no longer receive data for ClickType = MOBILE_CALL_TRACKING. This change will impact existing mobile click-to-call data, including historical performance.

If your applications use these report types to process mobile click-to-call data, make sure they account for this new data format. If you have questions or comments, let us know on our developer forum. You can also follow our Google+ page for updates about the AdWords API.

New labels features in AdWords API v201406

Many developers in the AdWords API community have mentioned that being able to create, modify, assign, and report on labels through the API would be extremely helpful. Well, we're excited to report that the v201406 release of the AdWords API includes all of these requested features!

Summary of label services and features End-to-end example
So how do these new features work together? Check out our labels guide to get you on the road to AdWords label expertise!

Next steps
If you've never used labels in your account or need a refresher course, check out the Help Center labels guide. Once you're ready to dive in, try out the label examples in your client library of choice.

Still have questions? Feel free to visit us on the AdWords API Forum or our Google+ page.

DS features in May

In May, we added the following features to DoubleClick Search (DS):

  • Public launch of Shopping campaigns in DS
    You can create and manage AdWords Shopping campaigns in DS, a feature that we initially rolled out in beta in March. Shopping campaigns are a new campaign type for AdWords Product Listing Ads that streamline how you manage and bid on your products, report on the performance of your ads, and find opportunities to grow your traffic from Google. Learn more.

  • Specify and report on sitelinks for ad groups
    Sitelinks are an ad extension available in AdWords engine accounts. They appear beneath the text of your ads (and in addition to the main landing page), link to specific pages on your website, and help customers find what they're looking for on your site with just one click. By default, all ads inherit sitelinks from the campaign, but now you can add different sitelinks for each ad group or prevent an ad group from displaying sitelinks. Learn more.

  • Include custom dimensions and metrics in DS reports
    If you use Floodlight activities to track conversions, you can add details to your DS reports that are customized to your business needs, such as the genre of a movie that a user purchases, the zip code to which an item is shipped, shipping costs, and so on. Learn more.

  • Upgrade to the new AdWords “Search Network with Display Select” campaigns
    AdWords will soon be replacing “Search & Display Networks” campaigns with a new campaign type, “Search Network with Display Select”, that offers 35% better Google Display Network performance than your current “Search & Display Networks” campaigns. You can upgrade your “Search only" and “Search & Display Networks" campaigns one at a time from AdWords, or use DS bulksheets to upgrade multiple campaigns with a single upload. Learn more.

We also made the following feature updates:

  • Executive reporting: Filter data sources in charts
    By default, charts display metrics from all data sources that are in a report. If you want a chart to display metrics only from specific campaigns, devices, or even keywords of a particular match type, you can add a filter to the chart. The chart will contain data only for items that match the filter.

  • Support for the AdWords "Rotate indefinitely" and "Conversion optimize" settings
    DS now supports the “Rotate indefinitely” and “Conversion optimize” settings for AdWords campaigns in addition to the “Rotate evenly” and “Optimize for clicks” settings that were available previously. Learn more.

Watch the recorded webinar for May features to see these updates in action.

Posted by the DoubleClick Search team