Class: Google::Ads::GoogleAds::V18::Services::KeywordPlanIdeaService::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/google/ads/google_ads/v18/services/keyword_plan_idea_service/client.rb

Overview

Client for the KeywordPlanIdeaService service.

Service to generate keyword ideas.

Defined Under Namespace

Classes: Configuration

Constant Summary collapse

API_VERSION = 
""
DEFAULT_ENDPOINT_TEMPLATE = 
"googleads.$UNIVERSE_DOMAIN$"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new KeywordPlanIdeaService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the KeywordPlanIdeaService client.

Yield Parameters:



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/google/ads/google_ads/v18/services/keyword_plan_idea_service/client.rb', line 121

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/v18/services/keyword_plan_idea_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.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_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_idea_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V18::Services::KeywordPlanIdeaService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @keyword_plan_idea_service_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Instance Attribute Details

#keyword_plan_idea_service_stub ⇒ Object (readonly) 



41
42
43
 
# File 'lib/google/ads/google_ads/v18/services/keyword_plan_idea_service/client.rb', line 41

def keyword_plan_idea_service_stub
  @keyword_plan_idea_service_stub
end

Class Method Details

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

Configure the KeywordPlanIdeaService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/google/ads/google_ads/v18/services/keyword_plan_idea_service/client.rb', line 61

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 KeywordPlanIdeaService 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:



91
92
93
94
 
# File 'lib/google/ads/google_ads/v18/services/keyword_plan_idea_service/client.rb', line 91

def configure
  yield @config if block_given?
  @config
end

#generate_ad_group_themes(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V18::Services::GenerateAdGroupThemesResponse #generate_ad_group_themes(customer_id: nil, keywords: nil, ad_groups: nil) ⇒ ::Google::Ads::GoogleAds::V18::Services::GenerateAdGroupThemesResponse

Returns a list of suggested AdGroups and suggested modifications (text, match type) for the given keywords.

List of thrown errors:

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

Examples:

Basic example

require "google/ads/google_ads/v18/services"

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

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

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

# The returned object is of type Google::Ads::GoogleAds::V18::Services::GenerateAdGroupThemesResponse.
p result

