Class: Google::Ads::GoogleAds::V16::Services::RecommendationService::Client

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

Overview

Client for the RecommendationService service.

Service to manage recommendations.

Defined Under Namespace

Classes: Configuration

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"googleads.$UNIVERSE_DOMAIN$"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#ad_group_path, #ad_path, #asset_path, #campaign_budget_path, #campaign_path, #conversion_action_path, #recommendation_path

Constructor Details

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

Create a new RecommendationService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the RecommendationService client.

Yield Parameters:



120
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
 
# File 'lib/google/ads/google_ads/v16/services/recommendation_service/client.rb', line 120

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/v16/services/recommendation_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

  @recommendation_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V16::Services::RecommendationService::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
  )
end

Instance Attribute Details

#recommendation_service_stub ⇒ Object (readonly) 



40
41
42
 
# File 'lib/google/ads/google_ads/v16/services/recommendation_service/client.rb', line 40

def recommendation_service_stub
  @recommendation_service_stub
end

Class Method Details

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

Configure the RecommendationService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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

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

#apply_recommendation(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::ApplyRecommendationResponse #apply_recommendation(customer_id: nil, operations: nil, partial_failure: nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::ApplyRecommendationResponse

Applies given recommendations with corresponding apply parameters.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[DatabaseError]()
[FieldError]()
[HeaderError]()
[InternalError]()
[MutateError]()
[QuotaError]()
[RecommendationError]()
[RequestError]()
[UrlFieldError]()

Examples:

Basic example

require "google/ads/google_ads/v16/services"

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

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

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

# The returned object is of type Google::Ads::GoogleAds::V16::Services::ApplyRecommendationResponse.
p result

Overloads:

  • #apply_recommendation(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::ApplyRecommendationResponse

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

    Parameters:

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

  • #apply_recommendation(customer_id: nil, operations: nil, partial_failure: nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::ApplyRecommendationResponse

    Pass arguments to ‘apply_recommendation` 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 with the recommendation.

    • operations (::Array<::Google::Ads::GoogleAds::V16::Services::ApplyRecommendationOperation, ::Hash>) (defaults to: nil) —

      Required. The list of operations to apply recommendations. If partial_failure=false all recommendations should be of the same type There is a limit of 100 operations per request.

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

      If true, successful operations will be carried out and invalid operations will return errors. If false, operations will be carried out as a transaction if and only if they are all valid. Default is false.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/google/ads/google_ads/v16/services/recommendation_service/client.rb', line 228

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

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V16::Services::ApplyRecommendationRequest

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

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

  @recommendation_service_stub.call_rpc :apply_recommendation, 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

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

Configure the RecommendationService 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:



90
91
92
93
 
# File 'lib/google/ads/google_ads/v16/services/recommendation_service/client.rb', line 90

def configure
  yield @config if block_given?
  @config
end

#dismiss_recommendation(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::DismissRecommendationResponse #dismiss_recommendation(customer_id: nil, operations: nil, partial_failure: nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::DismissRecommendationResponse

Dismisses given recommendations.

List of thrown errors:

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

Examples:

Basic example

require "google/ads/google_ads/v16/services"

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

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

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

# The returned object is of type Google::Ads::GoogleAds::V16::Services::DismissRecommendationResponse.
p result

Overloads:

  • #dismiss_recommendation(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::DismissRecommendationResponse

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

    Parameters:

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

  • #dismiss_recommendation(customer_id: nil, operations: nil, partial_failure: nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::DismissRecommendationResponse

    Pass arguments to ‘dismiss_recommendation` 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 with the recommendation.

    • operations (::Array<::Google::Ads::GoogleAds::V16::Services::DismissRecommendationRequest::DismissRecommendationOperation, ::Hash>) (defaults to: nil) —

      Required. The list of operations to dismiss recommendations. If partial_failure=false all recommendations should be of the same type There is a limit of 100 operations per request.

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

      If true, successful operations will be carried out and invalid operations will return errors. If false, operations will be carried in a single transaction if and only if they are all valid. Default is false.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/google/ads/google_ads/v16/services/recommendation_service/client.rb', line 333

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

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V16::Services::DismissRecommendationRequest

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

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

  @recommendation_service_stub.call_rpc :dismiss_recommendation, 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

