google-ads-googleads 11.0.0 → 12.0.1

data/lib/google/ads/google_ads/v8/services/keyword_plan_idea_service/credentials.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "googleauth"
+
+module Google
+  module Ads
+    module GoogleAds
+      module V8
+        module Services
+          module KeywordPlanIdeaService
+            # Credentials for the KeywordPlanIdeaService API.
+            class Credentials < ::Google::Auth::Credentials
+              self.scope = [
+                "https://www.googleapis.com/auth/adwords"
+              ]
+              self.env_vars = [
+                "GOOGLEADS_CREDENTIALS",
+                "GOOGLEADS_KEYFILE",
+                "GOOGLEADS_CREDENTIALS_JSON",
+                "GOOGLEADS_KEYFILE_JSON"
+              ]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/ads/google_ads/v8/services/keyword_plan_idea_service_pb.rb

@@ -0,0 +1,74 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/ads/googleads/v8/services/keyword_plan_idea_service.proto
+
+require 'google/protobuf'
+
+require 'google/ads/google_ads/v8/common/keyword_plan_common_pb'
+require 'google/ads/google_ads/v8/enums/keyword_plan_keyword_annotation_pb'
+require 'google/ads/google_ads/v8/enums/keyword_plan_network_pb'
+require 'google/api/annotations_pb'
+require 'google/api/client_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/ads/googleads/v8/services/keyword_plan_idea_service.proto", :syntax => :proto3) do
+    add_message "google.ads.googleads.v8.services.GenerateKeywordIdeasRequest" do
+      optional :customer_id, :string, 1
+      proto3_optional :language, :string, 14
+      repeated :geo_target_constants, :string, 15
+      optional :include_adult_keywords, :bool, 10
+      optional :page_token, :string, 12
+      optional :page_size, :int32, 13
+      optional :keyword_plan_network, :enum, 9, "google.ads.googleads.v8.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork"
+      repeated :keyword_annotation, :enum, 17, "google.ads.googleads.v8.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation"
+      optional :aggregate_metrics, :message, 16, "google.ads.googleads.v8.common.KeywordPlanAggregateMetrics"
+      optional :historical_metrics_options, :message, 18, "google.ads.googleads.v8.common.HistoricalMetricsOptions"
+      oneof :seed do
+        optional :keyword_and_url_seed, :message, 2, "google.ads.googleads.v8.services.KeywordAndUrlSeed"
+        optional :keyword_seed, :message, 3, "google.ads.googleads.v8.services.KeywordSeed"
+        optional :url_seed, :message, 5, "google.ads.googleads.v8.services.UrlSeed"
+        optional :site_seed, :message, 11, "google.ads.googleads.v8.services.SiteSeed"
+      end
+    end
+    add_message "google.ads.googleads.v8.services.KeywordAndUrlSeed" do
+      proto3_optional :url, :string, 3
+      repeated :keywords, :string, 4
+    end
+    add_message "google.ads.googleads.v8.services.KeywordSeed" do
+      repeated :keywords, :string, 2
+    end
+    add_message "google.ads.googleads.v8.services.SiteSeed" do
+      proto3_optional :site, :string, 2
+    end
+    add_message "google.ads.googleads.v8.services.UrlSeed" do
+      proto3_optional :url, :string, 2
+    end
+    add_message "google.ads.googleads.v8.services.GenerateKeywordIdeaResponse" do
+      repeated :results, :message, 1, "google.ads.googleads.v8.services.GenerateKeywordIdeaResult"
+      optional :aggregate_metric_results, :message, 4, "google.ads.googleads.v8.common.KeywordPlanAggregateMetricResults"
+      optional :next_page_token, :string, 2
+      optional :total_size, :int64, 3
+    end
+    add_message "google.ads.googleads.v8.services.GenerateKeywordIdeaResult" do
+      proto3_optional :text, :string, 5
+      optional :keyword_idea_metrics, :message, 3, "google.ads.googleads.v8.common.KeywordPlanHistoricalMetrics"
+      optional :keyword_annotations, :message, 6, "google.ads.googleads.v8.common.KeywordAnnotations"
+    end
+  end
+end
+
+module Google
+  module Ads
+    module GoogleAds
+      module V8
+        module Services
+          GenerateKeywordIdeasRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v8.services.GenerateKeywordIdeasRequest").msgclass
+          KeywordAndUrlSeed = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v8.services.KeywordAndUrlSeed").msgclass
+          KeywordSeed = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v8.services.KeywordSeed").msgclass
+          SiteSeed = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v8.services.SiteSeed").msgclass
+          UrlSeed = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v8.services.UrlSeed").msgclass
+          GenerateKeywordIdeaResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v8.services.GenerateKeywordIdeaResponse").msgclass
+          GenerateKeywordIdeaResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v8.services.GenerateKeywordIdeaResult").msgclass
+        end
+      end
+    end
+  end
+end

