Class: Google::Shopping::Merchant::Inventories::V1::RegionalInventoryService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/shopping/merchant/inventories/v1/regional_inventory_service/client.rb

Overview

Client for the RegionalInventoryService service.

Service to manage regional inventory for products. There is also separate regions resource and API to manage regions definitions.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#product_path, #regional_inventory_path

Constructor Details

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

Create a new RegionalInventoryService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Shopping::Merchant::Inventories::V1::RegionalInventoryService::Client.new

# Create a client using a custom configuration
client = ::Google::Shopping::Merchant::Inventories::V1::RegionalInventoryService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the RegionalInventoryService 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/inventories/v1/regional_inventory_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/inventories/v1/regionalinventory_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

  @regional_inventory_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Shopping::Merchant::Inventories::V1::RegionalInventoryService::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
  )

  @regional_inventory_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 RegionalInventoryService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all RegionalInventoryService clients
::Google::Shopping::Merchant::Inventories::V1::RegionalInventoryService::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/inventories/v1/regional_inventory_service/client.rb', line 64

def self.configure
  @configure ||= begin
    namespace = ["Google", "Shopping", "Merchant", "Inventories", "V1"]
    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 RegionalInventoryService 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/inventories/v1/regional_inventory_service/client.rb', line 101

def configure
  yield @config if block_given?
  @config
end

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

Deletes the specified RegionalInventory resource from the given product in your merchant account. It might take up to an hour for the RegionalInventory to be deleted from the specific product. Once you have received a successful delete response, wait for that period before attempting a delete again.

Examples:

Basic example