#generate_recommendations(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::GenerateRecommendationsResponse #generate_recommendations(customer_id: nil, recommendation_types: nil, advertising_channel_type: nil, campaign_sitelink_count: nil, conversion_tracking_status: nil, bidding_info: nil, ad_group_info: nil, seed_info: nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::GenerateRecommendationsResponse

Generates Recommendations based off the requested recommendation_types.

List of thrown errors:

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

Examples:

Basic example

require "google/ads/google_ads/v16/services"

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

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

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

# The returned object is of type Google::Ads::GoogleAds::V16::Services::GenerateRecommendationsResponse.
p result

Overloads:

  • #generate_recommendations(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::GenerateRecommendationsResponse

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

    Parameters:

    • request (::Google::Ads::GoogleAds::V16::Services::GenerateRecommendationsRequest, ::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_recommendations(customer_id: nil, recommendation_types: nil, advertising_channel_type: nil, campaign_sitelink_count: nil, conversion_tracking_status: nil, bidding_info: nil, ad_group_info: nil, seed_info: nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::GenerateRecommendationsResponse

    Pass arguments to ‘generate_recommendations` 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 generating recommendations.

    • recommendation_types (::Array<::Google::Ads::GoogleAds::V16::Enums::RecommendationTypeEnum::RecommendationType>) (defaults to: nil) —

      Required. List of eligible recommendation_types to generate. If the uploaded criteria isn’t sufficient to make a recommendation, or the campaign is already in the recommended state, no recommendation will be returned for that type. Generally, a recommendation is returned if all required fields for that recommendation_type are uploaded, but there are cases where this is still not sufficient.

      The following recommendation_types are supported for recommendation generation: KEYWORD, MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN, MAXIMIZE_CONVERSION_VALUE_OPT_IN, SET_TARGET_CPA, SET_TARGET_ROAS, SITELINK_ASSET, TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN

    • advertising_channel_type (::Google::Ads::GoogleAds::V16::Enums::AdvertisingChannelTypeEnum::AdvertisingChannelType) (defaults to: nil) —

      Required. Advertising channel type of the campaign. The following advertising_channel_types are supported for recommendation generation: PERFORMANCE_MAX and SEARCH

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

      Optional. Number of sitelinks on the campaign. This field is necessary for the following recommendation_types: SITELINK_ASSET

    • conversion_tracking_status (::Google::Ads::GoogleAds::V16::Enums::ConversionTrackingStatusEnum::ConversionTrackingStatus) (defaults to: nil) —

      Optional. Current conversion tracking status. This field is necessary for the following recommendation_types: MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN, MAXIMIZE_CONVERSION_VALUE_OPT_IN, SET_TARGET_CPA, SET_TARGET_ROAS, TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN

    • bidding_info (::Google::Ads::GoogleAds::V16::Services::GenerateRecommendationsRequest::BiddingInfo, ::Hash) (defaults to: nil) —

      Optional. Current bidding information of the campaign. This field is necessary for the following recommendation_types: MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN, MAXIMIZE_CONVERSION_VALUE_OPT_IN, SET_TARGET_CPA, SET_TARGET_ROAS, TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN

    • ad_group_info (::Array<::Google::Ads::GoogleAds::V16::Services::GenerateRecommendationsRequest::AdGroupInfo, ::Hash>) (defaults to: nil) —

      Optional. Current AdGroup Information. Supports information from a single AdGroup. This field is optional for the following recommendation_types: KEYWORD

    • seed_info (::Google::Ads::GoogleAds::V16::Services::GenerateRecommendationsRequest::SeedInfo, ::Hash) (defaults to: nil) —

      Optional. Seed information for Keywords. This field is necessary for the following recommendation_types: KEYWORD

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/google/ads/google_ads/v16/services/recommendation_service/client.rb', line 472

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

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V16::Services::GenerateRecommendationsRequest

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

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

  @recommendation_service_stub.call_rpc :generate_recommendations, 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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


100
101
102
 
# File 'lib/google/ads/google_ads/v16/services/recommendation_service/client.rb', line 100

def universe_domain
  @recommendation_service_stub.universe_domain
end