feat: Added the product_id_base64_url_encoded field to ListLocalInventoriesRequest, InsertLocalInventoryRequest, DeleteLocalInventoryRequest, ListRegionalInventoriesRequest, InsertRegionalInventoryRequest, and DeleteRegionalInventoryRequest. This allows for product IDs containing special characters to be correctly handled when base64url-encoded

Google APIs · copybara-github · commit 3a8b8ddf8958 · 2025-11-11T00:24:22.000-08:00
feat: Added C#, PHP, and Ruby namespace options to LocalInventory and RegionalInventory proto files for improved client library generation
docs: Updated the API summary and overview in the service configuration

PiperOrigin-RevId: 830781339
diff --git a/google/shopping/merchant/inventories/v1beta/localinventory.proto b/google/shopping/merchant/inventories/v1beta/localinventory.proto
@@ -24,10 +24,13 @@ import "google/protobuf/empty.proto";
 import "google/shopping/type/types.proto";
 import "google/type/interval.proto";
 
+option csharp_namespace = "Google.Shopping.Merchant.Inventories.V1Beta";
 option go_package = "cloud.google.com/go/shopping/merchant/inventories/apiv1beta/inventoriespb;inventoriespb";
 option java_multiple_files = true;
 option java_outer_classname = "LocalInventoryProto";
 option java_package = "com.google.shopping.merchant.inventories.v1beta";
