google-ads-googleads 7.0.0 → 11.0.0

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

@@ -16,64 +16,6 @@
 #
 # GoogleAds client class to configure settings and fetch services.
 
-# We need to define all modules for all known versions in advance because of a
-# generation issue where they are defined in a single line, which cannot be used
-# to create new modules.
-module Google
-  module Ads
-    module GoogleAds
-      module V2
-        module Common
-        end
-        module Enums
-        end
-        module Errors
-        end
-        module Resources
-        end
-        module Services
-        end
-      end
-      module V3
-        module Common
-        end
-        module Enums
-        end
-        module Errors
-        end
-        module Resources
-        end
-        module Services
-        end
-      end
-      module V4
-        module Common
-        end
-        module Enums
-        end
-        module Errors
-        end
-        module Resources
-        end
-        module Services
-        end
-      end
-      module V5
-        module Common
-        end
-        module Enums
-        end
-        module Errors
-        end
-        module Resources
-        end
-        module Services
-        end
-      end
-    end
-  end
-end
-
 # this require needs to always come first to patch protobufs to have "autoboxing
 # fields"
 require 'google/ads/google_ads/autoboxing_fields'
@@ -121,7 +63,8 @@ module Google
             yield @config
           else
             if config_path.nil?
-              config_path = File.join(ENV['HOME'], DEFAULT_CONFIG_FILENAME)
+              config_path = ENV.fetch("GOOGLE_ADS_CONFIGURATION_FILE_PATH",
+                File.join(ENV['HOME'], DEFAULT_CONFIG_FILENAME))
             end
 
             unless File.exist?(config_path)
@@ -154,6 +97,23 @@ module Google
           yield @config
         end
 
+        def load_environment_config
+          # Generic variables
+          @config.refresh_token = ENV.fetch("GOOGLE_ADS_REFRESH_TOKEN", @config.refresh_token)
+          @config.client_id = ENV.fetch("GOOGLE_ADS_CLIENT_ID", @config.client_id)
+          @config.client_secret = ENV.fetch("GOOGLE_ADS_CLIENT_SECRET", @config.client_secret)
+          @config.keyfile = ENV.fetch("GOOGLE_ADS_JSON_KEY_FILE_PATH", @config.keyfile)
+          @config.impersonate = ENV.fetch("GOOGLE_ADS_IMPERSONATED_EMAIL", @config.impersonate)
+          @config.developer_token = ENV.fetch("GOOGLE_ADS_DEVELOPER_TOKEN", @config.developer_token)
+          @config.login_customer_id = ENV.fetch("GOOGLE_ADS_LOGIN_CUSTOMER_ID", @config.login_customer_id)
+          @config.linked_customer_id = ENV.fetch("GOOGLE_ADS_LINKED_CUSTOMER_ID", @config.linked_customer_id)
+          @config.api_endpoint = ENV.fetch("GOOGLE_ADS_ENDPOINT", @config.api_endpoint)
+
+          # Client library-specific variables
+          @config.log_level = ENV.fetch("GOOGLE_ADS_RUBY_LOG_LEVEL", @config.log_level)
+          @config.http_proxy = ENV.fetch("GOOGLE_ADS_RUBY_HTTP_PROXY", @config.http_proxy)
+        end
+
         # Return a service for the provided entity type. For example, passing
         # :Campaign will return an instantiated CampaignServiceClient.
         #
@@ -175,7 +135,7 @@ module Google
 
         def target
           default_target = "googleads.googleapis.com:443"
-          target = ENV.fetch('GOOGLEADS_SERVICE_PATH', default_target)
+          target = @config.api_endpoint || default_target
         end
 
         def make_channel

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

@@ -27,6 +27,21 @@ module Google
       module Interceptors
         class LoggingInterceptor < GRPC::ClientInterceptor
 
+          HEADERS_TO_MASK = [:"developer-token"]
+          SEARCH_RESPONSE_FIELDS_TO_MASK = %w[
+            emailAddress
+            inviterUserEmailAddress
+            userEmail
+          ]
+          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"
+
           def initialize(logger)
             # Don't propagate args, parens are necessary
             super()
@@ -136,7 +151,7 @@ module Google
           end
 
           def build_success_response_message(response)
