@googleapis/merchantapi 6.0.1 → 9.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/CHANGELOG.md +43 -0
  2. package/README.md +9 -0
  3. package/accounts_v1beta.ts +6894 -534
  4. package/build/accounts_v1beta.d.ts +4933 -137
  5. package/build/accounts_v1beta.js +679 -26
  6. package/build/accounts_v1beta.js.map +1 -1
  7. package/build/conversions_v1beta.d.ts +336 -1
  8. package/build/conversions_v1beta.js.map +1 -1
  9. package/build/datasources_v1beta.d.ts +412 -6
  10. package/build/datasources_v1beta.js.map +1 -1
  11. package/build/inventories_v1beta.d.ts +336 -2
  12. package/build/inventories_v1beta.js.map +1 -1
  13. package/build/issueresolution_v1beta.d.ts +367 -1
  14. package/build/issueresolution_v1beta.js +48 -0
  15. package/build/issueresolution_v1beta.js.map +1 -1
  16. package/build/lfp_v1beta.d.ts +436 -3
  17. package/build/lfp_v1beta.js.map +1 -1
  18. package/build/notifications_v1beta.d.ts +272 -1
  19. package/build/notifications_v1beta.js.map +1 -1
  20. package/build/ordertracking_v1beta.d.ts +75 -1
  21. package/build/ordertracking_v1beta.js.map +1 -1
  22. package/build/products_v1beta.d.ts +352 -45
  23. package/build/products_v1beta.js.map +1 -1
  24. package/build/promotions_v1beta.d.ts +171 -4
  25. package/build/promotions_v1beta.js.map +1 -1
  26. package/build/quota_v1beta.d.ts +52 -1
  27. package/build/quota_v1beta.js.map +1 -1
  28. package/build/reports_v1beta.d.ts +58 -1
  29. package/build/reports_v1beta.js.map +1 -1
  30. package/build/reviews_v1beta.d.ts +434 -2
  31. package/build/reviews_v1beta.js.map +1 -1
  32. package/conversions_v1beta.ts +336 -1
  33. package/datasources_v1beta.ts +412 -6
  34. package/inventories_v1beta.ts +336 -2
  35. package/issueresolution_v1beta.ts +465 -1
  36. package/lfp_v1beta.ts +436 -3
  37. package/notifications_v1beta.ts +272 -1
  38. package/ordertracking_v1beta.ts +75 -1
  39. package/package.json +1 -1
  40. package/products_v1beta.ts +352 -45
  41. package/promotions_v1beta.ts +171 -4
  42. package/quota_v1beta.ts +52 -1
  43. package/reports_v1beta.ts +58 -1
  44. package/reviews_v1beta.ts +434 -2
