Skip to content

Commit 3d019bf

Browse files
feat: Added the product_id_base64_url_encoded. This allows for product IDs containing special characters to be correctly handled when base64url-encoded (#32169)
PiperOrigin-RevId: 830781196 Source-Link: googleapis/googleapis@5fa0268 Source-Link: googleapis/googleapis-gen@ef0ff8b Copy-Tag: eyJwIjoiZ29vZ2xlLXNob3BwaW5nLW1lcmNoYW50LWludmVudG9yaWVzLXYxLy5Pd2xCb3QueWFtbCIsImgiOiJlZjBmZjhiYjRlYjExZTA4MDYzNzIxNjJlYjQxZjhkYTJiNDc0ZmIxIn0= * 🦉 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 ce284df commit 3d019bf

File tree

12 files changed

+296
-74
lines changed

12 files changed

+296
-74
lines changed

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

Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ def logger
207207
# @param options [::Gapic::CallOptions, ::Hash]
208208
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
209209
#
210-
# @overload list_local_inventories(parent: nil, page_size: nil, page_token: nil)
210+
# @overload list_local_inventories(parent: nil, page_size: nil, page_token: nil, product_id_base64_url_encoded: nil)
211211
# Pass arguments to `list_local_inventories` via keyword arguments. Note that at
212212
# least one keyword argument is required. To specify no parameters, or to keep all
213213
# the default parameter values, pass an empty Hash as a request object (see above).
@@ -230,6 +230,17 @@ def logger
230230
# must match the call that provided the page token. The token returned as
231231
# {::Google::Shopping::Merchant::Inventories::V1::ListLocalInventoriesResponse#next_page_token nextPageToken}
232232
# in the response to the previous request.
233+
# @param product_id_base64_url_encoded [::Boolean]
234+
# Optional. If true, the `{product}` in the `parent` field of the request
235+
# will be interpreted as unpadded base64url-encoded and decoded during
236+
# request processing to match the decoded value. Default value is `false`.
237+
# Use this if your `{product}` contains special characters, such as forward
238+
# slash `/` or other characters that are unpadded base64url-encoded (as per
239+
# RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2).
240+
#
241+
# Note that future versions of the API will only accept unpadded
242+
# base64url-encoded product ids, so we strongly recommend proactively setting
243+
# this to `true` and encoding the product ids.
233244
#
234245
# @yield [response, operation] Access the result along with the RPC operation
235246
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Shopping::Merchant::Inventories::V1::LocalInventory>]
@@ -322,7 +333,7 @@ def list_local_inventories request, options = nil
322333
# @param options [::Gapic::CallOptions, ::Hash]
323334
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
324335
#
325-
# @overload insert_local_inventory(parent: nil, local_inventory: nil)
336+
# @overload insert_local_inventory(parent: nil, local_inventory: nil, product_id_base64_url_encoded: nil)
326337
# Pass arguments to `insert_local_inventory` via keyword arguments. Note that at
327338
# least one keyword argument is required. To specify no parameters, or to keep all
328339
# the default parameter values, pass an empty Hash as a request object (see above).
@@ -334,6 +345,17 @@ def list_local_inventories request, options = nil
334345
# Required. Local inventory information of the product. If the product
335346
# already has a `LocalInventory` resource for the same `storeCode`, full
336347
# replacement of the `LocalInventory` resource is performed.
348+
# @param product_id_base64_url_encoded [::Boolean]
349+
# Optional. If true, the `{product}` in the `parent` field of the request
350+
# will be interpreted as unpadded base64url-encoded and decoded during
351+
# request processing to match the decoded value. Default value is `false`.
352+
# Use this if your `{product}` contains special characters, such as forward
353+
# slash `/` or other characters that are unpadded base64url-encoded (as per
354+
# RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2).
355+
#
356+
# Note that future versions of the API will only accept unpadded
357+
# base64url-encoded product ids, so we strongly recommend proactively setting
358+
# this to `true` and encoding the product ids.
337359
#
338360
# @yield [response, operation] Access the result along with the RPC operation
339361
# @yieldparam response [::Google::Shopping::Merchant::Inventories::V1::LocalInventory]
@@ -416,7 +438,7 @@ def insert_local_inventory request, options = nil
416438
# @param options [::Gapic::CallOptions, ::Hash]
417439
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
418440
#
419-
# @overload delete_local_inventory(name: nil)
441+
# @overload delete_local_inventory(name: nil, product_id_base64_url_encoded: nil)
420442
# Pass arguments to `delete_local_inventory` via keyword arguments. Note that at
421443
# least one keyword argument is required. To specify no parameters, or to keep all
422444
# the default parameter values, pass an empty Hash as a request object (see above).
@@ -425,6 +447,17 @@ def insert_local_inventory request, options = nil
425447
# Required. The name of the local inventory for the given product to delete.
426448
# Format:
427449
# `accounts/{account}/products/{product}/localInventories/{store_code}`
450+
# @param product_id_base64_url_encoded [::Boolean]
451+
# Optional. If true, the `{product}` in the `name` field of the request will
452+
# be interpreted as unpadded base64url-encoded and decoded during request
453+
# processing to match the decoded value. Default value is `false`. Use this
454+
# if your `{product}` contains special characters, such as forward slash `/`
455+
# or other characters that are unpadded base64url-encoded (as per RFC 7515:
456+
# https://datatracker.ietf.org/doc/html/rfc7515#section-2).
457+
#
458+
# Note that future versions of the API will only accept unpadded
459+
# base64url-encoded product ids, so we strongly recommend proactively setting
460+
# this to `true` and encoding the product ids.
428461
#
429462
# @yield [response, operation] Access the result along with the RPC operation
430463
# @yieldparam response [::Google::Protobuf::Empty]

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

Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ def logger
200200
# @param options [::Gapic::CallOptions, ::Hash]
201201
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
202202
#
203-
# @overload list_local_inventories(parent: nil, page_size: nil, page_token: nil)
203+
# @overload list_local_inventories(parent: nil, page_size: nil, page_token: nil, product_id_base64_url_encoded: nil)
204204
# Pass arguments to `list_local_inventories` via keyword arguments. Note that at
205205
# least one keyword argument is required. To specify no parameters, or to keep all
206206
# the default parameter values, pass an empty Hash as a request object (see above).
@@ -223,6 +223,17 @@ def logger
223223
# must match the call that provided the page token. The token returned as
224224
# {::Google::Shopping::Merchant::Inventories::V1::ListLocalInventoriesResponse#next_page_token nextPageToken}
225225
# in the response to the previous request.
226+
# @param product_id_base64_url_encoded [::Boolean]
227+
# Optional. If true, the `{product}` in the `parent` field of the request
228+
# will be interpreted as unpadded base64url-encoded and decoded during
229+
# request processing to match the decoded value. Default value is `false`.
230+
# Use this if your `{product}` contains special characters, such as forward
231+
# slash `/` or other characters that are unpadded base64url-encoded (as per
232+
# RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2).
233+
#
234+
# Note that future versions of the API will only accept unpadded
235+
# base64url-encoded product ids, so we strongly recommend proactively setting
236+
# this to `true` and encoding the product ids.
226237
# @yield [result, operation] Access the result along with the TransportOperation object
227238
# @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Shopping::Merchant::Inventories::V1::LocalInventory>]
228239
# @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -308,7 +319,7 @@ def list_local_inventories request, options = nil
308319
# @param options [::Gapic::CallOptions, ::Hash]
309320
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
310321
#
311-
# @overload insert_local_inventory(parent: nil, local_inventory: nil)
322+
# @overload insert_local_inventory(parent: nil, local_inventory: nil, product_id_base64_url_encoded: nil)
312323
# Pass arguments to `insert_local_inventory` via keyword arguments. Note that at
313324
# least one keyword argument is required. To specify no parameters, or to keep all
314325
# the default parameter values, pass an empty Hash as a request object (see above).
@@ -320,6 +331,17 @@ def list_local_inventories request, options = nil
320331
# Required. Local inventory information of the product. If the product
321332
# already has a `LocalInventory` resource for the same `storeCode`, full
322333
# replacement of the `LocalInventory` resource is performed.
334+
# @param product_id_base64_url_encoded [::Boolean]
335+
# Optional. If true, the `{product}` in the `parent` field of the request
336+
# will be interpreted as unpadded base64url-encoded and decoded during
337+
# request processing to match the decoded value. Default value is `false`.
338+
# Use this if your `{product}` contains special characters, such as forward
339+
# slash `/` or other characters that are unpadded base64url-encoded (as per
340+
# RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2).
341+
#
342+
# Note that future versions of the API will only accept unpadded
343+
# base64url-encoded product ids, so we strongly recommend proactively setting
344+
# this to `true` and encoding the product ids.
323345
# @yield [result, operation] Access the result along with the TransportOperation object
324346
# @yieldparam result [::Google::Shopping::Merchant::Inventories::V1::LocalInventory]
325347
# @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -395,7 +417,7 @@ def insert_local_inventory request, options = nil
395417
# @param options [::Gapic::CallOptions, ::Hash]
396418
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
397419
#
398-
# @overload delete_local_inventory(name: nil)
420+
# @overload delete_local_inventory(name: nil, product_id_base64_url_encoded: nil)
399421
# Pass arguments to `delete_local_inventory` via keyword arguments. Note that at
400422
# least one keyword argument is required. To specify no parameters, or to keep all
401423
# the default parameter values, pass an empty Hash as a request object (see above).
@@ -404,6 +426,17 @@ def insert_local_inventory request, options = nil
404426
# Required. The name of the local inventory for the given product to delete.
405427
# Format:
406428
# `accounts/{account}/products/{product}/localInventories/{store_code}`
429+
# @param product_id_base64_url_encoded [::Boolean]
430+
# Optional. If true, the `{product}` in the `name` field of the request will
431+
# be interpreted as unpadded base64url-encoded and decoded during request
432+
# processing to match the decoded value. Default value is `false`. Use this
433+
# if your `{product}` contains special characters, such as forward slash `/`
434+
# or other characters that are unpadded base64url-encoded (as per RFC 7515:
435+
# https://datatracker.ietf.org/doc/html/rfc7515#section-2).
436+
#
437+
# Note that future versions of the API will only accept unpadded
438+
# base64url-encoded product ids, so we strongly recommend proactively setting
439+
# this to `true` and encoding the product ids.
407440
# @yield [result, operation] Access the result along with the TransportOperation object
408441
# @yieldparam result [::Google::Protobuf::Empty]
409442
# @yieldparam operation [::Gapic::Rest::TransportOperation]

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

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

0 commit comments

Comments
 (0)