google-ads-googleads 0.3.0 → 0.4.0

data/lib/google/ads/googleads/v0/services/ad_group_ad_service_client.rb

@@ -202,9 +202,9 @@ module Google
             # @return [Google::Ads::Googleads::V0::Resources::AdGroupAd]
             # @raise [Google::Gax::GaxError] if the RPC is aborted.
             # @example
-            #   require "google/ads/googleads/v0/services"
+            #   require "google/ads/googleads"
             #
-            #   ad_group_ad_service_client = Google::Ads::Googleads::V0::Services::AdGroupAd.new
+            #   ad_group_ad_service_client = Google::Ads::Googleads::AdGroupAd.new(version: :v0)
             #   formatted_resource_name = Google::Ads::Googleads::V0::Services::AdGroupAdServiceClient.ad_group_ad_path("[CUSTOMER]", "[AD_GROUP_AD]")
             #   response = ad_group_ad_service_client.get_ad_group_ad(formatted_resource_name)
 
@@ -236,9 +236,9 @@ module Google
             # @return [Google::Ads::Googleads::V0::Services::MutateAdGroupAdsResponse]
             # @raise [Google::Gax::GaxError] if the RPC is aborted.
             # @example
-            #   require "google/ads/googleads/v0/services"
+            #   require "google/ads/googleads"
             #
-            #   ad_group_ad_service_client = Google::Ads::Googleads::V0::Services::AdGroupAd.new
+            #   ad_group_ad_service_client = Google::Ads::Googleads::AdGroupAd.new(version: :v0)
             #
             #   # TODO: Initialize +customer_id+:
             #   customer_id = ''

data/lib/google/ads/googleads/v0/services/ad_group_ad_service_services_pb.rb

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/ads/googleads/v0/services/ad_group_ad_service.proto for package 'google.ads.googleads.v0.services'
 # Original file comments:
-# Copyright 2018 Google Inc.
+# 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.
@@ -15,6 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+#
 
 require 'grpc'
 require 'google/ads/googleads/v0/services/ad_group_ad_service_pb'
@@ -25,8 +26,6 @@ module Google
       module V0
         module Services
           module AdGroupAdService
-            # Proto file describing the Ad Group Ad service.
-            #
             # Service to manage ads in an ad group.
             class Service
 

data/lib/google/ads/googleads/v0/services/ad_group_bid_modifier_service_client.rb

@@ -202,9 +202,9 @@ module Google
             # @return [Google::Ads::Googleads::V0::Resources::AdGroupBidModifier]
             # @raise [Google::Gax::GaxError] if the RPC is aborted.
             # @example
-            #   require "google/ads/googleads/v0/services"
+            #   require "google/ads/googleads"
             #
-            #   ad_group_bid_modifier_service_client = Google::Ads::Googleads::V0::Services::AdGroupBidModifier.new
+            #   ad_group_bid_modifier_service_client = Google::Ads::Googleads::AdGroupBidModifier.new(version: :v0)
             #   formatted_resource_name = Google::Ads::Googleads::V0::Services::AdGroupBidModifierServiceClient.ad_group_bid_modifier_path("[CUSTOMER]", "[AD_GROUP_BID_MODIFIER]")
             #   response = ad_group_bid_modifier_service_client.get_ad_group_bid_modifier(formatted_resource_name)
 
@@ -237,9 +237,9 @@ module Google
             # @return [Google::Ads::Googleads::V0::Services::MutateAdGroupBidModifiersResponse]
             # @raise [Google::Gax::GaxError] if the RPC is aborted.
             # @example
-            #   require "google/ads/googleads/v0/services"
+            #   require "google/ads/googleads"
             #
-            #   ad_group_bid_modifier_service_client = Google::Ads::Googleads::V0::Services::AdGroupBidModifier.new
+            #   ad_group_bid_modifier_service_client = Google::Ads::Googleads::AdGroupBidModifier.new(version: :v0)
             #
             #   # TODO: Initialize +customer_id+:
             #   customer_id = ''

data/lib/google/ads/googleads/v0/services/ad_group_bid_modifier_service_services_pb.rb

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/ads/googleads/v0/services/ad_group_bid_modifier_service.proto for package 'google.ads.googleads.v0.services'
 # Original file comments:
-# Copyright 2018 Google Inc.
+# 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.
@@ -15,6 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+#
 
 require 'grpc'
 require 'google/ads/googleads/v0/services/ad_group_bid_modifier_service_pb'
