google-ads-googleads 0.8.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7ea3850c88b88cdf4a11358b3e7f1fe332bbe8ddc08c55762ea5a5d14bc4c3b
-  data.tar.gz: 8123f27c2a0c4336dc450f0384ecdb1ee97195264b11800aeb6ca4149e3839fd
+  metadata.gz: 6a1a539dda2e56f08c9b1daac7d65c2a31a8f78d20906f3a1f9e393c65c8d563
+  data.tar.gz: 0543d6351bab5085cefe55b257659145f9405252c31de9b7d7885184de995984
 SHA512:
-  metadata.gz: b3d0eba9c29ffe4cbdc5c0160928d2deebd36c46b63221e210e6131a140a3ad1e0be1dcdbc25ac5d435c5bf68dddc1846447b1248d4321992b4f6f5d2263b446
-  data.tar.gz: d107c6c69e8bbc8275d27614dcd5cb0a97f3dcc71916c9ed62f3bf776387d06503a60b08b97d5f60ae441438e9188d214caa576a7f19f3595668423f7fcba62b
+  metadata.gz: 775083f4e4d3f15f33607ab7cd0bdc7ff232118536617bb6d8e0abc90f1f4bec0c2cd9de32b7f46432c15905f2295af477510bf1648c6c92ec596378a7fc257f
+  data.tar.gz: af918d18fee221dd34da5453538bb81670591d56bea0467d27a57204c0ab67f8b708d3e13ec83d2116e4789d4213b772ecccd5ad847212af9cac248c1a0d7073

data/ChangeLog

@@ -1,3 +1,8 @@
+1.0.0:
+  - Adding support for Google Ads API v1.
+  - Adding support for versioned path and proto lookup utils.
+  - Fix to logging interceptor for customer service requests.
+
 0.8.0:
   - Adding support for Google Ads API v0_7.
 

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

@@ -34,6 +34,18 @@ module Google
         module Services
         end
       end
+      module V1
+        module Common
+        end
+        module Enums
+        end
+        module Errors
+        end
+        module Resources
+        end
+        module Services
+        end
+      end
     end
   end
 end
@@ -44,8 +56,6 @@ require 'google/ads/google_ads/patches'
 require 'google/ads/google_ads/config'
 require 'google/ads/google_ads/field_mask_util'
 require 'google/ads/google_ads/wrapper_util'
-require 'google/ads/google_ads/proto_lookup_util'
-require 'google/ads/google_ads/path_lookup_util'
 require 'google/ads/google_ads/logging_interceptor'
 
 require 'google/ads/google_ads/errors'
@@ -59,7 +69,8 @@ module Google
   module Ads
     module GoogleAds
       class GoogleAdsClient
-        API_VERSION = :V0
+        DEFAULT_API_VERSION = :V1
+        KNOWN_API_VERSIONS = [:V0, :V1]
 
         DEFAULT_CONFIG_FILENAME = 'google_ads_config.rb'
 
@@ -92,10 +103,8 @@ module Google
             end
             @config = eval_result
           end
-          @proto_lookup_util =
-              Google::Ads::GoogleAds::ProtoLookupUtil.new(API_VERSION)
-          @path_lookup_util =
-              Google::Ads::GoogleAds::PathLookupUtil.new(@proto_lookup_util)
+          @proto_lookup_utils = {}
+          @path_lookup_utils = {}
 
           begin
             @logger = create_default_logger
@@ -113,14 +122,14 @@ module Google
         # :Campaign will return an instantiated CampaignServiceClient.
         #
         # Raises ArgumentError if no service can be found for the provided type.
-        def service(name)
+        def service(name, version = DEFAULT_API_VERSION)
           service_path = ENV['GOOGLEADS_SERVICE_PATH']
 
           # We need a local reference to refer to from within the class block
           # below.
           logger = @logger
 
-          class_to_return = @proto_lookup_util.service(name)
+          class_to_return = proto_lookup_util(version).service(name)
           class_to_return = Class.new(class_to_return) do
             unless service_path.nil? || service_path.empty?
               const_set('SERVICE_ADDRESS', service_path.freeze)
