Tag Archives: reporting

AdWords scripts now supports v201708 and v201710 in reports

We have added support for AdWords API v201708 and v201710 reports in AdWords scripts.

The major changes in v201708 are:
  • New fields in various report types.
  • The TABLE_EXTENSION enum value for ClickType was renamed to PRICE_EXTENSION.
  • See the full AdWords API release notes for more details.
The major changes in v201710 are:
  • The Automated field was added to the AD_PERFORMANCE_REPORT.
  • The EnhancedCpvEnabled field was removed from all reports.
  • See the full AdWords API release notes for more details.
In addition to these changes, v201705 is now the default version for reports. You can use one of the newly supported versions instead by specifying the apiVersion in your report request:
var report = AdWordsApp.report(query, {
    apiVersion: 'v201710'
});

If you have any questions about these changes or AdWords scripts in general, you can post them on our developer forum.
- Mike Cloonan, AdWords API Team.

Changes to AdWords Express campaigns in AdWords API reports

If you use AdWords API reports to retrieve performance statistics for AdWords Express campaigns, please read on as these changes will affect you.

What's changing?
In preparation for upcoming improvements, an ongoing migration process is modifying campaigns managed by AdWords Express.

Currently, when you enable an AdWords Express promotion, it creates up to two AdWords campaigns:
  • A Search Network campaign with:
    • AdvertisingChannelType = SEARCH (appears as Search)
    • AdvertisingChannelSubType = SEARCH_EXPRESS (appears as Search Express)
  • A Display Network campaign with:
    • AdvertisingChannelType = DISPLAY (appears as Display)
    • AdvertisingChannelSubType = DISPLAY_EXPRESS (appears as Display Express)
As part of the migration, the two campaigns above will be paused and replaced by a single AdWords campaign with:
  • AdvertisingChannelType = EXPRESS (appears as Express)
  • AdvertisingChannelSubType = UNKNOWN (appears as an empty string)
After the campaigns for a promotion are migrated, performance statistics for the AdWords Express promotion will be available in reports as follows:
  • Performance statistics for dates prior to the migration will be attributed to the original campaigns with SEARCH / SEARCH_EXPRESS and DISPLAY / DISPLAY_EXPRESS.
  • Performance statistics for dates after the migration will be attributed to the new campaign with EXPRESS / UNKNOWN. The new campaign will only appear in the CAMPAIGN_PERFORMANCE_REPORT.
For example, assume an AdWords Express promotion manages the following two AdWords campaigns today:

Campaign ID Campaign Status Advertising Channel Type Advertising Channel Sub Type
1000 ENABLED SEARCH SEARCH_EXPRESS
2000 ENABLED DISPLAY DISPLAY_EXPRESS

After the migration, the account will contain the following campaigns for the AdWords Express promotion:

Campaign ID Campaign Status Advertising Channel Type Advertising Channel Sub Type Performance statistics
1000 PAUSED SEARCH SEARCH_EXPRESS Before the migration
2000 PAUSED DISPLAY DISPLAY_EXPRESS Before the migration
3000 ENABLED EXPRESS UNKNOWN After the migration

What should you do?
Ensure that your application properly handles all three combinations of AdvertisingChannelType and AdvertisingChannelSubType. For example:
  • If your application inspects AdvertisingChannelType or AdvertisingChannelSubType to handle AdWords Express campaigns, please adjust the logic to handle the new combination of EXPRESS / UNKNOWN.
  • If you use predicates on AdvertisingChannelType or AdvertisingChannelSubType to include or exclude AdWords Express campaigns, make sure that your predicate takes the new combination into account.
Reminder: The AdWords API only supports AdWords Express campaigns in reports. You cannot modify AdWords Express entities in your account using the AdWords API.

If you have any questions about this change, please contact us via the forum.
- Josh Radcliff, AdWords API Team

Search impression share data will be updated more frequently

Starting mid-November, we’ll be updating AdWords API impression share reporting data more frequently. As a result, you'll be able to get the previous day's data by 12 PM (your local time). Previously, you might have had to wait up to 48 hours for the previous day’s data. This change affects the following reporting fields:
  • SearchBudgetLostImpressionShare
  • SearchExactMatchImpressionShare
  • SearchImpressionShare
  • SearchRankLostImpressionShare
With this change, you may see data fluctuate for report definitions that contain any of the above fields along with one of the following date ranges:
  • YESTERDAY, TODAY, LAST_7_DAYS, THIS_MONTH, ALL_TIME, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY
  • CUSTOM_DATE that includes the current date or the day before the day when you make a report request
This change allows for more real-time monitoring of search impression share. If you prefer to see more stable values, make sure the date range in your request doesn’t include the current date or yesterday if it’s not yet 12 PM in your time zone.

As always, if you have any questions, please post on the forum.
 - , AdWords API Team

Launch of AwReporting 2.0

AwReporting is an open-source Java framework optimized for large-scale retrieval of AdWords API reports.

We’ve just released a new major version of the tool that encompasses the full suite of AdWords API Reports and their fields. As mentioned in our pre-announcement, "aw-reporting-server” and “aw-reporting-server-appengine” modules were removed.

You can find the latest release on GitHub. Please find the full list of changes in the ChangeLog, and follow the migration guide to upgrade from the current version of the tool.

Feel free to ask questions or give us feedback via the forum or the project’s issue tracker.
, AdWords API Team

Upcoming changes to AwReporting

AwReporting is an open-source Java framework that is optimized for large-scale retrieval of AdWords API reports.

