google-ads-googleads 1.1.1 → 2.0.0

data/lib/google/ads/google_ads/v0/services/keyword_plan_service_services_pb.rb

@@ -1,47 +0,0 @@
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# Source: google/ads/google_ads/v0/services/keyword_plan_service.proto for package 'Google::Ads::GoogleAds::V0::Services'
-# Original file comments:
-# 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
-#
-#     http://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.
-#
-#
-
-require 'grpc'
-require 'google/ads/google_ads/v0/services/keyword_plan_service_pb'
-
-module Google::Ads::GoogleAds::V0::Services
-  module KeywordPlanService
-    # Service to manage keyword plans.
-    class Service
-
-      include GRPC::GenericService
-
-      self.marshal_class_method = :encode
-      self.unmarshal_class_method = :decode
-      self.service_name = 'google.ads.googleads.v0.services.KeywordPlanService'
-
-      # Returns the requested plan in full detail.
-      rpc :GetKeywordPlan, GetKeywordPlanRequest, Google::Ads::GoogleAds::V0::Resources::KeywordPlan
-      # Creates, updates, or removes keyword plans. Operation statuses are
-      # returned.
-      rpc :MutateKeywordPlans, MutateKeywordPlansRequest, MutateKeywordPlansResponse
-      # Returns the requested Keyword Plan forecasts.
-      rpc :GenerateForecastMetrics, GenerateForecastMetricsRequest, GenerateForecastMetricsResponse
-      # Returns the requested Keyword Plan historical metrics.
-      rpc :GenerateHistoricalMetrics, GenerateHistoricalMetricsRequest, GenerateHistoricalMetricsResponse
-    end
-
-    Stub = Service.rpc_stub_class
-  end
-end

data/lib/google/ads/google_ads/v0/services/keyword_view_service_client.rb

@@ -1,221 +0,0 @@
-# Copyright 2019 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/google_ads/v0/services/keyword_view_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/google_ads/v0/services/keyword_view_service_pb"
-require "google/ads/google_ads/v0/services/credentials"
-
-module Google
-  module Ads
-    module GoogleAds
-      module V0
-        module Services
-          # Service to manage keyword views.
-          #
-          # @!attribute [r] keyword_view_service_stub
-          #   @return [Google::Ads::GoogleAds::V0::Services::KeywordViewService::Stub]
-          class KeywordViewServiceClient
-            attr_reader :keyword_view_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
-
-
-            KEYWORD_VIEW_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
-              "customers/{customer}/keywordViews/{keyword_view}"
-            )
-
-            private_constant :KEYWORD_VIEW_PATH_TEMPLATE
-
-            # Returns a fully-qualified keyword_view resource name string.
-            # @param customer [String]
-            # @param keyword_view [String]
-            # @return [String]
-            def self.keyword_view_path customer, keyword_view
-              KEYWORD_VIEW_PATH_TEMPLATE.render(
-                :"customer" => customer,
-                :"keyword_view" => keyword_view
-              )
-            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/google_ads/v0/services/keyword_view_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(
-                "keyword_view_service_client_config.json"
-              )
-              defaults = client_config_file.open do |f|
-                Google::Gax.construct_settings(
-                  "google.ads.googleads.v0.services.KeywordViewService",
-                  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
-              @keyword_view_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::KeywordViewService::Stub.method(:new)
-              )
-
-              @get_keyword_view = Google::Gax.create_api_call(
-                @keyword_view_service_stub.method(:get_keyword_view),
-                defaults["get_keyword_view"],
-                exception_transformer: exception_transformer
-              )
-            end
-
-            # Service calls
-
-            # Returns the requested keyword view in full detail.
-            #
-            # @param resource_name [String]
-            #   The resource name of the keyword view 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::KeywordView]
-            # @yieldparam operation [GRPC::ActiveCall::Operation]
-            # @return [Google::Ads::GoogleAds::V0::Resources::KeywordView]
-            # @raise [Google::Gax::GaxError] if the RPC is aborted.
-            # @example
-            #   require "google/ads/google_ads"
-            #
-            #   keyword_view_service_client = Google::Ads::GoogleAds::KeywordView.new(version: :v0)
-            #   formatted_resource_name = Google::Ads::GoogleAds::V0::Services::KeywordViewServiceClient.keyword_view_path("[CUSTOMER]", "[KEYWORD_VIEW]")
-            #   response = keyword_view_service_client.get_keyword_view(formatted_resource_name)
-
-            def get_keyword_view \
-                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::GetKeywordViewRequest)
-              @get_keyword_view.call(req, options, &block)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/google/ads/google_ads/v0/services/keyword_view_service_client_config.json

