Class: Google::Ads::GoogleAds::V13::Services::KeywordPlanService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/ads/google_ads/v13/services/keyword_plan_service/client.rb

Overview

Client for the KeywordPlanService service.

Service to manage keyword plans.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#keyword_plan_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new KeywordPlanService client object.

Examples:


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

# Create a client using a custom configuration
client = ::Google::Ads::GoogleAds::V13::Services::KeywordPlanService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the KeywordPlanService client.

Yield Parameters:



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/google/ads/google_ads/v13/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/v13/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::V13::Services::KeywordPlanService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Instance Attribute Details

#keyword_plan_service_stub ⇒ Object (readonly) 



37
38
39
 
# File 'lib/google/ads/google_ads/v13/services/keyword_plan_service/client.rb', line 37

def keyword_plan_service_stub
  @keyword_plan_service_stub
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the KeywordPlanService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all KeywordPlanService clients
::Google::Ads::GoogleAds::V13::Services::KeywordPlanService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/google/ads/google_ads/v13/services/keyword_plan_service/client.rb', line 57

def self.configure
  @configure ||= begin
    default_config = Client::Configuration.new

    default_config.timeout = 14_400.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

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



87
88
89
90
 
# File 'lib/google/ads/google_ads/v13/services/keyword_plan_service/client.rb', line 87

def configure
  yield @config if block_given?
  @config
end

#generate_forecast_curve(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V13::Services::GenerateForecastCurveResponse #generate_forecast_curve(keyword_plan: nil) ⇒ ::Google::Ads::GoogleAds::V13::Services::GenerateForecastCurveResponse

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]()

Examples:

Basic example

require "google/ads/google_ads/v13/services"

# Create a client object. The client can be reused for multiple calls.
client = Google::Ads::GoogleAds::V13::Services::KeywordPlanService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::GoogleAds::V13::Services::GenerateForecastCurveRequest.new

# Call the generate_forecast_curve method.
result = client.generate_forecast_curve request

# The returned object is of type Google::Ads::GoogleAds::V13::Services::GenerateForecastCurveResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Ads::GoogleAds::Error) —

    if the RPC is aborted.



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/google/ads/google_ads/v13/services/keyword_plan_service/client.rb', line 317

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::V13::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 = {}
  if request.keyword_plan
    header_params["keyword_plan"] = request.keyword_plan
  end

  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) ⇒ ::Google::Ads::GoogleAds::V13::Services::GenerateForecastMetricsResponse #generate_forecast_metrics(keyword_plan: nil) ⇒ ::Google::Ads::GoogleAds::V13::Services::GenerateForecastMetricsResponse

Returns the requested Keyword Plan forecasts.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[HeaderError]()
[InternalError]()
[KeywordPlanError]()
[QuotaError]()
[RequestError]()

Examples:

Basic example

require "google/ads/google_ads/v13/services"

# Create a client object. The client can be reused for multiple calls.
client = Google::Ads::GoogleAds::V13::Services::KeywordPlanService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::GoogleAds::V13::Services::GenerateForecastMetricsRequest.new

# Call the generate_forecast_metrics method.
result = client.generate_forecast_metrics request

# The returned object is of type Google::Ads::GoogleAds::V13::Services::GenerateForecastMetricsResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Ads::GoogleAds::Error) —

    if the RPC is aborted.



515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
 
# File 'lib/google/ads/google_ads/v13/services/keyword_plan_service/client.rb', line 515

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::V13::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 = {}
  if request.keyword_plan
    header_params["keyword_plan"] = request.keyword_plan
  end

  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) ⇒ ::Google::Ads::GoogleAds::V13::Services::GenerateForecastTimeSeriesResponse #generate_forecast_time_series(keyword_plan: nil) ⇒ ::Google::Ads::GoogleAds::V13::Services::GenerateForecastTimeSeriesResponse

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]()

Examples:

Basic example

require "google/ads/google_ads/v13/services"

