google-ads-googleads 8.1.0 → 12.0.1

data/lib/google/ads/google_ads/google_ads_client.rb

@@ -231,16 +231,14 @@ module Google
           raise 'config.impersonate required if keyfile specified' unless @config.impersonate
           keyfile = File.read(@config.keyfile)
           keyfile = JSON.parse(keyfile)
-          Google::Auth::Credentials.new(
-            Signet::OAuth2::Client.new(
-              token_credential_uri: "https://accounts.google.com/o/oauth2/token",
-              audience: "https://accounts.google.com/o/oauth2/token",
-              issuer: keyfile.fetch("client_email"),
-              signing_key: OpenSSL::PKey::RSA.new(keyfile.fetch("private_key")),
-              person: @config.impersonate,
-              scope: [SCOPE],
-            )
-          )
+          Signet::OAuth2::Client.new(
+            token_credential_uri: "https://accounts.google.com/o/oauth2/token",
+            audience: "https://accounts.google.com/o/oauth2/token",
+            issuer: keyfile.fetch("client_email"),
+            signing_key: OpenSSL::PKey::RSA.new(keyfile.fetch("private_key")),
+            person: @config.impersonate,
+            scope: [SCOPE],
+          ).updater_proc
         end
 
         # Create the default logger, useful if the user hasn't defined one.

data/lib/google/ads/google_ads/interceptors/logging_interceptor.rb

@@ -33,8 +33,12 @@ module Google
             inviterUserEmailAddress
             userEmail
           ]
-          SEARCH_REQUEST_MASK =
-            /customer_user_access.email_address|change_event.user_email|feed.places_location_feed_data.email_address/
+          SEARCH_REQUEST_MASK = /
+            customer_user_access.email_address|
+            customer_user_access_invitation.email_address|
+            change_event.user_email|
+            feed.places_location_feed_data.email_address
+          /x
 
           MASK_REPLACEMENT = "REDACTED"
 
@@ -184,7 +188,7 @@ module Google
               message = clone_to_json(message)
               message["fieldMask"].split(",").each do |path|
                 if SEARCH_RESPONSE_FIELDS_TO_MASK.include?(path.split(".").last)
-                  message["results"].each do |result|
+                  message["results"]&.each do |result|
                     sanitize_field(result, path)
                   end
                 end
@@ -209,6 +213,18 @@ module Google
                   sanitize_customer_user_access(message["operation"]["update"])
               end
               message
+            elsif "CustomerUserAccessInvitation" == message_class
+              # Sanitize sensitive fields specific to CustomerUserAccessInvitation get requests.
+              message = clone_to_json(message)
+              sanitize_customer_user_access_invitation(message)
+            elsif "MutateCustomerUserAccessInvitationRequest" == message_class
+              # Sanitize sensitive fields when mutating a CustomerUserAccessInvitation.
+              message = clone_to_json(message)
+              if message.include?("operation") && message["operation"].include?("create")
+                message["operation"]["create"] =
+                  sanitize_customer_user_access_invitation(message["operation"]["create"])
+              end
+              message
             elsif "Feed" == message_class
               # Sanitize sensitive fields specific to Feed get requests.
               message = clone_to_json(message)
@@ -243,6 +259,13 @@ module Google
             message
           end
 
+          def sanitize_customer_user_access_invitation(message)
+            if message.include?("emailAddress")
+              message["emailAddress"] = MASK_REPLACEMENT
+            end
+            message
+          end
+
           def sanitize_feeds_request(message)
             if message.include?("operations")
               message["operations"].each do |operation|
@@ -289,11 +312,21 @@ module Google
                                 "no"
                               end
 
+            wrapped_var = call.instance_variable_get(:@wrapped)
+
+            trailing_metadata = wrapped_var
+              .instance_variable_get(:@call)
+              .trailing_metadata
+
+            request_id = "N/A"
+            request_id = trailing_metadata["request-id"] if trailing_metadata
+
             [
               "CID: #{customer_id}",
-              "Host: #{call.instance_variable_get('@wrapped').peer}",
+              "Host: #{wrapped_var.peer}",
               "Method: #{method}",
               "IsFault: #{is_fault_string}",
+              "Request ID: #{request_id}",
             ].join(", ")
           end
 

data/lib/google/ads/google_ads/service_wrapper.rb

@@ -52,10 +52,7 @@ module Google
             # no args specified at all, just pass through
             service.public_send(name, request, nil)
           else
-            # this branch is the legacy version
-            kwargs.each do |name, value|
-              request.public_send("#{name}=", value)
-            end
+            # this branch is the legacy version, which is no longer supported
 
             # zip will fill with nils by default, so we truncate the number
             # of fields we set to match the argument length here.
