google-ads-googleads 38.0.0 → 38.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 868d414576f30e198ed49cb5aa562c3195430c072286d37a866e48af07aa83d1
-  data.tar.gz: 9f5b446f3ee98457f0400c11def3c42516e410e2b7455261e8f2a19f935527a8
+  metadata.gz: e0309b225ea94bd45816250dfffab407b06b27c6f894e5886df73522fa4a203b
+  data.tar.gz: f6d80d3f1d56d3e752cdf5a9be13e324f5eb7139345935c3397f2c972119466e
 SHA512:
-  metadata.gz: a9661b3ba5ec3debdb41ccc2da2d4b5a784095051265b5061aef3a1eb70344d5852fd9eda5bb456a3aa7eaa92de95903d19ad3261f9e3c9ed44935fe502cfa97
-  data.tar.gz: 7b601c6e08e732b8e2cdd5e6bfafb428183878fcada3c9f8269d3cfabd29435f56d36d612efb4e0b5c2f06909ed26d4e8a6c870d2000ceaeddc77eea62d919b0
+  metadata.gz: ad93f92c0973d7cb71bc9d79ceb58114c11ed9fc10e6587027c7750c809320d6acb5df4c201244ce22ecc6d3c5f93ea897248d04c81c550436727072e398e6e7
+  data.tar.gz: d54bc979b2c62d4be08489279038a744340c4736c0179feb63a0d2f3f2dc1a80e3977cab55fdda5ca7ac547a06b80bf45fd009787e3a4691a7b1f023545efc07

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+38.1.0
+-----
+- Added more detailed metadata headers.
+
 38.0.0
 -----
 - Compatibility with v23.1, v22.1, v21.1, v20.2 of the API: https://developers.google.com/google-ads/api/docs/release-notes

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

@@ -34,6 +34,7 @@ module Google
         attr_accessor :login_customer_id
         attr_accessor :linked_customer_id
         attr_accessor :use_cloud_org_for_api_access
+        attr_accessor :gaada
 
         attr_accessor :log_level
         attr_accessor :log_target
@@ -59,6 +60,7 @@ module Google
           @login_customer_id = nil
           @linked_customer_id = nil
           @use_cloud_org_for_api_access = false
+          @gaada = nil
 
           @log_level = nil
           @log_target = nil

data/lib/google/ads/google_ads/factories/v20/services.rb

@@ -9,6 +9,7 @@ module Google
             def initialize(
               logging_interceptor:,
               error_interceptor:,
+              metadata_interceptor:,
               credentials:,
               metadata:,
               endpoint:,
@@ -16,7 +17,8 @@ module Google
             )
               @interceptors = [
                 error_interceptor,
-                logging_interceptor
+                logging_interceptor,
+                metadata_interceptor
               ].compact
               @credentials = credentials
               @metadata = metadata

data/lib/google/ads/google_ads/factories/v21/services.rb

@@ -9,6 +9,7 @@ module Google
             def initialize(
               logging_interceptor:,
               error_interceptor:,
+              metadata_interceptor:,
               credentials:,
               metadata:,
               endpoint:,
@@ -16,7 +17,8 @@ module Google
             )
               @interceptors = [
                 error_interceptor,
-                logging_interceptor
+                logging_interceptor,
+                metadata_interceptor
               ].compact
               @credentials = credentials
               @metadata = metadata

data/lib/google/ads/google_ads/factories/v22/services.rb

@@ -9,6 +9,7 @@ module Google
             def initialize(
               logging_interceptor:,
               error_interceptor:,
+              metadata_interceptor:,
               credentials:,
               metadata:,
               endpoint:,
@@ -16,7 +17,8 @@ module Google
             )
               @interceptors = [
                 error_interceptor,
-                logging_interceptor
+                logging_interceptor,
+                metadata_interceptor
               ].compact
               @credentials = credentials
               @metadata = metadata

data/lib/google/ads/google_ads/factories/v23/services.rb

@@ -9,6 +9,7 @@ module Google
             def initialize(
               logging_interceptor:,
               error_interceptor:,
+              metadata_interceptor:,
               credentials:,
               metadata:,
               endpoint:,
@@ -16,7 +17,8 @@ module Google
             )
               @interceptors = [
                 error_interceptor,
-                logging_interceptor
+                logging_interceptor,
+                metadata_interceptor
               ].compact
               @credentials = credentials
               @metadata = metadata

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

@@ -114,6 +114,7 @@ module Google
           if @config.use_cloud_org_for_api_access.is_a?(String)
             @config.use_cloud_org_for_api_access = @config.use_cloud_org_for_api_access.downcase == "true"
           end
+          @config.gaada = ENV.fetch("GOOGLE_ADS_GAADA", @config.gaada)
         end
 
         # Return a service for the provided entity type. For example, passing

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