+option php_namespace = "Google\\Shopping\\Merchant\\Inventories\\V1beta";
+option ruby_package = "Google::Shopping::Merchant::Inventories::V1beta";
 option (google.api.resource_definition) = {
   type: "merchantapi.googleapis.com/Product"
   pattern: "accounts/{account}/products/{product}"
@@ -113,17 +116,19 @@ message LocalInventory {
     (google.api.field_behavior) = IMMUTABLE
   ];
 
-  // Price of the product at this store.
-  google.shopping.type.Price price = 4;
+  // Optional. Price of the product at this store.
+  google.shopping.type.Price price = 4 [(google.api.field_behavior) = OPTIONAL];
 
-  // Sale price of the product at this store. Mandatory if
+  // Optional. Sale price of the product at this store. Mandatory if
   // [`salePriceEffectiveDate`][google.shopping.merchant.inventories.v1beta.LocalInventory.sale_price_effective_date]
   // is defined.
-  google.shopping.type.Price sale_price = 5;
+  google.shopping.type.Price sale_price = 5
+      [(google.api.field_behavior) = OPTIONAL];
 
-  // The `TimePeriod` of the
+  // Optional. The `TimePeriod` of the
   // sale at this store.
-  google.type.Interval sale_price_effective_date = 6;
+  google.type.Interval sale_price_effective_date = 6
+      [(google.api.field_behavior) = OPTIONAL];
 
   // Availability of the product at this store.
   // For accepted attribute values, see the [local product inventory data
@@ -154,7 +159,8 @@ message LocalInventory {
   // A list of custom (merchant-provided) attributes. You can also use
   // `CustomAttribute` to submit any attribute of the data specification in its
   // generic form.
-  repeated google.shopping.type.CustomAttribute custom_attributes = 12;
+  repeated google.shopping.type.CustomAttribute custom_attributes = 12
+      [deprecated = true];
 }
 
 // Request message for the `ListLocalInventories` method.
@@ -184,6 +190,19 @@ message ListLocalInventoriesRequest {
   // [nextPageToken][google.shopping.merchant.inventories.v1beta.ListLocalInventoriesResponse.next_page_token]
   // in the response to the previous request.
   string page_token = 3;
+
+  // Optional. If true, the `{product}` in the `parent` field of the request
+  // will be interpreted as unpadded base64url-encoded and decoded during
+  // request processing to match the decoded value. Default value is `false`.
+  // Use this if your `{product}` contains special characters, such as forward
+  // slash `/` or other characters that are unpadded base64url-encoded (as per
+  // RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2).
+  //
+  // Note that future versions of the API will only accept unpadded
+  // base64url-encoded product ids, so we strongly recommend proactively setting
+  // this to `true` and encoding the product ids.
+  bool product_id_base64_url_encoded = 4
+      [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Response message for the `ListLocalInventories` method.
@@ -212,6 +231,19 @@ message InsertLocalInventoryRequest {
   // already has a `LocalInventory` resource for the same `storeCode`, full
   // replacement of the `LocalInventory` resource is performed.
   LocalInventory local_inventory = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Optional. If true, the `{product}` in the `parent` field of the request
+  // will be interpreted as unpadded base64url-encoded and decoded during
+  // request processing to match the decoded value. Default value is `false`.
+  // Use this if your `{product}` contains special characters, such as forward
+  // slash `/` or other characters that are unpadded base64url-encoded (as per
+  // RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2).
+  //
+  // Note that future versions of the API will only accept unpadded
+  // base64url-encoded product ids, so we strongly recommend proactively setting
+  // this to `true` and encoding the product ids.
+  bool product_id_base64_url_encoded = 3
+      [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Request message for the `DeleteLocalInventory` method.
@@ -225,4 +257,17 @@ message DeleteLocalInventoryRequest {
       type: "merchantapi.googleapis.com/LocalInventory"
     }
   ];
+
+  // Optional. If true, the `{product}` in the `name` field of the request will
+  // be interpreted as unpadded base64url-encoded and decoded during request
+  // processing to match the decoded value. Default value is `false`. Use this
+  // if your `{product}` contains special characters, such as forward slash `/`
+  // or other characters that are unpadded base64url-encoded (as per RFC 7515:
+  // https://datatracker.ietf.org/doc/html/rfc7515#section-2).
+  //
+  // Note that future versions of the API will only accept unpadded
+  // base64url-encoded product ids, so we strongly recommend proactively setting
+  // this to `true` and encoding the product ids.
+  bool product_id_base64_url_encoded = 2
+      [(google.api.field_behavior) = OPTIONAL];
 }
diff --git a/google/shopping/merchant/inventories/v1beta/merchantapi_v1beta.yaml b/google/shopping/merchant/inventories/v1beta/merchantapi_v1beta.yaml
@@ -8,7 +8,23 @@ apis:
 - name: google.shopping.merchant.inventories.v1beta.RegionalInventoryService
 
 documentation:
-  summary: Programmatically manage your Merchant Center accounts.
+  summary: Programmatically manage your Merchant Center Accounts.
+  overview: |-
+    Merchant API consists of multiple Sub-APIs. Accounts Sub-API: Enables you
+    to programmatically manage your accounts. Conversions Sub-API: Enables you
+    to programmatically manage your conversion sources for a merchant account.
+    Datasources Sub-API: Enables you to programmatically manage your
+    datasources. Inventories Sub-API: This bundle enables you to
+    programmatically manage your local and regional inventories. Local Feeds
+    Partnerships Sub-API: This bundle enables LFP partners to submit local
+    inventories for a merchant. Notifications Sub-API: This bundle enables you
+    to programmatically manage your notification subscriptions. Products
+    Sub-API: This bundle enables you to programmatically manage your products.
+    Promotions Sub-API: This bundle enables you to programmatically manage
+    your promotions for products. Quota Sub-API: This bundle enables you to
+    list your quotas for all APIs you are using. Reports Sub-API: This bundle
+    enables you to programmatically retrieve reports and insights about
+    products, their performance and their competitive environment.
 
 authentication:
   rules:
diff --git a/google/shopping/merchant/inventories/v1beta/regionalinventory.proto b/google/shopping/merchant/inventories/v1beta/regionalinventory.proto
@@ -24,10 +24,13 @@ import "google/protobuf/empty.proto";
 import "google/shopping/type/types.proto";
 import "google/type/interval.proto";
 
+option csharp_namespace = "Google.Shopping.Merchant.Inventories.V1Beta";
 option go_package = "cloud.google.com/go/shopping/merchant/inventories/apiv1beta/inventoriespb;inventoriespb";
 option java_multiple_files = true;
 option java_outer_classname = "RegionalInventoryProto";
 option java_package = "com.google.shopping.merchant.inventories.v1beta";
+option php_namespace = "Google\\Shopping\\Merchant\\Inventories\\V1beta";
+option ruby_package = "Google::Shopping::Merchant::Inventories::V1beta";
 
 // Service to manage regional inventory for products. There is also separate
 // `regions` resource and API to manage regions definitions.
@@ -110,27 +113,30 @@ message RegionalInventory {
     (google.api.field_behavior) = IMMUTABLE
   ];
 
-  // Price of the product in this region.
-  google.shopping.type.Price price = 4;
+  // Optional. Price of the product in this region.
+  google.shopping.type.Price price = 4 [(google.api.field_behavior) = OPTIONAL];
 
-  // Sale price of the product in this region. Mandatory if
+  // Optional. Sale price of the product in this region. Mandatory if
   // [`salePriceEffectiveDate`][google.shopping.merchant.inventories.v1beta.RegionalInventory.sale_price_effective_date]
   // is defined.
-  google.shopping.type.Price sale_price = 5;
+  google.shopping.type.Price sale_price = 5
+      [(google.api.field_behavior) = OPTIONAL];
 
-  // The `TimePeriod` of the
+  // Optional. The `TimePeriod` of the
   // sale price in this region.
-  google.type.Interval sale_price_effective_date = 6;
+  google.type.Interval sale_price_effective_date = 6
+      [(google.api.field_behavior) = OPTIONAL];
 
   // Availability of the product in this region.
   // For accepted attribute values, see the [regional product inventory data
-  // specification](https://support.google.com/merchants/answer/3061342)
+  // specification](https://support.google.com/merchants/answer/14644124).
   optional string availability = 7;
 
   // A list of custom (merchant-provided) attributes. You can also use
   // `CustomAttribute` to submit any attribute of the data specification in its
   // generic form.
-  repeated google.shopping.type.CustomAttribute custom_attributes = 8;
+  repeated google.shopping.type.CustomAttribute custom_attributes = 8
+      [deprecated = true];
 }
 
 // Request message for the `ListRegionalInventories` method.
@@ -159,6 +165,19 @@ message ListRegionalInventoriesRequest {
   // [nextPageToken][google.shopping.merchant.inventories.v1beta.ListRegionalInventoriesResponse.next_page_token]
   // in the response to the previous request.
   string page_token = 3;
+
+  // Optional. If true, the `{product}` in the `parent` field of the request
+  // will be interpreted as unpadded base64url-encoded and decoded during
+  // request processing to match the decoded value. Default value is `false`.
+  // Use this if your `{product}` contains special characters, such as forward
+  // slash `/` or other characters that are unpadded base64url-encoded (as per
+  // RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2).
+  //
+  // Note that future versions of the API will only accept unpadded
+  // base64url-encoded product ids, so we strongly recommend proactively setting
+  // this to `true` and encoding the product ids.
+  bool product_id_base64_url_encoded = 4
+      [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Response message for the `ListRegionalInventories` method.
@@ -188,6 +207,19 @@ message InsertRegionalInventoryRequest {
   // full replacement of the `RegionalInventory` resource is performed.
   RegionalInventory regional_inventory = 2
       [(google.api.field_behavior) = REQUIRED];
+
+  // Optional. If true, the `{product}` in the `parent` field of the request
+  // will be interpreted as unpadded base64url-encoded and decoded during
+  // request processing to match the decoded value. Default value is `false`.
+  // Use this if your `{product}` contains special characters, such as forward
+  // slash `/` or other characters that are unpadded base64url-encoded (as per
+  // RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2).
+  //
+  // Note that future versions of the API will only accept unpadded
+  // base64url-encoded product ids, so we strongly recommend proactively setting
+  // this to `true` and encoding the product ids.
+  bool product_id_base64_url_encoded = 3
+      [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Request message for the `DeleteRegionalInventory` method.
@@ -201,4 +233,17 @@ message DeleteRegionalInventoryRequest {
       type: "merchantapi.googleapis.com/RegionalInventory"
     }
   ];
+
+  // Optional. If true, the `{product}` in the `name` field of the request will
+  // be interpreted as unpadded base64url-encoded and decoded during request
+  // processing to match the decoded value. Default value is `false`. Use this
+  // if your `{product}` contains special characters, such as forward slash `/`
+  // or other characters that are unpadded base64url-encoded (as per RFC 7515:
+  // https://datatracker.ietf.org/doc/html/rfc7515#section-2).
+  //
+  // Note that future versions of the API will only accept unpadded
+  // base64url-encoded product ids, so we strongly recommend proactively setting
+  // this to `true` and encoding the product ids.
+  bool product_id_base64_url_encoded = 2
+      [(google.api.field_behavior) = OPTIONAL];
 }
