class Google::Ads::GoogleAds::V7::Services::KeywordPlanIdeaService::Client
Client
for the KeywordPlanIdeaService
service.
Service
to generate keyword ideas.
Attributes
@private
Public Class Methods
Configure the KeywordPlanIdeaService
Client
class.
See {::Google::Ads::GoogleAds::V7::Services::KeywordPlanIdeaService::Client::Configuration} for a description of the configuration fields.
## Example
To modify the configuration for all KeywordPlanIdeaService
clients:
::Google::Ads::GoogleAds::V7::Services::KeywordPlanIdeaService::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/v7/services/keyword_plan_idea_service/client.rb, line 56 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
Create a new KeywordPlanIdeaService
client object.
## Examples
To create a new KeywordPlanIdeaService
client with the default configuration:
client = ::Google::Ads::GoogleAds::V7::Services::KeywordPlanIdeaService::Client.new
To create a new KeywordPlanIdeaService
client with a custom configuration:
client = ::Google::Ads::GoogleAds::V7::Services::KeywordPlanIdeaService::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the KeywordPlanIdeaService
client. @yieldparam config [Client::Configuration]
# File lib/google/ads/google_ads/v7/services/keyword_plan_idea_service/client.rb, line 114 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/v7/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 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_idea_service_stub = ::Gapic::ServiceStub.new( ::Google::Ads::GoogleAds::V7::Services::KeywordPlanIdeaService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
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 {Client.configure}.
See {::Google::Ads::GoogleAds::V7::Services::KeywordPlanIdeaService::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/v7/services/keyword_plan_idea_service/client.rb, line 89 def configure yield @config if block_given? @config end
Returns a list of keyword ideas.
List of thrown errors:
[AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [HeaderError]() [InternalError]() [KeywordPlanIdeaError]() [QuotaError]() [RequestError]()
@overload generate_keyword_ideas
(request, options = nil)
Pass arguments to `generate_keyword_ideas` via a request object, either of type {::Google::Ads::GoogleAds::V7::Services::GenerateKeywordIdeasRequest} or an equivalent Hash. @param request [::Google::Ads::GoogleAds::V7::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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload 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)
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). @param customer_id [::String] The ID of the customer with the recommendation. @param language [::String] The resource name of the language to target. Required @param geo_target_constants [::Array<::String>] The resource names of the location to target. Max 10 @param include_adult_keywords [::Boolean] If true, adult keywords will be included in response. The default value is false. @param page_token [::String] 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. @param page_size [::Integer] 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. @param keyword_plan_network [::Google::Ads::GoogleAds::V7::Enums::KeywordPlanNetworkEnum::KeywordPlanNetwork] Targeting network. @param keyword_annotation [::Array<::Google::Ads::GoogleAds::V7::Enums::KeywordPlanKeywordAnnotationEnum::KeywordPlanKeywordAnnotation>] The keyword annotations to include in response. @param aggregate_metrics [::Google::Ads::GoogleAds::V7::Common::KeywordPlanAggregateMetrics, ::Hash] The aggregate fields to include in response. @param historical_metrics_options [::Google::Ads::GoogleAds::V7::Common::HistoricalMetricsOptions, ::Hash] The options for historical metrics data. @param keyword_and_url_seed [::Google::Ads::GoogleAds::V7::Services::KeywordAndUrlSeed, ::Hash] A Keyword and a specific Url to generate ideas from e.g. cars, www.example.com/cars. @param keyword_seed [::Google::Ads::GoogleAds::V7::Services::KeywordSeed, ::Hash] A Keyword or phrase to generate ideas from, e.g. cars. @param url_seed [::Google::Ads::GoogleAds::V7::Services::UrlSeed, ::Hash] A specific url to generate ideas from, e.g. www.example.com/cars. @param site_seed [::Google::Ads::GoogleAds::V7::Services::SiteSeed, ::Hash] The site to generate ideas from, e.g. www.example.com.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Ads::GoogleAds::V7::Services::GenerateKeywordIdeaResult>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Ads::GoogleAds::V7::Services::GenerateKeywordIdeaResult>]
@raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.
# File lib/google/ads/google_ads/v7/services/keyword_plan_idea_service/client.rb, line 231 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::V7::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 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.generate_keyword_ideas.timeout, metadata: metadata, retry_policy: @config.rpcs.generate_keyword_ideas.retry_policy options.apply_defaults 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? return response end # rescue GRPC::BadStatus => grpc_error # raise Google::Ads::GoogleAds::Error.new grpc_error.message end