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

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

Overview

Client for the SmartCampaignSuggestService service.

Service to get suggestions for Smart Campaigns.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#campaign_path, #keyword_theme_constant_path

Constructor Details

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

Create a new SmartCampaignSuggestService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the SmartCampaignSuggestService 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/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/v13/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::V13::Services::SmartCampaignSuggestService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Instance Attribute Details

#smart_campaign_suggest_service_stub ⇒ Object (readonly) 



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

def smart_campaign_suggest_service_stub
  @smart_campaign_suggest_service_stub
end

Class Method Details

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

Configure the SmartCampaignSuggestService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all SmartCampaignSuggestService clients
::Google::Ads::GoogleAds::V13::Services::SmartCampaignSuggestService::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/smart_campaign_suggest_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 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 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/smart_campaign_suggest_service/client.rb', line 87

def configure
  yield @config if block_given?
  @config
end

#suggest_keyword_themes(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V13::Services::SuggestKeywordThemesResponse #suggest_keyword_themes(customer_id: nil, suggestion_info: nil) ⇒ ::Google::Ads::GoogleAds::V13::Services::SuggestKeywordThemesResponse

Suggests keyword themes to advertise on.

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::SmartCampaignSuggestService::Client.new

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

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

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



385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/google/ads/google_ads/v13/services/smart_campaign_suggest_service/client.rb', line 385

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

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V13::Services::SuggestKeywordThemesRequest

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

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

  @smart_campaign_suggest_service_stub.call_rpc :suggest_keyword_themes, 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_ad(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V13::Services::SuggestSmartCampaignAdResponse #suggest_smart_campaign_ad(customer_id: nil, suggestion_info: nil) ⇒ ::Google::Ads::GoogleAds::V13::Services::SuggestSmartCampaignAdResponse

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

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::SmartCampaignSuggestService::Client.new

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

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

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



287
288
289
290
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
 
# File 'lib/google/ads/google_ads/v13/services/smart_campaign_suggest_service/client.rb', line 287

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::V13::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 = {}
  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.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) ⇒ ::Google::Ads::GoogleAds::V13::Services::SuggestSmartCampaignBudgetOptionsResponse #suggest_smart_campaign_budget_options(customer_id: nil, campaign: nil, suggestion_info: nil) ⇒ ::Google::Ads::GoogleAds::V13::Services::SuggestSmartCampaignBudgetOptionsResponse

Returns BudgetOption suggestions.

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::SmartCampaignSuggestService::Client.new

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

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

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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/google/ads/google_ads/v13/services/smart_campaign_suggest_service/client.rb', line 194

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::V13::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 = {}
  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.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