-            "Incoming response: Payload: #{response.to_json}"
+            "Incoming response: Payload: #{sanitize_message(response).to_json}"
           end
 
           def build_request_message(metadata, request)
@@ -147,9 +162,140 @@ module Google
             request_inspect = if use_bytes_inspect?(request)
                                 request.inspect
                               else
-                                request.to_json
+                                sanitize_message(request).to_json
                               end
-            "Outgoing request: Headers: #{metadata.to_json} Payload: #{request_inspect}"
+            "Outgoing request: Headers: #{sanitize_headers(metadata).to_json} " \
+              "Payload: #{request_inspect}"
+          end
+
+          def sanitize_headers(metadata)
+            metadata = metadata.clone
+            HEADERS_TO_MASK.each do |header|
+              metadata[header] = MASK_REPLACEMENT
+            end
+            metadata
+          end
+
+          def clone_to_json(message)
+            JSON.parse(message.to_json)
+          end
+
+          def sanitize_message(message)
+            message_class = message.class.to_s.split("::").last
+            if %w[SearchGoogleAdsStreamResponse SearchGoogleAdsResponse].include?(
+                message_class)
+              # Sanitize all known sensitive fields across all search responses.
+              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|
+                    sanitize_field(result, path)
+                  end
+                end
+              end
+              message
+            elsif %w[SearchGoogleAdsRequest SearchGoogleAdsStreamRequest].include?(
+                message_class)
+              if SEARCH_REQUEST_MASK === message.query
+                message = clone_to_json(message)
+                message["query"] = MASK_REPLACEMENT
+              end
+              message
+            elsif "CustomerUserAccess" == message_class
+              # Sanitize sensitive fields specific to CustomerUserAccess get requests.
+              message = clone_to_json(message)
+              sanitize_customer_user_access(message)
+            elsif "MutateCustomerUserAccessRequest" == message_class
+              # Sanitize sensitive fields when mutating a CustomerUserAccess.
+              message = clone_to_json(message)
+              if message.include?("operation") && message["operation"].include?("update")
+                message["operation"]["update"] =
+                  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)
+              if message.include?("placesLocationFeedData") &&
+                  message["placesLocationFeedData"].include?("emailAddress")
+                message["placesLocationFeedData"]["emailAddress"] = MASK_REPLACEMENT
+              end
+              message
+            elsif "MutateFeedsRequest" == message_class
+              # Sanitize sensitive fields when mutating a Feed.
+              message = clone_to_json(message)
+              sanitize_feeds_request(message)
+            elsif "CreateCustomerClientRequest" == message_class
+              # Sanitize sensitive fields when creating a CustomerClient.
+              message = clone_to_json(message)
+              if message.include?("emailAddress")
+                message["emailAddress"] = MASK_REPLACEMENT
+              end
+              message
+            else
+              message
+            end
+          end
+
+          def sanitize_customer_user_access(message)
+            if message.include?("emailAddress")
+              message["emailAddress"] = MASK_REPLACEMENT
+            end
+            if message.include?("inviterUserEmailAddress")
+              message["inviterUserEmailAddress"] = MASK_REPLACEMENT
+            end
+            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|
+                if operation.include?("create")
+                  operation = operation["create"]
+                elsif operation.include?("update")
+                  operation = operation["update"]
+                else
+                  # Only create and update can contain sensitive fields.
+                  next
+                end
+                if operation.include?("placesLocationFeedData") &&
+                    operation["placesLocationFeedData"].include?("emailAddress")
+                  operation["placesLocationFeedData"]["emailAddress"] = MASK_REPLACEMENT
+                end
+              end
+            end
+            message
+          end
+
+          def sanitize_field(object, path)
+            split_path = path.split(".")
+            target_field = split_path.last
+            split_path.inject(object) do |obj, field|
+              if obj.include?(target_field)
+                obj[target_field] = MASK_REPLACEMENT
+                break
+              end
+              obj[field]
+            end
           end
 
           def build_summary_message(request, call, method, is_fault)

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

@@ -67,26 +67,39 @@ module Google
           }
 
           if config.login_customer_id
-            validate_login_customer_id
+            validate_customer_id(:login_customer_id)
             # header values must be strings
             headers[:"login-customer-id"] = config.login_customer_id.to_s
           end
 