@@ -80,7 +80,7 @@ export declare namespace merchantapi_products_v1beta {
80
80
  */
81
81
  additionalImageLinks?: string[] | null;
82
82
  /**
83
- * Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
83
+ * Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387).
84
84
  */
85
85
  adsGrouping?: string | null;
86
86
  /**
@@ -100,11 +100,11 @@ export declare namespace merchantapi_products_v1beta {
100
100
  */
101
101
  ageGroup?: string | null;
102
102
  /**
103
- * A safeguard in the "Automated Discounts" (https://support.google.com/merchants/answer/10295759) and "Dynamic Promotions" (https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on merchants' offers do not fall below this value, thereby preserving the offer's value and profitability.
103
+ * A safeguard in the [automated discounts] (https://support.google.com/merchants/answer/10295759) and "Dynamic Promotions" (https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability.
104
104
  */
105
105
  autoPricingMinPrice?: Schema$Price;
106
106
  /**
107
- * Availability status of the item.
107
+ * [Availability](https://support.google.com/merchants/answer/6324448) status of the item. For example, "in_stock" or "out_of_stock".
108
108
  */
109
109
  availability?: string | null;
110
110
  /**
@@ -112,7 +112,7 @@ export declare namespace merchantapi_products_v1beta {
112
112
  */
113
113
  availabilityDate?: string | null;
114
114
  /**
115
- * Brand of the item.
115
+ * [Brand](https://support.google.com/merchants/answer/6324351) of the item. For example, "Google".
116
116
  */
117
117
  brand?: string | null;
118
118
  /**
@@ -128,11 +128,11 @@ export declare namespace merchantapi_products_v1beta {
128
128
  */
129
129
  cloudExportAdditionalProperties?: Schema$CloudExportAdditionalProperties[];
130
130
  /**
131
- * Color of the item.
131
+ * [Color](https://support.google.com/merchants/answer/6324487) of the item. For example, "red".
132
132
  */
133
133
  color?: string | null;
134
134
  /**
135
- * Condition or state of the item.
135
+ * [Condition](https://support.google.com/merchants/answer/6324469) or state of the item. For example, "new" or "used".
136
136
  */
137
137
  condition?: string | null;
138
138
  /**
@@ -140,23 +140,23 @@ export declare namespace merchantapi_products_v1beta {
140
140
  */
141
141
  costOfGoodsSold?: Schema$Price;
142
142
  /**
143
- * Custom label 0 for custom grouping of items in a Shopping campaign.
143
+ * [Custom label 0](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.
144
144
  */
145
145
  customLabel0?: string | null;
146
146
  /**
147
- * Custom label 1 for custom grouping of items in a Shopping campaign.
147
+ * [Custom label 1](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.
148
148
  */
149
149
  customLabel1?: string | null;
150
150
  /**
151
- * Custom label 2 for custom grouping of items in a Shopping campaign.
151
+ * [Custom label 2](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.
152
152
  */
153
153
  customLabel2?: string | null;
154
154
  /**
155
- * Custom label 3 for custom grouping of items in a Shopping campaign.
155
+ * [Custom label 3](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.
156
156
  */
157
157
  customLabel3?: string | null;
158
158
  /**
159
- * Custom label 4 for custom grouping of items in a Shopping campaign.
159
+ * [Custom label 4](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.
160
160
  */
161
161
  customLabel4?: string | null;
162
162
  /**
@@ -164,7 +164,7 @@ export declare namespace merchantapi_products_v1beta {
164
164
  */
165
165
  description?: string | null;
166
166
  /**
167
- * The date time when an offer becomes visible in search results across Google’s YouTube surfaces, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. See [Disclosure date]( https://support.google.com/merchants/answer/13034208) for more information.
167
+ * The date time when an offer becomes visible in search results across Google’s YouTube surfaces, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. See [Disclosure date](https://support.google.com/merchants/answer/13034208) for more information.
168
168
  */
169
169
  disclosureDate?: string | null;
170
170
  /**
@@ -176,7 +176,7 @@ export declare namespace merchantapi_products_v1beta {
176
176
  */
177
177
  displayAdsLink?: string | null;
178
178
  /**
179
- * Advertiser-specified recommendations.
179
+ * Advertiser-specified recommendations. For more information, see [Display ads attribute specification](https://support.google.com/merchants/answer/6069387).
180
180
  */
181
181
  displayAdsSimilarIds?: string[] | null;
182
182
  /**
@@ -184,7 +184,7 @@ export declare namespace merchantapi_products_v1beta {
184
184
  */
185
185
  displayAdsTitle?: string | null;
186
186
  /**
187
- * Offer margin for dynamic remarketing campaigns.
187
+ * Offer margin for dynamic remarketing campaigns. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387).
188
188
  */
189
189
  displayAdsValue?: number | null;
190
190
  /**
@@ -192,7 +192,7 @@ export declare namespace merchantapi_products_v1beta {
192
192
  */
193
193
  energyEfficiencyClass?: string | null;
194
194
  /**
195
- * The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
195
+ * The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center). For more information, see [Excluded destination](https://support.google.com/merchants/answer/6324486). Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
196
196
  */
197
197
  excludedDestinations?: string[] | null;
198
198
  /**
@@ -208,7 +208,7 @@ export declare namespace merchantapi_products_v1beta {
208
208
  */
209
209
  freeShippingThreshold?: Schema$FreeShippingThreshold[];
210
210
  /**
211
- * Target gender of the item.
211
+ * Target [gender](https://support.google.com/merchants/answer/6324479) of the item. For example, "male" or "female".
212
212
  */
213
213
  gender?: string | null;
214
214
  /**
@@ -216,9 +216,13 @@ export declare namespace merchantapi_products_v1beta {
216
216
  */
217
217
  googleProductCategory?: string | null;
218
218
  /**
219
- * Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs.
219
+ * Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. Deprecated: Use `gtins` instead.
220
220
  */
221
221
  gtin?: string[] | null;
222
+ /**
223
+ * Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs.
224
+ */
225
+ gtins?: string[] | null;
222
226
  /**
223
227
  * Set this value to false when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Defaults to true, if not provided.
224
228
  */
@@ -228,7 +232,7 @@ export declare namespace merchantapi_products_v1beta {
228
232
  */
229
233
  imageLink?: string | null;
230
234
  /**
231
- * The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
235
+ * The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`. For more information, see [Included destination](https://support.google.com/merchants/answer/7501026). Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
232
236
  */
233
237
  includedDestinations?: string[] | null;
234
238
  /**
@@ -236,7 +240,7 @@ export declare namespace merchantapi_products_v1beta {
236
240
  */
237
241
  installment?: Schema$Installment;
238
242
  /**
239
- * Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
243
+ * Whether the item is a business-defined sub-API. A [sub-API] (https://support.google.com/merchants/answer/6324449) is a custom grouping of different products sold by a business for a single price.
240
244
  */
241
245
  isBundle?: boolean | null;
242
246
  /**
@@ -252,7 +256,7 @@ export declare namespace merchantapi_products_v1beta {
252
256
  */
253
257
  link?: string | null;
254
258
  /**
255
- * Link template for merchant hosted local storefront.
259
+ * [Link template](https://support.google.com/merchants/answer/13871172) for business hosted local storefront.
256
260
  */
257
261
  linkTemplate?: string | null;
258
262
  /**
@@ -264,7 +268,7 @@ export declare namespace merchantapi_products_v1beta {
264
268
  */
265
269
  loyaltyPrograms?: Schema$LoyaltyProgram[];
266
270
  /**
267
- * The material of which the item is made.
271
+ * The [material](https://support.google.com/merchants/answer/6324410) of which the item is made. For example, "Leather" or "Cotton".
268
272
  */
269
273
  material?: string | null;
270
274
  /**
@@ -275,6 +279,10 @@ export declare namespace merchantapi_products_v1beta {
275
279
  * Maximal product handling time (in business days).
276
280
  */
277
281
  maxHandlingTime?: string | null;
282
+ /**
283
+ * Maximum retail price (MRP) of the item. Applicable to India only.
284
+ */
285
+ maximumRetailPrice?: Schema$Price;
278
286
  /**
279
287
  * The energy efficiency class as defined in EU directive 2010/30/EU.
280
288
  */
@@ -288,7 +296,7 @@ export declare namespace merchantapi_products_v1beta {
288
296
  */
289
297
  mobileLink?: string | null;
290
298
  /**
291
- * Link template for merchant hosted local storefront optimized for mobile devices.
299
+ * [Link template](https://support.google.com/merchants/answer/13870216) for business hosted local storefront optimized for mobile devices.
292
300
  */
293
301
  mobileLinkTemplate?: string | null;
294
302
  /**
@@ -296,11 +304,11 @@ export declare namespace merchantapi_products_v1beta {
296
304
  */
297
305
  mpn?: string | null;
298
306
  /**
299
- * The number of identical products in a merchant-defined multipack.
307
+ * The number of identical products in a business-defined multipack.
300
308
  */
301
309
  multipack?: string | null;
302
310
  /**
303
- * The item's pattern (for example, polka dots).
311
+ * The item's [pattern](https://support.google.com/merchants/answer/6324483). For example, polka dots.
304
312
  */
305
313
  pattern?: string | null;
306
314
  /**
@@ -308,11 +316,11 @@ export declare namespace merchantapi_products_v1beta {
308
316
  */
309
317
  pause?: string | null;
310
318
  /**
311
- * The pick up option for the item.
319
+ * The [pickup](https://support.google.com/merchants/answer/14634021) option for the item.
312
320
  */
313
321
  pickupMethod?: string | null;
314
322
  /**
315
- * Item store pickup timeline.
323
+ * Item store pickup timeline. For more information, see [Pickup SLA](https://support.google.com/merchants/answer/14635400).
316
324
  */
317
325
  pickupSla?: string | null;
318
326
  /**
@@ -328,7 +336,7 @@ export declare namespace merchantapi_products_v1beta {
328
336
  */
329
337
  productHeight?: Schema$ProductDimension;
330
338
  /**
331
- * Bullet points describing the most relevant highlights of a product.
339
+ * Bullet points describing the most relevant [product highlights](https://support.google.com/merchants/answer/9216100).
332
340
  */
333
341
  productHighlights?: string[] | null;
334
342
  /**
@@ -336,7 +344,7 @@ export declare namespace merchantapi_products_v1beta {
336
344
  */
337
345
  productLength?: Schema$ProductDimension;
338
346
  /**
339
- * Categories of the item (formatted as in [product data specification](https://support.google.com/merchants/answer/188494#product_type)).
347
+ * Categories of the item (formatted as in [product data specification](https://support.google.com/merchants/answer/7052112#product_category)).
340
348
  */
341
349
  productTypes?: string[] | null;
342
350
  /**
@@ -356,7 +364,7 @@ export declare namespace merchantapi_products_v1beta {
356
364
  */
357
365
  salePrice?: Schema$Price;
358
366
  /**
359
- * Date range during which the item is on sale (see [product data specification](https://support.google.com/merchants/answer/188494#sale_price_effective_date)).
367
+ * Date range during which the item is on sale, see [product data specification](https://support.google.com/merchants/answer/7052112#price_and_availability).
360
368
  */
361
369
  salePriceEffectiveDate?: Schema$Interval;
362
370
  /**
@@ -388,19 +396,19 @@ export declare namespace merchantapi_products_v1beta {
388
396
  */
389
397
  shippingWidth?: Schema$ShippingDimension;
390
398
  /**
391
- * List of country codes (ISO 3166-1 alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in data source settings.
399
+ * List of country codes [(ISO 3166-1 alpha-2)](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in data source settings.
392
400
  */
393
401
  shoppingAdsExcludedCountries?: string[] | null;
394
402
  /**
395
- * Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)).
403
+ * Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value, see [Size](https://support.google.com/merchants/answer/6324492).
396
404
  */
397
405
  size?: string | null;
398
406
  /**
399
- * System in which the size is specified. Recommended for apparel items.
407
+ * System in which the size is specified. Recommended for apparel items. For example, "US", "UK", "DE". For more information, see [Size system](https://support.google.com/merchants/answer/6324502).
400
408
  */
401
409
  sizeSystem?: string | null;
402
410
  /**
403
- * The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [https://support.google.com/merchants/answer/6324497](size type)).
411
+ * The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided, see [Size type](https://support.google.com/merchants/answer/6324497). For example, "petite", "plus size".
404
412
  */
405
413
  sizeTypes?: string[] | null;
406
414
  /**
@@ -420,7 +428,7 @@ export declare namespace merchantapi_products_v1beta {
420
428
  */
421
429
  sustainabilityIncentives?: Schema$ProductSustainabilityIncentive[];
422
430
  /**
423
- * The tax category of the product.
431
+ * The [tax category](https://support.google.com/merchants/answer/7569847) of the product.
424
432
  */
425
433
  taxCategory?: string | null;
426
434
  /**
@@ -646,7 +654,7 @@ export declare namespace merchantapi_products_v1beta {
646
654
  */
647
655
  reportingContext?: string | null;
648
656
  /**
649
- * Whether the issue can be resolved by the merchant.
657
+ * Whether the issue can be resolved by the business.
650
658
  */
651
659
  resolution?: string | null;
652
660
  /**
@@ -705,7 +713,7 @@ export declare namespace merchantapi_products_v1beta {
705
713
  */
706
714
  price?: Schema$Price;
707
715
  /**
708
- * The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. The label must be provided so that the system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account.
716
+ * The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a business entity and a loyalty program entity. The label must be provided so that the system can associate the assets below (for example, price and points) with a business. The corresponding program must be linked to the Merchant Center account.
709
717
  */
710
718
  programLabel?: string | null;
711
719
  /**
@@ -759,7 +767,7 @@ export declare namespace merchantapi_products_v1beta {
759
767
  */
760
768
  dataSource?: string | null;
761
769
  /**
762
- * Output only. The feed label for the product.
770
+ * Output only. The feed label lets you categorize and identify your products. The maximum allowed characters is 20 and the supported characters are`A-Z`, `0-9`, hyphen and underscore. The feed label must not include any spaces. For more information, see [Using feed labels](//support.google.com/merchants/answer/14994087)
763
771
  */
764
772
  feedLabel?: string | null;
765
773
  /**
@@ -831,7 +839,7 @@ export declare namespace merchantapi_products_v1beta {
831
839
  value?: number | null;
832
840
  }
833
841
  /**
834
- * This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product. Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the [Products Data Specification](https://support.google.com/merchants/answer/188494) with [some exceptions](https://support.google.com/merchants/answer/7052112). The following reference documentation lists the field names in the **camelCase** casing style while the Products Data Specification lists the names in the **snake_case** casing style.
842
+ * This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product. For more information, see [Manage products](/merchant/api/guides/products/overview). Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the [Products Data Specification](https://support.google.com/merchants/answer/188494) with [some exceptions](https://support.google.com/merchants/answer/7052112). The following reference documentation lists the field names in the **camelCase** casing style while the Products Data Specification lists the names in the **snake_case** casing style.
835
843
  */
836
844
  export interface Schema$ProductInput {
837
845
  /**
@@ -851,7 +859,7 @@ export declare namespace merchantapi_products_v1beta {
851
859
  */
852
860
  customAttributes?: Schema$CustomAttribute[];
853
861
  /**
854
- * Required. Immutable. The [feed label](https://developers.google.com/shopping-content/guides/products/feed-labels) for the product.
862
+ * Required. Immutable. The label that lets you categorize and identify your products. The maximum allowed characters are 20, and the supported characters are `A-Z`, `0-9`, hyphen, and underscore. The feed label must not include any spaces. For more information, see [Using feed labels](//support.google.com/merchants/answer/14994087).
855
863
  */
856
864
  feedLabel?: string | null;
857
865
  /**
@@ -917,7 +925,7 @@ export declare namespace merchantapi_products_v1beta {
917
925
  */
918
926
  eventTime?: string | null;
919
927
  /**
920
- * Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event.
928
+ * Optional. The product expiration time. This field will not be set if the notification is sent for a product deletion event.
921
929
  */
922
930
  expirationTime?: string | null;
923
931
  /**
@@ -1151,6 +1159,52 @@ export declare namespace merchantapi_products_v1beta {
1151
1159
  constructor(context: APIRequestContext);
1152
1160
  /**
1153
1161
  * Deletes a product input from your Merchant Center account. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.
1162
+ * @example
1163
+ * ```js
1164
+ * // Before running the sample:
1165
+ * // - Enable the API at:
1166
+ * // https://console.developers.google.com/apis/api/merchantapi.googleapis.com
1167
+ * // - Login into gcloud by running:
1168
+ * // ```sh
1169
+ * // $ gcloud auth application-default login
1170
+ * // ```
1171
+ * // - Install the npm module by running:
1172
+ * // ```sh
1173
+ * // $ npm install googleapis
1174
+ * // ```
1175
+ *
1176
+ * const {google} = require('googleapis');
1177
+ * const merchantapi = google.merchantapi('products_v1beta');
1178
+ *
1179
+ * async function main() {
1180
+ * const auth = new google.auth.GoogleAuth({
1181
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1182
+ * scopes: ['https://www.googleapis.com/auth/content'],
1183
+ * });
1184
+ *
1185
+ * // Acquire an auth client, and bind it to all future calls
1186
+ * const authClient = await auth.getClient();
1187
+ * google.options({auth: authClient});
1188
+ *
1189
+ * // Do the magic
1190
+ * const res = await merchantapi.accounts.productInputs.delete({
1191
+ * // Required. The primary or supplemental data source from which the product input should be deleted. Format: `accounts/{account\}/dataSources/{datasource\}`. For example, `accounts/123456/dataSources/104628`.
1192
+ * dataSource: 'placeholder-value',
1193
+ * // Required. The name of the product input resource to delete. Format: `accounts/{account\}/productInputs/{product\}` where the last section `product` consists of 4 parts: `channel~content_language~feed_label~offer_id` example for product name is `accounts/123/productInputs/online~en~US~sku123`.
1194
+ * name: 'accounts/my-account/productInputs/my-productInput',
1195
+ * });
1196
+ * console.log(res.data);
1197
+ *
1198
+ * // Example response
1199
+ * // {}
1200
+ * }
1201
+ *
1202
+ * main().catch(e => {
1203
+ * console.error(e);
1204
+ * throw e;
1205
+ * });
1206
+ *
1207
+ * ```
1154
1208
  *
1155
1209
  * @param params - Parameters for request
1156
1210
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1164,7 +1218,79 @@ export declare namespace merchantapi_products_v1beta {
1164
1218
  delete(params: Params$Resource$Accounts$Productinputs$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
1165
1219
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
1166
1220
  /**
1167
- * Uploads a product input to your Merchant Center account. If an input with the same contentLanguage, offerId, and dataSource already exists, this method replaces that entry. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.
1221
+ * [Uploads a product input to your Merchant Center account](/merchant/api/guides/products/overview#upload-product-input). You must have a products data source to be able to insert a product. The unique identifier of the data source is passed as a query parameter in the request URL. If an input with the same contentLanguage, offerId, and dataSource already exists, this method replaces that entry. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.
1222
+ * @example
1223
+ * ```js
1224
+ * // Before running the sample:
1225
+ * // - Enable the API at:
1226
+ * // https://console.developers.google.com/apis/api/merchantapi.googleapis.com
1227
+ * // - Login into gcloud by running:
1228
+ * // ```sh
1229
+ * // $ gcloud auth application-default login
1230
+ * // ```
1231
+ * // - Install the npm module by running:
1232
+ * // ```sh
1233
+ * // $ npm install googleapis
1234
+ * // ```
1235
+ *
1236
+ * const {google} = require('googleapis');
1237
+ * const merchantapi = google.merchantapi('products_v1beta');
1238
+ *
1239
+ * async function main() {
1240
+ * const auth = new google.auth.GoogleAuth({
1241
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1242
+ * scopes: ['https://www.googleapis.com/auth/content'],
1243
+ * });
1244
+ *
1245
+ * // Acquire an auth client, and bind it to all future calls
1246
+ * const authClient = await auth.getClient();
1247
+ * google.options({auth: authClient});
1248
+ *
1249
+ * // Do the magic
1250
+ * const res = await merchantapi.accounts.productInputs.insert({
1251
+ * // Required. The primary or supplemental product data source name. If the product already exists and data source provided is different, then the product will be moved to a new data source. For more information, see [Overview of Data sources sub-API](/merchant/api/guides/data-sources/overview). Only API data sources are supported. Format: `accounts/{account\}/dataSources/{datasource\}`. For example, `accounts/123456/dataSources/104628`.
1252
+ * dataSource: 'placeholder-value',
1253
+ * // Required. The account where this product will be inserted. Format: `accounts/{account\}`
1254
+ * parent: 'accounts/my-account',
1255
+ *
1256
+ * // Request body metadata
1257
+ * requestBody: {
1258
+ * // request body parameters
1259
+ * // {
1260
+ * // "attributes": {},
1261
+ * // "channel": "my_channel",
1262
+ * // "contentLanguage": "my_contentLanguage",
1263
+ * // "customAttributes": [],
1264
+ * // "feedLabel": "my_feedLabel",
1265
+ * // "name": "my_name",
1266
+ * // "offerId": "my_offerId",
1267
+ * // "product": "my_product",
1268
+ * // "versionNumber": "my_versionNumber"
1269
+ * // }
1270
+ * },
1271
+ * });
1272
+ * console.log(res.data);
1273
+ *
1274
+ * // Example response
1275
+ * // {
1276
+ * // "attributes": {},
1277
+ * // "channel": "my_channel",
1278
+ * // "contentLanguage": "my_contentLanguage",
1279
+ * // "customAttributes": [],
1280
+ * // "feedLabel": "my_feedLabel",
1281
+ * // "name": "my_name",
1282
+ * // "offerId": "my_offerId",
1283
+ * // "product": "my_product",
1284
+ * // "versionNumber": "my_versionNumber"
1285
+ * // }
1286
+ * }
1287
+ *
1288
+ * main().catch(e => {
1289
+ * console.error(e);
1290
+ * throw e;
1291
+ * });
1292
+ *
1293
+ * ```
1168
1294
  *
1169
1295
  * @param params - Parameters for request
1170
1296
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1179,6 +1305,80 @@ export declare namespace merchantapi_products_v1beta {
1179
1305
  insert(callback: BodyResponseCallback<Schema$ProductInput>): void;
1180
1306
  /**
1181
1307
  * Updates the existing product input in your Merchant Center account. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.
1308
+ * @example
1309
+ * ```js
1310
+ * // Before running the sample:
1311
+ * // - Enable the API at:
1312
+ * // https://console.developers.google.com/apis/api/merchantapi.googleapis.com
1313
+ * // - Login into gcloud by running:
1314
+ * // ```sh
1315
+ * // $ gcloud auth application-default login
1316
+ * // ```
1317
+ * // - Install the npm module by running:
1318
+ * // ```sh
1319
+ * // $ npm install googleapis
1320
+ * // ```
1321
+ *
1322
+ * const {google} = require('googleapis');
1323
+ * const merchantapi = google.merchantapi('products_v1beta');
1324
+ *
1325
+ * async function main() {
1326
+ * const auth = new google.auth.GoogleAuth({
1327
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1328
+ * scopes: ['https://www.googleapis.com/auth/content'],
1329
+ * });
1330
+ *
1331
+ * // Acquire an auth client, and bind it to all future calls
1332
+ * const authClient = await auth.getClient();
1333
+ * google.options({auth: authClient});
1334
+ *
1335
+ * // Do the magic
1336
+ * const res = await merchantapi.accounts.productInputs.patch({
1337
+ * // Required. The primary or supplemental product data source where `data_source` name identifies the product input to be updated. Only API data sources are supported. Format: `accounts/{account\}/dataSources/{datasource\}`. For example, `accounts/123456/dataSources/104628`.
1338
+ * dataSource: 'placeholder-value',
1339
+ * // Identifier. The name of the product input. Format: `accounts/{account\}/productInputs/{productinput\}` where the last section `productinput` consists of 4 parts: `channel~content_language~feed_label~offer_id` example for product input name is `accounts/123/productInputs/online~en~US~sku123`
1340
+ * name: 'accounts/my-account/productInputs/my-productInput',
1341
+ * // Optional. The list of product attributes to be updated. If the update mask is omitted, then it is treated as implied field mask equivalent to all fields that are populated (have a non-empty value). Attributes specified in the update mask without a value specified in the body will be deleted from the product. Update mask can only be specified for top level fields in attributes and custom attributes. To specify the update mask for custom attributes you need to add the `custom_attribute.` prefix. Providing special "*" value for full product replacement is not supported.
1342
+ * updateMask: 'placeholder-value',
1343
+ *
1344
+ * // Request body metadata
1345
+ * requestBody: {
1346
+ * // request body parameters
1347
+ * // {
1348
+ * // "attributes": {},
1349
+ * // "channel": "my_channel",
1350
+ * // "contentLanguage": "my_contentLanguage",
1351
+ * // "customAttributes": [],
1352
+ * // "feedLabel": "my_feedLabel",
1353
+ * // "name": "my_name",
1354
+ * // "offerId": "my_offerId",
1355
+ * // "product": "my_product",
1356
+ * // "versionNumber": "my_versionNumber"
1357
+ * // }
1358
+ * },
1359
+ * });
1360
+ * console.log(res.data);
1361
+ *
1362
+ * // Example response
1363
+ * // {
1364
+ * // "attributes": {},
1365
+ * // "channel": "my_channel",
1366
+ * // "contentLanguage": "my_contentLanguage",
1367
+ * // "customAttributes": [],
1368
+ * // "feedLabel": "my_feedLabel",
1369
+ * // "name": "my_name",
1370
+ * // "offerId": "my_offerId",
1371
+ * // "product": "my_product",
1372
+ * // "versionNumber": "my_versionNumber"
1373
+ * // }
1374
+ * }
1375
+ *
1376
+ * main().catch(e => {
1377
+ * console.error(e);
1378
+ * throw e;
1379
+ * });
1380
+ *
1381
+ * ```
1182
1382
  *
1183
1383
  * @param params - Parameters for request
1184
1384
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1194,7 +1394,7 @@ export declare namespace merchantapi_products_v1beta {
1194
1394
  }
1195
1395
  export interface Params$Resource$Accounts$Productinputs$Delete extends StandardParameters {
1196
1396
  /**
1197
- * Required. The primary or supplemental data source from which the product input should be deleted. Format: `accounts/{account\}/dataSources/{datasource\}`.
1397
+ * Required. The primary or supplemental data source from which the product input should be deleted. Format: `accounts/{account\}/dataSources/{datasource\}`. For example, `accounts/123456/dataSources/104628`.
1198
1398
  */
1199
1399
  dataSource?: string;
1200
1400
  /**
@@ -1204,7 +1404,7 @@ export declare namespace merchantapi_products_v1beta {
1204
1404
  }
1205
1405
  export interface Params$Resource$Accounts$Productinputs$Insert extends StandardParameters {
1206
1406
  /**
1207
- * Required. The primary or supplemental product data source name. If the product already exists and data source provided is different, then the product will be moved to a new data source. Only API data sources are supported. Format: `accounts/{account\}/dataSources/{datasource\}`.
1407
+ * Required. The primary or supplemental product data source name. If the product already exists and data source provided is different, then the product will be moved to a new data source. For more information, see [Overview of Data sources sub-API](/merchant/api/guides/data-sources/overview). Only API data sources are supported. Format: `accounts/{account\}/dataSources/{datasource\}`. For example, `accounts/123456/dataSources/104628`.
1208
1408
  */
1209
1409
  dataSource?: string;
1210
1410
  /**
@@ -1218,7 +1418,7 @@ export declare namespace merchantapi_products_v1beta {
1218
1418
  }
1219
1419
  export interface Params$Resource$Accounts$Productinputs$Patch extends StandardParameters {
1220
1420
  /**
1221
- * Required. The primary or supplemental product data source where `data_source` name identifies the product input to be updated. Only API data sources are supported. Format: `accounts/{account\}/dataSources/{datasource\}`.
1421
+ * Required. The primary or supplemental product data source where `data_source` name identifies the product input to be updated. Only API data sources are supported. Format: `accounts/{account\}/dataSources/{datasource\}`. For example, `accounts/123456/dataSources/104628`.
1222
1422
  */
1223
1423
  dataSource?: string;
1224
1424
  /**
@@ -1239,6 +1439,62 @@ export declare namespace merchantapi_products_v1beta {
1239
1439
  constructor(context: APIRequestContext);
1240
1440
  /**
1241
1441
  * Retrieves the processed product from your Merchant Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.
1442
+ * @example
1443
+ * ```js
1444
+ * // Before running the sample:
1445
+ * // - Enable the API at:
1446
+ * // https://console.developers.google.com/apis/api/merchantapi.googleapis.com
1447
+ * // - Login into gcloud by running:
1448
+ * // ```sh
1449
+ * // $ gcloud auth application-default login
1450
+ * // ```
1451
+ * // - Install the npm module by running:
1452
+ * // ```sh
1453
+ * // $ npm install googleapis
1454
+ * // ```
1455
+ *
1456
+ * const {google} = require('googleapis');
1457
+ * const merchantapi = google.merchantapi('products_v1beta');
1458
+ *
1459
+ * async function main() {
1460
+ * const auth = new google.auth.GoogleAuth({
1461
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1462
+ * scopes: ['https://www.googleapis.com/auth/content'],
1463
+ * });
1464
+ *
1465
+ * // Acquire an auth client, and bind it to all future calls
1466
+ * const authClient = await auth.getClient();
1467
+ * google.options({auth: authClient});
1468
+ *
1469
+ * // Do the magic
1470
+ * const res = await merchantapi.accounts.products.get({
1471
+ * // Required. The name of the product to retrieve. Format: `accounts/{account\}/products/{product\}` where the last section `product` consists of 4 parts: `channel~content_language~feed_label~offer_id` example for product name is `accounts/123/products/online~en~US~sku123`
1472
+ * name: 'accounts/my-account/products/my-product',
1473
+ * });
1474
+ * console.log(res.data);
1475
+ *
1476
+ * // Example response
1477
+ * // {
1478
+ * // "attributes": {},
1479
+ * // "automatedDiscounts": {},
1480
+ * // "channel": "my_channel",
1481
+ * // "contentLanguage": "my_contentLanguage",
1482
+ * // "customAttributes": [],
1483
+ * // "dataSource": "my_dataSource",
1484
+ * // "feedLabel": "my_feedLabel",
1485
+ * // "name": "my_name",
1486
+ * // "offerId": "my_offerId",
1487
+ * // "productStatus": {},
1488
+ * // "versionNumber": "my_versionNumber"
1489
+ * // }
1490
+ * }
1491
+ *
1492
+ * main().catch(e => {
1493
+ * console.error(e);
1494
+ * throw e;
1495
+ * });
1496
+ *
1497
+ * ```
1242
1498
  *
1243
1499
  * @param params - Parameters for request
1244
1500
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1253,6 +1509,57 @@ export declare namespace merchantapi_products_v1beta {
1253
1509
  get(callback: BodyResponseCallback<Schema$Product>): void;
1254
1510
  /**
1255
1511
  * Lists the processed products in your Merchant Center account. The response might contain fewer items than specified by `pageSize`. Rely on `pageToken` to determine if there are more items to be requested. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved.
1512
+ * @example
1513
+ * ```js
1514
+ * // Before running the sample:
1515
+ * // - Enable the API at:
1516
+ * // https://console.developers.google.com/apis/api/merchantapi.googleapis.com
1517
+ * // - Login into gcloud by running:
1518
+ * // ```sh
1519
+ * // $ gcloud auth application-default login
1520
+ * // ```
1521
+ * // - Install the npm module by running:
1522
+ * // ```sh
1523
+ * // $ npm install googleapis
1524
+ * // ```
1525
+ *
1526
+ * const {google} = require('googleapis');
1527
+ * const merchantapi = google.merchantapi('products_v1beta');
1528
+ *
1529
+ * async function main() {
1530
+ * const auth = new google.auth.GoogleAuth({
1531
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1532
+ * scopes: ['https://www.googleapis.com/auth/content'],
1533
+ * });
1534
+ *
1535
+ * // Acquire an auth client, and bind it to all future calls
1536
+ * const authClient = await auth.getClient();
1537
+ * google.options({auth: authClient});
1538
+ *
1539
+ * // Do the magic
1540
+ * const res = await merchantapi.accounts.products.list({
1541
+ * // The maximum number of products to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of products will be returned.
1542
+ * pageSize: 'placeholder-value',
1543
+ * // A page token, received from a previous `ListProducts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProducts` must match the call that provided the page token.
1544
+ * pageToken: 'placeholder-value',
1545
+ * // Required. The account to list processed products for. Format: `accounts/{account\}`
1546
+ * parent: 'accounts/my-account',
1547
+ * });
1548
+ * console.log(res.data);
1549
+ *
1550
+ * // Example response
1551
+ * // {
1552
+ * // "nextPageToken": "my_nextPageToken",
1553
+ * // "products": []
1554
+ * // }
1555
+ * }
1556
+ *
1557
+ * main().catch(e => {
1558
+ * console.error(e);
1559
+ * throw e;
1560
+ * });
1561
+ *
1562
+ * ```
1256
1563
  *
1257
1564
  * @param params - Parameters for request
1258
1565
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1274,7 +1581,7 @@ export declare namespace merchantapi_products_v1beta {
1274
1581
  }
1275
1582
  export interface Params$Resource$Accounts$Products$List extends StandardParameters {
1276
1583
  /**
1277
- * The maximum number of products to return. The service may return fewer than this value. The maximum value is 250; values above 250 will be coerced to 250. If unspecified, the maximum number of products will be returned.
1584
+ * The maximum number of products to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of products will be returned.
1278
1585
  */
1279
1586
  pageSize?: number;
1280
1587
  /**