Skip to content

Commit 75717da

Browse files
docs: A comment for field name in message .google.shopping.merchant.products.v1.LocalInventory is changed (#33825)
* docs: A comment for field `name` in message `.google.shopping.merchant.products.v1.LocalInventory` is changed docs: A comment for field `name` in message `.google.shopping.merchant.products.v1.RegionalInventory` is changed feat: a new field `base64_encoded_name` is added to the `LocalInventory` message feat: new field `base64_encoded_name` is added to the `RegionalInventory` message PiperOrigin-RevId: 897575741 Source-Link: googleapis/googleapis@6db5d2e Source-Link: googleapis/googleapis-gen@6203224 Copy-Tag: eyJwIjoiZ29vZ2xlLXNob3BwaW5nLW1lcmNoYW50LWludmVudG9yaWVzLXYxLy5Pd2xCb3QueWFtbCIsImgiOiI2MjAzMjI0MDMwM2ExOTcwN2I0Y2UwYWRlNjAyOGI1OGVmOWY3NGNjIn0= * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 03442a5 commit 75717da

10 files changed

Lines changed: 725 additions & 4 deletions

File tree

google-shopping-merchant-inventories-v1/lib/google/shopping/merchant/inventories/v1/inventories_common_pb.rb

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

google-shopping-merchant-inventories-v1/lib/google/shopping/merchant/inventories/v1/local_inventory_service/client.rb

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,36 @@ def logger
216216
# Required. The `name` of the parent product to list local inventories for.
217217
# Format:
218218
# `accounts/{account}/products/{product}`
219+
#
220+
# The `{product}` segment is a unique identifier for the product.
221+
# This identifier must be unique within a merchant account and generally
222+
# follows the structure: `content_language~feed_label~offer_id`. Example:
223+
# `en~US~sku123` For legacy local products, the structure is:
224+
# `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123`
225+
#
226+
# The format of the `{product}` segment in the URL is automatically detected
227+
# by the server, supporting two options:
228+
#
229+
# 1. **Encoded Format**: The `{product}` segment is an unpadded base64url
230+
# encoded string (RFC 4648 Section 5). The decoded string must result
231+
# in the `content_language~feed_label~offer_id` structure. This encoding
232+
# MUST be used if any part of the product identifier (like `offer_id`)
233+
# contains characters such as `/`, `%`, or `~`.
234+
# * Example: To represent the product ID `en~US~sku/123`, the
235+
# `{product}` segment must be the unpadded base64url encoding of this
236+
# string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name
237+
# for the product would be
238+
# `accounts/123/products/ZW5-VVN-c2t1LzEyMw`.
239+
#
240+
# 2. **Plain Format**: The `{product}` segment is the tilde-separated string
241+
# `content_language~feed_label~offer_id`. This format is suitable only
242+
# when `content_language`, `feed_label`, and `offer_id` do not contain
243+
# URL-problematic characters like `/`, `%`, or `~`.
244+
#
245+
# We recommend using the **Encoded Format** for all product IDs to ensure
246+
# correct parsing, especially those containing special characters. The
247+
# presence of tilde (`~`) characters in the `{product}` segment is used to
248+
# differentiate between the two formats.
219249
# @param page_size [::Integer]
220250
# The maximum number of `LocalInventory` resources for the given
221251
# product to return. The service returns fewer than this value if the number
@@ -330,6 +360,36 @@ def list_local_inventories request, options = nil
330360
# @param parent [::String]
331361
# Required. The account and product where this inventory will be inserted.
332362
# Format: `accounts/{account}/products/{product}`
363+
#
364+
# The `{product}` segment is a unique identifier for the product.
365+
# This identifier must be unique within a merchant account and generally
366+
# follows the structure: `content_language~feed_label~offer_id`. Example:
367+
# `en~US~sku123` For legacy local products, the structure is:
368+
# `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123`
369+
#
370+
# The format of the `{product}` segment in the URL is automatically detected
371+
# by the server, supporting two options:
372+
#
373+
# 1. **Encoded Format**: The `{product}` segment is an unpadded base64url
374+
# encoded string (RFC 4648 Section 5). The decoded string must result
375+
# in the `content_language~feed_label~offer_id` structure. This encoding
376+
# MUST be used if any part of the product identifier (like `offer_id`)
377+
# contains characters such as `/`, `%`, or `~`.
378+
# * Example: To represent the product ID `en~US~sku/123`, the
379+
# `{product}` segment must be the unpadded base64url encoding of this
380+
# string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name
381+
# for the product would be
382+
# `accounts/123/products/ZW5-VVN-c2t1LzEyMw`.
383+
#
384+
# 2. **Plain Format**: The `{product}` segment is the tilde-separated string
385+
# `content_language~feed_label~offer_id`. This format is suitable only
386+
# when `content_language`, `feed_label`, and `offer_id` do not contain
387+
# URL-problematic characters like `/`, `%`, or `~`.
388+
#
389+
# We recommend using the **Encoded Format** for all product IDs to ensure
390+
# correct parsing, especially those containing special characters. The
391+
# presence of tilde (`~`) characters in the `{product}` segment is used to
392+
# differentiate between the two formats.
333393
# @param local_inventory [::Google::Shopping::Merchant::Inventories::V1::LocalInventory, ::Hash]
334394
# Required. Local inventory information of the product. If the product
335395
# already has a `LocalInventory` resource for the same `storeCode`, full
@@ -426,6 +486,37 @@ def insert_local_inventory request, options = nil
426486
# Format:
427487
# `accounts/{account}/products/{product}/localInventories/{store_code}`
428488
#
489+
# The `{product}` segment is a unique identifier for the product.
490+
# This identifier must be unique within a merchant account and generally
491+
# follows the structure: `content_language~feed_label~offer_id`. Example:
492+
# `en~US~sku123` For legacy local products, the structure is:
493+
# `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123`
494+
#
495+
# The format of the `{product}` segment in the URL is automatically detected
496+
# by the server, supporting two options:
497+
#
498+
# 1. **Encoded Format**: The `{product}` segment is an unpadded base64url
499+
# encoded string (RFC 4648 Section 5). The decoded string must result
500+
# in the `content_language~feed_label~offer_id` structure. This encoding
501+
# MUST be used if any part of the product identifier (like `offer_id`)
502+
# contains characters such as `/`, `%`, or `~`.
503+
# * Example: To represent the product ID `en~US~sku/123` for
504+
# `store_code` "store123", the `{product}` segment must be the
505+
# unpadded base64url encoding of this string, which is
506+
# `ZW5-VVN-c2t1LzEyMw`. The full resource name for the local
507+
# inventory would be
508+
# `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123`.
509+
#
510+
# 2. **Plain Format**: The `{product}` segment is the tilde-separated string
511+
# `content_language~feed_label~offer_id`. This format is suitable only
512+
# when `content_language`, `feed_label`, and `offer_id` do not contain
513+
# URL-problematic characters like `/`, `%`, or `~`.
514+
#
515+
# We recommend using the **Encoded Format** for all product IDs to ensure
516+
# correct parsing, especially those containing special characters. The
517+
# presence of tilde (`~`) characters in the `{product}` segment is used to
518+
# differentiate between the two formats.
519+
#
429520
# @yield [response, operation] Access the result along with the RPC operation
430521
# @yieldparam response [::Google::Protobuf::Empty]
431522
# @yieldparam operation [::GRPC::ActiveCall::Operation]

0 commit comments

Comments
 (0)