Overloads:

  • #generate_ad_group_themes(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V18::Services::GenerateAdGroupThemesResponse

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

    Parameters:

    • request (::Google::Ads::GoogleAds::V18::Services::GenerateAdGroupThemesRequest, ::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.

  • #generate_ad_group_themes(customer_id: nil, keywords: nil, ad_groups: nil) ⇒ ::Google::Ads::GoogleAds::V18::Services::GenerateAdGroupThemesResponse

    Pass arguments to ‘generate_ad_group_themes` 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.

    • keywords (::Array<::String>) (defaults to: nil) —

      Required. A list of keywords to group into the provided AdGroups.

    • ad_groups (::Array<::String>) (defaults to: nil) —

      Required. A list of resource names of AdGroups to group keywords into.

      Resource name format: `customers/{customer_id}/adGroups/{ad_group_id}`

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
557
 
# File 'lib/google/ads/google_ads/v18/services/keyword_plan_idea_service/client.rb', line 516

def generate_ad_group_themes request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V18::Services::GenerateAdGroupThemesRequest

  # 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_ad_group_themes.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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.generate_ad_group_themes.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.generate_ad_group_themes.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @keyword_plan_idea_service_stub.call_rpc :generate_ad_group_themes, request,
                                           options: options do |response, operation|
    yield response, operation if block_given?
  end
  # rescue GRPC::BadStatus => grpc_error
  #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
end

#generate_keyword_forecast_metrics(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V18::Services::GenerateKeywordForecastMetricsResponse #generate_keyword_forecast_metrics(customer_id: nil, currency_code: nil, forecast_period: nil, campaign: nil) ⇒ ::Google::Ads::GoogleAds::V18::Services::GenerateKeywordForecastMetricsResponse

Returns metrics (such as impressions, clicks, total cost) of a keyword forecast for the given campaign.

List of thrown errors:

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

Examples:

Basic example

require "google/ads/google_ads/v18/services"

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

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

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

# The returned object is of type Google::Ads::GoogleAds::V18::Services::GenerateKeywordForecastMetricsResponse.
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.



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
658
659
660
661
662
663
664
665
666
667
 
# File 'lib/google/ads/google_ads/v18/services/keyword_plan_idea_service/client.rb', line 626

def generate_keyword_forecast_metrics request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V18::Services::GenerateKeywordForecastMetricsRequest

  # 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_keyword_forecast_metrics.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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.generate_keyword_forecast_metrics.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.generate_keyword_forecast_metrics.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @keyword_plan_idea_service_stub.call_rpc :generate_keyword_forecast_metrics, request,
                                           options: options do |response, operation|
    yield response, operation if block_given?
  end
  # rescue GRPC::BadStatus => grpc_error
  #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
end

#generate_keyword_historical_metrics(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V18::Services::GenerateKeywordHistoricalMetricsResponse #generate_keyword_historical_metrics(customer_id: nil, keywords: nil, language: nil, include_adult_keywords: nil, geo_target_constants: nil, keyword_plan_network: nil, aggregate_metrics: nil, historical_metrics_options: nil) ⇒ ::Google::Ads::GoogleAds::V18::Services::GenerateKeywordHistoricalMetricsResponse

Returns a list of keyword historical metrics.

List of thrown errors:

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

Examples:

Basic example

require "google/ads/google_ads/v18/services"

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

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

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

# The returned object is of type Google::Ads::GoogleAds::V18::Services::GenerateKeywordHistoricalMetricsResponse.
p result

Overloads:

  • #generate_keyword_historical_metrics(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V18::Services::GenerateKeywordHistoricalMetricsResponse

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

    Parameters:

    • request (::Google::Ads::GoogleAds::V18::Services::GenerateKeywordHistoricalMetricsRequest, ::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.

  • #generate_keyword_historical_metrics(customer_id: nil, keywords: nil, language: nil, include_adult_keywords: nil, geo_target_constants: nil, keyword_plan_network: nil, aggregate_metrics: nil, historical_metrics_options: nil) ⇒ ::Google::Ads::GoogleAds::V18::Services::GenerateKeywordHistoricalMetricsResponse

    Pass arguments to ‘generate_keyword_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).

    Parameters:

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

      The ID of the customer with the recommendation.

    • keywords (::Array<::String>) (defaults to: nil) —

      A list of keywords to get historical metrics. Not all inputs will be returned as a result of near-exact deduplication. For example, if stats for “car” and “cars” are requested, only “car” will be returned. A maximum of 10,000 keywords can be used.

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

      The resource name of the language to target. Each keyword belongs to some set of languages; a keyword is included if language is one of its languages. If not set, all keywords will be included.

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

      If true, adult keywords will be included in response. The default value is false.

    • geo_target_constants (::Array<::String>) (defaults to: nil) —

      The resource names of the location to target. Maximum is 10. An empty list MAY be used to specify all targeting geos.

    • keyword_plan_network (::Google::Ads::GoogleAds::V18::Enums::KeywordPlanNetworkEnum::KeywordPlanNetwork) (defaults to: nil) —

      Targeting network. If not set, Google Search And Partners Network will be used.

    • aggregate_metrics (::Google::Ads::GoogleAds::V18::Common::KeywordPlanAggregateMetrics, ::Hash) (defaults to: nil) —

      The aggregate fields to include in response.

    • historical_metrics_options (::Google::Ads::GoogleAds::V18::Common::HistoricalMetricsOptions, ::Hash) (defaults to: nil) —

      The options for historical metrics data.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



414
415
416
417
418
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
 
# File 'lib/google/ads/google_ads/v18/services/keyword_plan_idea_service/client.rb', line 414

def generate_keyword_historical_metrics request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V18::Services::GenerateKeywordHistoricalMetricsRequest

  # 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_keyword_historical_metrics.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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.generate_keyword_historical_metrics.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.generate_keyword_historical_metrics.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @keyword_plan_idea_service_stub.call_rpc :generate_keyword_historical_metrics, request,
                                           options: options do |response, operation|
    yield response, operation if block_given?
  end
  # rescue GRPC::BadStatus => grpc_error
  #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
end

#generate_keyword_ideas(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Ads::GoogleAds::V18::Services::GenerateKeywordIdeaResult> #generate_keyword_ideas(customer_id: nil, language: nil, geo_target_constants: nil, include_adult_keywords: nil, page_token: nil, page_size: nil, keyword_plan_network: nil, keyword_annotation: nil, aggregate_metrics: nil, historical_metrics_options: nil, keyword_and_url_seed: nil, keyword_seed: nil, url_seed: nil, site_seed: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Ads::GoogleAds::V18::Services::GenerateKeywordIdeaResult>

Returns a list of keyword ideas.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[CollectionSizeError]()
[HeaderError]()
[InternalError]()
[KeywordPlanIdeaError]()
[QuotaError]()
[RequestError]()

Examples:

Basic example

require "google/ads/google_ads/v18/services"

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

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Ads::GoogleAds::V18::Services::GenerateKeywordIdeaResult.
  p item
end

Overloads:

  • #generate_keyword_ideas(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Ads::GoogleAds::V18::Services::GenerateKeywordIdeaResult>

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

    Parameters:

    • request (::Google::Ads::GoogleAds::V18::Services::GenerateKeywordIdeasRequest, ::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.

  • #generate_keyword_ideas(customer_id: nil, language: nil, geo_target_constants: nil, include_adult_keywords: nil, page_token: nil, page_size: nil, keyword_plan_network: nil, keyword_annotation: nil, aggregate_metrics: nil, historical_metrics_options: nil, keyword_and_url_seed: nil, keyword_seed: nil, url_seed: nil, site_seed: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Ads::GoogleAds::V18::Services::GenerateKeywordIdeaResult>

    Pass arguments to ‘generate_keyword_ideas` 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) —

      The ID of the customer with the recommendation.

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

      The resource name of the language to target. Each keyword belongs to some set of languages; a keyword is included if language is one of its languages. If not set, all keywords will be included.

    • geo_target_constants (::Array<::String>) (defaults to: nil) —

      The resource names of the location to target. Maximum is 10. An empty list MAY be used to specify all targeting geos.

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

      If true, adult keywords will be included in response. The default value is false.

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

      Token of the page to retrieve. If not specified, the first page of results will be returned. To request next page of results use the value obtained from ‘next_page_token` in the previous response. The request fields must match across pages.

    • page_size (::Integer) (defaults to: nil) —

      Number of results to retrieve in a single page. A maximum of 10,000 results may be returned, if the page_size exceeds this, it is ignored. If unspecified, at most 10,000 results will be returned. The server may decide to further limit the number of returned resources. If the response contains fewer than 10,000 results it may not be assumed as last page of results.

    • keyword_plan_network (::Google::Ads::GoogleAds::V18::Enums::KeywordPlanNetworkEnum::KeywordPlanNetwork) (defaults to: nil) —

      Targeting network. If not set, Google Search And Partners Network will be used.

    • keyword_annotation (::Array<::Google::Ads::GoogleAds::V18::Enums::KeywordPlanKeywordAnnotationEnum::KeywordPlanKeywordAnnotation>) (defaults to: nil) —

      The keyword annotations to include in response.

    • aggregate_metrics (::Google::Ads::GoogleAds::V18::Common::KeywordPlanAggregateMetrics, ::Hash) (defaults to: nil) —

      The aggregate fields to include in response.

    • historical_metrics_options (::Google::Ads::GoogleAds::V18::Common::HistoricalMetricsOptions, ::Hash) (defaults to: nil) —

      The options for historical metrics data.

    • keyword_and_url_seed (::Google::Ads::GoogleAds::V18::Services::KeywordAndUrlSeed, ::Hash) (defaults to: nil) —

      A Keyword and a specific Url to generate ideas from for example, cars, www.example.com/cars.

      Note: The following fields are mutually exclusive: ‘keyword_and_url_seed`, `keyword_seed`, `url_seed`, `site_seed`. If a field in that set is populated, all other fields in the set will automatically be cleared.

    • keyword_seed (::Google::Ads::GoogleAds::V18::Services::KeywordSeed, ::Hash) (defaults to: nil) —

      A Keyword or phrase to generate ideas from, for example, cars.

      Note: The following fields are mutually exclusive: ‘keyword_seed`, `keyword_and_url_seed`, `url_seed`, `site_seed`. If a field in that set is populated, all other fields in the set will automatically be cleared.

    • url_seed (::Google::Ads::GoogleAds::V18::Services::UrlSeed, ::Hash) (defaults to: nil) —

      A specific url to generate ideas from, for example, www.example.com/cars.

      Note: The following fields are mutually exclusive: ‘url_seed`, `keyword_and_url_seed`, `keyword_seed`, `site_seed`. If a field in that set is populated, all other fields in the set will automatically be cleared.

    • site_seed (::Google::Ads::GoogleAds::V18::Services::SiteSeed, ::Hash) (defaults to: nil) —

      The site to generate ideas from, for example, www.example.com.

      Note: The following fields are mutually exclusive: ‘site_seed`, `keyword_and_url_seed`, `keyword_seed`, `url_seed`. If a field in that set is populated, all other fields in the set will automatically be cleared.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/google/ads/google_ads/v18/services/keyword_plan_idea_service/client.rb', line 291

def generate_keyword_ideas request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V18::Services::GenerateKeywordIdeasRequest

  # 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_keyword_ideas.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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.generate_keyword_ideas.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.generate_keyword_ideas.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @keyword_plan_idea_service_stub.call_rpc :generate_keyword_ideas, request,
                                           options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @keyword_plan_idea_service_stub, :generate_keyword_ideas,
                                            request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
  # rescue GRPC::BadStatus => grpc_error
  #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


177
178
179
 
# File 'lib/google/ads/google_ads/v18/services/keyword_plan_idea_service/client.rb', line 177

def logger
  @keyword_plan_idea_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


101
102
103
 
# File 'lib/google/ads/google_ads/v18/services/keyword_plan_idea_service/client.rb', line 101

def universe_domain
  @keyword_plan_idea_service_stub.universe_domain
end