@@ -153,16 +162,16 @@ module Google
         # example, passing :Campaign will return an instantiated Campaign.
         #
         # Raises ArgumentError if no entity can be found for the provided type.
-        def resource(name)
-          @proto_lookup_util.resource(name).new
+        def resource(name, version = DEFAULT_API_VERSION)
+          proto_lookup_util(version).resource(name).new
         end
 
         # Return an operation for the provided entity type. For example, passing
         # :Campaign will return an instantiated CampaignOperation.
         #
         # Raises ArgumentError if no entity can be found for the provided type.
-        def operation(name)
-          @proto_lookup_util.operation(name).new
+        def operation(name, version = DEFAULT_API_VERSION)
+          proto_lookup_util(version).operation(name).new
         end
 
         # Return a reference to the enum class for the provided enum type. For
@@ -170,8 +179,8 @@ module Google
         # CampaignStatusEnum.
         #
         # Raises ArgumentError if no enum can be found for the provided type.
-        def enum(name)
-          @proto_lookup_util.enum(name)
+        def enum(name, version = DEFAULT_API_VERSION)
+          proto_lookup_util(version).enum(name)
         end
 
         # Returns a reference to the FieldMaskUtil class for ease of access.
@@ -185,8 +194,8 @@ module Google
         end
 
         # Returns a reference to the PathLookupUtil to generate resource names.
-        def path()
-          @path_lookup_util
+        def path(version = DEFAULT_API_VERSION)
+          path_lookup_util(version)
         end
 
         # Set the logger to use. This will only take effect on services fetched
@@ -244,6 +253,56 @@ module Google
           logger.level = Logger.const_get(@config.log_level)
           return logger
         end
+
+        def valid_version?(version)
+          KNOWN_API_VERSIONS.include?(version)
+        end
+
+        # Load up the proto lookup util for the given version, storing a copy
+        # of it if this is the first time we needed it.
+        def proto_lookup_util(version)
+          unless valid_version?(version)
+            raise sprintf('Unknown version %s', version)
+          end
+          if @proto_lookup_utils[version].nil?
+            path_version = version.downcase
+            require sprintf('google/ads/google_ads/utils/%s/proto_lookup_util',
+                path_version)
+            class_path = sprintf(
+              'Google::Ads::GoogleAds::Utils::%s::ProtoLookupUtil',
+              version
+            )
+            @proto_lookup_utils[version] = class_for_path(class_path).new
+          end
+          @proto_lookup_utils[version]
+        end
+
+        # Load up the path lookup util for the given version, storing a copy
+        # of it if this is the first time we needed it.
+        def path_lookup_util(version)
+          unless valid_version?(version)
+            raise sprintf('Unknown version %s', version)
+          end
+          if @path_lookup_utils[version].nil?
+            path_version = version.downcase
+            require sprintf('google/ads/google_ads/utils/%s/path_lookup_util',
+                path_version)
+            class_path = sprintf(
+              'Google::Ads::GoogleAds::Utils::%s::PathLookupUtil',
+              version
+            )
+            @path_lookup_utils[version] = class_for_path(class_path).new(
+                proto_lookup_util(version))
+          end
+          @path_lookup_utils[version]
+        end
+
+        # Converts complete class path into class object.
+        def class_for_path(path)
+          path.split('::').inject(Kernel) do |scope, const_name|
+            scope.const_get(const_name)
+          end
+        end
       end
     end
   end

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

@@ -29,9 +29,15 @@ module Google
         end
 
         def request_response(request:, call:, method:, metadata: {})
+          customer_id = "N/A"
+          customer_id = request.customer_id if request.respond_to?(:customer_id)
+          # CustomerService get requests have a different format.
+          if request.respond_to?(:resource_name)
+            customer_id = request.resource_name.split('/').last
+          end
           summary_message =
               sprintf("CID: %s, Host: %s, Method: %s",
-                request.customer_id,
+                customer_id,
                 call.instance_variable_get('@wrapped').peer,
                 method
               )
@@ -52,7 +58,7 @@ module Google
             response_message = "Incoming response (errors): \n"
 
             most_recent_error = Google::Gax::GaxError.new('')
