Class: Google::Shopping::Merchant::Accounts::V1beta::RegionsService::Rest::Client

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

Overview

REST client for the RegionsService service.

Manages regions configuration.

This API defines the following resource model:

  • [Region][google.shopping.merchant.accounts.v1main.Region]

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#account_path, #region_path

Constructor Details

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

Create a new RegionsService REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the RegionsService client.

Yield Parameters:



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
 
# File 'lib/google/shopping/merchant/accounts/v1beta/regions_service/rest/client.rb', line 136

def initialize
  # 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

  @regions_service_stub = ::Google::Shopping::Merchant::Accounts::V1beta::RegionsService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials
  )
end

Class Method Details

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

Configure the RegionsService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/google/shopping/merchant/accounts/v1beta/regions_service/rest/client.rb', line 69

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

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

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



106
107
108
109
 
# File 'lib/google/shopping/merchant/accounts/v1beta/regions_service/rest/client.rb', line 106

def configure
  yield @config if block_given?
  @config
end

#create_region(request, options = nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::Region #create_region(parent: nil, region_id: nil, region: nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::Region

Creates a region definition in your Merchant Center account. 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::RegionsService::Rest::Client.new

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

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

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

Overloads:

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

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

    Parameters:

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

  • #create_region(parent: nil, region_id: nil, region: nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::Region

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

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

      Required. The account to create a region for. Format: accounts/{account}

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

      Required. The identifier for the region, unique over all regions of the same account.

    • region (::Google::Shopping::Merchant::Accounts::V1beta::Region, ::Hash) (defaults to: nil) —

      Required. The region to create.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
329
330
331
332
333
 
# File 'lib/google/shopping/merchant/accounts/v1beta/regions_service/rest/client.rb', line 299

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

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

  # 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
  call_metadata = @config.rpcs.create_region.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_region.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_region.retry_policy

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

  @regions_service_stub.create_region request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_region(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_region(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a region definition from your Merchant Center account. 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::RegionsService::Rest::Client.new

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

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

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

Overloads:

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

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

    Parameters:

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

  • #delete_region(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_region 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 region to delete. Format: accounts/{account}/regions/{region}

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
490
491
492
493
494
495
496
497
498
 
# File 'lib/google/shopping/merchant/accounts/v1beta/regions_service/rest/client.rb', line 464

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

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

  # 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
  call_metadata = @config.rpcs.delete_region.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_region.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_region.retry_policy

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

  @regions_service_stub.delete_region request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Retrieves a region defined in your Merchant Center account.

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

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

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Shopping::Merchant::Accounts::V1beta::GetRegionRequest, ::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_region(name: nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::Region

    Pass arguments to get_region 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 region to retrieve. Format: accounts/{account}/regions/{region}

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



213
214
215
216
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
 
# File 'lib/google/shopping/merchant/accounts/v1beta/regions_service/rest/client.rb', line 213

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

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

  # 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
  call_metadata = @config.rpcs.get_region.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_region.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_region.retry_policy

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

  @regions_service_stub.get_region request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_regions(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Shopping::Merchant::Accounts::V1beta::Region> #list_regions(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Shopping::Merchant::Accounts::V1beta::Region>

Lists the regions in your Merchant Center account.

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

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Shopping::Merchant::Accounts::V1beta::Region.
  p item
end

Overloads:

  • #list_regions(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Shopping::Merchant::Accounts::V1beta::Region>

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

    Parameters:

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

  • #list_regions(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Shopping::Merchant::Accounts::V1beta::Region>

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

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

      Required. The account to list regions for. Format: accounts/{account}

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

      Optional. The maximum number of regions to return. The service may return fewer than this value. If unspecified, at most 50 regions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

      Optional. A page token, received from a previous ListRegions call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters provided to ListRegions must match the call that provided the page token.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
 
# File 'lib/google/shopping/merchant/accounts/v1beta/regions_service/rest/client.rb', line 559

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

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

  # 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
  call_metadata = @config.rpcs.list_regions.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_regions.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_regions.retry_policy

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

  @regions_service_stub.list_regions request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @regions_service_stub, :list_regions, "regions", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


116
117
118
 
# File 'lib/google/shopping/merchant/accounts/v1beta/regions_service/rest/client.rb', line 116

def universe_domain
  @regions_service_stub.universe_domain
end

#update_region(request, options = nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::Region #update_region(region: nil, update_mask: nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::Region

Updates a region definition in your Merchant Center account. 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::RegionsService::Rest::Client.new

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

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

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

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



383
384
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
 
# File 'lib/google/shopping/merchant/accounts/v1beta/regions_service/rest/client.rb', line 383

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

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

  # 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
  call_metadata = @config.rpcs.update_region.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_region.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_region.retry_policy

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

  @regions_service_stub.update_region request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end