@@ -65,7 +62,6 @@ module Google
 
             field_names = []
             args_and_fields.each do |(arg, field)|
-              write_field(request, arg, field)
               field_names << field.name
             end
 
@@ -74,14 +70,10 @@ module Google
               service_name_segments[service_name_segments.length-2]
             )
             method_name = "#{service_name}.#{name}"
-            deprecation.deprecate(
-              "Calling #{method_name} with positional " \
+            raise ArgumentError, "Calling #{method_name} with positional " \
               "arguments is deprecated, please update it to use kwargs, e.g.: " \
               "#{method_name}" \
               "(#{field_names.map { |fn| "#{fn}: ..."}.join(", ")})"
-            )
-
-            service.public_send(name, request)
           end
         end
 

data/lib/google/ads/google_ads/utils/path_lookup_config.rb

@@ -32,11 +32,13 @@ module Google
           # The way that the arguments to the gapic generated function are
           # determined by introspection of its required keyword arguments.
           PATH_LOOKUP_BASE = {
+            accessible_bidding_strategy: [:customer, [:accessible_bidding_strategy]],
             account_budget_proposal: [:customer, [:account_budget_proposal]],
             account_budget: [:customer, [:account_budget]],
             account_link: [:customer, [:account_link_id]],
             ad_group_ad_label: [:customer, [:ad_group, :ad, :label]],
             ad_group_ad: [:customer, [:ad_group, :ad]],
+            ad_group_asset: [:customer, :ad_group, :asset, :field_type],
             ad_group_audience_view: [:customer, [:ad_group, :criterion]],
             ad_group_bid_modifier: [:customer, [:ad_group, :criterion]],
             ad_group_criterion_label: [:customer, [:ad_group, :criterion, :label]],
@@ -52,8 +54,10 @@ module Google
             ad: [:customer, [:ad]],
             age_range_view: [:customer, [:ad_group, :criterion]],
             asset: [:customer, [:asset]],
+            asset_field_type_view: [:customer, [:asset_field_type_view]],
             batch_job: [:customer, [:batch_job]],
             bidding_strategy: [:customer, [:bidding_strategy]],
+            bidding_strategy_simulation: [:customer, :bidding_strategy, :type, :modification_method, :start_date, :end_date],
             billing_setup: [:customer, [:billing]],
             campaign_audience_view: [:customer, [:campaign, :criterion]],
             campaign_bid_modifier: [:customer, [:campaign, :criterion]],
@@ -65,6 +69,7 @@ module Google
             campaign_extension_setting: [:customer, [:campaign, :extension_type]],
             campaign_feed: [:customer, [:campaign, :feed]],
             campaign_label: [:customer, [:campaign, :label]],
+            campaign_simulation: [:customer, :campaign, :type, :modification_method, :start_date, :end_date],
             campaign_shared_set: [:customer, [:campaign, :shared_set]],
             campaign: [:customer, [:campaign]],
             carrier_constant: [:criterion],
@@ -72,9 +77,11 @@ module Google
             click_view: [:customer, [:date, :gclid]],
             combined_audience: [:customer, :combined_audience],
             conversion_action: [:customer, [:conversion_action]],
+            conversion_custom_variable: [:customer, :conversion_custom_variable],
             currency_constant: [:currency_constant],
             custom_audience: [:customer, :custom_audience],
             custom_interest: [:customer, [:custom_interest]],
+            customer_asset: [:customer, :asset, :field_type],
             customer_client_link: [:customer, [:client_customer, :manager_link]],
             customer_client: [:customer, [:client_customer]],
             customer_extension_setting: [:customer, [:extension_type]],
@@ -83,8 +90,10 @@ module Google
             customer_manager_link: [:customer, [:manager_customer, :manager_link]],
             customer_negative_criterion: [:customer, [:criterion]],
             customer_user_access: [:customer, :user],
+            customer_user_access_invitation: [:customer, :invitation],
             customer: [:customer],
             detail_placement_view: [:customer, [:ad_group, :base64_placement]],
+            detailed_demographic: [:customer, :detailed_demographic],
             display_keyword_view: [:customer, [:ad_group, :criterion]],
             domain_category: [:customer, [:campaign, :category_base64, :language_code]],
             dynamic_search_ads_search_term_view: [:customer, [:ad_group, :search_term, :headline, :landing_page, :page_url]],
@@ -112,16 +121,17 @@ module Google
             keyword_plan_keyword: [:customer, [:kp_ad_group_keyword]],
             keyword_plan_negative_keyword: [:customer, [:kp_negative_keyword]],
             keyword_plan: [:customer, [:kp_plan]],
+            keyword_theme_constant: [[:express_category_id, :express_sub_category_id]],
             keyword_view: [:customer, [:ad_group, :criterion]],
             label: [:customer, [:label]],
             language_constant: [:criterion],
+            life_event: [:customer, :life_event],
             location_view: [:customer, [:campaign, :criterion]],
             managed_placement_view: [:customer, [:ad_group, :criterion]],
             media_file: [:customer, [:media_file]],
             merchant_center_link: [:customer, [:merchant_center]],
             mobile_app_category_constant: [:mobile_app_category],
             mobile_device_constant: [:criterion],
-            mutate_job: [:customer, [:mutate_job]],
             operating_system_version_constant: [:criterion],
             payments_account: [:customer, :payments_account_id],
             parental_status_view: [:customer, [:ad_group, :criterion]],
@@ -133,44 +143,83 @@ module Google
             shared_criterion: [:customer, [:shared_set, :criterion]],
             shared_set: [:customer, [:shared_set]],
             shopping_performance_view: [:customer],
+            smart_campaign_search_term_view: [:customer, [:campaign_id, :query]],
+            smart_campaign_setting: [:customer, [:smart_campaign_setting]],
             third_party_app_analytics_link: [:customer, [:account_link_id]],
             topic_constant: [:vertical],
             topic_view: [:customer, [:ad_group, :criterion]],
             user_interest: [:customer, [:user_interest]],
             user_list: [:customer, [:user_list]],
             video: [:customer, [:video]],
+            webpage_view: [:customer, :ad_group, :criterion],
           }
 
