Skip to content

Commit 29839aa

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs: A comment for method InsertProductInput in service ProductInputsService is changed
docs: A comment for message `ProductInput` is changed docs: A comment for field `name` in message `.google.shopping.merchant.products.v1beta.ProductInput` is changed docs: A comment for field `product` in message `.google.shopping.merchant.products.v1beta.ProductInput` is changed docs: A comment for field `feed_label` in message `.google.shopping.merchant.products.v1beta.ProductInput` is changed docs: A comment for field `version_number` in message `.google.shopping.merchant.products.v1beta.ProductInput` is changed docs: A comment for field `custom_attributes` in message `.google.shopping.merchant.products.v1beta.ProductInput` is changed docs: A comment for field `parent` in message `.google.shopping.merchant.products.v1beta.InsertProductInputRequest` is changed docs: A comment for field `data_source` in message `.google.shopping.merchant.products.v1beta.InsertProductInputRequest` is changed docs: A comment for field `data_source` in message `.google.shopping.merchant.products.v1beta.UpdateProductInputRequest` is changed docs: A comment for field `name` in message `.google.shopping.merchant.products.v1beta.DeleteProductInputRequest` is changed docs: A comment for field `data_source` in message `.google.shopping.merchant.products.v1beta.DeleteProductInputRequest` is changed docs: A comment for field `feed_label` in message `.google.shopping.merchant.products.v1beta.Product` is changed docs: A comment for field `page_size` in message `.google.shopping.merchant.products.v1beta.ListProductsRequest` is changed docs: A comment for field `is_bundle` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `disclosure_date` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `availability` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `brand` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `color` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `condition` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `gender` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `gtin` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `material` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `pattern` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `product_types` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `sale_price_effective_date` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `size` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `size_system` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `size_types` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `tax_category` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `multipack` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `ads_grouping` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `product_highlights` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `display_ads_similar_ids` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `display_ads_value` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `pickup_method` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `pickup_sla` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `link_template` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `mobile_link_template` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `custom_label_0` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `custom_label_1` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `custom_label_2` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `custom_label_3` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `custom_label_4` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `included_destinations` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `excluded_destinations` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `shopping_ads_excluded_countries` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `auto_pricing_min_price` in message `.google.shopping.merchant.products.v1beta.Attributes` is changed docs: A comment for field `program_label` in message `.google.shopping.merchant.products.v1beta.LoyaltyProgram` is changed docs: A comment for field `resolution` in message `.google.shopping.merchant.products.v1beta.ProductStatus` is changed feat: A new field `gtins` is added to message `.google.shopping.merchant.products.v1beta.Attributes` feat: A new field `maximum_retail_price` is added to message `.google.shopping.merchant.products.v1beta.Attributes` PiperOrigin-RevId: 781460799
1 parent d60f969 commit 29839aa

File tree

3 files changed

+155
-75
lines changed

3 files changed

+155
-75
lines changed

‎google/shopping/merchant/products/v1beta/productinputs.proto‎

