Changes for release v22_0. (#531)

Author: dorasun

CHANGELOG.md

@@ -1,3 +1,9 @@
+36.0.0
+------
+ - Compatibility with v22 of the API: https://developers.google.com/google-ads/api/docs/release-notes
+ - Updated dependencies.
+ - Updated Performance Max examples to add Asset automation settings.
+
 35.2.0
 -----
 - Made grpc versioning more permissive to allow any version except 1.74.0, to fix [issue#524](https://github.com/googleads/google-ads-ruby/issues/524).

Gemfile

@@ -4,9 +4,6 @@ gemspec
 
 gem 'pry', '~> 0.14.1'
 
-# pull in the soap library for migration examples execution
-gem 'google-adwords-api', '~> 1.5'
-
 # used for the factories generator
 gem 'activesupport', '>= 7.2'
 gem 'rspec', '~> 3.11'

examples/advanced_operations/add_performance_max_campaign.rb

@@ -192,14 +192,30 @@ def create_performance_max_campaign_operation(
       c.maximize_conversion_value = client.resource.maximize_conversion_value do |mcv|
         mcv.target_roas = 3.5
       end
-      # Set the Final URL expansion opt out. This flag is specific to
-      # Performance Max campaigns. If opted out (true), only the final URLs in
-      # the asset group or URLs specified in the advertiser's Google Merchant
-      # Center or business data feeds are targeted.
-      # If opted in (false), the entire domain will be targeted. For best
-      # results, set this value to false to opt in and allow URL expansions. You
-      # can optionally add exclusions to limit traffic to parts of your website.
-      c.url_expansion_opt_out = false
+      
+      # [START add_pmax_asset_automation_settings]
+      # Configures the optional opt-in/out status for asset automation settings.
+      c.asset_automation_settings << client.resource.asset_automation_setting do |aas|
+        aas.asset_automation_type = :GENERATE_IMAGE_EXTRACTION
+        aas.asset_automation_status = :OPTED_IN
+      end
+      c.asset_automation_settings << client.resource.asset_automation_setting do |aas|
+        aas.asset_automation_type = :FINAL_URL_EXPANSION_TEXT_ASSET_AUTOMATION
+        aas.asset_automation_status = :OPTED_IN
+      end
+      c.asset_automation_settings << client.resource.asset_automation_setting do |aas|
+        aas.asset_automation_type = :TEXT_ASSET_AUTOMATION
+        aas.asset_automation_status = :OPTED_IN
+      end
+      c.asset_automation_settings << client.resource.asset_automation_setting do |aas|
+        aas.asset_automation_type = :GENERATE_ENHANCED_YOUTUBE_VIDEOS
+        aas.asset_automation_status = :OPTED_IN
+      end
+      c.asset_automation_settings << client.resource.asset_automation_setting do |aas|
+        aas.asset_automation_type = :GENERATE_IMAGE_ENHANCEMENT
+        aas.asset_automation_status = :OPTED_IN
+      end
+      # [END add_pmax_asset_automation_settings]
 
       # Set if the campaign is enabled for brand guidelines. For more
       # information on brand guidelines, see
@@ -492,6 +508,7 @@ def create_and_link_image_asset(client, customer_id, url, field_type, asset_name
 end
 # [END add_performance_max_campaign_8]
 
+# [START create_and_link_brand_assets]
 # Creates a list of MutateOperations that create linked brand assets.
 def create_and_link_brand_assets(
     client,
@@ -583,6 +600,7 @@ def create_and_link_brand_assets(
 
   operations
 end
+# [END create_and_link_brand_assets]
 
 # [START add_performance_max_campaign_9]
 # Create a list of MutateOperations that create AssetGroupSignals.

examples/shopping_ads/add_performance_max_retail_campaign.rb

@@ -230,17 +230,27 @@ def create_performance_max_campaign_operation(
             # feed_label = "INSERT_FEED_LABEL_HERE"
         end
 
-        # Set the Final URL expansion opt out. This flag is specific to
-        # Performance Max campaigns. If opted out (true), only the final URLs in
-        # the asset group or URLs specified in the advertiser's Google Merchant
-        # Center or business data feeds are targeted.
-        # If opted in (false), the entire domain will be targeted. For best
-        # results, set this value to false to opt in and allow URL expansions. You
-        # can optionally add exclusions to limit traffic to parts of your website.
-        #
-        # For a Retail campaign, we want the final URLs to be limited to those
-        # explicitly surfaced via GMC.
-        c.url_expansion_opt_out = true
+        # Configures the optional opt-in/out status for asset automation settings.
+        c.asset_automation_settings << client.resource.asset_automation_setting do |aas|
+          aas.asset_automation_type = :GENERATE_IMAGE_EXTRACTION
+          aas.asset_automation_status = :OPTED_IN
+        end
+        c.asset_automation_settings << client.resource.asset_automation_setting do |aas|
+          aas.asset_automation_type = :FINAL_URL_EXPANSION_TEXT_ASSET_AUTOMATION
+          aas.asset_automation_status = :OPTED_IN
+        end
+        c.asset_automation_settings << client.resource.asset_automation_setting do |aas|
+          aas.asset_automation_type = :TEXT_ASSET_AUTOMATION
+          aas.asset_automation_status = :OPTED_IN
+        end
+        c.asset_automation_settings << client.resource.asset_automation_setting do |aas|
+          aas.asset_automation_type = :GENERATE_ENHANCED_YOUTUBE_VIDEOS
+          aas.asset_automation_status = :OPTED_IN
+        end
+        c.asset_automation_settings << client.resource.asset_automation_setting do |aas|
+          aas.asset_automation_type = :GENERATE_IMAGE_ENHANCEMENT
+          aas.asset_automation_status = :OPTED_IN
+        end
 
         # Set if the campaign is enabled for brand guidelines. For more
         # information on brand guidelines, see

lib/google/ads/google_ads/api_versions.rb

@@ -1,8 +1,8 @@
 module Google
   module Ads
     module GoogleAds
-      KNOWN_API_VERSIONS = [:V19, :V20, :V21]
-      DEFAULT_API_VERSION = :V21
+      KNOWN_API_VERSIONS = [:V19, :V20, :V21, :V22]
+      DEFAULT_API_VERSION = :V22
 
       def self.default_api_version
         DEFAULT_API_VERSION

lib/google/ads/google_ads/utils/v22/path_lookup_util.rb

@@ -0,0 +1,31 @@
+# Encoding: utf-8
+#
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Utility that generates up resource names for entities given IDs.
+
+require "google/ads/google_ads/utils/build_path_lookup_class"
+
+module Google
+  module Ads
+    module GoogleAds
+      module Utils
+        module V22
+          PathLookupUtil = Utils.build_path_lookup_class(:v22)
+        end
+      end
+    end
+  end
+end

lib/google/ads/google_ads/v19/services/batch_job_service/operations.rb

@@ -135,7 +135,7 @@ def initialize
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
               #
-              # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
+              # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
               #   Pass arguments to `list_operations` via keyword arguments. Note that at
               #   least one keyword argument is required. To specify no parameters, or to keep all
               #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -148,6 +148,17 @@ def initialize
               #     The standard list page size.
               #   @param page_token [::String]
               #     The standard list page token.
+              #   @param return_partial_success [::Boolean]
+              #     When set to `true`, operations that are reachable are returned as normal,
+              #     and those that are unreachable are returned in the
+              #     [ListOperationsResponse.unreachable] field.
+              #
+              #     This can only be `true` when reading across collections e.g. when `parent`
+              #     is set to `"projects/example/locations/-"`.
+              #
+              #     This field is not by default supported and will result in an
+              #     `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
+              #     service or product specific documentation.
               #
               # @yield [response, operation] Access the result along with the RPC operation
               # @yieldparam response [::Gapic::PagedEnumerable<::Gapic::Operation>]

lib/google/ads/google_ads/v19/services/campaign_draft_service/operations.rb

@@ -135,7 +135,7 @@ def initialize
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
               #
-              # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
+              # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
               #   Pass arguments to `list_operations` via keyword arguments. Note that at
               #   least one keyword argument is required. To specify no parameters, or to keep all
               #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -148,6 +148,17 @@ def initialize
               #     The standard list page size.
               #   @param page_token [::String]
               #     The standard list page token.
+              #   @param return_partial_success [::Boolean]
+              #     When set to `true`, operations that are reachable are returned as normal,
+              #     and those that are unreachable are returned in the
+              #     [ListOperationsResponse.unreachable] field.
+              #
+              #     This can only be `true` when reading across collections e.g. when `parent`
+              #     is set to `"projects/example/locations/-"`.
+              #
+              #     This field is not by default supported and will result in an
+              #     `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
+              #     service or product specific documentation.
               #
               # @yield [response, operation] Access the result along with the RPC operation
               # @yieldparam response [::Gapic::PagedEnumerable<::Gapic::Operation>]

lib/google/ads/google_ads/v19/services/experiment_service/operations.rb

@@ -135,7 +135,7 @@ def initialize
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
               #
-              # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
+              # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
               #   Pass arguments to `list_operations` via keyword arguments. Note that at
               #   least one keyword argument is required. To specify no parameters, or to keep all
               #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -148,6 +148,17 @@ def initialize
               #     The standard list page size.
               #   @param page_token [::String]
               #     The standard list page token.
+              #   @param return_partial_success [::Boolean]
+              #     When set to `true`, operations that are reachable are returned as normal,
+              #     and those that are unreachable are returned in the
+              #     [ListOperationsResponse.unreachable] field.
+              #
+              #     This can only be `true` when reading across collections e.g. when `parent`
+              #     is set to `"projects/example/locations/-"`.
+              #
+              #     This field is not by default supported and will result in an
+              #     `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
+              #     service or product specific documentation.
               #
               # @yield [response, operation] Access the result along with the RPC operation
               # @yieldparam response [::Gapic::PagedEnumerable<::Gapic::Operation>]

lib/google/ads/google_ads/v19/services/offline_user_data_job_service/operations.rb

@@ -135,7 +135,7 @@ def initialize
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
               #
-              # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
+              # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
               #   Pass arguments to `list_operations` via keyword arguments. Note that at
               #   least one keyword argument is required. To specify no parameters, or to keep all
               #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -148,6 +148,17 @@ def initialize
               #     The standard list page size.
               #   @param page_token [::String]
               #     The standard list page token.
+              #   @param return_partial_success [::Boolean]
+              #     When set to `true`, operations that are reachable are returned as normal,
+              #     and those that are unreachable are returned in the
+              #     [ListOperationsResponse.unreachable] field.
+              #
+              #     This can only be `true` when reading across collections e.g. when `parent`
+              #     is set to `"projects/example/locations/-"`.
+              #
+              #     This field is not by default supported and will result in an
+              #     `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
+              #     service or product specific documentation.
               #
               # @yield [response, operation] Access the result along with the RPC operation
               # @yieldparam response [::Gapic::PagedEnumerable<::Gapic::Operation>]