-          PATH_LOOKUP_V3 = PATH_LOOKUP_BASE.reject { |k, _|
+          PATH_LOOKUP_V5 = PATH_LOOKUP_BASE.reject { |k, _|
             [
-              :batch_job,
-              :account_link,
-              :income_range_view,
-              :keyword_plan_ad_group_keyword,
-              :keyword_plan_campaign_keyword,
-              :third_party_app_analytics_link,
+              :asset_field_type_view,
               :combined_audience,
+              :conversion_value_rule,
+              :conversion_value_rule_set,
               :custom_audience,
               :customer_user_access,
+              :detailed_demographic,
               :feed_item_set_link,
               :feed_item_set,
+              :customer_user_access_invitation,
+              :ad_group_asset,
+              :bidding_strategy_simulation,
+              :campaign_simulation,
+              :conversion_custom_variable,
+              :customer_asset,
+              :life_event,
+              :webpage_view,
+              :accessible_bidding_strategy,
+              :keyword_theme_constant,
+              :smart_campaign_search_term_view,
+              :smart_campaign_setting,
             ].include?(k)
           }
 
-          PATH_LOOKUP_V4 = PATH_LOOKUP_BASE.reject { |k, _|
-            [
-              :mutate_job,
-              :combined_audience,
-              :custom_audience,
-              :customer_user_access,
-              :feed_item_set_link,
-              :feed_item_set,
-            ].include?(k)
-          }
-          PATH_LOOKUP_V5 = PATH_LOOKUP_V4
-
           PATH_LOOKUP_V6 = PATH_LOOKUP_BASE
-            .reject { |k, _| [:mutate_job].include?(k) }
+            .reject { |k, _|
+              [
+                :ad_group_asset,
+                :asset_field_type_view,
+                :bidding_strategy_simulation,
+                :campaign_simulation,
+                :conversion_custom_variable,
+                :conversion_value_rule,
+                :conversion_value_rule_set,
+                :customer_asset,
+                :detailed_demographic,
+                :life_event,
+                :webpage_view,
+                :accessible_bidding_strategy,
+                :keyword_theme_constant,
+                :smart_campaign_search_term_view,
+                :smart_campaign_setting,
+              ].include?(k)
+            }
+            .map { |k, v| [k, v.flatten] }
+            .to_h
+
+          PATH_LOOKUP_V7 = PATH_LOOKUP_BASE
+            .reject { |k, _|
+              [
+                :asset_field_type_view,
+                :conversion_value_rule,
+                :conversion_value_rule_set,
+                :detailed_demographic,
+                :accessible_bidding_strategy,
+                :keyword_theme_constant,
+                :smart_campaign_search_term_view,
+                :smart_campaign_setting,
+              ].include?(k)
+            }
+            .map { |k, v| [k, v.flatten] }
+            .to_h
+
+          PATH_LOOKUP_V8 = PATH_LOOKUP_BASE
             .map { |k, v| [k, v.flatten] }
             .to_h
         end

data/lib/google/ads/google_ads/utils/v7/path_lookup_util.rb

@@ -0,0 +1,31 @@
+# Encoding: utf-8
+#
+# Copyright 2021 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 V7
+          PathLookupUtil = Utils.build_path_lookup_class(:v7)
+        end
+      end
+    end
+  end
+end

data/lib/google/ads/google_ads/utils/v8/path_lookup_util.rb

@@ -0,0 +1,31 @@
+# Encoding: utf-8
+#
+# Copyright 2021 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 V8
+          PathLookupUtil = Utils.build_path_lookup_class(:v8)
+        end
+      end
+    end
+  end
+end

data/lib/google/ads/google_ads/v6/common/asset_types_pb.rb

@@ -14,6 +14,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/ads/googleads/v6/common/asset_types.proto", :syntax => :proto3) do
     add_message "google.ads.googleads.v6.common.YoutubeVideoAsset" do
       proto3_optional :youtube_video_id, :string, 2
+      optional :youtube_video_title, :string, 3
     end
     add_message "google.ads.googleads.v6.common.MediaBundleAsset" do
       proto3_optional :data, :bytes, 2

data/lib/google/ads/google_ads/v6/common/metrics_pb.rb

@@ -19,7 +19,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       proto3_optional :active_view_viewability, :double, 190
       proto3_optional :all_conversions_from_interactions_rate, :double, 191
       proto3_optional :all_conversions_value, :double, 192
+      optional :all_conversions_value_by_conversion_date, :double, 240
       proto3_optional :all_conversions, :double, 193
+      optional :all_conversions_by_conversion_date, :double, 241
       proto3_optional :all_conversions_value_per_cost, :double, 194
       proto3_optional :all_conversions_from_click_to_call, :double, 195
       proto3_optional :all_conversions_from_directions, :double, 196
@@ -50,9 +52,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       proto3_optional :content_rank_lost_impression_share, :double, 163
       proto3_optional :conversions_from_interactions_rate, :double, 164
       proto3_optional :conversions_value, :double, 165
+      optional :conversions_value_by_conversion_date, :double, 242
       proto3_optional :conversions_value_per_cost, :double, 166
       proto3_optional :conversions_from_interactions_value_per_interaction, :double, 167
       proto3_optional :conversions, :double, 168
+      optional :conversions_by_conversion_date, :double, 243
       proto3_optional :cost_micros, :int64, 169
       proto3_optional :cost_per_all_conversions, :double, 170
       proto3_optional :cost_per_conversion, :double, 171
@@ -112,7 +116,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       proto3_optional :top_impression_percentage, :double, 148
       proto3_optional :valid_accelerated_mobile_pages_clicks_percentage, :double, 149
       proto3_optional :value_per_all_conversions, :double, 150
+      proto3_optional :value_per_all_conversions_by_conversion_date, :double, 244
       proto3_optional :value_per_conversion, :double, 151
+      proto3_optional :value_per_conversions_by_conversion_date, :double, 245
       proto3_optional :value_per_current_model_attributed_conversion, :double, 152
       proto3_optional :video_quartile_p100_rate, :double, 132
       proto3_optional :video_quartile_p25_rate, :double, 133

data/lib/google/ads/google_ads/v6/common/segments_pb.rb

@@ -26,7 +26,6 @@ require 'google/ads/google_ads/v6/enums/product_condition_pb'
 require 'google/ads/google_ads/v6/enums/search_engine_results_page_type_pb'
 require 'google/ads/google_ads/v6/enums/search_term_match_type_pb'
 require 'google/ads/google_ads/v6/enums/slot_pb'
-require 'google/api/resource_pb'
 require 'google/api/annotations_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/ads/googleads/v6/common/segments.proto", :syntax => :proto3) do

data/lib/google/ads/google_ads/v6/enums/access_invitation_status_pb.rb

@@ -0,0 +1,32 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/ads/googleads/v6/enums/access_invitation_status.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/ads/googleads/v6/enums/access_invitation_status.proto", :syntax => :proto3) do
+    add_message "google.ads.googleads.v6.enums.AccessInvitationStatusEnum" do
+    end
+    add_enum "google.ads.googleads.v6.enums.AccessInvitationStatusEnum.AccessInvitationStatus" do
+      value :UNSPECIFIED, 0
+      value :UNKNOWN, 1
+      value :PENDING, 2
+      value :DECLINED, 3
+      value :EXPIRED, 4
+    end
+  end
+end
+
+module Google
+  module Ads
+    module GoogleAds
+      module V6
+        module Enums
+          AccessInvitationStatusEnum = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v6.enums.AccessInvitationStatusEnum").msgclass
+          AccessInvitationStatusEnum::AccessInvitationStatus = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v6.enums.AccessInvitationStatusEnum.AccessInvitationStatus").enummodule
+        end
+      end
+    end
+  end
+end