-            most_recent_error.status_details.each do |detail|
+            most_recent_error.status_details && most_recent_error.status_details.each do |detail|
               if detail.is_a?(
                   Google::Ads::GoogleAds::V0::Errors::GoogleAdsFailure)
                 detail.errors.each_with_index do |error, i|

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

@@ -0,0 +1,431 @@
+# Encoding: utf-8
+#
+# Copyright 2018 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.
+
+module Google
+  module Ads
+    module GoogleAds
+      module Utils
+        module V0
+          class PathLookupUtil
+            def initialize(proto_lookup_util)
+              @proto_lookup_util = proto_lookup_util
+            end
+
+            def account_budget_proposal(customer_id, account_budget_proposal_id)
+              @proto_lookup_util.service(:AccountBudgetProposal).
+                  account_budget_proposal_path(customer_id.to_s,
+                    account_budget_proposal_id.to_s)
+            end
+
+            def account_budget(customer_id, account_budget_id)
+              @proto_lookup_util.service(:AccountBudget).
+                  account_budget_path(customer_id.to_s, account_budget_id.to_s)
+            end
+
+            def ad_group_ad(customer_id, ad_group_id, ad_id)
+              @proto_lookup_util.service(:AdGroupAd).ad_group_ad_path(
+                customer_id.to_s,
+                sprintf('%s_%s', ad_group_id.to_s, ad_id.to_s)
+              )
+            end
+
+            def ad_group_audience_view(customer_id, ad_group_id, criterion_id)
+              @proto_lookup_util.service(:AdGroupAudienceView).
+                  ad_group_audience_view_path(
+                    customer_id.to_s,
+                    sprintf('%s_%s', ad_group_id.to_s, criterion_id.to_s)
+                  )
+            end
+
+            def ad_group_bid_modifier(customer_id, ad_group_id, criterion_id)
+              @proto_lookup_util.service(:AdGroupBidModifier).
+                  ad_group_bid_modifier_path(
+                    customer_id.to_s,
+                    sprintf('%s_%s', ad_group_id.to_s, criterion_id.to_s)
+                  )
+            end
+
+            def ad_group_criterion(customer_id, ad_group_id, criterion_id)
+              @proto_lookup_util.service(:AdGroupCriterion).
+                  ad_group_criteria_path(
+                customer_id.to_s,
+                sprintf('%s_%s', ad_group_id.to_s, criterion_id.to_s)
+              )
+            end
+
+            def ad_group_feed(customer_id, ad_group_id, feed_id)
+              @proto_lookup_util.service(:AdGroupFeed).ad_group_feed_path(
+                customer_id.to_s,
+                sprintf('%s_%s', ad_group_id.to_s, feed_id.to_s)
+              )
+            end
+
+            def ad_group(customer_id, ad_group_id)
+              @proto_lookup_util.service(:AdGroup).ad_group_path(
+                  customer_id.to_s, ad_group_id.to_s)
+            end
+
+            def ad_parameter(customer_id, ad_group_id, criterion_id,
+                parameter_index)
+              @proto_lookup_util.service(:AdParameter).ad_parameter_path(
+                customer_id.to_s,
+                sprintf('%s_%s_%s', ad_group_id, criterion_id, parameter_index)
+              )
+            end
+
+            def ad_schedule_view(customer_id, campaign_id, criterion_id)
+              @proto_lookup_util.service(:AdScheduleView).ad_schedule_view_path(
+                customer_id.to_s,
+                sprintf('%s_%s', campaign_id, criterion_id)
+              )
+            end
+
+            def age_range_view(customer_id, ad_group_id, criterion_id)
+              @proto_lookup_util.service(:AgeRangeView).age_range_view_path(
+                customer_id.to_s,
+                sprintf('%s_%s', ad_group_id.to_s, criterion_id.to_s)
+              )
+            end
+
+            def bidding_strategy(customer_id, bidding_strategy_id)
+              @proto_lookup_util.service(:BiddingStrategy).
+                  bidding_strategy_path(
+                    customer_id.to_s,
+                    bidding_strategy_id.to_s
+                  )
+            end
+
+            def billing_setup(customer_id, billing_id)
+              @proto_lookup_util.service(:BillingSetup).billing_setup_path(
+                  customer_id.to_s, billing_id.to_s)
+            end
+
+            def campaign_audience_view(customer_id, campaign_id, criterion_id)
+              @proto_lookup_util.service(:CampaignAudienceView).
+                  campaign_audience_view_path(
+                    customer_id.to_s,
+                    sprintf('%s_%s', campaign_id.to_s, criterion_id.to_s)
+                  )
+            end
+
+            def campaign_bid_modifier(customer_id, campaign_bid_modifier_id)
+              @proto_lookup_util.service(:CampaignBidModifier).
+                  campaign_bid_modifier_path(customer_id.to_s,
+                      campaign_bid_modifier_id.to_s)
+            end
+
+            def campaign_budget(customer_id, campaign_budget_id)
+              @proto_lookup_util.service(:CampaignBudget).campaign_budget_path(
+                  customer_id.to_s, campaign_budget_id.to_s)
+            end
+
+            def campaign_criterion(customer_id, campaign_id, criterion_id)
+              @proto_lookup_util.service(:CampaignCriterion).
+                  campaign_criteria_path(
+                    customer_id.to_s,
+                    sprintf('%s_%s', campaign_id.to_s, criterion_id.to_s)
+                  )
+            end
+
+            def campaign_feed(customer_id, campaign_id, feed_id)
+              @proto_lookup_util.service(:CampaignFeed).campaign_feed_path(
+                customer_id.to_s,
+                sprintf('%s_%s', campaign_id.to_s, feed_id.to_s)
+              )
+            end
+
+            def campaign_shared_set(customer_id, campaign_shared_set_id)
+              @proto_lookup_util.service(:CampaignSharedSet).
+                  campaign_shared_set_path(customer_id.to_s,
+                      campaign_shared_set_id.to_s)
+            end
+
+            def campaign(customer_id, campaign_id)
+              @proto_lookup_util.service(:Campaign).campaign_path(
+                  customer_id.to_s, campaign_id.to_s)
+            end
+
+            def carrier_constant(criterion_id)
+              @proto_lookup_util.service(:CarrierConstant).
+                  carrier_constant_path(criterion_id.to_s)
+            end
+
+            def change_status(customer_id, change_status_id)
+              @proto_lookup_util.service(:ChangeStatus).change_status_path(
+                  customer_id.to_s, change_status_id.to_s)
+            end
+
+            def conversion_action(customer_id, conversion_action_id)
+              @proto_lookup_util.service(:ConversionAction).
+                  conversion_action_path(
+                    customer_id.to_s,
+                    conversion_action_id.to_s
+                  )
+            end
+
+            def customer_client_link(
+                customer_id, client_customer_id, manager_link_id)
+              @proto_lookup_util.service(:CustomerClientLink).
+                  customer_client_link_path(
+                    customer_id.to_s,
+                    sprintf('%s_%s', client_customer_id.to_s,
+                        manager_link_id.to_s)
+                  )
+            end
+
+            def customer_client(customer_id, client_customer_id)
+              @proto_lookup_util.service(:CustomerClient).customer_client_path(
+                  customer_id.to_s, client_customer_id.to_s)
+            end
+
+            def customer_feed(customer_id, feed_id)
+              @proto_lookup_util.service(:CustomerFeed).customer_feed_path(
+                  customer_id.to_s, feed_id.to_s)
+            end
+
+            def customer_manager_link(
+                customer_id, manager_customer_id, manager_link_id)
+              @proto_lookup_util.service(:CustomerManagerLink).
+                  customer_manager_link_path(
+                    customer_id.to_s,
+                    sprintf('%s_%s', manager_customer_id.to_s,
+                        manager_link_id.to_s)
+                  )
+            end
+
+            def customer(customer_id)
+              @proto_lookup_util.service(:Customer).
+                  customer_path(customer_id.to_s)
+            end
+
+            def display_keyword_view(customer_id, ad_group_id, criterion_id)
+              @proto_lookup_util.service(:DisplayKeywordView).
+                  display_keyword_view_path(
+                    customer_id.to_s,
+                    sprintf('%s_%s', ad_group_id.to_s, criterion_id.to_s)
+                  )
+            end
+
+            def feed_item(customer_id, feed_id, feed_item_id)
+              @proto_lookup_util.service(:FeedItem).feed_item_path(
+                customer_id.to_s,
+                sprintf('%s_%s', feed_id.to_s, feed_item_id.to_s)
+              )
+            end
+
+            def feed_mapping(customer_id, feed_id, feed_mapping_id)
+              @proto_lookup_util.service(:FeedMapping).feed_mapping_path(
+                customer_id.to_s,
+                sprintf('%s_%s', feed_id.to_s, feed_mapping_id.to_s)
+              )
+            end
+
+            def feed(customer_id, feed_id)
+              @proto_lookup_util.service(:Feed).feed_path(
+                  customer_id.to_s, feed_id.to_s)
+            end
+
+            def gender_view(customer_id, ad_group_id, criterion_id)
+              @proto_lookup_util.service(:GenderView).gender_view_path(
+                customer_id.to_s,
+                sprintf('%s_%s', ad_group_id.to_s, criterion_id.to_s)
+              )
+            end
+
+            def geo_target_constant(geo_target_constant_id)
+              @proto_lookup_util.service(:GeoTargetConstant).
+                  geo_target_constant_path(geo_target_constant_id.to_s)
+            end
+
+            def google_ads_field(google_ads_field)
+              @proto_lookup_util.service(:GoogleAdsField).google_ads_field_path(
+                  google_ads_field.to_s)
+            end
+
+            def hotel_group_view(customer_id, ad_group_id, criterion_id)
+              @proto_lookup_util.service(:HotelGroupView).hotel_group_view_path(
+                customer_id.to_s,
+                sprintf('%s_%s', ad_group_id.to_s, criterion_id.to_s)
+              )
+            end
+
+            def hotel_performance_view(customer_id)
+              @proto_lookup_util.service(:HotelPerformanceView).
+                  hotel_performance_view_path(customer_id.to_s)
+            end
+
+            def keyword_plan_ad_group(customer_id, kp_ad_group_id)
+              @proto_lookup_util.service(:KeywordPlanAdGroup).
+                  keyword_plan_ad_group_path(
+                    customer_id.to_s,
+                    kp_ad_group_id.to_s
+                  )
+            end
+
+            def keyword_plan_campaign(customer_id, kp_campaign_id)
+              @proto_lookup_util.service(:KeywordPlanCampaign).
+                  keyword_plan_campaign_path(
+                    customer_id.to_s,
+                    kp_campaign_id.to_s
+                  )
+            end
+
+            def keyword_plan_keyword(customer_id, kp_ad_group_keyword_id)
+              @proto_lookup_util.service(:KeywordPlanKeyword).
+                  keyword_plan_keyword_path(
+                    customer_id.to_s,
+                    kp_ad_group_keyword_id.to_s
+                  )
+            end
+
+            def keyword_plan_negative_keyword(customer_id,
+                kp_negative_keyword_id)
+              @proto_lookup_util.service(:KeywordPlanNegativeKeyword).
+                  keyword_plan_negative_keyword_path(
+                    customer_id.to_s,
+                    kp_negative_keyword_id.to_s
+                  )
+            end
+
+            def keyword_plan(customer_id, kp_plan_id)
+              @proto_lookup_util.service(:KeywordPlan).keyword_plan_path(
+                  customer_id.to_s, kp_plan_id.to_s)
+            end
+
+            def keyword_view(customer_id, ad_group_id, criterion_id)
+              @proto_lookup_util.service(:KeywordView).keyword_view_path(
+                customer_id.to_s,
+                sprintf('%s_%s', ad_group_id.to_s, criterion_id.to_s)
+              )
+            end
+
+            def language_constant(criterion_id)
+              @proto_lookup_util.service(:LanguageConstant).
+                  language_constant_path(criterion_id.to_s)
+            end
+
+            def managed_placement_view(customer_id, ad_group_id, criterion_id)
+              @proto_lookup_util.service(:ManagedPlacementView).
+                  managed_placement_view_path(
+                    customer_id.to_s,
+                    sprintf('%s_%s', ad_group_id.to_s, criterion_id.to_s)
+                  )
+            end
+
+            def media_file(customer_id, media_file_id)
+              @proto_lookup_util.service(:MediaFile).media_file_path(
+                  customer_id.to_s, media_file_id.to_s)
+            end
+
+            def mobile_app_category_constant(mobile_app_category_id)
+              @proto_lookup_util.service(:MobileAppCategoryConstant).
+                  mobile_app_category_constant_path(mobile_app_category_id.to_s)
+            end
+
+            def mobile_device_constant(criterion_id)
+              @proto_lookup_util.service(:MobileDeviceConstant).
+                  mobile_device_constant_path(criterion_id.to_s)
+            end
+
+            def operating_system_version_constant(criterion_id)
+              @proto_lookup_util.service(:OperatingSystemVersionConstant).
+                  operating_system_version_constant_path(criterion_id.to_s)
+            end
+
+            def parental_status_view(customer_id, ad_group_id, criterion_id)
+              @proto_lookup_util.service(:ParentalStatusView).
+                  parental_status_view_path(
+                    customer_id.to_s,
+                    sprintf('%s_%s', ad_group_id.to_s, criterion_id.to_s)
+                  )
+            end
+
+            def product_group_view(customer_id, ad_group_id, criterion_id)
+              @proto_lookup_util.service(:ProductGroupView).
+                  product_group_view_path(
+                    customer_id.to_s,
+                    sprintf('%s_%s', ad_group_id.to_s, criterion_id.to_s)
+                  )
+            end
+
+            def recommendation(customer_id, recommendation_id)
+              @proto_lookup_util.service(:Recommendation).recommendation_path(
+                customer_id.to_s, recommendation_id.to_s)
+            end
+
+            def remarketing_action(customer_id, remarketing_action_id)
+              @proto_lookup_util.service(:RemarketingAction).
+                  remarketing_action_path(
+                    customer_id.to_s,
+                    remarketing_action_id.to_s
+                  )
+            end
+
+            def search_term_view(customer_id, campaign_id, ad_group_id,
+                search_term)
+              @proto_lookup_util.service(:SearchTermView).search_term_view_path(
+                customer_id.to_s,
+                sprintf('%s_%s_%s',
+                    campaign_id.to_s, ad_group_id.to_s, search_term.to_s)
+              )
+            end
+
+            def shared_criterion(customer_id, shared_set_id, criterion_id)
+              @proto_lookup_util.service(:SharedCriterion).shared_criteria_path(
+                customer_id.to_s,
+                sprintf('%s_%s', shared_set_id.to_s, criterion_id.to_s)
+              )
+            end
+
+            def shared_set(customer_id, shared_set_id)
+              @proto_lookup_util.service(:SharedSet).shared_set_path(
+                  customer_id.to_s, shared_set_id.to_s)
+            end
+
+            def topic_constant(vertical_id)
+              @proto_lookup_util.service(:TopicConstant).topic_constant_path(
+                  vertical_id.to_s)
+            end
+
+            def topic_view(customer_id, ad_group_id, criterion_id)
+              @proto_lookup_util.service(:TopicView).topic_view_path(
+                customer_id.to_s,
+                sprintf('%s_%s', ad_group_id.to_s, criterion_id.to_s)
+              )
+            end
+
+            def user_interest(customer_id, user_interest_id)
+              @proto_lookup_util.service(:UserInterest).user_interest_path(
+                  customer_id.to_s, user_interest_id.to_s)
+            end
+
+            def user_list(customer_id, user_list_id)
+              @proto_lookup_util.service(:UserList).user_list_path(
+                customer_id.to_s, user_list_id.to_s)
+            end
+
+            def video(customer_id, video_id)
+              @proto_lookup_util.service(:Video).video_path(
+                  customer_id.to_s, video_id.to_s)
+            end
+          end
+        end
+      end
+    end
+  end
+end