1- // Copyright 2025 Google LLC
1+ // Copyright 2026 Google LLC
22//
33// Licensed under the Apache License, Version 2.0 (the "License");
44// you may not use this file except in compliance with the License.
@@ -39,11 +39,11 @@ service ProductInputsService {
3939 option (google.api.oauth_scopes ) = "https://www.googleapis.com/auth/content" ;
4040
4141 // [Uploads a product input to your Merchant Center
42- // account](/merchant/api/guides/products/overview#upload-product-input ). You
42+ // account](/merchant/api/guides/products/add-manage#add_a_product ). You
4343 // must have a products [data
44- // source](/merchant/api/guides/data-sources/overview) to be able to insert a
45- // product. The unique identifier of the data source is passed as a query
46- // parameter in the request URL.
44+ // source](/merchant/api/guides/data-sources/api-sources#create-primary-data-source)
45+ // to be able to insert a product. The unique identifier of the data source is
46+ // passed as a query parameter in the request URL.
4747 //
4848 // If a product input with the same contentLanguage, offerId, and dataSource
4949 // already exists, then the product input inserted by this method replaces
@@ -59,6 +59,8 @@ service ProductInputsService {
5959 }
6060
6161 // Updates the existing product input in your Merchant Center account.
62+ // The name of the product input to update is taken from the `name` field
63+ // within the `ProductInput` resource.
6264 //
6365 // After inserting, updating, or deleting a product input, it may take several
6466 // minutes before the processed product can be retrieved.
@@ -117,16 +119,44 @@ message ProductInput {
117119 singular : "productInput"
118120 };
119121
120- // Identifier. The name of the product input .
122+ // Identifier. The name of the product.
121123 // Format: `accounts/{account}/productInputs/{productinput}`
122- // where the last section `productinput` consists of:
123- // `content_language~feed_label~offer_id`
124- // example for product input name is
125- // `accounts/123/productInputs/en~US~sku123`. A legacy local product input
126- // name would be `accounts/123/productInputs/local~en~US~sku123`.
127- // Note: For calls to the v1beta version, the `productInput` section consists
128- // of: `channel~content_language~feed_label~offer_id`, for example:
129- // `accounts/123/productInputs/online~en~US~sku123`.
124+ //
125+ // The {productinput} segment is a unique identifier for the product.
126+ // This identifier must be unique within a merchant account and generally
127+ // follows the structure: `content_language~feed_label~offer_id`. Example:
128+ // `en~US~sku123` For legacy local products, the structure is:
129+ // `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123`
130+ //
131+ // The format of the {productinput} segment in the URL is automatically
132+ // detected by the server, supporting two options:
133+ //
134+ // 1. **Encoded Format**: The `{productinput}` segment is an unpadded
135+ // base64url
136+ // encoded string (RFC 4648 Section 5). The decoded string must result
137+ // in the `content_language~feed_label~offer_id` structure. This encoding
138+ // MUST be used if any part of the product identifier (like `offer_id`)
139+ // contains characters such as `/`, `%`, or `~`.
140+ // * Example: To represent the product ID `en~US~sku/123`, the
141+ // `{productinput}` segment must be the base64url encoding of this
142+ // string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name
143+ // for the product would be
144+ // `accounts/123/productinputs/ZW5-VVMtc2t1LzEyMw`.
145+ //
146+ // 2. **Plain Format**: The `{productinput}` segment is the tilde-separated
147+ // string
148+ // `content_language~feed_label~offer_id`. This format is suitable only
149+ // when `content_language`, `feed_label`, and `offer_id` do not contain
150+ // URL-problematic characters like `/`, `%`, or `~`.
151+ //
152+ // We recommend using the **Encoded Format** for all product IDs to ensure
153+ // correct parsing, especially those containing special characters. The
154+ // presence of tilde (`~`) characters in the `{productinput}` segment is used
155+ // to differentiate between the two formats.
156+ //
157+ // Note: For calls to the v1beta version, the plain format is
158+ // `channel~content_language~feed_label~offer_id`, for example:
159+ // `accounts/123/productinputs/online~en~US~sku123`.
130160 string name = 1 [(google.api.field_behavior ) = IDENTIFIER ];
131161
132162 // Output only. The name of the processed product.
@@ -227,8 +257,8 @@ message InsertProductInputRequest {
227257 // Required. The primary or supplemental product data source name. If the
228258 // product already exists and data source provided is different, then the
229259 // product will be moved to a new data source. For more information, see
230- // [Overview of Data sources
231- // sub-API ](/merchant/api/guides/data-sources/overview ).
260+ // [Create a primary data
261+ // source ](/merchant/api/guides/data-sources/api-sources#create-primary-data-source ).
232262 //
233263 // Only API data sources are supported.
234264 //
@@ -243,7 +273,8 @@ message InsertProductInputRequest {
243273// input must be from the same data source.
244274message UpdateProductInputRequest {
245275 // Required. The product input resource to update. Information you submit will
246- // be applied to the processed product as well.
276+ // be applied to the processed product as well. The `name` field within this
277+ // resource identifies the product input to be updated.
247278 ProductInput product_input = 1 [(google.api.field_behavior ) = REQUIRED ];
248279
249280 // Optional. The list of product attributes to be updated.
@@ -276,12 +307,44 @@ message UpdateProductInputRequest {
276307
277308// Request message for the DeleteProductInput method.
278309message DeleteProductInputRequest {
279- // Required. The name of the product input resource to delete.
280- // Format: `accounts/{account}/productInputs/{product}`
281- // where the last section `product` consists of:
282- // `content_language~feed_label~offer_id`
283- // example for product name is
284- // `accounts/123/productInputs/en~US~sku123`.
310+ // Required. The name of the product input to delete.
311+ // Format: `accounts/{account}/productInputs/{productInput}`
312+ //
313+ // The {productInput} segment is a unique identifier for the product.
314+ // This identifier must be unique within a merchant account and generally
315+ // follows the structure: `content_language~feed_label~offer_id`. Example:
316+ // `en~US~sku123` For legacy local products, the structure is:
317+ // `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123`
318+ //
319+ // The format of the {productInput} segment in the URL is automatically
320+ // detected by the server, supporting two options:
321+ //
322+ // 1. **Encoded Format**: The `{productInput}` segment is an unpadded
323+ // base64url
324+ // encoded string (RFC 4648 Section 5). The decoded string must result
325+ // in the `content_language~feed_label~offer_id` structure. This encoding
326+ // MUST be used if any part of the product identifier (like `offer_id`)
327+ // contains characters such as `/`, `%`, or `~`.
328+ // * Example: To represent the product ID `en~US~sku/123`, the
329+ // `{productInput}` segment must be the base64url encoding of this
330+ // string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name
331+ // for the product would be
332+ // `accounts/123/productInputs/ZW5-VVMtc2t1LzEyMw`.
333+ //
334+ // 2. **Plain Format**: The `{productInput}` segment is the tilde-separated
335+ // string
336+ // `content_language~feed_label~offer_id`. This format is suitable only
337+ // when `content_language`, `feed_label`, and `offer_id` do not contain
338+ // URL-problematic characters like `/`, `%`, or `~`.
339+ //
340+ // We recommend using the **Encoded Format** for all product IDs to ensure
341+ // correct parsing, especially those containing special characters. The
342+ // presence of tilde (`~`) characters in the `{productInput}` segment is used
343+ // to differentiate between the two formats.
344+ //
345+ // Note: For calls to the v1beta version, the plain format is
346+ // `channel~content_language~feed_label~offer_id`, for example:
347+ // `accounts/123/productinputs/online~en~US~sku123`.
285348 string name = 1 [
286349 (google.api.field_behavior ) = REQUIRED ,
287350 (google.api.resource_reference ) = {
0 commit comments