Tag Archives: reports

Changes to ClickType field compatibility in AdWords API & Scripts Reports

We are marking the ClickType column in AdWords API and Scripts reports as incompatible with the following engagement and video-related fields in version v201607 and earlier:
  • AverageCpe
  • EngagementRate
  • VideoQuartile25Rate
  • VideoQuartile50Rate
  • VideoQuartile75Rate
  • VideoQuartile100Rate
  • VideoViews
  • VideoViewRate
  • AverageCpv
These fields refer to engagement and video view interactions, and aren’t compatible with the ClickType column, a click interaction metric. This restriction is already enforced in v201609 reports, see our migration guide for more details.

Starting Dec 1, 2016, you will get a ReportDefinitionError.INVALID_FIELD_NAME_FOR_REPORT error if ClickType column is requested with any of these fields.

Questions? Visit us on the AdWords API Forum or our Google+ page.

Support for v201607 reports in AdWords Scripts

We have added support for AdWords API v201607 reports in AdWords scripts. The major changes in this release are: See the AdWords API release notes for more details.

v201605 will remain the default version for reports until the week of October 10th, 2016. This gives you enough time to verify your scripts and make sure it works with the latest report version.

If you use API versioning in your reports, you need to modify your code to use v201607:

var report = AdWordsApp.report(query, {
apiVersion: 'v201607'
});
If you don’t use API versioning, no code changes are required. Your reports will continue using v201605 for now, and switch to v201607 when we make v201607 the default version the week of October 10th, 2016.

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

New dates for quality score changes in AdWords scripts

We recently announced some changes to the way AdWords scripts returns quality score data for keywords. To give developers more time to review their scripts that rely on Quality Scores in preparation for this update, null Quality Scores will now roll out on the the week of October 10th, 2016.

If you need help updating your script, or have any questions about these changes or AdWords scripts in general, you can post them on our developer forum.

Changes to quality score in AdWords scripts

We are making some changes to the way AdWords scripts returns quality score data for keywords.

We will return a null quality score for keywords that don’t have enough impressions and clicks to determine a Quality Score, such as new keywords or old ones that haven't served a long time. This will impact your scripts in two ways:
  • Reports: Starting with version v201607, the Critieria Performance and Keywords Performance reports will return a quality score of “--” for these keywords. Past versions (v201605 and earlier) of these reports will remain unchanged.
  • getQualityScore method: Starting the week of Sep 12, 2016, the getQualityScore method of the Keyword entity will return NULL score for these keywords instead of a numeric value.
If you use use quality score information in your script, please make sure you update it to work with the new changes.

Filtering on quality score

Filtering on quality score will work as follows:
  • If no filtering conditions are specified on the QualityScore field, all matching keywords are returned, including those with NULL quality score.
  • If numerical filtering conditions are specified on the QualityScore field, keywords with NULL quality score information are excluded automatically. For example, QualityScore <= 6 will include keywords with quality score from 1 to 6 but exclude keywords with NULL quality score.
  • To retrieve keywords with NULL quality score, filter using the condition HasQualityScore = FALSE.
  • To retrieve keywords with NULL quality score along with keywords with specific quality scores, you need to run two separate reports and combine the results locally.
If you have any questions about these changes or AdWords scripts in general, you can post them on our developer forum.

Support for v201605 reports in AdWords Scripts

We have added support for AdWords API v201605 reports in AdWords Scripts. The major changes in this release are:

See the AdWords API release notes for more details.

v201603 will remain the default version of the reports until July 20, 2016. This gives you enough time to verify your scripts and make sure it works with the latest report version.

If you use API versioning in your reports, you need to modify your code to use v201605:


var report = AdWordsApp.report(query, {
apiVersion: 'v201605'
});

If you don’t use API versioning, no code changes are required. Your reports will continue using v201603 for now, and switch to v201605 when we make v201605 the default version on July 20, 2016.

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

Support for v201603 reports in AdWords Scripts

We have added support for AdWords API v201603 reports in AdWords scripts. The major changes in this release are: See the AdWords API release notes for more details.

Starting from this release, we will not switch to the latest reporting version on the day of the release by default. Instead, we will keep the previous report version as the default version for a while before switching to the latest reports version. This will give you enough time to verify your scripts and make sure it works with the latest report version.

If you use API versioning in your reports, you need to modify your code to use v201603 as shown below.

var report = AdWordsApp.report(query, {
apiVersion: 'v201603'
});
If you don’t use API versioning, no code changes are required. Your reports will continue using v201601 for now, and switch to v201603 when we make v201603 the default version on May 17, 2016.

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

Support for v201601 reports in AdWords Scripts

We have added support for AdWords API v201601 reports in AdWords scripts. The major changes in this release are:

The release also introduces some improvements to several reports in existing versions (v201506, v201509).

See our release notes for more details.

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


var report = AdWordsApp.report(query, {
apiVersion: 'v201601'
});

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

Support for v201509 reports in AdWords Scripts

We have added support for AdWords API v201509 reports in AdWords scripts.

Changes to conversion columns

This release includes several changes that coincide with the recent announcement on conversion columns. Several reporting columns were removed and new columns were added. See the AdWords API release notes for more details.

Video and multi-channel reporting

We are now including statistics and metrics for AdWords for video and TrueView video campaigns in several reports. This includes a new Video Performance Report. Note that reports will only include data for newly created video campaigns in AdWords campaign management or campaigns that were migrated from AdWords for video.

We have also added new reporting columns that help multi-channel advertisers more easily manage reporting for specific campaign types like Search, Shopping, Display, and Video.

See Video and multi-channel reporting changes for more details.

Miscellaneous reporting changes

  • All columns that have a List or Map return type now return data in JSON format.
  • Shared set type is now returned as an ENUM instead of an Integer in SHARED_SET_REPORT and CAMPAIGN_SHARED_SET_REPORT.
  • Several new columns have been added to existing reports.
  • A few duplicate columns in existing reports were removed.
  • MatchType and MatchTypeWithVariant columns were renamed to QueryMatchType and QueryMatchTypeWithVariant in PAID_ORGANIC_QUERY_REPORT and SEARCH_QUERY_PERFORMANCE_REPORT.

See Miscellaneous reporting changes for more details.

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


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

Support for v201506 reports in AdWords Scripts

We have added support for AdWords API v201506 reports in AdWords Scripts. This version adds support for FINAL_URL_REPORT, the Upgraded URLs-compatible replacement for the DESTINATION_URL_REPORT.

This version also introduces several changes to the reporting columns
If you use API versioning in your reports, then you need to modify your code to use v201506 as shown below. If you don’t use API versioning, no code changes are required.

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

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!