data/lib/google/ads/google_ads/v8/services/keyword_plan_idea_service_services_pb.rb

@@ -0,0 +1,59 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/ads/googleads/v8/services/keyword_plan_idea_service.proto for package 'Google.Ads.GoogleAds.V8.Services'
+# Original file comments:
+# Copyright 2021 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/v8/services/keyword_plan_idea_service_pb'
+
+module Google
+  module Ads
+    module GoogleAds
+      module V8
+        module Services
+          module KeywordPlanIdeaService
+            # Proto file describing the keyword plan idea service.
+            #
+            # Service to generate keyword ideas.
+            class Service
+
+              include GRPC::GenericService
+
+              self.marshal_class_method = :encode
+              self.unmarshal_class_method = :decode
+              self.service_name = 'google.ads.googleads.v8.services.KeywordPlanIdeaService'
+
+              # Returns a list of keyword ideas.
+              #
+              # List of thrown errors:
+              #   [AuthenticationError]()
+              #   [AuthorizationError]()
+              #   [CollectionSizeError]()
+              #   [HeaderError]()
+              #   [InternalError]()
+              #   [KeywordPlanIdeaError]()
+              #   [QuotaError]()
+              #   [RequestError]()
+              rpc :GenerateKeywordIdeas, ::Google::Ads::GoogleAds::V8::Services::GenerateKeywordIdeasRequest, ::Google::Ads::GoogleAds::V8::Services::GenerateKeywordIdeaResponse
+            end
+
+            Stub = Service.rpc_stub_class
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/ads/google_ads/v8/services/keyword_plan_service.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/ads/google_ads/version"
+
+require "google/ads/google_ads/v8/services/keyword_plan_service/credentials"
+require "google/ads/google_ads/v8/services/keyword_plan_service/paths"
+require "google/ads/google_ads/v8/services/keyword_plan_service/client"
+
+module Google
+  module Ads
+    module GoogleAds
+      module V8
+        module Services
+          ##
+          # Service to manage keyword plans.
+          #
+          # To load this service and instantiate a client:
+          #
+          #     require "google/ads/google_ads/v8/services/keyword_plan_service"
+          #     client = ::Google::Ads::GoogleAds::V8::Services::KeywordPlanService::Client.new
+          #
+          module KeywordPlanService
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "keyword_plan_service", "helpers.rb"
+require "google/ads/google_ads/v8/services/keyword_plan_service/helpers" if ::File.file? helper_path

data/lib/google/ads/google_ads/v8/services/keyword_plan_service/client.rb

