Release Notes

6.1.0 (2021-02-10)

The functionality and changes below were added in v6.1.0.

Account Management

Ads

Campaigns

Change History

Conversions

Criteria

Feeds

Hotel Ads

Recommendations

Reporting

Resources

  • Improved an error message thrown when a malformed resource name is passed by also showing the correct form. For example, customers/{customer_id}/customerUserAccesses/{user_id} instead of customers/{part_1}/customerUserAccesses/{part_2}.

6.0.0 (2020-11-05)

The functionality and changes below were added in v6.0.0.

Account Management

Ads

Audiences

Bidding

Billing

  • Added the following fields to Invoice:
    • adjustments_subtotal_amount_micros
    • adjustments_tax_amount_micros
    • adjustments_total_amount_micros
    • regulatory_costs_subtotal_amount_micros
    • regulatory_costs_tax_amount_micros
    • regulatory_costs_total_amount_micros
  • Removed Invoice.invoice_level_adjustment_micros.

Campaigns

Change History

  • Added the resource ChangeEvent to retrieve the Change History of a Google Ads account. This is similar to Change History in the UI, including retrieving what interface made the change and who made the change.

Client libraries

  • The API finished moving towards using field presence such as optional string and optional double instead of wrapper types such as StringValue and DoubleValue. Your code will be easier to use and more concise with payloads that are significantly smaller. Approximately half of our resources have been updated in this release; the other half was updated in v5. The full list is in the migration guide, and our code examples have been updated.
  • Added a separator (~) for compound IDs in resource name patterns. For example, in ad_group_ad.proto, customers/{customer}/adGroupAds/{ad_group_ad} changed to customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}.

Criteria

Feeds

Planning

Recommendations

  • Added Customer.optimization_score_weight. This is only available for non-manager accounts and is used to determine the overall optimization score of the manager account. Retrieve the optimization score and optimization score weight of sub-accounts and multiply them (Customer.optimization_score * Customer.optimization_score_weight) to determine the overall optimization score.

Reporting

5.0.0 (2020-08-26)

The functionality and changes below were added in v5.0.0.

Account Management

Ads

Audiences

Batch jobs

Bidding

Campaigns

Client libraries

  • The API is moving towards using field presence such as optional string and optional double instead of wrapper types such as StringValue and DoubleValue. Your code will be easier to use and more concise with payloads that are significantly smaller. Approximately half of our resources have been updated in this release. The full list is in the migration guide, and our code examples have been updated. The rest of the resources will change to field presence in a future release.

Constants

Conversions

Feeds

Hotel Ads

Limits

  • Added more detailed errors when a developer is exceeding either the account rate limits or the developer token rate limits. The error will include if it was the account or the developer token with details on the limit that was reached.

Planning

Recommendations

Reporting

Request Parameters

  • Set response_content_type to MUTABLE_RESOURCE as a request parameter to return all the fields mutated in a mutate request. This was added to some services including GoogleAdsService.Mutate. By default only the resource name is returned on a mutate.

Resources

Shopping

Video

4.0.0 beta (2020-07-08)

The functionality and changes below were added in v4.0.0.

Account Management

  • Added ThirdPartyAppAnalyticsLinkService and AccountLinkService. This lets users create a link between a third-party app and Google Ads. A user can use these links to import data and view metrics to manage campaigns.
  • Added linked-customer-id to the request header. This header is only required for methods that update the resources of an entity when permissioned using Linked Accounts in the Google Ads UI (AccountLink resource in the Google Ads API). Set this value to the customer ID of the data provider that updates the resources of the specified customer ID. It should be set without dashes, for example 1234567890 instead of 123-456-7890. Learn more about Linked Accounts.
  • Added CreateCustomerClientResponse.invitation_link, which is a link for inviting users to access the created customer. This is accessible to allowlisted customers only, and the allowlist is currently closed.

Ads

Audiences

Batch Jobs

  • Renamed MutateJobService to BatchJobService. This service is not yet available for general use, but you can start coding against the service.

Bidding

  • Added support for Target ROAS in simulations:
  • Updated AdGroup, AgeRangeView, KeywordView, and ParentalStatusView to be selectable with BiddingStrategy.

Billing

Campaigns

Conversions

  • Added new values to ConversionActionType to include:
    • FIREBASE_ANDROID_FIRST_OPEN
    • FIREBASE_ANDROID_IN_APP_PURCHASE
    • FIREBASE_ANDROID_CUSTOM
    • FIREBASE_IOS_FIRST_OPEN
    • FIREBASE_IOS_IN_APP_PURCHASE
    • FIREBASE_IOS_CUSTOM
    • STORE_SALES
    • STORE_SALES_DIRECT_UPLOAD
    • THIRD_PARTY_APP_ANALYTICS_ANDROID_FIRST_OPEN
    • THIRD_PARTY_APP_ANALYTICS_ANDROID_IN_APP_PURCHASE
    • THIRD_PARTY_APP_ANALYTICS_ANDROID_CUSTOM
    • THIRD_PARTY_APP_ANALYTICS_IOS_FIRST_OPEN
    • THIRD_PARTY_APP_ANALYTICS_IOS_IN_APP_PURCHASE
    • THIRD_PARTY_APP_ANALYTICS_IOS_CUSTOM
  • Added CREATION_NOT_SUPPORTED to ConversionActionError.

Criteria

  • Added disapproval_reasons to AdGroupCriterion.
  • Added income_range_view to retrieve income range metrics.

Hotel Ads

Planning

Recommendations

Reporting

  • Starting in v4, segments.date, segments.week, segments.month, segments.quarter, and segments.year will function as follows:
    • These segments can be filtered in the WHERE clause without being required in the SELECT clause.
    • If any of these segments are in the SELECT clause, at least one of these segments should have a finite date range specified in the WHERE clause.

Shopping

  • Moved errors from AdGroupCriterionError to CriterionError:
    • INVALID_LISTING_GROUP_HIERARCHY
    • LISTING_GROUP_UNIT_CANNOT_HAVE_CHILDREN
    • LISTING_GROUP_SUBDIVISION_REQUIRES_OTHERS_CASE
    • LISTING_GROUP_REQUIRES_SAME_DIMENSION_TYPE_AS_SIBLINGS
    • LISTING_GROUP_ALREADY_EXISTS
    • LISTING_GROUP_DOES_NOT_EXIST
    • LISTING_GROUP_CANNOT_BE_REMOVED
    • INVALID_LISTING_GROUP_TYPE
    • LISTING_GROUP_ADD_MAY_ONLY_USE_TEMP_ID
  • Renamed the following errors inside CriterionError:
    • PRODUCT_FILTER_TOO_LONG -> LISTING_SCOPE_TOO_LONG
    • PRODUCT_SCOPE_TOO_MANY_DIMENSIONS -> LISTING_SCOPE_TOO_MANY_DIMENSIONS
    • PRODUCT_PARTITION_TOO_LONG -> LISTING_GROUP_TOO_LONG
    • PRODUCT_PARTITION_TOO_MANY_DIMENSIONS -> LISTING_GROUP_TREE_TOO_DEEP
    • INVALID_PRODUCT_DIMENSION -> INVALID_LISTING_DIMENSION
    • INVALID_PRODUCT_DIMENSION_TYPE -> INVALID_LISTING_DIMENSION_TYPE
  • Merged the following errors in CriterionError:
    • INVALID_PRODUCT_FILTER and INVALID_PRODUCT_DIMENSION -> INVALID_LISTING_DIMENSION
    • PRODUCT_SCOPE_TOO_LONG and PRODUCT_FILTER_TOO_LONG -> LISTING_SCOPE_TOO_LONG