Tag Archives: reports

Support for v201802 reports in AdWords scripts

We have added support for AdWords API v201802 reports in AdWords scripts. The key changes in this release include:
  • A new report type, LANDING_PAGE_REPORT, to provide performance stats for the pages that receive traffic from your ads.
  • ConversionLagBucket field added to various reports to help you determine how long it takes customers to convert.
  • New fields added to support Gmail ads.
Read the AdWords API release notes for complete details, including additional features not listed here.

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

var report = AdWordsApp.report(query, {
  apiVersion: 'v201802'
});
If you don't use API versioning, no code changes are required. We are updating the default reporting version to v201710 along with this change, and your reports will upgrade automatically.

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

Upcoming changes to ad network type columns in AdWords API and Scripts reports

On March 19, 2018, we are updating how AdNetworkType1 and AdNetworkType2 columns report zero impression rows related to video networks.

Currently, if you request AdNetworkType1 or AdNetworkType2 columns and request zero impression rows by setting the includeZeroImpressions flag to true, you get back zero impression rows for YOUTUBE_SEARCH and YOUTUBE_WATCH values only if you target these networks in your Advertiser account. After this change, we will always return zero rows corresponding to these network types irrespective of whether you advertise on these networks. Other network types are not affected by this change.

This change makes the behavior of YOUTUBE_SEARCH and YOUTUBE_WATCH network types consistent with the behavior of other network types. Once this change goes live, you may start seeing a higher number of zero impression rows than what you see today when requesting AdNetworkType1 or AdNetworkType2 columns along with zero impression rows.

If you have any questions about these changes, post them in our developer forum.
 - , 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

Support for v201702 reports in AdWords scripts

We have added support for AdWords API v201702 reports in AdWords scripts. The major changes in this release are:
  • New conversion fields to help when changing attribution models: CostPerCurrentModelAttributedConversion, CurrentModelAttributedConversions, CurrentModelAttributedConversionValue, and ValuePerCurrentModelAttributedConversion
  • Fields of type Double that don't represent percentages now return without a thousands separator and with two decimal places.
  • The AdGroupName and AdGroupStatus fields of the Audience Performance Report now behave as segments
  • All fields in the Call Metrics Call Details Report now behave as attributes
See the AdWords API release notes for more details.

v201609 will remain the default version for reports until the week of April 24, 2017. This gives you enough time to verify your scripts and make sure they work with the latest report version.

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

var report = AdWordsApp.report(query {
  apiVersion: 'v201702'
});
If you don't use API versioning, no code changes are required. Your reports will continue using v201609 for now, and switch to v201702 when we make v201702 the default version the week of April 24, 2017.

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

Support for v201609 reports in AdWords Scripts

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

The v201607 will remain the default version for reports until the week of November 28, 2016. This gives you enough time to verify your scripts and make sure they work with the latest report version.

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

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

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 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.
 - , AdWords API Team

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.
 - , AdWords Scripts Team

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.
Anash P. Oommen, AdWords Scripts Team

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.

Anash P. Oommen, AdWords Scripts Team

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.

 - , AdWords Scripts Team