# Create a client object. The client can be reused for multiple calls.
client = Google::Ads::GoogleAds::V13::Services::KeywordPlanService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::GoogleAds::V13::Services::GenerateForecastTimeSeriesRequest.new

# Call the generate_forecast_time_series method.
result = client.generate_forecast_time_series request

# The returned object is of type Google::Ads::GoogleAds::V13::Services::GenerateForecastTimeSeriesResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Ads::GoogleAds::Error) —

    if the RPC is aborted.



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/google/ads/google_ads/v13/services/keyword_plan_service/client.rb', line 419

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::V13::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 = {}
  if request.keyword_plan
    header_params["keyword_plan"] = request.keyword_plan
  end

  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) ⇒ ::Google::Ads::GoogleAds::V13::Services::GenerateHistoricalMetricsResponse #generate_historical_metrics(keyword_plan: nil, aggregate_metrics: nil, historical_metrics_options: nil) ⇒ ::Google::Ads::GoogleAds::V13::Services::GenerateHistoricalMetricsResponse

Returns the requested Keyword Plan historical metrics.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[HeaderError]()
[InternalError]()
[KeywordPlanError]()
[QuotaError]()
[RequestError]()

Examples:

Basic example

require "google/ads/google_ads/v13/services"

# Create a client object. The client can be reused for multiple calls.
client = Google::Ads::GoogleAds::V13::Services::KeywordPlanService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::GoogleAds::V13::Services::GenerateHistoricalMetricsRequest.new

# Call the generate_historical_metrics method.
result = client.generate_historical_metrics request

# The returned object is of type Google::Ads::GoogleAds::V13::Services::GenerateHistoricalMetricsResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Ads::GoogleAds::Error) —

    if the RPC is aborted.



616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
 
# File 'lib/google/ads/google_ads/v13/services/keyword_plan_service/client.rb', line 616

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::V13::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 = {}
  if request.keyword_plan
    header_params["keyword_plan"] = request.keyword_plan
  end

  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

#mutate_keyword_plans(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V13::Services::MutateKeywordPlansResponse #mutate_keyword_plans(customer_id: nil, operations: nil, partial_failure: nil, validate_only: nil) ⇒ ::Google::Ads::GoogleAds::V13::Services::MutateKeywordPlansResponse

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]()

Examples:

Basic example

require "google/ads/google_ads/v13/services"

# Create a client object. The client can be reused for multiple calls.
client = Google::Ads::GoogleAds::V13::Services::KeywordPlanService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::GoogleAds::V13::Services::MutateKeywordPlansRequest.new

# Call the mutate_keyword_plans method.
result = client.mutate_keyword_plans request

# The returned object is of type Google::Ads::GoogleAds::V13::Services::MutateKeywordPlansResponse.
p result

Overloads:

  • #mutate_keyword_plans(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V13::Services::MutateKeywordPlansResponse

    Pass arguments to ‘mutate_keyword_plans` via a request object, either of type MutateKeywordPlansRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Ads::GoogleAds::V13::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #mutate_keyword_plans(customer_id: nil, operations: nil, partial_failure: nil, validate_only: nil) ⇒ ::Google::Ads::GoogleAds::V13::Services::MutateKeywordPlansResponse

    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).

    Parameters:

    • customer_id (::String) (defaults to: nil) —

      Required. The ID of the customer whose keyword plans are being modified.

    • operations (::Array<::Google::Ads::GoogleAds::V13::Services::KeywordPlanOperation, ::Hash>) (defaults to: nil) —

      Required. The list of operations to perform on individual keyword plans.

    • partial_failure (::Boolean) (defaults to: nil) —

      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.

    • validate_only (::Boolean) (defaults to: nil) —

      If true, the request is validated but not executed. Only errors are returned, not results.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Ads::GoogleAds::Error) —

    if the RPC is aborted.



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/google/ads/google_ads/v13/services/keyword_plan_service/client.rb', line 216

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::V13::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 = {}
  if request.customer_id
    header_params["customer_id"] = request.customer_id
  end

  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