@@ -1,31 +0,0 @@
-{
-  "interfaces": {
-    "google.ads.googleads.v0.services.KeywordViewService": {
-      "retry_codes": {
-        "idempotent": [
-          "DEADLINE_EXCEEDED",
-          "UNAVAILABLE"
-        ],
-        "non_idempotent": []
-      },
-      "retry_params": {
-        "default": {
-          "initial_retry_delay_millis": 100,
-          "retry_delay_multiplier": 1.3,
-          "max_retry_delay_millis": 60000,
-          "initial_rpc_timeout_millis": 20000,
-          "rpc_timeout_multiplier": 1.0,
-          "max_rpc_timeout_millis": 20000,
-          "total_timeout_millis": 600000
-        }
-      },
-      "methods": {
-        "GetKeywordView": {
-          "timeout_millis": 60000,
-          "retry_codes_name": "idempotent",
-          "retry_params_name": "default"
-        }
-      }
-    }
-  }
-}

data/lib/google/ads/google_ads/v0/services/keyword_view_service_pb.rb

@@ -1,16 +0,0 @@
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: google/ads/google_ads/v0/services/keyword_view_service.proto
-
-require 'google/protobuf'
-
-require 'google/ads/google_ads/v0/resources/keyword_view_pb'
-require 'google/api/annotations_pb'
-Google::Protobuf::DescriptorPool.generated_pool.build do
-  add_message "google.ads.googleads.v0.services.GetKeywordViewRequest" do
-    optional :resource_name, :string, 1
-  end
-end
-
-module Google::Ads::GoogleAds::V0::Services
-  GetKeywordViewRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v0.services.GetKeywordViewRequest").msgclass
-end

data/lib/google/ads/google_ads/v0/services/keyword_view_service_services_pb.rb

@@ -1,40 +0,0 @@
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# Source: google/ads/google_ads/v0/services/keyword_view_service.proto for package 'Google::Ads::GoogleAds::V0::Services'
-# Original file comments:
-# 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
-#
-#     http://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.
-#
-#
-
-require 'grpc'
-require 'google/ads/google_ads/v0/services/keyword_view_service_pb'
-
-module Google::Ads::GoogleAds::V0::Services
-  module KeywordViewService
-    # Service to manage keyword views.
-    class Service
-
-      include GRPC::GenericService
-
-      self.marshal_class_method = :encode
-      self.unmarshal_class_method = :decode
-      self.service_name = 'google.ads.googleads.v0.services.KeywordViewService'
-
-      # Returns the requested keyword view in full detail.
-      rpc :GetKeywordView, GetKeywordViewRequest, Google::Ads::GoogleAds::V0::Resources::KeywordView
-    end
-
-    Stub = Service.rpc_stub_class
-  end
-end

data/lib/google/ads/google_ads/v0/services/language_constant_service_client.rb

@@ -1,219 +0,0 @@
-# Copyright 2019 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/google_ads/v0/services/language_constant_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/google_ads/v0/services/language_constant_service_pb"
-require "google/ads/google_ads/v0/services/credentials"
-
-module Google
-  module Ads
-    module GoogleAds
-      module V0
-        module Services
-          # Service to fetch language constants.
-          #
-          # @!attribute [r] language_constant_service_stub
-          #   @return [Google::Ads::GoogleAds::V0::Services::LanguageConstantService::Stub]
-          class LanguageConstantServiceClient
-            attr_reader :language_constant_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
-
-
-            LANGUAGE_CONSTANT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
-              "languageConstants/{language_constant}"
-            )
-
-            private_constant :LANGUAGE_CONSTANT_PATH_TEMPLATE
-
-            # Returns a fully-qualified language_constant resource name string.
-            # @param language_constant [String]
-            # @return [String]
-            def self.language_constant_path language_constant
-              LANGUAGE_CONSTANT_PATH_TEMPLATE.render(
-                :"language_constant" => language_constant
-              )
-            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/google_ads/v0/services/language_constant_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(
-                "language_constant_service_client_config.json"
-              )
-              defaults = client_config_file.open do |f|
-                Google::Gax.construct_settings(
-                  "google.ads.googleads.v0.services.LanguageConstantService",
-                  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
-              @language_constant_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::LanguageConstantService::Stub.method(:new)
-              )
-
-              @get_language_constant = Google::Gax.create_api_call(
-                @language_constant_service_stub.method(:get_language_constant),
-                defaults["get_language_constant"],
-                exception_transformer: exception_transformer
-              )
-            end
-
-            # Service calls
-
-            # Returns the requested language constant.
-            #
-            # @param resource_name [String]
-            #   Resource name of the language constant 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::LanguageConstant]
-            # @yieldparam operation [GRPC::ActiveCall::Operation]
-            # @return [Google::Ads::GoogleAds::V0::Resources::LanguageConstant]
-            # @raise [Google::Gax::GaxError] if the RPC is aborted.
-            # @example
-            #   require "google/ads/google_ads"
-            #
-            #   language_constant_service_client = Google::Ads::GoogleAds::LanguageConstant.new(version: :v0)
-            #   formatted_resource_name = Google::Ads::GoogleAds::V0::Services::LanguageConstantServiceClient.language_constant_path("[LANGUAGE_CONSTANT]")
-            #   response = language_constant_service_client.get_language_constant(formatted_resource_name)
-
-            def get_language_constant \
-                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::GetLanguageConstantRequest)
-              @get_language_constant.call(req, options, &block)
-            end
-          end
-        end
-      end
-    end
-  end
-end