require "google/shopping/merchant/inventories/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Merchant::Inventories::V1::RegionalInventoryService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Merchant::Inventories::V1::DeleteRegionalInventoryRequest.new

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Shopping::Merchant::Inventories::V1::DeleteRegionalInventoryRequest, ::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_regional_inventory(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_regional_inventory 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 RegionalInventory resource to delete. Format: accounts/{account}/products/{product}/regionalInventories/{region}

      The {product} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: content_language~feed_label~offer_id. Example: en~US~sku123 For legacy local products, the structure is: local~content_language~feed_label~offer_id. Example: local~en~US~sku123

      The format of the {product} segment in the URL is automatically detected by the server, supporting two options:

      1. Encoded Format: The {product} segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the content_language~feed_label~offer_id structure. This encoding MUST be used if any part of the product identifier (like offer_id) contains characters such as /, %, or ~.

        • Example: To represent the product ID en~US~sku/123 for region "region123", the {product} segment must be the unpadded base64url encoding of this string, which is ZW5-VVN-c2t1LzEyMw. The full resource name for the regional inventory would be accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123.

      2. Plain Format: The {product} segment is the tilde-separated string content_language~feed_label~offer_id. This format is suitable only when content_language, feed_label, and offer_id do not contain URL-problematic characters like /, %, or ~.

      We recommend using the Encoded Format for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (~) characters in the {product} segment is used to differentiate between the two formats.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



546
547
548
549
550
551
552
553
554
555
556
557
558
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
 
# File 'lib/google/shopping/merchant/inventories/v1/regional_inventory_service/client.rb', line 546

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Inventories::V1::DeleteRegionalInventoryRequest

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

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

  @regional_inventory_service_stub.call_rpc :delete_regional_inventory, 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

#insert_regional_inventory(request, options = nil) ⇒ ::Google::Shopping::Merchant::Inventories::V1::RegionalInventory #insert_regional_inventory(parent: nil, regional_inventory: nil) ⇒ ::Google::Shopping::Merchant::Inventories::V1::RegionalInventory

Inserts a RegionalInventory to a given product in your merchant account.

Replaces the full RegionalInventory resource if an entry with the same `region` already exists for the product.

It might take up to 30 minutes for the new or updated RegionalInventory resource to appear in products.

Examples:

Basic example

require "google/shopping/merchant/inventories/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Merchant::Inventories::V1::RegionalInventoryService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Merchant::Inventories::V1::InsertRegionalInventoryRequest.new

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

# The returned object is of type Google::Shopping::Merchant::Inventories::V1::RegionalInventory.
p result

Overloads:

  • #insert_regional_inventory(request, options = nil) ⇒ ::Google::Shopping::Merchant::Inventories::V1::RegionalInventory

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

    Parameters:

    • request (::Google::Shopping::Merchant::Inventories::V1::InsertRegionalInventoryRequest, ::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.

  • #insert_regional_inventory(parent: nil, regional_inventory: nil) ⇒ ::Google::Shopping::Merchant::Inventories::V1::RegionalInventory

    Pass arguments to insert_regional_inventory 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 and product where this inventory will be inserted. Format: accounts/{account}/products/{product}

      The {product} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: content_language~feed_label~offer_id. Example: en~US~sku123 For legacy local products, the structure is: local~content_language~feed_label~offer_id. Example: local~en~US~sku123

      The format of the {product} segment in the URL is automatically detected by the server, supporting two options:

      1. Encoded Format: The {product} segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the content_language~feed_label~offer_id structure. This encoding MUST be used if any part of the product identifier (like offer_id) contains characters such as /, %, or ~.

        • Example: To represent the product ID en~US~sku/123, the {product} segment must be the unpadded base64url encoding of this string, which is ZW5-VVN-c2t1LzEyMw. The full resource name for the product would be accounts/123/products/ZW5-VVN-c2t1LzEyMw.

      2. Plain Format: The {product} segment is the tilde-separated string content_language~feed_label~offer_id. This format is suitable only when content_language, feed_label, and offer_id do not contain URL-problematic characters like /, %, or ~.

      We recommend using the Encoded Format for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (~) characters in the {product} segment is used to differentiate between the two formats.

    • regional_inventory (::Google::Shopping::Merchant::Inventories::V1::RegionalInventory, ::Hash) (defaults to: nil) —

      Required. Regional inventory information to add to the product. If the product already has a RegionalInventory resource for the same region, full replacement of the RegionalInventory resource is performed.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/google/shopping/merchant/inventories/v1/regional_inventory_service/client.rb', line 423

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Inventories::V1::InsertRegionalInventoryRequest

  # 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.insert_regional_inventory.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::Inventories::V1::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.parent
    header_params["parent"] = request.parent
  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.insert_regional_inventory.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.insert_regional_inventory.retry_policy

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

  @regional_inventory_service_stub.call_rpc :insert_regional_inventory, 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

#list_regional_inventories(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Shopping::Merchant::Inventories::V1::RegionalInventory> #list_regional_inventories(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Shopping::Merchant::Inventories::V1::RegionalInventory>

Lists the RegionalInventory resources for the given product in your merchant account. The response might contain fewer items than specified by pageSize. If pageToken was returned in previous request, it can be used to obtain additional results.

RegionalInventory resources are listed per product for a given account.

Examples:

Basic example

require "google/shopping/merchant/inventories/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Merchant::Inventories::V1::RegionalInventoryService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Merchant::Inventories::V1::ListRegionalInventoriesRequest.new

# Call the list_regional_inventories method.
result = client.list_regional_inventories 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::Inventories::V1::RegionalInventory.
  p item
end

Overloads:

  • #list_regional_inventories(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Shopping::Merchant::Inventories::V1::RegionalInventory>

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

    Parameters:

    • request (::Google::Shopping::Merchant::Inventories::V1::ListRegionalInventoriesRequest, ::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_regional_inventories(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Shopping::Merchant::Inventories::V1::RegionalInventory>

    Pass arguments to list_regional_inventories 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 name of the parent product to list RegionalInventory resources for. Format: accounts/{account}/products/{product}

      The {product} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: content_language~feed_label~offer_id. Example: en~US~sku123 For legacy local products, the structure is: local~content_language~feed_label~offer_id. Example: local~en~US~sku123

      The format of the {product} segment in the URL is automatically detected by the server, supporting two options:

      1. Encoded Format: The {product} segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the content_language~feed_label~offer_id structure. This encoding MUST be used if any part of the product identifier (like offer_id) contains characters such as /, %, or ~.

        • Example: To represent the product ID en~US~sku/123, the {product} segment must be the unpadded base64url encoding of this string, which is ZW5-VVN-c2t1LzEyMw. The full resource name for the product would be accounts/123/products/ZW5-VVN-c2t1LzEyMw.

      2. Plain Format: The {product} segment is the tilde-separated string content_language~feed_label~offer_id. This format is suitable only when content_language, feed_label, and offer_id do not contain URL-problematic characters like /, %, or ~.

      We recommend using the Encoded Format for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (~) characters in the {product} segment is used to differentiate between the two formats.

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

      The maximum number of RegionalInventory resources for the given product to return. The service returns fewer than this value if the number of inventories for the given product is less that than the pageSize. The default value is 25000. The maximum value is 100000; If a value higher than the maximum is specified, then the pageSize will default to the maximum.

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

      A page token, received from a previous ListRegionalInventories call. Provide the page token to retrieve the subsequent page.

      When paginating, all other parameters provided to ListRegionalInventories must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



292
293
294
295
296
297
298
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/inventories/v1/regional_inventory_service/client.rb', line 292

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Inventories::V1::ListRegionalInventoriesRequest

  # 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.list_regional_inventories.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::Inventories::V1::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.parent
    header_params["parent"] = request.parent
  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.list_regional_inventories.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_regional_inventories.retry_policy

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

  @regional_inventory_service_stub.call_rpc :list_regional_inventories, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @regional_inventory_service_stub, :list_regional_inventories, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


187
188
189
 
# File 'lib/google/shopping/merchant/inventories/v1/regional_inventory_service/client.rb', line 187

def logger
  @regional_inventory_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


111
112
113
 
# File 'lib/google/shopping/merchant/inventories/v1/regional_inventory_service/client.rb', line 111

def universe_domain
  @regional_inventory_service_stub.universe_domain
end