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

Client for the KeywordThemeConstantService service.

Service to fetch Smart Campaign keyword themes.

Attributes

keyword_theme_constant_service_stub[R]

@private

Public Class Methods

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

Configure the KeywordThemeConstantService Client class.

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

@example

# Modify the configuration for all KeywordThemeConstantService clients
::Google::Ads::GoogleAds::V8::Services::KeywordThemeConstantService::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_theme_constant_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 KeywordThemeConstantService client object.

@example

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

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

@yield [config] Configure the KeywordThemeConstantService client. @yieldparam config [Client::Configuration]

# File lib/google/ads/google_ads/v8/services/keyword_theme_constant_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_theme_constant_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_theme_constant_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V8::Services::KeywordThemeConstantService::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 KeywordThemeConstantService 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::KeywordThemeConstantService::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_theme_constant_service/client.rb, line 87
def configure
  yield @config if block_given?
  @config
end
get_keyword_theme_constant(request, options = nil) { |response, operation| ... } click to toggle source

Returns the requested keyword theme constant in full detail.

@overload get_keyword_theme_constant(request, options = nil)

Pass arguments to `get_keyword_theme_constant` via a request object, either of type
{::Google::Ads::GoogleAds::V8::Services::GetKeywordThemeConstantRequest} or an equivalent Hash.

@param request [::Google::Ads::GoogleAds::V8::Services::GetKeywordThemeConstantRequest, ::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_theme_constant(resource_name: nil)

Pass arguments to `get_keyword_theme_constant` 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 keyword theme constant to fetch.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Ads::GoogleAds::V8::Resources::KeywordThemeConstant] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Ads::GoogleAds::V8::Resources::KeywordThemeConstant]

@raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.

# File lib/google/ads/google_ads/v8/services/keyword_theme_constant_service/client.rb, line 175
def get_keyword_theme_constant request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V8::Services::GetKeywordThemeConstantRequest

  # 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_theme_constant.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_theme_constant.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_keyword_theme_constant.retry_policy

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

  @keyword_theme_constant_service_stub.call_rpc :get_keyword_theme_constant, 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
suggest_keyword_theme_constants(request, options = nil) { |response, operation| ... } click to toggle source

Returns KeywordThemeConstant suggestions by keyword themes.

List of thrown errors:

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

@overload suggest_keyword_theme_constants(request, options = nil)

Pass arguments to `suggest_keyword_theme_constants` via a request object, either of type
{::Google::Ads::GoogleAds::V8::Services::SuggestKeywordThemeConstantsRequest} or an equivalent Hash.

@param request [::Google::Ads::GoogleAds::V8::Services::SuggestKeywordThemeConstantsRequest, ::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 suggest_keyword_theme_constants(query_text: nil, country_code: nil, language_code: nil)

Pass arguments to `suggest_keyword_theme_constants` 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 query_text [::String]
  The query text of a keyword theme that will be used to map to similar
  keyword themes. E.g. "plumber" or "roofer".
@param country_code [::String]
  Upper-case, two-letter country code as defined by ISO-3166. This for
  refining the scope of the query, default to 'US' if not set.
@param language_code [::String]
  The two letter language code for get corresponding keyword theme for
  refining the scope of the query, default to 'en' if not set.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Ads::GoogleAds::V8::Services::SuggestKeywordThemeConstantsResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Ads::GoogleAds::V8::Services::SuggestKeywordThemeConstantsResponse]

@raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.

# File lib/google/ads/google_ads/v8/services/keyword_theme_constant_service/client.rb, line 260
def suggest_keyword_theme_constants request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V8::Services::SuggestKeywordThemeConstantsRequest

  # 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.suggest_keyword_theme_constants.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

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

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

  @keyword_theme_constant_service_stub.call_rpc :suggest_keyword_theme_constants, 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