@@ -25,8 +26,6 @@ module Google
       module V0
         module Services
           module AdGroupBidModifierService
-            # Proto file describing the Ad Group Bid Modifier service.
-            #
             # Service to manage ad group bid modifiers.
             class Service
 

data/lib/google/ads/googleads/v0/services/ad_group_criterion_service_client.rb

@@ -202,9 +202,9 @@ module Google
             # @return [Google::Ads::Googleads::V0::Resources::AdGroupCriterion]
             # @raise [Google::Gax::GaxError] if the RPC is aborted.
             # @example
-            #   require "google/ads/googleads/v0/services"
+            #   require "google/ads/googleads"
             #
-            #   ad_group_criterion_service_client = Google::Ads::Googleads::V0::Services::AdGroupCriterion.new
+            #   ad_group_criterion_service_client = Google::Ads::Googleads::AdGroupCriterion.new(version: :v0)
             #   formatted_resource_name = Google::Ads::Googleads::V0::Services::AdGroupCriterionServiceClient.ad_group_criteria_path("[CUSTOMER]", "[AD_GROUP_CRITERIA]")
             #   response = ad_group_criterion_service_client.get_ad_group_criterion(formatted_resource_name)
 
@@ -236,9 +236,9 @@ module Google
             # @return [Google::Ads::Googleads::V0::Services::MutateAdGroupCriteriaResponse]
             # @raise [Google::Gax::GaxError] if the RPC is aborted.
             # @example
-            #   require "google/ads/googleads/v0/services"
+            #   require "google/ads/googleads"
             #
-            #   ad_group_criterion_service_client = Google::Ads::Googleads::V0::Services::AdGroupCriterion.new
+            #   ad_group_criterion_service_client = Google::Ads::Googleads::AdGroupCriterion.new(version: :v0)
             #
             #   # TODO: Initialize +customer_id+:
             #   customer_id = ''

data/lib/google/ads/googleads/v0/services/ad_group_criterion_service_services_pb.rb

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/ads/googleads/v0/services/ad_group_criterion_service.proto for package 'google.ads.googleads.v0.services'
 # Original file comments:
-# Copyright 2018 Google Inc.
+# 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.
@@ -15,6 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+#
 
 require 'grpc'
 require 'google/ads/googleads/v0/services/ad_group_criterion_service_pb'
@@ -25,8 +26,6 @@ module Google
       module V0
         module Services
           module AdGroupCriterionService
-            # Proto file describing the Ad Group Criterion service.
-            #
             # Service to manage ad group criteria.
             class Service
 

data/lib/google/ads/googleads/v0/services/ad_group_service_client.rb

@@ -202,9 +202,9 @@ module Google
             # @return [Google::Ads::Googleads::V0::Resources::AdGroup]
             # @raise [Google::Gax::GaxError] if the RPC is aborted.
             # @example
-            #   require "google/ads/googleads/v0/services"
+            #   require "google/ads/googleads"
             #
-            #   ad_group_service_client = Google::Ads::Googleads::V0::Services::AdGroup.new
+            #   ad_group_service_client = Google::Ads::Googleads::AdGroup.new(version: :v0)
             #   formatted_resource_name = Google::Ads::Googleads::V0::Services::AdGroupServiceClient.ad_group_path("[CUSTOMER]", "[AD_GROUP]")
             #   response = ad_group_service_client.get_ad_group(formatted_resource_name)
 
@@ -236,9 +236,9 @@ module Google
             # @return [Google::Ads::Googleads::V0::Services::MutateAdGroupsResponse]
             # @raise [Google::Gax::GaxError] if the RPC is aborted.
             # @example
-            #   require "google/ads/googleads/v0/services"
+            #   require "google/ads/googleads"
             #
-            #   ad_group_service_client = Google::Ads::Googleads::V0::Services::AdGroup.new
+            #   ad_group_service_client = Google::Ads::Googleads::AdGroup.new(version: :v0)
             #
             #   # TODO: Initialize +customer_id+:
             #   customer_id = ''

data/lib/google/ads/googleads/v0/services/ad_group_service_services_pb.rb

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/ads/googleads/v0/services/ad_group_service.proto for package 'google.ads.googleads.v0.services'
 # Original file comments:
-# Copyright 2018 Google Inc.
+# 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.
@@ -15,6 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+#
 
 require 'grpc'
 require 'google/ads/googleads/v0/services/ad_group_service_pb'