@@ -0,0 +1,78 @@
+# 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.
+#
+# Interceptor to add metadata headers to requests.
+
+require 'grpc/generic/interceptors'
+require 'google/protobuf'
+
+module Google
+  module Ads
+    module GoogleAds
+      module Interceptors
+        class MetadataInterceptor < GRPC::ClientInterceptor
+          def initialize(developer_token, login_customer_id, linked_customer_id, use_cloud_org_for_api_access, gaada)
+            super()
+            @developer_token = developer_token
+            @login_customer_id = login_customer_id
+            @linked_customer_id = linked_customer_id
+            @use_cloud_org_for_api_access = use_cloud_org_for_api_access
+            @gaada = gaada
+          end
+
+          def request_response(request:, call:, method:, metadata: {})
+            update_metadata(metadata)
+            yield
+          end
+
+          def server_streamer(request:, call:, method:, metadata: {})
+            update_metadata(metadata)
+            yield
+          end
+
+          private
+
+          def update_metadata(metadata)
+            if !@use_cloud_org_for_api_access
+              metadata[:"developer-token"] = @developer_token
+            end
+
+            if @login_customer_id
+              metadata[:"login-customer-id"] = @login_customer_id.to_s
+            end
+
+            if @linked_customer_id
+              metadata[:"linked-customer-id"] = @linked_customer_id.to_s
+            end
+
+            # The python library iterates over metadata and modifies x-goog-api-client
+            # Here we can directly access it.
+            if metadata.key?(:"x-goog-api-client")
+              if @gaada
+                 metadata[:"x-goog-api-client"] += " gaada/#{@gaada}"
+              end
+
+              # Check if "pb" is already in the header
+              unless metadata[:"x-goog-api-client"].include?("pb")
+                metadata[:"x-goog-api-client"] += " pb/#{Gem.loaded_specs["google-protobuf"].version}"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,6 @@
 require 'google/ads/google_ads/interceptors/logging_interceptor'
 require 'google/ads/google_ads/interceptors/error_interceptor'
+require 'google/ads/google_ads/interceptors/metadata_interceptor'
 
 module Google
   module Ads
@@ -26,16 +27,24 @@ module Google
             logging_interceptor = GoogleAds::Interceptors::LoggingInterceptor.new(logger)
           end
           error_interceptor = GoogleAds::Interceptors::ErrorInterceptor.new
+          metadata_interceptor = GoogleAds::Interceptors::MetadataInterceptor.new(
+            config.developer_token,
+            config.login_customer_id,
+            config.linked_customer_id,
+            config.use_cloud_org_for_api_access,
+            config.gaada
+          )
 
           version_alternates = {}
           Factories::VERSIONS.each do |v|
-            version_alternates[v] = factory_at_version(v, error_interceptor, logging_interceptor)
+            version_alternates[v] = factory_at_version(v, error_interceptor, logging_interceptor, metadata_interceptor)
           end
 
           highest_factory = factory_at_version(
             Factories::HIGHEST_VERSION,
             error_interceptor,
             logging_interceptor,
+            metadata_interceptor,
           )
 
           VersionAlternate.new(highest_factory, version_alternates)
@@ -43,10 +52,11 @@ module Google
 
         private
 
-        def factory_at_version(version, error_interceptor, logging_interceptor)
+        def factory_at_version(version, error_interceptor, logging_interceptor, metadata_interceptor)
           factory = Factories.at_version(version).services.new(**{
             logging_interceptor: logging_interceptor,
             error_interceptor: error_interceptor,
+            metadata_interceptor: metadata_interceptor,
             deprecation: deprecator
           }.merge(gax_service_params))
 
@@ -62,27 +72,15 @@ module Google
         end
 
         def headers
-          headers = {}
-
-          # If config.use_cloud_org_for_api_access is not True, add the developer
-          # token to the request's metadata
-          if !config.use_cloud_org_for_api_access
-            headers[:"developer-token"] = config.developer_token
-          end
-
           if config.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_customer_id(field)

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

@@ -20,7 +20,7 @@ module Google
   module Ads
     module GoogleAds
       CLIENT_LIB_NAME = 'gccl'.freeze
-      CLIENT_LIB_VERSION = '38.0.0'.freeze
+      CLIENT_LIB_VERSION = '38.1.0'.freeze
       VERSION = CLIENT_LIB_VERSION
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-ads-googleads
 version: !ruby/object:Gem::Version
-  version: 38.0.0
+  version: 38.1.0
 platform: ruby
 authors:
 - Google Inc
@@ -129,6 +129,7 @@ files:
 - lib/google/ads/google_ads/google_ads_client.rb
 - lib/google/ads/google_ads/interceptors/error_interceptor.rb
 - lib/google/ads/google_ads/interceptors/logging_interceptor.rb
+- lib/google/ads/google_ads/interceptors/metadata_interceptor.rb
 - lib/google/ads/google_ads/lookup_util.rb
 - lib/google/ads/google_ads/patches.rb
 - lib/google/ads/google_ads/service_lookup.rb