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

Client for the SmartCampaignSuggestService service.

Service to get suggestions for Smart Campaigns.

Attributes

smart_campaign_suggest_service_stub[R]

@private

Public Class Methods

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

Configure the SmartCampaignSuggestService Client class.

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

@example

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

@example

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

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

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

# File lib/google/ads/google_ads/v8/services/smart_campaign_suggest_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/smart_campaign_suggest_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

  @smart_campaign_suggest_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V8::Services::SmartCampaignSuggestService::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 SmartCampaignSuggestService 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::SmartCampaignSuggestService::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/smart_campaign_suggest_service/client.rb, line 87
def configure
  yield @config if block_given?
  @config
end
suggest_smart_campaign_ad(request, options = nil) { |response, operation| ... } click to toggle source

Suggests a Smart campaign ad compatible with the Ad family of resources, based on data points such as targeting and the business to advertise.

@overload suggest_smart_campaign_ad(request, options = nil)

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

@param request [::Google::Ads::GoogleAds::V8::Services::SuggestSmartCampaignAdRequest, ::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_smart_campaign_ad(customer_id: nil, suggestion_info: nil)

Pass arguments to `suggest_smart_campaign_ad` 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.
@param suggestion_info [::Google::Ads::GoogleAds::V8::Services::SmartCampaignSuggestionInfo, ::Hash]
  Required. Inputs used to suggest a Smart campaign ad.
  Required fields: final_url, language_code, keyword_themes.
  Optional but recommended fields to improve the quality of the suggestion:
  business_setting and geo_target.

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

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

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

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

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

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

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

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

Returns BudgetOption suggestions.

@overload suggest_smart_campaign_budget_options(request, options = nil)

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

@param request [::Google::Ads::GoogleAds::V8::Services::SuggestSmartCampaignBudgetOptionsRequest, ::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_smart_campaign_budget_options(customer_id: nil, campaign: nil, suggestion_info: nil)

Pass arguments to `suggest_smart_campaign_budget_options` 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 budget options are to be suggested.
@param campaign [::String]
  Required. The resource name of the campaign to get suggestion for.
@param suggestion_info [::Google::Ads::GoogleAds::V8::Services::SmartCampaignSuggestionInfo, ::Hash]
  Required. Information needed to get budget options

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

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

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

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

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

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

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

  @smart_campaign_suggest_service_stub.call_rpc :suggest_smart_campaign_budget_options, 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