Class: Google::Shopping::Merchant::Accounts::V1beta::TermsOfServiceService::Client

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

Overview

Client for the TermsOfServiceService service.

Service to support TermsOfService API.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#account_path, #terms_of_service_path

Constructor Details

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

Create a new TermsOfServiceService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the TermsOfServiceService client.

Yield Parameters:



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
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/google/shopping/merchant/accounts/v1beta/terms_of_service_service/client.rb', line 130

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/accounts/v1beta/termsofservice_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

  @terms_of_service_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Shopping::Merchant::Accounts::V1beta::TermsOfServiceService::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

Class Method Details

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

Configure the TermsOfServiceService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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

def self.configure
  @configure ||= begin
    namespace = ["Google", "Shopping", "Merchant", "Accounts", "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

#accept_terms_of_service(request, options = nil) ⇒ ::Google::Protobuf::Empty #accept_terms_of_service(name: nil, account: nil, region_code: nil) ⇒ ::Google::Protobuf::Empty

Accepts a TermsOfService. Executing this method requires admin access.

Examples:

Basic example

require "google/shopping/merchant/accounts/v1beta"

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

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

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

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #accept_terms_of_service(request, options = nil) ⇒ ::Google::Protobuf::Empty

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

    Parameters:

    • request (::Google::Shopping::Merchant::Accounts::V1beta::AcceptTermsOfServiceRequest, ::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.

  • #accept_terms_of_service(name: nil, account: nil, region_code: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to accept_terms_of_service 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 resource name of the terms of service version. Format: termsOfService/{version}

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

      Required. The account for which to accept the ToS.

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

      Required. Region code as defined by CLDR. This is either a country when the ToS applies specifically to that country or 001 when it applies globally.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
427
428
429
430
431
432
433
 
# File 'lib/google/shopping/merchant/accounts/v1beta/terms_of_service_service/client.rb', line 393

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Accounts::V1beta::AcceptTermsOfServiceRequest

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

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

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

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

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



100
101
102
103
 
# File 'lib/google/shopping/merchant/accounts/v1beta/terms_of_service_service/client.rb', line 100

def configure
  yield @config if block_given?
  @config
end

#get_terms_of_service(request, options = nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::TermsOfService #get_terms_of_service(name: nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::TermsOfService

Retrieves the TermsOfService associated with the provided version.

Examples:

Basic example

require "google/shopping/merchant/accounts/v1beta"

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

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

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

# The returned object is of type Google::Shopping::Merchant::Accounts::V1beta::TermsOfService.
p result

Overloads:

  • #get_terms_of_service(request, options = nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::TermsOfService

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

    Parameters:

    • request (::Google::Shopping::Merchant::Accounts::V1beta::GetTermsOfServiceRequest, ::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.

  • #get_terms_of_service(name: nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::TermsOfService

    Pass arguments to get_terms_of_service 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 resource name of the terms of service version. Format: termsOfService/{version}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



217
218
219
220
221
222
223
224
225
226
227
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
 
# File 'lib/google/shopping/merchant/accounts/v1beta/terms_of_service_service/client.rb', line 217

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Accounts::V1beta::GetTermsOfServiceRequest

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

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

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

#retrieve_latest_terms_of_service(request, options = nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::TermsOfService #retrieve_latest_terms_of_service(region_code: nil, kind: nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::TermsOfService

Retrieves the latest version of the TermsOfService for a given kind and region_code.

Examples:

Basic example

require "google/shopping/merchant/accounts/v1beta"

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

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

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

# The returned object is of type Google::Shopping::Merchant::Accounts::V1beta::TermsOfService.
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.



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/google/shopping/merchant/accounts/v1beta/terms_of_service_service/client.rb', line 308

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Accounts::V1beta::RetrieveLatestTermsOfServiceRequest

  # 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.retrieve_latest_terms_of_service.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::Accounts::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

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

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

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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


110
111
112
 
# File 'lib/google/shopping/merchant/accounts/v1beta/terms_of_service_service/client.rb', line 110

def universe_domain
  @terms_of_service_service_stub.universe_domain
end