Class: Google::Shopping::Merchant::IssueResolution::V1beta::IssueResolutionService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/shopping/merchant/issue_resolution/v1beta/issue_resolution_service/client.rb

Overview

Client for the IssueResolutionService service.

Service to provide an issue resolution content for account issues and product issues.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#account_path, #product_path

Constructor Details

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

Create a new IssueResolutionService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Shopping::Merchant::IssueResolution::V1beta::IssueResolutionService::Client.new

# Create a client using a custom configuration
client = ::Google::Shopping::Merchant::IssueResolution::V1beta::IssueResolutionService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the IssueResolutionService client.

Yield Parameters:



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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/google/shopping/merchant/issue_resolution/v1beta/issue_resolution_service/client.rb', line 131

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/shopping/merchant/issueresolution/v1beta/issueresolution_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

  @issue_resolution_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Shopping::Merchant::IssueResolution::V1beta::IssueResolutionService::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,
    logger: @config.logger
  )

  @issue_resolution_service_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Class Method Details

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

Configure the IssueResolutionService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all IssueResolutionService clients
::Google::Shopping::Merchant::IssueResolution::V1beta::IssueResolutionService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/google/shopping/merchant/issue_resolution/v1beta/issue_resolution_service/client.rb', line 64

def self.configure
  @configure ||= begin
    namespace = ["Google", "Shopping", "Merchant", "IssueResolution", "V1beta"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 60.0
    default_config.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

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



101
102
103
104
 
# File 'lib/google/shopping/merchant/issue_resolution/v1beta/issue_resolution_service/client.rb', line 101

def configure
  yield @config if block_given?
  @config
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


187
188
189
 
# File 'lib/google/shopping/merchant/issue_resolution/v1beta/issue_resolution_service/client.rb', line 187

def logger
  @issue_resolution_service_stub.logger
end

#render_account_issues(request, options = nil) ⇒ ::Google::Shopping::Merchant::IssueResolution::V1beta::RenderAccountIssuesResponse #render_account_issues(name: nil, language_code: nil, time_zone: nil, payload: nil) ⇒ ::Google::Shopping::Merchant::IssueResolution::V1beta::RenderAccountIssuesResponse

Provide a list of business's account issues with an issue resolution content and available actions. This content and actions are meant to be rendered and shown in third-party applications.

Examples:

Basic example

require "google/shopping/merchant/issue_resolution/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Merchant::IssueResolution::V1beta::IssueResolutionService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Merchant::IssueResolution::V1beta::RenderAccountIssuesRequest.new

# Call the render_account_issues method.
result = client. request

# The returned object is of type Google::Shopping::Merchant::IssueResolution::V1beta::RenderAccountIssuesResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/google/shopping/merchant/issue_resolution/v1beta/issue_resolution_service/client.rb', line 250

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::IssueResolution::V1beta::RenderAccountIssuesRequest

  # 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..metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Shopping::Merchant::IssueResolution::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  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..timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs..retry_policy

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

  @issue_resolution_service_stub.call_rpc :render_account_issues, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#render_product_issues(request, options = nil) ⇒ ::Google::Shopping::Merchant::IssueResolution::V1beta::RenderProductIssuesResponse #render_product_issues(name: nil, language_code: nil, time_zone: nil, payload: nil) ⇒ ::Google::Shopping::Merchant::IssueResolution::V1beta::RenderProductIssuesResponse

Provide a list of issues for business's product with an issue resolution content and available actions. This content and actions are meant to be rendered and shown in third-party applications.

Examples:

Basic example

require "google/shopping/merchant/issue_resolution/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Merchant::IssueResolution::V1beta::IssueResolutionService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Merchant::IssueResolution::V1beta::RenderProductIssuesRequest.new

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

# The returned object is of type Google::Shopping::Merchant::IssueResolution::V1beta::RenderProductIssuesResponse.
p result

Overloads:

  • #render_product_issues(request, options = nil) ⇒ ::Google::Shopping::Merchant::IssueResolution::V1beta::RenderProductIssuesResponse

    Pass arguments to render_product_issues via a request object, either of type RenderProductIssuesRequest or an equivalent Hash.

    Parameters:

  • #render_product_issues(name: nil, language_code: nil, time_zone: nil, payload: nil) ⇒ ::Google::Shopping::Merchant::IssueResolution::V1beta::RenderProductIssuesResponse

    Pass arguments to render_product_issues 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:

    • name (::String) (defaults to: nil) —

      Required. The name of the product to fetch issues for. Format: accounts/{account}/products/{product}

    • language_code (::String) (defaults to: nil) —

      Optional. The IETF BCP-47 language code used to localize an issue resolution content. If not set, the result will be in default language en-US.

    • time_zone (::String) (defaults to: nil) —

      Optional. The IANA timezone used to localize times in an issue resolution content. For example 'America/Los_Angeles'. If not set, results will use as a default UTC.

    • payload (::Google::Shopping::Merchant::IssueResolution::V1beta::RenderIssuesRequestPayload, ::Hash) (defaults to: nil) —

      Optional. The payload for configuring how the content should be rendered.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



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
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/google/shopping/merchant/issue_resolution/v1beta/issue_resolution_service/client.rb', line 348

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::IssueResolution::V1beta::RenderProductIssuesRequest

  # 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.render_product_issues.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Shopping::Merchant::IssueResolution::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  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.render_product_issues.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.render_product_issues.retry_policy

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

  @issue_resolution_service_stub.call_rpc :render_product_issues, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#trigger_action(request, options = nil) ⇒ ::Google::Shopping::Merchant::IssueResolution::V1beta::TriggerActionResponse #trigger_action(name: nil, payload: nil, language_code: nil) ⇒ ::Google::Shopping::Merchant::IssueResolution::V1beta::TriggerActionResponse

Start an action. The action can be requested by a business in third-party application. Before the business can request the action, the third-party application needs to show them action specific content and display a user input form.

The action can be successfully started only once all required inputs are provided. If any required input is missing, or invalid value was provided, the service will return 400 error. Validation errors will contain Ids for all problematic field together with translated, human readable error messages that can be shown to the user.

Examples:

Basic example

require "google/shopping/merchant/issue_resolution/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Merchant::IssueResolution::V1beta::IssueResolutionService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Merchant::IssueResolution::V1beta::TriggerActionRequest.new

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

# The returned object is of type Google::Shopping::Merchant::IssueResolution::V1beta::TriggerActionResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/google/shopping/merchant/issue_resolution/v1beta/issue_resolution_service/client.rb', line 450

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::IssueResolution::V1beta::TriggerActionRequest

  # 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.trigger_action.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Shopping::Merchant::IssueResolution::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  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.trigger_action.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.trigger_action.retry_policy

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

  @issue_resolution_service_stub.call_rpc :trigger_action, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


111
112
113
 
# File 'lib/google/shopping/merchant/issue_resolution/v1beta/issue_resolution_service/client.rb', line 111

def universe_domain
  @issue_resolution_service_stub.universe_domain
end