@@ -0,0 +1,842 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+# require "google/ads/google_ads/error"
+require "google/ads/google_ads/v8/services/keyword_plan_service_pb"
+
+module Google
+  module Ads
+    module GoogleAds
+      module V8
+        module Services
+          module KeywordPlanService
+            ##
+            # Client for the KeywordPlanService service.
+            #
+            # Service to manage keyword plans.
+            #
+            class Client
+              include Paths
+
+              # @private
+              attr_reader :keyword_plan_service_stub
+
+              ##
+              # Configure the KeywordPlanService Client class.
+              #
+              # See {::Google::Ads::GoogleAds::V8::Services::KeywordPlanService::Client::Configuration}
+              # for a description of the configuration fields.
+              #
+              # ## Example
+              #
+              # To modify the configuration for all KeywordPlanService clients:
+              #
+              #     ::Google::Ads::GoogleAds::V8::Services::KeywordPlanService::Client.configure do |config|
+              #       config.timeout = 10.0
+              #     end
+              #
+              # @yield [config] Configure the Client client.
+              # @yieldparam config [Client::Configuration]
+              #
+              # @return [Client::Configuration]
+              #
+              def self.configure
+                @configure ||= begin
+                  default_config = Client::Configuration.new
+
+                  default_config.timeout = 3600.0
+                  default_config.retry_policy = {
+                    initial_delay: 5.0,
+                    max_delay: 60.0,
+                    multiplier: 1.3,
+                    retry_codes: [14, 4]
+                  }
+
+                  default_config
+                end
+                yield @configure if block_given?
+                @configure
+              end
+
+              ##
+              # Configure the KeywordPlanService Client instance.
+              #
+              # The configuration is set to the derived mode, meaning that values can be changed,
+              # but structural changes (adding new fields, etc.) are not allowed. Structural changes
+              # should be made on {Client.configure}.
+              #
+              # See {::Google::Ads::GoogleAds::V8::Services::KeywordPlanService::Client::Configuration}
+              # for a description of the configuration fields.
+              #
+              # @yield [config] Configure the Client client.
+              # @yieldparam config [Client::Configuration]
+              #
+              # @return [Client::Configuration]
+              #
+              def configure
+                yield @config if block_given?
+                @config
+              end
+
+              ##
+              # Create a new KeywordPlanService client object.
+              #
+              # ## Examples
+              #
+              # To create a new KeywordPlanService client with the default
+              # configuration:
+              #
+              #     client = ::Google::Ads::GoogleAds::V8::Services::KeywordPlanService::Client.new
+              #
+              # To create a new KeywordPlanService client with a custom
+              # configuration:
+              #
+              #     client = ::Google::Ads::GoogleAds::V8::Services::KeywordPlanService::Client.new do |config|
+              #       config.timeout = 10.0
+              #     end
+              #
+              # @yield [config] Configure the KeywordPlanService client.
+              # @yieldparam config [Client::Configuration]
+              #
+              def initialize
+                # 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 "gapic/grpc"
+                require "google/ads/google_ads/v8/services/keyword_plan_service_services_pb"
+
+                # Create the configuration object
+                @config = Configuration.new Client.configure
+
+                # Yield the configuration if needed
+                yield @config if block_given?
+
+                # Create credentials
+                credentials = @config.credentials
+                # Use self-signed JWT if the scope and endpoint are unchanged from default,
+                # but only if the default endpoint does not have a region prefix.
+                enable_self_signed_jwt = @config.scope == Client.configure.scope &&
+                                         @config.endpoint == Client.configure.endpoint &&
+                                         !@config.endpoint.split(".").first.include?("-")
+                credentials ||= Credentials.default scope: @config.scope,
+                                                    enable_self_signed_jwt: enable_self_signed_jwt
+                if credentials.is_a?(String) || credentials.is_a?(Hash)
+                  credentials = Credentials.new credentials, scope: @config.scope
+                end
+                @quota_project_id = @config.quota_project
+                @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
+
+                @keyword_plan_service_stub = ::Gapic::ServiceStub.new(
+                  ::Google::Ads::GoogleAds::V8::Services::KeywordPlanService::Stub,
+                  credentials:  credentials,
+                  endpoint:     @config.endpoint,
+                  channel_args: @config.channel_args,
+                  interceptors: @config.interceptors
+                )
+              end
+
+              # Service calls
+
+              ##
+              # Returns the requested plan in full detail.
+              #
+              # List of thrown errors:
+              #   [AuthenticationError]()
+              #   [AuthorizationError]()
+              #   [HeaderError]()
+              #   [InternalError]()
+              #   [QuotaError]()
+              #   [RequestError]()
+              #
+              # @overload get_keyword_plan(request, options = nil)
+              #   Pass arguments to `get_keyword_plan` via a request object, either of type
+              #   {::Google::Ads::GoogleAds::V8::Services::GetKeywordPlanRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Ads::GoogleAds::V8::Services::GetKeywordPlanRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+              #
+              # @overload get_keyword_plan(resource_name: nil)
+              #   Pass arguments to `get_keyword_plan` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param resource_name [::String]
+              #     Required. The resource name of the plan to fetch.
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Google::Ads::GoogleAds::V8::Resources::KeywordPlan]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Google::Ads::GoogleAds::V8::Resources::KeywordPlan]
+              #
+              # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.
+              #
+              def get_keyword_plan request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request,
+                                                   to: ::Google::Ads::GoogleAds::V8::Services::GetKeywordPlanRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                metadata = @config.rpcs.get_keyword_plan.metadata.to_h
+
+                # Set x-goog-api-client and x-goog-user-project headers
+                metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Ads::GoogleAds::VERSION
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                header_params = {
+                  "resource_name" => request.resource_name
+                }
+                request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+                metadata[:"x-goog-request-params"] ||= request_params_header
+
+                options.apply_defaults timeout:      @config.rpcs.get_keyword_plan.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.get_keyword_plan.retry_policy
+                options.apply_defaults metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @keyword_plan_service_stub.call_rpc :get_keyword_plan, request,
+                                                    options: options do |response, operation|
+                  yield response, operation if block_given?
+                  return response
+                end
+                # rescue GRPC::BadStatus => grpc_error
+                #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
+              end
+
+              ##
+              # Creates, updates, or removes keyword plans. Operation statuses are
+              # returned.
+              #
+              # List of thrown errors:
+              #   [AuthenticationError]()
+              #   [AuthorizationError]()
+              #   [DatabaseError]()
+              #   [FieldError]()
+              #   [HeaderError]()
+              #   [InternalError]()
+              #   [KeywordPlanError]()
+              #   [MutateError]()
+              #   [NewResourceCreationError]()
+              #   [QuotaError]()
+              #   [RequestError]()
+              #   [ResourceCountLimitExceededError]()
+              #   [StringLengthError]()
+              #
+              # @overload mutate_keyword_plans(request, options = nil)
+              #   Pass arguments to `mutate_keyword_plans` via a request object, either of type
+              #   {::Google::Ads::GoogleAds::V8::Services::MutateKeywordPlansRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Ads::GoogleAds::V8::Services::MutateKeywordPlansRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+              #
+              # @overload mutate_keyword_plans(customer_id: nil, operations: nil, partial_failure: nil, validate_only: nil)
+              #   Pass arguments to `mutate_keyword_plans` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param customer_id [::String]
+              #     Required. The ID of the customer whose keyword plans are being modified.
+              #   @param operations [::Array<::Google::Ads::GoogleAds::V8::Services::KeywordPlanOperation, ::Hash>]
+              #     Required. The list of operations to perform on individual keyword plans.
+              #   @param partial_failure [::Boolean]
+              #     If true, successful operations will be carried out and invalid
+              #     operations will return errors. If false, all operations will be carried
+              #     out in one transaction if and only if they are all valid.
+              #     Default is false.
+              #   @param validate_only [::Boolean]
+              #     If true, the request is validated but not executed. Only errors are
+              #     returned, not results.
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Google::Ads::GoogleAds::V8::Services::MutateKeywordPlansResponse]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Google::Ads::GoogleAds::V8::Services::MutateKeywordPlansResponse]
+              #
+              # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.
+              #
+              def mutate_keyword_plans request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request,
+                                                   to: ::Google::Ads::GoogleAds::V8::Services::MutateKeywordPlansRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                metadata = @config.rpcs.mutate_keyword_plans.metadata.to_h
+
+                # Set x-goog-api-client and x-goog-user-project headers
+                metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Ads::GoogleAds::VERSION
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                header_params = {
+                  "customer_id" => request.customer_id
+                }
+                request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+                metadata[:"x-goog-request-params"] ||= request_params_header
+
+                options.apply_defaults timeout:      @config.rpcs.mutate_keyword_plans.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.mutate_keyword_plans.retry_policy
+                options.apply_defaults metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @keyword_plan_service_stub.call_rpc :mutate_keyword_plans, request,
+                                                    options: options do |response, operation|
+                  yield response, operation if block_given?
+                  return response
+                end
+                # rescue GRPC::BadStatus => grpc_error
+                #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
+              end
+
+              ##
+              # Returns the requested Keyword Plan forecast curve.
+              # Only the bidding strategy is considered for generating forecast curve.
+              # The bidding strategy value specified in the plan is ignored.
+              #
+              # To generate a forecast at a value specified in the plan, use
+              # KeywordPlanService.GenerateForecastMetrics.
+              #
+              # List of thrown errors:
+              #   [AuthenticationError]()
+              #   [AuthorizationError]()
+              #   [HeaderError]()
+              #   [InternalError]()
+              #   [KeywordPlanError]()
+              #   [QuotaError]()
+              #   [RequestError]()
+              #
+              # @overload generate_forecast_curve(request, options = nil)
+              #   Pass arguments to `generate_forecast_curve` via a request object, either of type
+              #   {::Google::Ads::GoogleAds::V8::Services::GenerateForecastCurveRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Ads::GoogleAds::V8::Services::GenerateForecastCurveRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+              #
+              # @overload generate_forecast_curve(keyword_plan: nil)
+              #   Pass arguments to `generate_forecast_curve` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param keyword_plan [::String]
+              #     Required. The resource name of the keyword plan to be forecasted.
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Google::Ads::GoogleAds::V8::Services::GenerateForecastCurveResponse]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Google::Ads::GoogleAds::V8::Services::GenerateForecastCurveResponse]
+              #
+              # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.
+              #
+              def generate_forecast_curve request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request,
+                                                   to: ::Google::Ads::GoogleAds::V8::Services::GenerateForecastCurveRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                metadata = @config.rpcs.generate_forecast_curve.metadata.to_h
+
+                # Set x-goog-api-client and x-goog-user-project headers
+                metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Ads::GoogleAds::VERSION
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                header_params = {
+                  "keyword_plan" => request.keyword_plan
+                }
+                request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+                metadata[:"x-goog-request-params"] ||= request_params_header
+
+                options.apply_defaults timeout:      @config.rpcs.generate_forecast_curve.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.generate_forecast_curve.retry_policy
+                options.apply_defaults metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @keyword_plan_service_stub.call_rpc :generate_forecast_curve, request,
+                                                    options: options do |response, operation|
+                  yield response, operation if block_given?
+                  return response
+                end
+                # rescue GRPC::BadStatus => grpc_error
+                #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
+              end
+
+              ##
+              # Returns a forecast in the form of a time series for the Keyword Plan over
+              # the next 52 weeks.
+              # (1) Forecasts closer to the current date are generally more accurate than
+              # further out.
+              #
+              # (2) The forecast reflects seasonal trends using current and
+              # prior traffic patterns. The forecast period of the plan is ignored.
+              #
+              # List of thrown errors:
+              #   [AuthenticationError]()
+              #   [AuthorizationError]()
+              #   [HeaderError]()
+              #   [InternalError]()
+              #   [KeywordPlanError]()
+              #   [QuotaError]()
+              #   [RequestError]()
+              #
+              # @overload generate_forecast_time_series(request, options = nil)
+              #   Pass arguments to `generate_forecast_time_series` via a request object, either of type
+              #   {::Google::Ads::GoogleAds::V8::Services::GenerateForecastTimeSeriesRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Ads::GoogleAds::V8::Services::GenerateForecastTimeSeriesRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+              #
+              # @overload generate_forecast_time_series(keyword_plan: nil)
+              #   Pass arguments to `generate_forecast_time_series` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param keyword_plan [::String]
+              #     Required. The resource name of the keyword plan to be forecasted.
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Google::Ads::GoogleAds::V8::Services::GenerateForecastTimeSeriesResponse]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Google::Ads::GoogleAds::V8::Services::GenerateForecastTimeSeriesResponse]
+              #
+              # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.
+              #
+              def generate_forecast_time_series request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request,
+                                                   to: ::Google::Ads::GoogleAds::V8::Services::GenerateForecastTimeSeriesRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                metadata = @config.rpcs.generate_forecast_time_series.metadata.to_h
+
+                # Set x-goog-api-client and x-goog-user-project headers
+                metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Ads::GoogleAds::VERSION
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                header_params = {
+                  "keyword_plan" => request.keyword_plan
+                }
+                request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+                metadata[:"x-goog-request-params"] ||= request_params_header
+
+                options.apply_defaults timeout:      @config.rpcs.generate_forecast_time_series.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.generate_forecast_time_series.retry_policy
+                options.apply_defaults metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @keyword_plan_service_stub.call_rpc :generate_forecast_time_series, request,
+                                                    options: options do |response, operation|
+                  yield response, operation if block_given?
+                  return response
+                end
+                # rescue GRPC::BadStatus => grpc_error
+                #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
+              end
+
+              ##
+              # Returns the requested Keyword Plan forecasts.
+              #
+              # List of thrown errors:
+              #   [AuthenticationError]()
+              #   [AuthorizationError]()
+              #   [HeaderError]()
+              #   [InternalError]()
+              #   [KeywordPlanError]()
+              #   [QuotaError]()
+              #   [RequestError]()
+              #
+              # @overload generate_forecast_metrics(request, options = nil)
+              #   Pass arguments to `generate_forecast_metrics` via a request object, either of type
+              #   {::Google::Ads::GoogleAds::V8::Services::GenerateForecastMetricsRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Ads::GoogleAds::V8::Services::GenerateForecastMetricsRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+              #
+              # @overload generate_forecast_metrics(keyword_plan: nil)
+              #   Pass arguments to `generate_forecast_metrics` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param keyword_plan [::String]
+              #     Required. The resource name of the keyword plan to be forecasted.
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Google::Ads::GoogleAds::V8::Services::GenerateForecastMetricsResponse]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Google::Ads::GoogleAds::V8::Services::GenerateForecastMetricsResponse]
+              #
+              # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.
+              #
+              def generate_forecast_metrics request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request,
+                                                   to: ::Google::Ads::GoogleAds::V8::Services::GenerateForecastMetricsRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                metadata = @config.rpcs.generate_forecast_metrics.metadata.to_h
+
+                # Set x-goog-api-client and x-goog-user-project headers
+                metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Ads::GoogleAds::VERSION
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                header_params = {
+                  "keyword_plan" => request.keyword_plan
+                }
+                request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+                metadata[:"x-goog-request-params"] ||= request_params_header
+
+                options.apply_defaults timeout:      @config.rpcs.generate_forecast_metrics.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.generate_forecast_metrics.retry_policy
+                options.apply_defaults metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @keyword_plan_service_stub.call_rpc :generate_forecast_metrics, request,
+                                                    options: options do |response, operation|
+                  yield response, operation if block_given?
+                  return response
+                end
+                # rescue GRPC::BadStatus => grpc_error
+                #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
+              end
+
+              ##
+              # Returns the requested Keyword Plan historical metrics.
+              #
+              # List of thrown errors:
+              #   [AuthenticationError]()
+              #   [AuthorizationError]()
+              #   [HeaderError]()
+              #   [InternalError]()
+              #   [KeywordPlanError]()
+              #   [QuotaError]()
+              #   [RequestError]()
+              #
+              # @overload generate_historical_metrics(request, options = nil)
+              #   Pass arguments to `generate_historical_metrics` via a request object, either of type
+              #   {::Google::Ads::GoogleAds::V8::Services::GenerateHistoricalMetricsRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Ads::GoogleAds::V8::Services::GenerateHistoricalMetricsRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+              #
+              # @overload generate_historical_metrics(keyword_plan: nil, aggregate_metrics: nil, historical_metrics_options: nil)
+              #   Pass arguments to `generate_historical_metrics` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param keyword_plan [::String]
+              #     Required. The resource name of the keyword plan of which historical metrics are
+              #     requested.
+              #   @param aggregate_metrics [::Google::Ads::GoogleAds::V8::Common::KeywordPlanAggregateMetrics, ::Hash]
+              #     The aggregate fields to include in response.
+              #   @param historical_metrics_options [::Google::Ads::GoogleAds::V8::Common::HistoricalMetricsOptions, ::Hash]
+              #     The options for historical metrics data.
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Google::Ads::GoogleAds::V8::Services::GenerateHistoricalMetricsResponse]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Google::Ads::GoogleAds::V8::Services::GenerateHistoricalMetricsResponse]
+              #
+              # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.
+              #
+              def generate_historical_metrics request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request,
+                                                   to: ::Google::Ads::GoogleAds::V8::Services::GenerateHistoricalMetricsRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                metadata = @config.rpcs.generate_historical_metrics.metadata.to_h
+
+                # Set x-goog-api-client and x-goog-user-project headers
+                metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Ads::GoogleAds::VERSION
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                header_params = {
+                  "keyword_plan" => request.keyword_plan
+                }
+                request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+                metadata[:"x-goog-request-params"] ||= request_params_header
+
+                options.apply_defaults timeout:      @config.rpcs.generate_historical_metrics.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.generate_historical_metrics.retry_policy
+                options.apply_defaults metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @keyword_plan_service_stub.call_rpc :generate_historical_metrics, request,
+                                                    options: options do |response, operation|
+                  yield response, operation if block_given?
+                  return response
+                end
+                # rescue GRPC::BadStatus => grpc_error
+                #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
+              end
+
+              ##
+              # Configuration class for the KeywordPlanService API.
+              #
+              # This class represents the configuration for KeywordPlanService,
+              # providing control over timeouts, retry behavior, logging, transport
+              # parameters, and other low-level controls. Certain parameters can also be
+              # applied individually to specific RPCs. See
+              # {::Google::Ads::GoogleAds::V8::Services::KeywordPlanService::Client::Configuration::Rpcs}
+              # for a list of RPCs that can be configured independently.
+              #
+              # Configuration can be applied globally to all clients, or to a single client
+              # on construction.
+              #
+              # # Examples
+              #
+              # To modify the global config, setting the timeout for get_keyword_plan
+              # to 20 seconds, and all remaining timeouts to 10 seconds:
+              #
+              #     ::Google::Ads::GoogleAds::V8::Services::KeywordPlanService::Client.configure do |config|
+              #       config.timeout = 10.0
+              #       config.rpcs.get_keyword_plan.timeout = 20.0
+              #     end
+              #
+              # To apply the above configuration only to a new client:
+              #
+              #     client = ::Google::Ads::GoogleAds::V8::Services::KeywordPlanService::Client.new do |config|
+              #       config.timeout = 10.0
+              #       config.rpcs.get_keyword_plan.timeout = 20.0
+              #     end
+              #
+              # @!attribute [rw] endpoint
+              #   The hostname or hostname:port of the service endpoint.
+              #   Defaults to `"googleads.googleapis.com"`.
+              #   @return [::String]
+              # @!attribute [rw] credentials
+              #   Credentials to send with calls. You may provide any of the following types:
+              #    *  (`String`) The path to a service account key file in JSON format
+              #    *  (`Hash`) A service account key as a Hash
+              #    *  (`Google::Auth::Credentials`) A googleauth credentials object
+              #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+              #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
+              #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+              #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
+              #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
+              #    *  (`nil`) indicating no credentials
+              #   @return [::Object]
+              # @!attribute [rw] scope
+              #   The OAuth scopes
+              #   @return [::Array<::String>]
+              # @!attribute [rw] lib_name
+              #   The library name as recorded in instrumentation and logging
+              #   @return [::String]
+              # @!attribute [rw] lib_version
+              #   The library version as recorded in instrumentation and logging
+              #   @return [::String]
+              # @!attribute [rw] channel_args
+              #   Extra parameters passed to the gRPC channel. Note: this is ignored if a
+              #   `GRPC::Core::Channel` object is provided as the credential.
+              #   @return [::Hash]
+              # @!attribute [rw] interceptors
+              #   An array of interceptors that are run before calls are executed.
+              #   @return [::Array<::GRPC::ClientInterceptor>]
+              # @!attribute [rw] timeout
+              #   The call timeout in seconds.
+              #   @return [::Numeric]
+              # @!attribute [rw] metadata
+              #   Additional gRPC headers to be sent with the call.
+              #   @return [::Hash{::Symbol=>::String}]
+              # @!attribute [rw] retry_policy
+              #   The retry policy. The value is a hash with the following keys:
+              #    *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+              #    *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+              #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+              #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+              #       trigger a retry.
+              #   @return [::Hash]
+              # @!attribute [rw] quota_project
+              #   A separate project against which to charge quota.
+              #   @return [::String]
+              #
+              class Configuration
+                extend ::Gapic::Config
+
+                config_attr :endpoint,      "googleads.googleapis.com", ::String
+                config_attr :credentials,   nil do |value|
+                  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client,
+                             nil]
+                  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
+                  allowed.any? { |klass| klass === value }
+                end
+                config_attr :scope,         nil, ::String, ::Array, nil
+                config_attr :lib_name,      nil, ::String, nil
+                config_attr :lib_version,   nil, ::String, nil
+                config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
+                config_attr :interceptors,  nil, ::Array, nil
+                config_attr :timeout,       nil, ::Numeric, nil
+                config_attr :metadata,      nil, ::Hash, nil
+                config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
+                config_attr :quota_project, nil, ::String, nil
+
+                # @private
+                def initialize parent_config = nil
+                  @parent_config = parent_config unless parent_config.nil?
+
+                  yield self if block_given?
+                end
+
+                ##
+                # Configurations for individual RPCs
+                # @return [Rpcs]
+                #
+                def rpcs
+                  @rpcs ||= begin
+                    parent_rpcs = nil
+                    parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
+                    Rpcs.new parent_rpcs
+                  end
+                end
+
+                ##
+                # Configuration RPC class for the KeywordPlanService API.
+                #
+                # Includes fields providing the configuration for each RPC in this service.
+                # Each configuration object is of type `Gapic::Config::Method` and includes
+                # the following configuration fields:
+                #
+                #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
+                #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
+                #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
+                #     include the following keys:
+                #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+                #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+                #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+                #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+                #         trigger a retry.
+                #
+                class Rpcs
+                  ##
+                  # RPC-specific configuration for `get_keyword_plan`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :get_keyword_plan
+                  ##
+                  # RPC-specific configuration for `mutate_keyword_plans`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :mutate_keyword_plans
+                  ##
+                  # RPC-specific configuration for `generate_forecast_curve`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :generate_forecast_curve
+                  ##
+                  # RPC-specific configuration for `generate_forecast_time_series`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :generate_forecast_time_series
+                  ##
+                  # RPC-specific configuration for `generate_forecast_metrics`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :generate_forecast_metrics
+                  ##
+                  # RPC-specific configuration for `generate_historical_metrics`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :generate_historical_metrics
+
+                  # @private
+                  def initialize parent_rpcs = nil
+                    get_keyword_plan_config = parent_rpcs.get_keyword_plan if parent_rpcs.respond_to? :get_keyword_plan
+                    @get_keyword_plan = ::Gapic::Config::Method.new get_keyword_plan_config
+                    mutate_keyword_plans_config = parent_rpcs.mutate_keyword_plans if parent_rpcs.respond_to? :mutate_keyword_plans
+                    @mutate_keyword_plans = ::Gapic::Config::Method.new mutate_keyword_plans_config
+                    generate_forecast_curve_config = parent_rpcs.generate_forecast_curve if parent_rpcs.respond_to? :generate_forecast_curve
+                    @generate_forecast_curve = ::Gapic::Config::Method.new generate_forecast_curve_config
+                    generate_forecast_time_series_config = parent_rpcs.generate_forecast_time_series if parent_rpcs.respond_to? :generate_forecast_time_series
+                    @generate_forecast_time_series = ::Gapic::Config::Method.new generate_forecast_time_series_config
+                    generate_forecast_metrics_config = parent_rpcs.generate_forecast_metrics if parent_rpcs.respond_to? :generate_forecast_metrics
+                    @generate_forecast_metrics = ::Gapic::Config::Method.new generate_forecast_metrics_config
+                    generate_historical_metrics_config = parent_rpcs.generate_historical_metrics if parent_rpcs.respond_to? :generate_historical_metrics
+                    @generate_historical_metrics = ::Gapic::Config::Method.new generate_historical_metrics_config
+
+                    yield self if block_given?
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end