We plan to release a new major version (v2.0) within the next few months that will
This release will have some backwards incompatible changes, such as
  • uses report type names with “AW_” prefix as database table names
  • uses field names as database column names
  • renames setting “mccAccountId” to “managerAccountId” in properties file
  • renames setting "aw.report.downloader.retries.count" to "aw.report.downloader.num.attempts"
  • renames processor type setting’s options from “ON_FILE” to “FILE”, and “ON_MEMORY” to “STREAM”
  • removes “-debug” and “-verbose” command line options, and depends on log configuration file (default one is log4j.properties) for setting logging granularity
  • removes server modules (aw-reporting-server and aw-reporting-server-appengine) in the new release since they have third-party dependencies that are not actively maintained
If you are actively using the aw-reporting-server or aw-reporting-server-appengine module or have any questions about this upcoming release, please let us know on this forum thread.
, AdWords API Team

AdWords: Updates to impression share in reporting

Starting in late April, 2016, AdWords will begin rolling out a new calculation for impression share, which will potentially affect your reports in the AdWords API if you rely on impression share columns and run Video Campaigns.

Historically, a small percentage of impressions on YouTube videos were not being included in the calculation of the impression share columns. We've implemented an improved algorithm to more accurately count impression share volume that now accounts for these impressions.

We plan to roll out the improved calculation over the next few months for all accounts and impressions, so if you run campaigns on YouTube, your impression share statistics will become more accurate when your account goes live.

If you have any questions about this change, or other questions about the AdWords API, please contact us via the forum or the Ads Developers Plus Page.

- Michael Cloonan, AdWords API Team

Reporting changes in AdWords API v201509

AdWords API v201509 introduces some changes to reporting columns, particularly Clicks. Recently, AdWords introduced new columns called Engagements and Interactions. It also added reporting columns related to video campaigns such as VideoViews, which have previously been unavailable via API reporting. AdWords API version v201509 has updated its reporting to match these changes.

The new Interactions field, available in API performance reports, can be thought of as the main action a user takes with the ad format: clicks for text ads, engagements for Lightbox ads, and views for video ads. Previously, views for video ads were not returned in API reporting, so having access to this data is new.

Prior to v201509, the Clicks field always included both clicks and engagements. Starting in v201509, the Clicks field includes only click actions, like clickthroughs to a landing page or clicks to call. This means that clicks on video ads, which are unpaid, will be included in this field. However, engagements for Lightbox ads will not be counted.

If measuring performance across multiple ad formats, you might consider using Interactions to view the total number of primary user actions on ads, all in the same column. Clicks, Engagements, and VideoViews are available as well for more fine-grained reporting by ad format.

The table below summarizes the changes in each field for various ad formats.

Field
v201506
v201509
Clicks
Text ads: clickthrough to a landing page

Lightbox ads: hover to expanded ad format
Text ads: clickthrough to a landing page or clicks to call

Lightbox ads: clickthrough to a landing page

Video ads: clickthrough to a landing page
Engagements
N/A
Lightbox ads: hover to expanded ad format
VideoViews
N/A
Video ads: view
Interactions
N/A
Text ads: clickthrough to a landing page or clicks to call

Lightbox ads: hover to expanded ad format

Video ads: views

Please note that reporting in v201506 and previous versions is unaffected; they return the same data that they always have, represented the same way. This means that when comparing the data you receive from older versions of the API to user interface reports, or to v201509 reports, the numbers will not directly match up. Video-related stats will still be excluded from v201506. The Clicks column in v201506 will match the Interactions column from v201509 if you subtract out video interactions.

For ease of reporting, it’s recommended to migrate to v201509 as soon as possible.

Keep in mind these aren’t the only reporting changes in v201509 — for more details on conversion-related reporting changes, please see the release notes.

If you have any questions about this or other aspects of the AdWords API, please contact us via the forum or the Ads Developers Plus Page.

- Michael Cloonan, AdWords API Team

More features now available in the AdWords API

Following the release of AdWords API v201506, we've added a few additional features that are available immediately:
  • Android App ‘first open’ conversion tracking. Recently available in AdWords, this new conversion tracking solution measures when a user first opens an app after clicking on an ad and completing an Android app install. Check out the new FIRST_OPEN conversion type in the AppConversion tracker that also supports Postback URLs for Android.
  • A new report specific to final URLs: FINAL_URL_REPORT. The report replaces the deprecated DESTINATION_URL_REPORT and provides statistics aggregated at the final URL level.
We also launched account hiding support recently—see this announcement if you missed it. If you have any questions, feel free to reach us on the forum or via the Ads Developers Plus Page.
 - , on behalf of AdWords API Team.

Changes to DFP Reporting, now with more deprecation!

After our last round of spring cleaning, we've gone back to the drawing board to take another look at how we could make reporting better. There currently is an abundance of Dimensions, DimensionAttributes, and Columns (and more coming with each release), so in an effort to simplify the list of fields, we will be sunsetting the following reconciliation-related dimension attributes / columns in all versions. This will happen on September 1, 2015.

Columns with equivalent replacements:

Columns without equivalent replacements:

While the first two have equivalent replacements, the latter ones are not being replaced, as they don’t exist in core product reporting either.

This means that usage of these columns / dimension attributes will begin throwing errors in all versions starting September 1st. If your network is actively using any of these, please update your reports to switch to the supported fields or remove them entirely. If you have any questions, comments, or concerns about this, you know where to reach us!

 - , DFP API Team