@@ -25,8 +26,6 @@ module Google
       module V0
         module Services
           module AdGroupService
-            # Proto file describing the Ad Group service.
-            #
             # Service to manage ad groups.
             class Service
 

data/lib/google/ads/googleads/v0/services/bidding_strategy_service_client.rb

@@ -202,9 +202,9 @@ module Google
             # @return [Google::Ads::Googleads::V0::Resources::BiddingStrategy]
             # @raise [Google::Gax::GaxError] if the RPC is aborted.
             # @example
-            #   require "google/ads/googleads/v0/services"
+            #   require "google/ads/googleads"
             #
-            #   bidding_strategy_service_client = Google::Ads::Googleads::V0::Services::BiddingStrategy.new
+            #   bidding_strategy_service_client = Google::Ads::Googleads::BiddingStrategy.new(version: :v0)
             #   formatted_resource_name = Google::Ads::Googleads::V0::Services::BiddingStrategyServiceClient.bidding_strategy_path("[CUSTOMER]", "[BIDDING_STRATEGY]")
             #   response = bidding_strategy_service_client.get_bidding_strategy(formatted_resource_name)
 
@@ -237,9 +237,9 @@ module Google
             # @return [Google::Ads::Googleads::V0::Services::MutateBiddingStrategiesResponse]
             # @raise [Google::Gax::GaxError] if the RPC is aborted.
             # @example
-            #   require "google/ads/googleads/v0/services"
+            #   require "google/ads/googleads"
             #
-            #   bidding_strategy_service_client = Google::Ads::Googleads::V0::Services::BiddingStrategy.new
+            #   bidding_strategy_service_client = Google::Ads::Googleads::BiddingStrategy.new(version: :v0)
             #
             #   # TODO: Initialize +customer_id+:
             #   customer_id = ''

data/lib/google/ads/googleads/v0/services/bidding_strategy_service_services_pb.rb

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/ads/googleads/v0/services/bidding_strategy_service.proto for package 'google.ads.googleads.v0.services'
 # Original file comments:
-# Copyright 2018 Google Inc.
+# 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.
@@ -15,6 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+#
 
 require 'grpc'
 require 'google/ads/googleads/v0/services/bidding_strategy_service_pb'
@@ -25,8 +26,6 @@ module Google
       module V0
         module Services
           module BiddingStrategyService
-            # Proto file describing the Bidding Strategy service.
-            #
             # Service to manage bidding strategies.
             class Service
 

data/lib/google/ads/googleads/v0/services/campaign_bid_modifier_service_client.rb

