class Google::Ads::GoogleAds::V7::Services::RecommendationService::Client

Client for the RecommendationService service.

Service to manage recommendations.

Attributes

recommendation_service_stub[R]

@private

Public Class Methods

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

Configure the RecommendationService Client class.

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

## Example

To modify the configuration for all RecommendationService clients:

::Google::Ads::GoogleAds::V7::Services::RecommendationService::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/recommendation_service/client.rb, line 58
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 RecommendationService client object.

## Examples

To create a new RecommendationService client with the default configuration:

client = ::Google::Ads::GoogleAds::V7::Services::RecommendationService::Client.new

To create a new RecommendationService client with a custom configuration:

client = ::Google::Ads::GoogleAds::V7::Services::RecommendationService::Client.new do |config|
  config.timeout = 10.0
end

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

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

  @recommendation_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V7::Services::RecommendationService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

apply_recommendation(request, options = nil) { |response, operation| ... } click to toggle source

Applies given recommendations with corresponding apply parameters.

List of thrown errors:

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

@overload apply_recommendation(request, options = nil)

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

@param request [::Google::Ads::GoogleAds::V7::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload apply_recommendation(customer_id: nil, operations: nil, partial_failure: nil)

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).

@param customer_id [::String]
  Required. The ID of the customer with the recommendation.
@param operations [::Array<::Google::Ads::GoogleAds::V7::Services::ApplyRecommendationOperation, ::Hash>]
  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.
@param partial_failure [::Boolean]
  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.

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

@return [::Google::Ads::GoogleAds::V7::Services::ApplyRecommendationResponse]

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

# File lib/google/ads/google_ads/v7/services/recommendation_service/client.rb, line 282
def apply_recommendation request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V7::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 = {
    "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.apply_recommendation.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.apply_recommendation.retry_policy
  options.apply_defaults 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| ... } click to toggle source

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 {Client.configure}.

See {::Google::Ads::GoogleAds::V7::Services::RecommendationService::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/recommendation_service/client.rb, line 91
def configure
  yield @config if block_given?
  @config
end
dismiss_recommendation(request, options = nil) { |response, operation| ... } click to toggle source

Dismisses given recommendations.

List of thrown errors:

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

@overload dismiss_recommendation(request, options = nil)

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

@param request [::Google::Ads::GoogleAds::V7::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload dismiss_recommendation(customer_id: nil, operations: nil, partial_failure: nil)

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).

@param customer_id [::String]
  Required. The ID of the customer with the recommendation.
@param operations [::Array<::Google::Ads::GoogleAds::V7::Services::DismissRecommendationRequest::DismissRecommendationOperation, ::Hash>]
  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.
@param partial_failure [::Boolean]
  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.

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

@return [::Google::Ads::GoogleAds::V7::Services::DismissRecommendationResponse]

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

# File lib/google/ads/google_ads/v7/services/recommendation_service/client.rb, line 368
def dismiss_recommendation request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V7::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 = {
    "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.dismiss_recommendation.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.dismiss_recommendation.retry_policy
  options.apply_defaults 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
get_recommendation(request, options = nil) { |response, operation| ... } click to toggle source

Returns the requested recommendation in full detail.

List of thrown errors:

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

@overload get_recommendation(request, options = nil)

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

@param request [::Google::Ads::GoogleAds::V7::Services::GetRecommendationRequest, ::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_recommendation(resource_name: nil)

Pass arguments to `get_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).

@param resource_name [::String]
  Required. The resource name of the recommendation to fetch.

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

@return [::Google::Ads::GoogleAds::V7::Resources::Recommendation]

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

# File lib/google/ads/google_ads/v7/services/recommendation_service/client.rb, line 192
def get_recommendation request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V7::Services::GetRecommendationRequest

  # 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_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 = {
    "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_recommendation.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_recommendation.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

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