+          if config.linked_customer_id
+            validate_customer_id(:linked_customer_id)
+            # header values must be strings
+            headers[:"linked-customer-id"] = config.linked_customer_id.to_s
+          end
+
           headers
         end
 
-        def validate_login_customer_id
+        def validate_customer_id(field)
           begin
-            login_customer_id = Integer(config.login_customer_id)
+            customer_id = -1
+            if field == :login_customer_id
+              customer_id = Integer(config.login_customer_id)
+            elsif field == :linked_customer_id
+              customer_id = Integer(config.linked_customer_id)
+            else
+              return
+            end
           rescue ArgumentError => e
             if e.message.start_with?("invalid value for Integer")
-              raise ArgumentError.new("Invalid value for login_customer_id, must be integer")
+              raise ArgumentError.new("Invalid value for #{field.to_s}, must be integer")
             end
           end
-          if login_customer_id <= 0 || login_customer_id > 9_999_999_999
+          if customer_id <= 0 || customer_id > 9_999_999_999
             raise ArgumentError.new(
-              "Invalid login_customer_id. Must be an integer " \
-              "0 < x <= 9,999,999,999. Got #{login_customer_id}"
+              "Invalid #{field.to_s}. Must be an integer " \
+              "0 < x <= 9,999,999,999. Got #{customer_id}"
             )
           end
         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

@@ -37,6 +37,7 @@ module Google
             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]],
@@ -54,9 +55,10 @@ module Google
             asset: [:customer, [:asset]],
             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_bid_modifier]],
+            campaign_bid_modifier: [:customer, [:campaign, :criterion]],
             campaign_budget: [:customer, [:campaign_budget]],
             campaign_criterion: [:customer, [:campaign, :criterion]],
             campaign_criterion_simulation: [:customer, [:campaign, :criterion, :type, :modification_method, :start_date, :end_date]],
@@ -65,14 +67,19 @@ 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],
             change_status: [:customer, [:change_status]],
             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]],
@@ -80,6 +87,8 @@ module Google
             customer_label: [:customer, [:label]],
             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]],
             display_keyword_view: [:customer, [:ad_group, :criterion]],
@@ -88,6 +97,8 @@ module Google
             expanded_landing_page_view: [:customer, [:expanded_final_url_fingerprint]],
             extension_feed_item: [:customer, [:feed_item]],
             feed_item: [:customer, [:feed, :feed_item]],
+            feed_item_set_link: [:customer, :feed, :feed_item_set, :feed_item],
+            feed_item_set: [:customer, :feed, :feed_item_set],
             feed_item_target: [:customer, [:feed, :feed_item, :feed_item_target_type, :feed_item_target_id]],
             feed_mapping: [:customer, [:feed, :feed_mapping]],
             feed_placeholder_view: [:customer, [:placeholder_type]],
@@ -110,14 +121,15 @@ module Google
             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]],
             product_bidding_category_constant: [[:country_code, :level, :id]],
             product_group_view: [:customer, [:ad_group, :criterion]],
@@ -133,22 +145,45 @@ module Google
             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,
+              :combined_audience,
+              :custom_audience,
+              :customer_user_access,
+              :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,
             ].include?(k)
           }
-          PATH_LOOKUP_V2 = PATH_LOOKUP_V3.reject { |k, _| [:currency_constant].include?(k) }
 
-          PATH_LOOKUP_V4 = PATH_LOOKUP_BASE.reject { |k, _| [:mutate_job].include?(k) }
-          PATH_LOOKUP_V5 = PATH_LOOKUP_V4
+          PATH_LOOKUP_V6 = PATH_LOOKUP_BASE
+            .reject { |k, _|
+              [
+                :ad_group_asset,
+                :bidding_strategy_simulation,
+                :campaign_simulation,
+                :conversion_custom_variable,
+                :customer_asset,
+                :life_event,
+                :webpage_view,
+              ].include?(k)
+            }
+            .map { |k, v| [k, v.flatten] }
+            .to_h
+
+          PATH_LOOKUP_V7 = PATH_LOOKUP_BASE
+            .map { |k, v| [k, v.flatten] }
+            .to_h
         end
       end
     end