Lines changed: 48 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,14 @@ service ProductInputsService {
3636
option (google.api.default_host) = "merchantapi.googleapis.com";
3737
option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/content";
3838

39-
// Uploads a product input to your Merchant Center account. If an input
40-
// with the same contentLanguage, offerId, and dataSource already exists,
41-
// this method replaces that entry.
39+
// [Uploads a product input to your Merchant Center
40+
// account](/merchant/api/guides/products/overview#upload-product-input). You
41+
// must have a products data source to be able to insert a product. The unique
42+
// identifier of the data source is passed as a query parameter in the request
43+
// URL.
44+
//
45+
// If an input with the same contentLanguage, offerId, and dataSource already
46+
// exists, this method replaces that entry.
4247
//
4348
// After inserting, updating, or deleting a product input, it may take several
4449
// minutes before the processed product can be retrieved.
@@ -78,7 +83,8 @@ service ProductInputsService {
7883
// processed product that you see in Merchant Center, in Shopping ads, or
7984
// across Google surfaces. Product inputs, rules and supplemental data source
8085
// data are combined to create the processed
81-
// [Product][google.shopping.merchant.products.v1beta.Product].
86+
// [Product][google.shopping.merchant.products.v1beta.Product]. For more
87+
// information, see [Manage products](/merchant/api/guides/products/overview).
8288
//
8389
// Required product input attributes to pass data validation checks are
8490
// primarily defined in the [Products Data
@@ -93,8 +99,12 @@ service ProductInputsService {
9399
// minutes before the processed product can be retrieved.
94100
//
95101
// All fields in the product input and its sub-messages match the English name
96-
// of their corresponding attribute in the vertical spec with [some
97-
// exceptions](https://support.google.com/merchants/answer/7052112).
102+
// of their corresponding attribute in the [Products Data
103+
// Specification](https://support.google.com/merchants/answer/188494) with
104+
// [some exceptions](https://support.google.com/merchants/answer/7052112).
105+
// The following reference documentation lists the field names in the
106+
// **camelCase** casing style while the Products Data Specification lists the
107+
// names in the **snake_case** casing style.
98108
message ProductInput {
99109
option (google.api.resource) = {
100110
type: "merchantapi.googleapis.com/ProductInput"
@@ -104,16 +114,15 @@ message ProductInput {
104114
};
105115

106116
// Identifier. The name of the product input.
107-
// Format: accounts/{account}/productInputs/{productinput}
117+
// Format: `accounts/{account}/productInputs/{productinput}`
108118
// where the last section `productinput` consists of 4 parts:
109-
// channel~content_language~feed_label~offer_id
119+
// `channel~content_language~feed_label~offer_id`
110120
// example for product input name is
111-
// "accounts/123/productInputs/online~en~US~sku123"
121+
// `accounts/123/productInputs/online~en~US~sku123`
112122
string name = 1 [(google.api.field_behavior) = IDENTIFIER];
113123

114124
// Output only. The name of the processed product.
115-
// Format:
116-
// `"{product.name=accounts/{account}/products/{product}}"`
125+
// Format: `accounts/{account}/products/{product}`
117126
string product = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
118127

119128
// Immutable. The
@@ -141,28 +150,35 @@ message ProductInput {
141150
(google.api.field_behavior) = IMMUTABLE
142151
];
143152

144-
// Required. Immutable. The [feed
145-
// label](https://developers.google.com/shopping-content/guides/products/feed-labels)
146-
// for the product.
153+
// Required. Immutable. The label that lets you categorize and identify your
154+
// products. The maximum allowed characters are 20, and the supported
155+
// characters are `A-Z`, `0-9`, hyphen, and underscore. The feed label must
156+
// not include any spaces. For more information, see [Using feed
157+
// labels](//support.google.com/merchants/answer/14994087).
147158
string feed_label = 6 [
148159
(google.api.field_behavior) = REQUIRED,
149160
(google.api.field_behavior) = IMMUTABLE
150161
];
151162

152-
// Optional. Represents the existing version (freshness) of the product, which
153-
// can be used to preserve the right order when multiple updates are done at
154-
// the same time.
163+
// Optional. Immutable. Represents the existing version (freshness) of the
164+
// product, which can be used to preserve the right order when multiple
165+
// updates are done at the same time.
155166
//
156167
// If set, the insertion is prevented when version number is lower than
157168
// the current version number of the existing product. Re-insertion (for
158169
// example, product refresh after 30 days) can be performed with the current
159170
// `version_number`.
160171
//
161172
// Only supported for insertions into primary data sources.
173+
// Do not set this field for updates.
174+
// Do not set this field for insertions into supplemental data sources.
162175
//
163176
// If the operation is prevented, the aborted exception will be
164177
// thrown.
165-
optional int64 version_number = 7 [(google.api.field_behavior) = OPTIONAL];
178+
optional int64 version_number = 7 [
179+
(google.api.field_behavior) = OPTIONAL,
180+
(google.api.field_behavior) = IMMUTABLE
181+
];
166182

167183
// Optional. A list of product attributes.
168184
Attributes attributes = 8 [(google.api.field_behavior) = OPTIONAL];
@@ -172,7 +188,7 @@ message ProductInput {
172188
// form (for example,
173189
// `{ "name": "size type", "value": "regular" }`).
174190
// This is useful for submitting attributes not explicitly exposed by the
175-
// API, such as additional attributes used for Buy on Google.
191+
// API.
176192
// Maximum allowed number of characters for each
177193
// custom attribute is 10240 (represents sum of characters for name and
178194
// value). Maximum 2500 custom attributes can be set per product, with total
@@ -185,7 +201,7 @@ message ProductInput {
185201
// Request message for the InsertProductInput method.
186202
message InsertProductInputRequest {
187203
// Required. The account where this product will be inserted.
188-
// Format: accounts/{account}
204+
// Format: `accounts/{account}`
189205
string parent = 1 [
190206
(google.api.field_behavior) = REQUIRED,
191207
(google.api.resource_reference) = {
@@ -198,11 +214,14 @@ message InsertProductInputRequest {
198214

199215
// Required. The primary or supplemental product data source name. If the
200216
// product already exists and data source provided is different, then the
201-
// product will be moved to a new data source.
217+
// product will be moved to a new data source. For more information, see
218+
// [Overview of Data sources
219+
// sub-API](/merchant/api/guides/data-sources/overview).
202220
//
203221
// Only API data sources are supported.
204222
//
205-
// Format: `accounts/{account}/dataSources/{datasource}`.
223+
// Format: `accounts/{account}/dataSources/{datasource}`. For example,
224+
// `accounts/123456/dataSources/104628`.
206225
string data_source = 3 [(google.api.field_behavior) = REQUIRED];
207226
}
208227

@@ -238,18 +257,19 @@ message UpdateProductInputRequest {
238257
//
239258
// Only API data sources are supported.
240259
//
241-
// Format: `accounts/{account}/dataSources/{datasource}`.
260+
// Format: `accounts/{account}/dataSources/{datasource}`. For example,
261+
// `accounts/123456/dataSources/104628`.
242262
string data_source = 3 [(google.api.field_behavior) = REQUIRED];
243263
}
244264

245265
// Request message for the DeleteProductInput method.
246266
message DeleteProductInputRequest {
247267
// Required. The name of the product input resource to delete.
248-
// Format: accounts/{account}/productInputs/{product}
268+
// Format: `accounts/{account}/productInputs/{product}`
249269
// where the last section `product` consists of 4 parts:
250-
// channel~content_language~feed_label~offer_id
270+
// `channel~content_language~feed_label~offer_id`
251271
// example for product name is
252-
// "accounts/123/productInputs/online~en~US~sku123"
272+
// `accounts/123/productInputs/online~en~US~sku123`.
253273
string name = 1 [
254274
(google.api.field_behavior) = REQUIRED,
255275
(google.api.resource_reference) = {
@@ -259,6 +279,7 @@ message DeleteProductInputRequest {
259279

260280
// Required. The primary or supplemental data source from which the product
261281
// input should be deleted. Format:
262-
// `accounts/{account}/dataSources/{datasource}`.
282+
// `accounts/{account}/dataSources/{datasource}`. For example,
283+
// `accounts/123456/dataSources/104628`.
263284
string data_source = 2 [(google.api.field_behavior) = REQUIRED];
264285
}

‎google/shopping/merchant/products/v1beta/products.proto‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,11 @@ message Product {
108108
// product.
109109
string content_language = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
110110

111-
// Output only. The feed label for the product.
111+
// Output only. The feed label lets you categorize and identify your products.
112+
// The maximum allowed characters is 20 and the supported characters are`A-Z`,
113+
// `0-9`, hyphen and underscore. The feed label must not include any spaces.
114+
// For more information, see [Using feed
115+
// labels](//support.google.com/merchants/answer/14994087)
112116
string feed_label = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
113117

114118
// Output only. The primary data source of the product.
@@ -179,7 +183,7 @@ message ListProductsRequest {
179183

180184
// The maximum number of products to return. The service may return fewer than
181185
// this value.
182-
// The maximum value is 250; values above 250 will be coerced to 250.
186+
// The maximum value is 1000; values above 1000 will be coerced to 1000.
183187
// If unspecified, the maximum number of products will be returned.
184188
int32 page_size = 2;
185189

0 commit comments

Comments
 (0)