@@ -0,0 +1,268 @@
+# 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.
+#
+# EDITING INSTRUCTIONS
+# This file was generated from the file
+# https://github.com/googleapis/googleapis/blob/master/google/ads/googleads/v0/services/campaign_bid_modifier_service.proto,
+# and updates to that file get reflected here through a refresh process.
+# For the short term, the refresh process will only be runnable by Google
+# engineers.
+
+require "json"
+require "pathname"
+
+require "google/gax"
+
+require "google/ads/googleads/v0/services/campaign_bid_modifier_service_pb"
+require "google/ads/googleads/v0/services/credentials"
+
+module Google
+  module Ads
+    module Googleads
+      module V0
+        module Services
+          # Service to manage campaign bid modifiers.
+          #
+          # @!attribute [r] campaign_bid_modifier_service_stub
+          #   @return [Google::Ads::Googleads::V0::Services::CampaignBidModifierService::Stub]
+          class CampaignBidModifierServiceClient
+            attr_reader :campaign_bid_modifier_service_stub
+
+            # The default address of the service.
+            SERVICE_ADDRESS = "googleads.googleapis.com".freeze
+
+            # The default port of the service.
+            DEFAULT_SERVICE_PORT = 443
+
+            # The default set of gRPC interceptors.
+            GRPC_INTERCEPTORS = []
+
+            DEFAULT_TIMEOUT = 30
+
+            # The scopes needed to make gRPC calls to all of the methods defined in
+            # this service.
+            ALL_SCOPES = [
+            ].freeze
+
+
+            CAMPAIGN_BID_MODIFIER_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+              "customers/{customer}/campaignBidModifiers/{campaign_bid_modifier}"
+            )
+
+            private_constant :CAMPAIGN_BID_MODIFIER_PATH_TEMPLATE
+
+            # Returns a fully-qualified campaign_bid_modifier resource name string.
+            # @param customer [String]
+            # @param campaign_bid_modifier [String]
+            # @return [String]
+            def self.campaign_bid_modifier_path customer, campaign_bid_modifier
+              CAMPAIGN_BID_MODIFIER_PATH_TEMPLATE.render(
+                :"customer" => customer,
+                :"campaign_bid_modifier" => campaign_bid_modifier
+              )
+            end
+
+            # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
+            #   Provides the means for authenticating requests made by the client. This parameter can
+            #   be many types.
+            #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
+            #   authenticating requests made by this client.
+            #   A `String` will be treated as the path to the keyfile to be used for the construction of
+            #   credentials for this client.
+            #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
+            #   credentials for this client.
+            #   A `GRPC::Core::Channel` will be used to make calls through.
+            #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
+            #   should already be composed with a `GRPC::Core::CallCredentials` object.
+            #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
+            #   metadata for requests, generally, to give OAuth credentials.
+            # @param scopes [Array<String>]
+            #   The OAuth scopes for this service. This parameter is ignored if
+            #   an updater_proc is supplied.
+            # @param client_config [Hash]
+            #   A Hash for call options for each method. See
+            #   Google::Gax#construct_settings for the structure of
+            #   this data. Falls back to the default config if not specified
+            #   or the specified config is missing data points.
+            # @param timeout [Numeric]
+            #   The default timeout, in seconds, for calls made through this client.
+            # @param metadata [Hash]
+            #   Default metadata to be sent with each request. This can be overridden on a per call basis.
+            # @param exception_transformer [Proc]
+            #   An optional proc that intercepts any exceptions raised during an API call to inject
+            #   custom error handling.
+            def initialize \
+                credentials: nil,
+                scopes: ALL_SCOPES,
+                client_config: {},
+                timeout: DEFAULT_TIMEOUT,
+                metadata: nil,
+                exception_transformer: nil,
+                lib_name: nil,
+                lib_version: ""
+              # These require statements are intentionally placed here to initialize
+              # the gRPC module only when it's required.
+              # See https://github.com/googleapis/toolkit/issues/446
+              require "google/gax/grpc"
+              require "google/ads/googleads/v0/services/campaign_bid_modifier_service_services_pb"
+
+              credentials ||= Google::Ads::Googleads::V0::Services::Credentials.default
+
+              if credentials.is_a?(String) || credentials.is_a?(Hash)
+                updater_proc = Google::Ads::Googleads::V0::Services::Credentials.new(credentials).updater_proc
+              end
+              if credentials.is_a?(GRPC::Core::Channel)
+                channel = credentials
+              end
+              if credentials.is_a?(GRPC::Core::ChannelCredentials)
+                chan_creds = credentials
+              end
+              if credentials.is_a?(Proc)
+                updater_proc = credentials
+              end
+              if credentials.is_a?(Google::Auth::Credentials)
+                updater_proc = credentials.updater_proc
+              end
+
+              package_version = Gem.loaded_specs['google-ads-googleads'].version.version
+
+              google_api_client = "gl-ruby/#{RUBY_VERSION}"
+              google_api_client << " #{lib_name}/#{lib_version}" if lib_name
+              google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
+              google_api_client << " grpc/#{GRPC::VERSION}"
+              google_api_client.freeze
+
+              headers = { :"x-goog-api-client" => google_api_client }
+              headers.merge!(metadata) unless metadata.nil?
+              client_config_file = Pathname.new(__dir__).join(
+                "campaign_bid_modifier_service_client_config.json"
+              )
+              defaults = client_config_file.open do |f|
+                Google::Gax.construct_settings(
+                  "google.ads.googleads.v0.services.CampaignBidModifierService",
+                  JSON.parse(f.read),
+                  client_config,
+                  Google::Gax::Grpc::STATUS_CODE_NAMES,
+                  timeout,
+                  errors: Google::Gax::Grpc::API_ERRORS,
+                  metadata: headers
+                )
+              end
+
+              # Allow overriding the service path/port in subclasses.
+              service_path = self.class::SERVICE_ADDRESS
+              port = self.class::DEFAULT_SERVICE_PORT
+              interceptors = self.class::GRPC_INTERCEPTORS
+              @campaign_bid_modifier_service_stub = Google::Gax::Grpc.create_stub(
+                service_path,
+                port,
+                chan_creds: chan_creds,
+                channel: channel,
+                updater_proc: updater_proc,
+                scopes: scopes,
+                interceptors: interceptors,
+                &Google::Ads::Googleads::V0::Services::CampaignBidModifierService::Stub.method(:new)
+              )
+
+              @get_campaign_bid_modifier = Google::Gax.create_api_call(
+                @campaign_bid_modifier_service_stub.method(:get_campaign_bid_modifier),
+                defaults["get_campaign_bid_modifier"],
+                exception_transformer: exception_transformer
+              )
+              @mutate_campaign_bid_modifiers = Google::Gax.create_api_call(
+                @campaign_bid_modifier_service_stub.method(:mutate_campaign_bid_modifiers),
+                defaults["mutate_campaign_bid_modifiers"],
+                exception_transformer: exception_transformer
+              )
+            end
+
+            # Service calls
+
+            # Returns the requested campaign bid modifier in full detail.
+            #
+            # @param resource_name [String]
+            #   The resource name of the campaign bid modifier to fetch.
+            # @param options [Google::Gax::CallOptions]
+            #   Overrides the default settings for this call, e.g, timeout,
+            #   retries, etc.
+            # @yield [result, operation] Access the result along with the RPC operation
+            # @yieldparam result [Google::Ads::Googleads::V0::Resources::CampaignBidModifier]
+            # @yieldparam operation [GRPC::ActiveCall::Operation]
+            # @return [Google::Ads::Googleads::V0::Resources::CampaignBidModifier]
+            # @raise [Google::Gax::GaxError] if the RPC is aborted.
+            # @example
+            #   require "google/ads/googleads"
+            #
+            #   campaign_bid_modifier_service_client = Google::Ads::Googleads::CampaignBidModifier.new(version: :v0)
+            #   formatted_resource_name = Google::Ads::Googleads::V0::Services::CampaignBidModifierServiceClient.campaign_bid_modifier_path("[CUSTOMER]", "[CAMPAIGN_BID_MODIFIER]")
+            #   response = campaign_bid_modifier_service_client.get_campaign_bid_modifier(formatted_resource_name)
+
+            def get_campaign_bid_modifier \
+                resource_name,
+                options: nil,
+                &block
+              req = {
+                resource_name: resource_name
+              }.delete_if { |_, v| v.nil? }
+              req = Google::Gax::to_proto(req, Google::Ads::Googleads::V0::Services::GetCampaignBidModifierRequest)
+              @get_campaign_bid_modifier.call(req, options, &block)
+            end
+
+            # Creates, updates, or removes campaign bid modifiers.
+            # Operation statuses are returned.
+            #
+            # @param customer_id [String]
+            #   ID of the customer whose campaign bid modifiers are being modified.
+            # @param operations [Array<Google::Ads::Googleads::V0::Services::CampaignBidModifierOperation | Hash>]
+            #   The list of operations to perform on individual campaign bid modifiers.
+            #   A hash of the same form as `Google::Ads::Googleads::V0::Services::CampaignBidModifierOperation`
+            #   can also be provided.
+            # @param options [Google::Gax::CallOptions]
+            #   Overrides the default settings for this call, e.g, timeout,
+            #   retries, etc.
+            # @yield [result, operation] Access the result along with the RPC operation
+            # @yieldparam result [Google::Ads::Googleads::V0::Services::MutateCampaignBidModifiersResponse]
+            # @yieldparam operation [GRPC::ActiveCall::Operation]
+            # @return [Google::Ads::Googleads::V0::Services::MutateCampaignBidModifiersResponse]
+            # @raise [Google::Gax::GaxError] if the RPC is aborted.
+            # @example
+            #   require "google/ads/googleads"
+            #
+            #   campaign_bid_modifier_service_client = Google::Ads::Googleads::CampaignBidModifier.new(version: :v0)
+            #
+            #   # TODO: Initialize +customer_id+:
+            #   customer_id = ''
+            #
+            #   # TODO: Initialize +operations+:
+            #   operations = []
+            #   response = campaign_bid_modifier_service_client.mutate_campaign_bid_modifiers(customer_id, operations)
+
+            def mutate_campaign_bid_modifiers \
+                customer_id,
+                operations,
+                options: nil,
+                &block
+              req = {
+                customer_id: customer_id,
+                operations: operations
+              }.delete_if { |_, v| v.nil? }
+              req = Google::Gax::to_proto(req, Google::Ads::Googleads::V0::Services::MutateCampaignBidModifiersRequest)
+              @mutate_campaign_bid_modifiers.call(req, options, &block)
+            end
+          end
+        end
+      end
+    end
+  end
+end