google-ads-googleads 0.1.0

data/lib/google/ads/googleads/patches.rb

@@ -0,0 +1,45 @@
+# 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.
+#
+# Here we gather custom patches we want to make the lib more usable.
+
+require 'google/protobuf/wrappers_pb'
+
+module Google
+  module Protobuf
+    class StringValue
+      def to_s; return value; end
+    end
+
+    class Int64Value
+      def to_s; return value.to_s; end
+      def to_i; return value.to_i; end
+      def to_f; return value.to_f; end
+    end
+
+    class Int32Value
+      def to_s; return value.to_s; end
+      def to_i; return value.to_i; end
+      def to_f; return value.to_f; end
+    end
+
+    class DoubleValue
+      def to_s; return value.to_s; end
+      def to_i; return value.to_i; end
+      def to_f; return value.to_f; end
+    end
+  end
+end

data/lib/google/ads/googleads/path_lookup_util.rb

@@ -0,0 +1,84 @@
+# 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
+      class PathLookupUtil
+        def initialize(proto_lookup_util)
+          @proto_lookup_util = proto_lookup_util
+        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_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(customer_id, ad_group_id)
+          @proto_lookup_util.service(:AdGroup).ad_group_path(
+              customer_id.to_s, ad_group_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 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(customer_id, campaign_id)
+          @proto_lookup_util.service(:Campaign).campaign_path(
+              customer_id.to_s, campaign_id.to_s)
+        end
+
+        def customer(customer_id)
+          @proto_lookup_util.service(:Customer).customer_path(customer_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 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
+      end
+    end
+  end
+end

data/lib/google/ads/googleads/proto_lookup_util.rb

@@ -0,0 +1,249 @@
+# 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 looks up references to generated classes for proto objects.
+
+module Google
+  module Ads
+    module Googleads
+      class ProtoLookupUtil
+        # Variables: Version, folder (resources/common), filename
+        RESOURCE_PATH = 'google/ads/googleads/%s/%s/%s'.freeze
+        # Variables: Version, class name
+        RESOURCE_CLASS_PATH = 'Google::Ads::Googleads::%s::Resources::%s'.freeze
+        # Variables: Version, class name
+        COMMON_CLASS_PATH = 'Google::Ads::Googleads::%s::Common::%s'.freeze
+
+        # Variables: Version, filename
+        ENUM_PATH = 'google/ads/googleads/%s/enums/%s'.freeze
+        # Variables: Version, enum name, enum name (again)
+        ENUM_CLASS_PATH = 'Google::Ads::Googleads::%s::Enums::%sEnum::%s'.freeze
+
+        # Variables: Version, filename
+        SERVICE_PATH = 'google/ads/googleads/%s/services/%s'.freeze
+        # Variables: Version, entity name
+        SERVICE_CLASS_PATH =
+            'Google::Ads::Googleads::%s::Services::%s'.freeze
+
+        RESOURCES = {
+          AdGroupAd: ['resources', 'ad_group_ad_pb', 'AdGroupAd'],
+          AdGroupCriterion: ['resources', 'ad_group_criterion_pb',
+              'AdGroupCriterion'],
+          QualityInfo: ['resources', 'ad_group_criterion_pb',
+              'AdGroupCriterion::QualityInfo'],
+          PositionEstimates: ['resources', 'ad_group_criterion_pb',
+            'AdGroupCriterion::PositionEstimates'],
+          AdGroup: ['resources', 'ad_group_pb', 'AdGroup'],
+          BiddingStrategy: ['resources', 'bidding_strategy_pb',
+              'BiddingStrategy'],
+          CampaignBudget: ['resources', 'campaign_budget_pb', 'CampaignBudget'],
+          CampaignCriterion: ['resources', 'campaign_criterion_pb',
+              'CampaignCriterion'],
+          Campaign: ['resources', 'campaign_pb', 'Campaign'],
+          NetworkSettings: ['resources', 'campaign_pb',
+              'Campaign::NetworkSettings'],
+          DynamicSearchAdsSetting: ['resources', 'campaign_pb',
+              'Campaign::DynamicSearchAdsSetting'],
+          Customer: ['resources', 'customer_pb', 'Customer'],
+          GoogleAdsField: ['resources', 'google_ads_field_pb',
+              'GoogleAdsField'],
+          KeywordView: ['resources', 'keyword_view_pb', 'KeywordView'],
+          Ad: ['common', 'ad_pb', 'Ad'],
+          TextAdInfo: ['common', 'ad_pb', 'TextAdInfo'],
+          ExpandedTextAdInfo: ['common', 'ad_pb', 'ExpandedTextAdInfo'],
+          DynamicSearchAdInfo: ['common', 'ad_pb', 'DynamicSearchAdInfo'],
+          ResponsiveDisplayAdInfo: ['common', 'ad_pb',
+              'ResponsiveDisplayAdInfo'],
+          CallOnlyAdInfo: ['common', 'ad_pb', 'CallOnlyAdInfo'],
+          ExpandedDynamicSearchAdInfo: ['common', 'ad_pb',
+              'ExpandedDynamicSearchAdInfo'],
+          EnhancedCpc: ['common', 'bidding_pb', 'EnhancedCpc'],
+          ManualCpc: ['common', 'bidding_pb', 'ManualCpc'],
+          ManualCpm: ['common', 'bidding_pb', 'ManualCpm'],
+          MaximizeConversions: ['common', 'bidding_pb', 'MaximizeConversions'],
+          MaximizeConversionValue: ['common', 'bidding_pb',
+              'MaximizeConversionValue'],
+          PageOnePromoted: ['common', 'bidding_pb', 'PageOnePromoted'],
+          TargetCpa: ['common', 'bidding_pb', 'TargetCpa'],
+          TargetOutrankShare: ['common', 'bidding_pb', 'TargetOutrankShare'],
+          TargetRoas: ['common', 'bidding_pb', 'TargetRoas'],
+          TargetSpend: ['common', 'bidding_pb', 'TargetSpend'],
+          KeywordInfo: ['common', 'criteria_pb', 'KeywordInfo'],
+          CustomParameter: ['common', 'custom_parameter_pb', 'CustomParameter'],
+          Metrics: ['common', 'metrics_pb', 'Metrics'],
+          PolicyViolationKey: ['common', 'policy_pb', 'PolicyViolationKey'],
+          Value: ['common', 'value_pb', 'Value']
+        }.freeze
+
+        ENUMS = {
+          AdGroupAdStatus: ['ad_group_ad_status_pb', 'AdGroupAdStatus'],
+          AdGroupCriterionStatus: ['ad_group_criterion_status_pb',
+              'AdGroupCriterionStatus'],
+          AdGroupStatus: ['ad_group_status_pb', 'AdGroupStatus'],
+          AdGroupType: ['ad_group_type_pb', 'AdGroupType'],
+          AdNetworkType: ['ad_network_type_pb', 'AdNetworkType'],
+          AdServingOptimizationStatus: ['ad_serving_optimization_status_pb',
+              'AdServingOptimizationStatus'],
+          AdType: ['ad_type_pb', 'AdType'],
+          AdvertisingChannelSubType: ['advertising_channel_sub_type_pb',
+              'AdvertisingChannelSubType'],
+          AdvertisingChannelType: ['advertising_channel_type_pb',
+              'AdvertisingChannelType'],
+          BidSource: ['bid_source_pb', 'BidSource'],
+          BiddingStrategyType: ['bidding_strategy_type_pb',
+              'BiddingStrategyType'],
+          BudgetDeliveryMethod: ['budget_delivery_method_pb',
+              'BudgetDeliveryMethod'],
+          BudgetStatus: ['budget_status_pb', 'BudgetStatus'],
+          CampaignServingStatus: ['campaign_serving_status_pb',
+              'CampaignServingStatus'],
+          CampaignStatus: ['campaign_status_pb', 'CampaignStatus'],
+          DayOfWeek: ['day_of_week_pb', 'DayOfWeek'],
+          Device: ['device_pb', 'Device'],
+          GoogleAdsFieldCategory: ['google_ads_field_category_pb',
+              'GoogleAdsFieldCategory'],
+          GoogleAdsFieldDataType: ['google_ads_field_data_type_pb',
+              'GoogleAdsFieldDataType'],
+          KeywordMatchType: ['keyword_match_type_pb', 'KeywordMatchType'],
+          PageOnePromotedStrategyGoal: ['page_one_promoted_strategy_goal_pb',
+              'PageOnePromotedStrategyGoal'],
+          QualityScoreBucket: ['quality_score_bucket_pb', 'QualityScoreBucket'],
+          Slot: ['slot_pb', 'Slot']
+        }.freeze
+
+        SERVICES = {
+          AdGroupAd: ['ad_group_ad_service_client', 'AdGroupAdServiceClient'],
+          AdGroupCriterion: ['ad_group_criterion_service_client',
+              'AdGroupCriterionServiceClient'],
+          AdGroup: ['ad_group_service_client', 'AdGroupServiceClient'],
+          BiddingStrategy: ['bidding_strategy_service_client',
+              'BiddingStrategyServiceClient'],
+          CampaignBudget: ['campaign_budget_service_client',
+              'CampaignBudgetServiceClient'],
+          CampaignCriterion: ['campaign_criterion_service_client',
+              'CampaignCriterionServiceClient'],
+          Campaign: ['campaign_service_client', 'CampaignServiceClient'],
+          Customer: ['customer_service_client', 'CustomerServiceClient'],
+          GoogleAdsField: ['google_ads_field_service_client',
+              'GoogleAdsFieldServiceClient'],
+          GoogleAds: ['google_ads_service_client', 'GoogleAdsServiceClient'],
+          KeywordView: ['keyword_view_service_client',
+              'KeywordViewServiceClient']
+        }
+
+        OPERATIONS = {
+          AdGroupAd: ['ad_group_ad_service_pb', 'AdGroupAdOperation'],
+          AdGroupCriterion: ['ad_group_criterion_service_pb',
+              'AdGroupCriterionOperation'],
+          AdGroup: ['ad_group_service_pb', 'AdGroupOperation'],
+          BiddingStrategy: ['bidding_strategy_service_pb',
+              'BiddingStrategyOperation'],
+          CampaignBudget: ['campaign_budget_service_pb',
+              'CampaignBudgetOperation'],
+          CampaignCriterion: ['campaign_criterion_service_pb',
+              'CampaignCriterionOperation'],
+          Campaign: ['campaign_service_pb', 'CampaignOperation'],
+        }
+
+        def initialize(version)
+          @version = version
+          @path_version = version.downcase
+        end
+
+        # Look up the class for a resource by name.
+        def resource(name)
+          name = name.to_sym
+
+          resource_info = RESOURCES[name]
+          if resource_info.nil?
+            raise ArgumentError, sprintf('No resource found with name %s', name)
+          end
+
+          require_path = sprintf(RESOURCE_PATH, @path_version, resource_info[0],
+              resource_info[1])
+          require require_path
+
+          class_path = resource_info.first == 'resources' ?
+              RESOURCE_CLASS_PATH : COMMON_CLASS_PATH
+          class_path = sprintf(class_path, @version, resource_info[2])
+          return class_for_path(class_path)
+        end
+
+        # Look up the class for an enum by name.
+        def enum(name)
+          name = name.to_sym
+
+          enum_info = ENUMS[name]
+          if enum_info.nil?
+            raise ArgumentError, sprintf('No enum found with name %s', name)
+          end
+
+          require_path = sprintf(ENUM_PATH, @path_version, enum_info.first)
+          require require_path
+
+          class_path = sprintf(ENUM_CLASS_PATH, @version, enum_info.last,
+              enum_info.last)
+          return class_for_path(class_path)
+        end
+
+        # Look up the class for a service by name.
+        def service(name)
+          name = name.to_sym
+
+          service_info = SERVICES[name]
+          if service_info.nil?
+            raise ArgumentError, sprintf('No service found with name %s', name)
+          end
+
+          require_path = sprintf(SERVICE_PATH, @path_version,
+              service_info.first)
+          require require_path
+
+          class_path = sprintf(SERVICE_CLASS_PATH, @version, service_info.last)
+          return class_for_path(class_path)
+        end
+
+        # Look up the class for an operation by name.
+        def operation(name)
+          name = name.to_sym
+
+          operation_info = OPERATIONS[name]
+          if operation_info.nil?
+            raise ArgumentError,
+                sprintf('No operation found with name %s', name)
+          end
+
+          require_path = sprintf(SERVICE_PATH, @path_version,
+              operation_info.first)
+          require require_path
+
+          class_path = sprintf(SERVICE_CLASS_PATH, @version,
+              operation_info.last)
+          return class_for_path(class_path)
+        end
+
+        private
+
+        # 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
+end

data/lib/google/ads/googleads/v0/common/ad_pb.rb

@@ -0,0 +1,80 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/ads/googleads/v0/common/ad.proto
+
+require 'google/protobuf'
+
+require 'google/ads/googleads/v0/common/custom_parameter_pb'
+require 'google/ads/googleads/v0/enums/ad_type_pb'
+require 'google/protobuf/wrappers_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "google.ads.googleads.v0.common.Ad" do
+    optional :id, :message, 1, "google.protobuf.Int64Value"
+    repeated :final_urls, :message, 2, "google.protobuf.StringValue"
+    repeated :final_mobile_urls, :message, 16, "google.protobuf.StringValue"
+    optional :tracking_url_template, :message, 12, "google.protobuf.StringValue"
+    repeated :url_custom_parameters, :message, 10, "google.ads.googleads.v0.common.CustomParameter"
+    optional :display_url, :message, 4, "google.protobuf.StringValue"
+    optional :type, :enum, 5, "google.ads.googleads.v0.enums.AdTypeEnum.AdType"
+    oneof :ad_data do
+      optional :text_ad, :message, 6, "google.ads.googleads.v0.common.TextAdInfo"
+      optional :expanded_text_ad, :message, 7, "google.ads.googleads.v0.common.ExpandedTextAdInfo"
+      optional :dynamic_search_ad, :message, 8, "google.ads.googleads.v0.common.DynamicSearchAdInfo"
+      optional :responsive_display_ad, :message, 9, "google.ads.googleads.v0.common.ResponsiveDisplayAdInfo"
+      optional :call_only_ad, :message, 13, "google.ads.googleads.v0.common.CallOnlyAdInfo"
+      optional :expanded_dynamic_search_ad, :message, 14, "google.ads.googleads.v0.common.ExpandedDynamicSearchAdInfo"
+    end
+  end
+  add_message "google.ads.googleads.v0.common.TextAdInfo" do
+    optional :headline, :message, 1, "google.protobuf.StringValue"
+    optional :description1, :message, 2, "google.protobuf.StringValue"
+    optional :description2, :message, 3, "google.protobuf.StringValue"
+  end
+  add_message "google.ads.googleads.v0.common.ExpandedTextAdInfo" do
+    optional :headline_part1, :message, 1, "google.protobuf.StringValue"
+    optional :headline_part2, :message, 2, "google.protobuf.StringValue"
+    optional :description, :message, 3, "google.protobuf.StringValue"
+    optional :path1, :message, 4, "google.protobuf.StringValue"
+    optional :path2, :message, 5, "google.protobuf.StringValue"
+  end
+  add_message "google.ads.googleads.v0.common.DynamicSearchAdInfo" do
+    optional :description1, :message, 1, "google.protobuf.StringValue"
+    optional :description2, :message, 2, "google.protobuf.StringValue"
+  end
+  add_message "google.ads.googleads.v0.common.ResponsiveDisplayAdInfo" do
+    optional :short_headline, :message, 1, "google.protobuf.StringValue"
+    optional :long_headline, :message, 2, "google.protobuf.StringValue"
+    optional :description, :message, 3, "google.protobuf.StringValue"
+    optional :business_name, :message, 4, "google.protobuf.StringValue"
+  end
+  add_message "google.ads.googleads.v0.common.CallOnlyAdInfo" do
+    optional :country_code, :message, 1, "google.protobuf.StringValue"
+    optional :phone_number, :message, 2, "google.protobuf.StringValue"
+    optional :business_name, :message, 3, "google.protobuf.StringValue"
+    optional :description1, :message, 4, "google.protobuf.StringValue"
+    optional :description2, :message, 5, "google.protobuf.StringValue"
+    optional :call_tracked, :message, 6, "google.protobuf.BoolValue"
+    optional :disable_call_conversion, :message, 7, "google.protobuf.BoolValue"
+    optional :phone_number_verification_url, :message, 8, "google.protobuf.StringValue"
+  end
+  add_message "google.ads.googleads.v0.common.ExpandedDynamicSearchAdInfo" do
+    optional :description, :message, 1, "google.protobuf.StringValue"
+  end
+end
+
+module Google
+  module Ads
+    module Googleads
+      module V0
+        module Common
+          Ad = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v0.common.Ad").msgclass
+          TextAdInfo = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v0.common.TextAdInfo").msgclass
+          ExpandedTextAdInfo = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v0.common.ExpandedTextAdInfo").msgclass
+          DynamicSearchAdInfo = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v0.common.DynamicSearchAdInfo").msgclass
+          ResponsiveDisplayAdInfo = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v0.common.ResponsiveDisplayAdInfo").msgclass
+          CallOnlyAdInfo = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v0.common.CallOnlyAdInfo").msgclass
+          ExpandedDynamicSearchAdInfo = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v0.common.ExpandedDynamicSearchAdInfo").msgclass
+        end
+      end
+    end
+  end
+end