class Google::Ads::GoogleAds::V8::Services::KeywordPlanService::Client

Client for the KeywordPlanService service.

Service to manage keyword plans.

Attributes

keyword_plan_service_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the KeywordPlanService Client class.

See {::Google::Ads::GoogleAds::V8::Services::KeywordPlanService::Client::Configuration} for a description of the configuration fields.

@example

# 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]

# File lib/google/ads/google_ads/v8/services/keyword_plan_service/client.rb, line 57
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
new() { |config| ... } click to toggle source

Create a new KeywordPlanService client object.

@example

# Create a client using the default configuration
client = ::Google::Ads::GoogleAds::V8::Services::KeywordPlanService::Client.new

# Create a client using 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]

# File lib/google/ads/google_ads/v8/services/keyword_plan_service/client.rb, line 108
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 endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @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

Public Instance Methods

configure() { |config| ... } click to toggle source

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]

# File lib/google/ads/google_ads/v8/services/keyword_plan_service/client.rb, line 87
def configure
  yield @config if block_given?
  @config
end
generate_forecast_curve(request, options = nil) { |response, operation| ... } click to toggle source

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.

# File lib/google/ads/google_ads/v8/services/keyword_plan_service/client.rb, line 363
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 timeout:      @config.timeout,
                         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
generate_forecast_metrics(request, options = nil) { |response, operation| ... } click to toggle source

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.

# File lib/google/ads/google_ads/v8/services/keyword_plan_service/client.rb, line 527
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 timeout:      @config.timeout,
                         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
generate_forecast_time_series(request, options = nil) { |response, operation| ... } click to toggle source

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.

# File lib/google/ads/google_ads/v8/services/keyword_plan_service/client.rb, line 448
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 timeout:      @config.timeout,
                         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
generate_historical_metrics(request, options = nil) { |response, operation| ... } click to toggle source

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.

# File lib/google/ads/google_ads/v8/services/keyword_plan_service/client.rb, line 611
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 timeout:      @config.timeout,
                         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
get_keyword_plan(request, options = nil) { |response, operation| ... } click to toggle source

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.

# File lib/google/ads/google_ads/v8/services/keyword_plan_service/client.rb, line 183
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 timeout:      @config.timeout,
                         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
mutate_keyword_plans(request, options = nil) { |response, operation| ... } click to toggle source

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.

# File lib/google/ads/google_ads/v8/services/keyword_plan_service/client.rb, line 279
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 timeout:      @config.timeout,
                         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