@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
@@ -133,7 +133,7 @@ export namespace merchantapi_products_v1beta {
133
133
  */
134
134
  additionalImageLinks?: string[] | null;
135
135
  /**
136
- * Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
136
+ * 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).
137
137
  */
138
138
  adsGrouping?: string | null;
139
139
  /**
@@ -153,11 +153,11 @@ export namespace merchantapi_products_v1beta {
153
153
  */
154
154
  ageGroup?: string | null;
155
155
  /**
156
- * 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.
156
+ * 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.
157
157
  */
158
158
  autoPricingMinPrice?: Schema$Price;
159
159
  /**
160
- * Availability status of the item.
160
+ * [Availability](https://support.google.com/merchants/answer/6324448) status of the item. For example, "in_stock" or "out_of_stock".
161
161
  */
162
162
  availability?: string | null;
163
163
  /**
@@ -165,7 +165,7 @@ export namespace merchantapi_products_v1beta {
165
165
  */
166
166
  availabilityDate?: string | null;
167
167
  /**
168
- * Brand of the item.
168
+ * [Brand](https://support.google.com/merchants/answer/6324351) of the item. For example, "Google".
169
169
  */
170
170
  brand?: string | null;
171
171
  /**
@@ -181,11 +181,11 @@ export namespace merchantapi_products_v1beta {
181
181
  */
182
182
  cloudExportAdditionalProperties?: Schema$CloudExportAdditionalProperties[];
183
183
  /**
184
- * Color of the item.
184
+ * [Color](https://support.google.com/merchants/answer/6324487) of the item. For example, "red".
185
185
  */
186
186
  color?: string | null;
187
187
  /**
188
- * Condition or state of the item.
188
+ * [Condition](https://support.google.com/merchants/answer/6324469) or state of the item. For example, "new" or "used".
189
189
  */
190
190
  condition?: string | null;
191
191
  /**
@@ -193,23 +193,23 @@ export namespace merchantapi_products_v1beta {
193
193
  */
194
194
  costOfGoodsSold?: Schema$Price;
195
195
  /**
196
- * Custom label 0 for custom grouping of items in a Shopping campaign.
196
+ * [Custom label 0](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.
197
197
  */
198
198
  customLabel0?: string | null;
199
199
  /**
200
- * Custom label 1 for custom grouping of items in a Shopping campaign.
200
+ * [Custom label 1](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.
201
201
  */
202
202
  customLabel1?: string | null;
203
203
  /**
204
- * Custom label 2 for custom grouping of items in a Shopping campaign.
204
+ * [Custom label 2](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.
205
205
  */
206
206
  customLabel2?: string | null;
207
207
  /**
208
- * Custom label 3 for custom grouping of items in a Shopping campaign.
208
+ * [Custom label 3](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.
209
209
  */
210
210
  customLabel3?: string | null;
211
211
  /**
212
- * Custom label 4 for custom grouping of items in a Shopping campaign.
212
+ * [Custom label 4](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.
213
213
  */
214
214
  customLabel4?: string | null;
215
215
  /**
@@ -217,7 +217,7 @@ export namespace merchantapi_products_v1beta {
217
217
  */
218
218
  description?: string | null;
219
219
  /**
220
- * 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.
220
+ * 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.
221
221
  */
222
222
  disclosureDate?: string | null;
223
223
  /**
@@ -229,7 +229,7 @@ export namespace merchantapi_products_v1beta {
229
229
  */
230
230
  displayAdsLink?: string | null;
231
231
  /**
232
- * Advertiser-specified recommendations.
232
+ * Advertiser-specified recommendations. For more information, see [Display ads attribute specification](https://support.google.com/merchants/answer/6069387).
233
233
  */
234
234
  displayAdsSimilarIds?: string[] | null;
235
235
  /**
@@ -237,7 +237,7 @@ export namespace merchantapi_products_v1beta {
237
237
  */
238
238
  displayAdsTitle?: string | null;
239
239
  /**
240
- * Offer margin for dynamic remarketing campaigns.
240
+ * Offer margin for dynamic remarketing campaigns. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387).
241
241
  */
242
242
  displayAdsValue?: number | null;
243
243
  /**
@@ -245,7 +245,7 @@ export namespace merchantapi_products_v1beta {
245
245
  */
246
246
  energyEfficiencyClass?: string | null;
247
247
  /**
248
- * The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
248
+ * 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.
249
249
  */
250
250
  excludedDestinations?: string[] | null;
251
251
  /**
@@ -261,7 +261,7 @@ export namespace merchantapi_products_v1beta {
261
261
  */
262
262
  freeShippingThreshold?: Schema$FreeShippingThreshold[];
263
263
  /**
264
- * Target gender of the item.
264
+ * Target [gender](https://support.google.com/merchants/answer/6324479) of the item. For example, "male" or "female".
265
265
  */
266
266
  gender?: string | null;
267
267
  /**
@@ -269,9 +269,13 @@ export namespace merchantapi_products_v1beta {
269
269
  */
270
270
  googleProductCategory?: string | null;
271
271
  /**
272
- * Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs.
272
+ * 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.
273
273
  */
274
274
  gtin?: string[] | null;
275
+ /**
276
+ * Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs.
277
+ */
278
+ gtins?: string[] | null;
275
279
  /**
276
280
  * 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.
277
281
  */
@@ -281,7 +285,7 @@ export namespace merchantapi_products_v1beta {
281
285
  */
282
286
  imageLink?: string | null;
283
287
  /**
284
- * 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`.
288
+ * 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.
285
289
  */
286
290
  includedDestinations?: string[] | null;
287
291
  /**
@@ -289,7 +293,7 @@ export namespace merchantapi_products_v1beta {
289
293
  */
290
294
  installment?: Schema$Installment;
291
295
  /**
292
- * 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.
296
+ * 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.
293
297
  */
294
298
  isBundle?: boolean | null;
295
299
  /**
@@ -305,7 +309,7 @@ export namespace merchantapi_products_v1beta {
305
309
  */
306
310
  link?: string | null;
307
311
  /**
308
- * Link template for merchant hosted local storefront.
312
+ * [Link template](https://support.google.com/merchants/answer/13871172) for business hosted local storefront.
309
313
  */
310
314
  linkTemplate?: string | null;
311
315
  /**
@@ -317,7 +321,7 @@ export namespace merchantapi_products_v1beta {
317
321
  */
318
322
  loyaltyPrograms?: Schema$LoyaltyProgram[];
319
323
  /**
320
- * The material of which the item is made.
324
+ * The [material](https://support.google.com/merchants/answer/6324410) of which the item is made. For example, "Leather" or "Cotton".
321
325
  */
322
326
  material?: string | null;
323
327
  /**
@@ -328,6 +332,10 @@ export namespace merchantapi_products_v1beta {
328
332
  * Maximal product handling time (in business days).
329
333
  */
330
334
  maxHandlingTime?: string | null;
335
+ /**
336
+ * Maximum retail price (MRP) of the item. Applicable to India only.
337
+ */
338
+ maximumRetailPrice?: Schema$Price;
331
339
  /**
332
340
  * The energy efficiency class as defined in EU directive 2010/30/EU.
333
341
  */
@@ -341,7 +349,7 @@ export namespace merchantapi_products_v1beta {
341
349
  */
342
350
  mobileLink?: string | null;
343
351
  /**
344
- * Link template for merchant hosted local storefront optimized for mobile devices.
352
+ * [Link template](https://support.google.com/merchants/answer/13870216) for business hosted local storefront optimized for mobile devices.
345
353
  */
346
354
  mobileLinkTemplate?: string | null;
347
355
  /**
@@ -349,11 +357,11 @@ export namespace merchantapi_products_v1beta {
349
357
  */
350
358
  mpn?: string | null;
351
359
  /**
352
- * The number of identical products in a merchant-defined multipack.
360
+ * The number of identical products in a business-defined multipack.
353
361
  */
354
362
  multipack?: string | null;
355
363
  /**
356
- * The item's pattern (for example, polka dots).
364
+ * The item's [pattern](https://support.google.com/merchants/answer/6324483). For example, polka dots.
357
365
  */
358
366
  pattern?: string | null;
359
367
  /**
@@ -361,11 +369,11 @@ export namespace merchantapi_products_v1beta {
361
369
  */
362
370
  pause?: string | null;
363
371
  /**
364
- * The pick up option for the item.
372
+ * The [pickup](https://support.google.com/merchants/answer/14634021) option for the item.
365
373
  */
366
374
  pickupMethod?: string | null;
367
375
  /**
368
- * Item store pickup timeline.
376
+ * Item store pickup timeline. For more information, see [Pickup SLA](https://support.google.com/merchants/answer/14635400).
369
377
  */
370
378
  pickupSla?: string | null;
371
379
  /**
@@ -381,7 +389,7 @@ export namespace merchantapi_products_v1beta {
381
389
  */
382
390
  productHeight?: Schema$ProductDimension;
383
391
  /**
384
- * Bullet points describing the most relevant highlights of a product.
392
+ * Bullet points describing the most relevant [product highlights](https://support.google.com/merchants/answer/9216100).
385
393
  */
386
394
  productHighlights?: string[] | null;
387
395
  /**
@@ -389,7 +397,7 @@ export namespace merchantapi_products_v1beta {
389
397
  */
390
398
  productLength?: Schema$ProductDimension;
391
399
  /**
392
- * Categories of the item (formatted as in [product data specification](https://support.google.com/merchants/answer/188494#product_type)).
400
+ * Categories of the item (formatted as in [product data specification](https://support.google.com/merchants/answer/7052112#product_category)).
393
401
  */
394
402
  productTypes?: string[] | null;
395
403
  /**
@@ -409,7 +417,7 @@ export namespace merchantapi_products_v1beta {
409
417
  */
410
418
  salePrice?: Schema$Price;
411
419
  /**
412
- * Date range during which the item is on sale (see [product data specification](https://support.google.com/merchants/answer/188494#sale_price_effective_date)).
420
+ * Date range during which the item is on sale, see [product data specification](https://support.google.com/merchants/answer/7052112#price_and_availability).
413
421
  */
414
422
  salePriceEffectiveDate?: Schema$Interval;
415
423
  /**
@@ -441,19 +449,19 @@ export namespace merchantapi_products_v1beta {
441
449
  */
442
450
  shippingWidth?: Schema$ShippingDimension;
443
451
  /**
444
- * 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.
452
+ * 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.
445
453
  */
446
454
  shoppingAdsExcludedCountries?: string[] | null;
447
455
  /**
448
- * 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)).
456
+ * 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).
449
457
  */
450
458
  size?: string | null;
451
459
  /**
452
- * System in which the size is specified. Recommended for apparel items.
460
+ * 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).
453
461
  */
454
462
  sizeSystem?: string | null;
455
463
  /**
456
- * 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)).
464
+ * 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".
457
465
  */
458
466
  sizeTypes?: string[] | null;
459
467
  /**
@@ -473,7 +481,7 @@ export namespace merchantapi_products_v1beta {
473
481
  */
474
482
  sustainabilityIncentives?: Schema$ProductSustainabilityIncentive[];
475
483
  /**
476
- * The tax category of the product.
484
+ * The [tax category](https://support.google.com/merchants/answer/7569847) of the product.
477
485
  */
478
486
  taxCategory?: string | null;
479
487
  /**
@@ -698,7 +706,7 @@ export namespace merchantapi_products_v1beta {
698
706
  */
699
707
  reportingContext?: string | null;
700
708
  /**
701
- * Whether the issue can be resolved by the merchant.
709
+ * Whether the issue can be resolved by the business.
702
710
  */
703
711
  resolution?: string | null;
704
712
  /**
@@ -757,7 +765,7 @@ export namespace merchantapi_products_v1beta {
757
765
  */
758
766
  price?: Schema$Price;
759
767
  /**
760
- * 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.
768
+ * 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.
761
769
  */
762
770
  programLabel?: string | null;
763
771
  /**
@@ -811,7 +819,7 @@ export namespace merchantapi_products_v1beta {
811
819
  */
812
820
  dataSource?: string | null;
813
821
  /**
814
- * Output only. The feed label for the product.
822
+ * 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)
815
823
  */
816
824
  feedLabel?: string | null;
817
825
  /**
@@ -883,7 +891,7 @@ export namespace merchantapi_products_v1beta {
883
891
  value?: number | null;
884
892
  }
885
893
  /**
886
- * 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.
894
+ * 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.
887
895
  */
888
896
  export interface Schema$ProductInput {
889
897
  /**
@@ -903,7 +911,7 @@ export namespace merchantapi_products_v1beta {
903
911
  */
904
912
  customAttributes?: Schema$CustomAttribute[];
905
913
  /**
906
- * Required. Immutable. The [feed label](https://developers.google.com/shopping-content/guides/products/feed-labels) for the product.
914
+ * 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).
907
915
  */
908
916
  feedLabel?: string | null;
909
917
  /**
@@ -969,7 +977,7 @@ export namespace merchantapi_products_v1beta {
969
977
  */
970
978
  eventTime?: string | null;
971
979
  /**
972
- * Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event.
980
+ * Optional. The product expiration time. This field will not be set if the notification is sent for a product deletion event.
973
981
  */
974
982
  expirationTime?: string | null;
975
983
  /**
@@ -1212,6 +1220,52 @@ export namespace merchantapi_products_v1beta {
1212
1220
 
1213
1221
  /**
1214
1222
  * 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.
1223
+ * @example
1224
+ * ```js
1225
+ * // Before running the sample:
1226
+ * // - Enable the API at:
1227
+ * // https://console.developers.google.com/apis/api/merchantapi.googleapis.com
1228
+ * // - Login into gcloud by running:
1229
+ * // ```sh
1230
+ * // $ gcloud auth application-default login
1231
+ * // ```
1232
+ * // - Install the npm module by running:
1233
+ * // ```sh
1234
+ * // $ npm install googleapis
1235
+ * // ```
1236
+ *
1237
+ * const {google} = require('googleapis');
1238
+ * const merchantapi = google.merchantapi('products_v1beta');
1239
+ *
1240
+ * async function main() {
1241
+ * const auth = new google.auth.GoogleAuth({
1242
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1243
+ * scopes: ['https://www.googleapis.com/auth/content'],
1244
+ * });
1245
+ *
1246
+ * // Acquire an auth client, and bind it to all future calls
1247
+ * const authClient = await auth.getClient();
1248
+ * google.options({auth: authClient});
1249
+ *
1250
+ * // Do the magic
1251
+ * const res = await merchantapi.accounts.productInputs.delete({
1252
+ * // 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`.
1253
+ * dataSource: 'placeholder-value',
1254
+ * // 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`.
1255
+ * name: 'accounts/my-account/productInputs/my-productInput',
1256
+ * });
1257
+ * console.log(res.data);
1258
+ *
1259
+ * // Example response
1260
+ * // {}
1261
+ * }
1262
+ *
1263
+ * main().catch(e => {
1264
+ * console.error(e);
1265
+ * throw e;
1266
+ * });
1267
+ *
1268
+ * ```
1215
1269
  *
1216
1270
  * @param params - Parameters for request
1217
1271
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1302,7 +1356,79 @@ export namespace merchantapi_products_v1beta {
1302
1356
  }
1303
1357
 
1304
1358
  /**
1305
- * 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.
1359
+ * [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.
1360
+ * @example
1361
+ * ```js
1362
+ * // Before running the sample:
1363
+ * // - Enable the API at:
1364
+ * // https://console.developers.google.com/apis/api/merchantapi.googleapis.com
1365
+ * // - Login into gcloud by running:
1366
+ * // ```sh
1367
+ * // $ gcloud auth application-default login
1368
+ * // ```
1369
+ * // - Install the npm module by running:
1370
+ * // ```sh
1371
+ * // $ npm install googleapis
1372
+ * // ```
1373
+ *
1374
+ * const {google} = require('googleapis');
1375
+ * const merchantapi = google.merchantapi('products_v1beta');
1376
+ *
1377
+ * async function main() {
1378
+ * const auth = new google.auth.GoogleAuth({
1379
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1380
+ * scopes: ['https://www.googleapis.com/auth/content'],
1381
+ * });
1382
+ *
1383
+ * // Acquire an auth client, and bind it to all future calls
1384
+ * const authClient = await auth.getClient();
1385
+ * google.options({auth: authClient});
1386
+ *
1387
+ * // Do the magic
1388
+ * const res = await merchantapi.accounts.productInputs.insert({
1389
+ * // 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`.
1390
+ * dataSource: 'placeholder-value',
1391
+ * // Required. The account where this product will be inserted. Format: `accounts/{account\}`
1392
+ * parent: 'accounts/my-account',
1393
+ *
1394
+ * // Request body metadata
1395
+ * requestBody: {
1396
+ * // request body parameters
1397
+ * // {
1398
+ * // "attributes": {},
1399
+ * // "channel": "my_channel",
1400
+ * // "contentLanguage": "my_contentLanguage",
1401
+ * // "customAttributes": [],
1402
+ * // "feedLabel": "my_feedLabel",
1403
+ * // "name": "my_name",
1404
+ * // "offerId": "my_offerId",
1405
+ * // "product": "my_product",
1406
+ * // "versionNumber": "my_versionNumber"
1407
+ * // }
1408
+ * },
1409
+ * });
1410
+ * console.log(res.data);
1411
+ *
1412
+ * // Example response
1413
+ * // {
1414
+ * // "attributes": {},
1415
+ * // "channel": "my_channel",
1416
+ * // "contentLanguage": "my_contentLanguage",
1417
+ * // "customAttributes": [],
1418
+ * // "feedLabel": "my_feedLabel",
1419
+ * // "name": "my_name",
1420
+ * // "offerId": "my_offerId",
1421
+ * // "product": "my_product",
1422
+ * // "versionNumber": "my_versionNumber"
1423
+ * // }
1424
+ * }
1425
+ *
1426
+ * main().catch(e => {
1427
+ * console.error(e);
1428
+ * throw e;
1429
+ * });
1430
+ *
1431
+ * ```
1306
1432
  *
1307
1433
  * @param params - Parameters for request
1308
1434
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1393,6 +1519,80 @@ export namespace merchantapi_products_v1beta {
1393
1519
 
1394
1520
  /**
1395
1521
  * 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.
1522
+ * @example
1523
+ * ```js
1524
+ * // Before running the sample:
1525
+ * // - Enable the API at:
1526
+ * // https://console.developers.google.com/apis/api/merchantapi.googleapis.com
1527
+ * // - Login into gcloud by running:
1528
+ * // ```sh
1529
+ * // $ gcloud auth application-default login
1530
+ * // ```
1531
+ * // - Install the npm module by running:
1532
+ * // ```sh
1533
+ * // $ npm install googleapis
1534
+ * // ```
1535
+ *
1536
+ * const {google} = require('googleapis');
1537
+ * const merchantapi = google.merchantapi('products_v1beta');
1538
+ *
1539
+ * async function main() {
1540
+ * const auth = new google.auth.GoogleAuth({
1541
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1542
+ * scopes: ['https://www.googleapis.com/auth/content'],
1543
+ * });
1544
+ *
1545
+ * // Acquire an auth client, and bind it to all future calls
1546
+ * const authClient = await auth.getClient();
1547
+ * google.options({auth: authClient});
1548
+ *
1549
+ * // Do the magic
1550
+ * const res = await merchantapi.accounts.productInputs.patch({
1551
+ * // 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`.
1552
+ * dataSource: 'placeholder-value',
1553
+ * // 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`
1554
+ * name: 'accounts/my-account/productInputs/my-productInput',
1555
+ * // 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.
1556
+ * updateMask: 'placeholder-value',
1557
+ *
1558
+ * // Request body metadata
1559
+ * requestBody: {
1560
+ * // request body parameters
1561
+ * // {
1562
+ * // "attributes": {},
1563
+ * // "channel": "my_channel",
1564
+ * // "contentLanguage": "my_contentLanguage",
1565
+ * // "customAttributes": [],
1566
+ * // "feedLabel": "my_feedLabel",
1567
+ * // "name": "my_name",
1568
+ * // "offerId": "my_offerId",
1569
+ * // "product": "my_product",
1570
+ * // "versionNumber": "my_versionNumber"
1571
+ * // }
1572
+ * },
1573
+ * });
1574
+ * console.log(res.data);
1575
+ *
1576
+ * // Example response
1577
+ * // {
1578
+ * // "attributes": {},
1579
+ * // "channel": "my_channel",
1580
+ * // "contentLanguage": "my_contentLanguage",
1581
+ * // "customAttributes": [],
1582
+ * // "feedLabel": "my_feedLabel",
1583
+ * // "name": "my_name",
1584
+ * // "offerId": "my_offerId",
1585
+ * // "product": "my_product",
1586
+ * // "versionNumber": "my_versionNumber"
1587
+ * // }
1588
+ * }
1589
+ *
1590
+ * main().catch(e => {
1591
+ * console.error(e);
1592
+ * throw e;
1593
+ * });
1594
+ *
1595
+ * ```
1396
1596
  *
1397
1597
  * @param params - Parameters for request
1398
1598
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1486,7 +1686,7 @@ export namespace merchantapi_products_v1beta {
1486
1686
  export interface Params$Resource$Accounts$Productinputs$Delete
1487
1687
  extends StandardParameters {
1488
1688
  /**
1489
- * Required. The primary or supplemental data source from which the product input should be deleted. Format: `accounts/{account\}/dataSources/{datasource\}`.
1689
+ * 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`.
1490
1690
  */
1491
1691
  dataSource?: string;
1492
1692
  /**
@@ -1497,7 +1697,7 @@ export namespace merchantapi_products_v1beta {
1497
1697
  export interface Params$Resource$Accounts$Productinputs$Insert
1498
1698
  extends StandardParameters {
1499
1699
  /**
1500
- * 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\}`.
1700
+ * 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`.
1501
1701
  */
1502
1702
  dataSource?: string;
1503
1703
  /**
@@ -1513,7 +1713,7 @@ export namespace merchantapi_products_v1beta {
1513
1713
  export interface Params$Resource$Accounts$Productinputs$Patch
1514
1714
  extends StandardParameters {
1515
1715
  /**
1516
- * 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\}`.
1716
+ * 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`.
1517
1717
  */
1518
1718
  dataSource?: string;
1519
1719
  /**
@@ -1539,6 +1739,62 @@ export namespace merchantapi_products_v1beta {
1539
1739
 
1540
1740
  /**
1541
1741
  * 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.
1742
+ * @example
1743
+ * ```js
1744
+ * // Before running the sample:
1745
+ * // - Enable the API at:
1746
+ * // https://console.developers.google.com/apis/api/merchantapi.googleapis.com
1747
+ * // - Login into gcloud by running:
1748
+ * // ```sh
1749
+ * // $ gcloud auth application-default login
1750
+ * // ```
1751
+ * // - Install the npm module by running:
1752
+ * // ```sh
1753
+ * // $ npm install googleapis
1754
+ * // ```
1755
+ *
1756
+ * const {google} = require('googleapis');
1757
+ * const merchantapi = google.merchantapi('products_v1beta');
1758
+ *
1759
+ * async function main() {
1760
+ * const auth = new google.auth.GoogleAuth({
1761
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1762
+ * scopes: ['https://www.googleapis.com/auth/content'],
1763
+ * });
1764
+ *
1765
+ * // Acquire an auth client, and bind it to all future calls
1766
+ * const authClient = await auth.getClient();
1767
+ * google.options({auth: authClient});
1768
+ *
1769
+ * // Do the magic
1770
+ * const res = await merchantapi.accounts.products.get({
1771
+ * // 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`
1772
+ * name: 'accounts/my-account/products/my-product',
1773
+ * });
1774
+ * console.log(res.data);
1775
+ *
1776
+ * // Example response
1777
+ * // {
1778
+ * // "attributes": {},
1779
+ * // "automatedDiscounts": {},
1780
+ * // "channel": "my_channel",
1781
+ * // "contentLanguage": "my_contentLanguage",
1782
+ * // "customAttributes": [],
1783
+ * // "dataSource": "my_dataSource",
1784
+ * // "feedLabel": "my_feedLabel",
1785
+ * // "name": "my_name",
1786
+ * // "offerId": "my_offerId",
1787
+ * // "productStatus": {},
1788
+ * // "versionNumber": "my_versionNumber"
1789
+ * // }
1790
+ * }
1791
+ *
1792
+ * main().catch(e => {
1793
+ * console.error(e);
1794
+ * throw e;
1795
+ * });
1796
+ *
1797
+ * ```
1542
1798
  *
1543
1799
  * @param params - Parameters for request
1544
1800
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1630,6 +1886,57 @@ export namespace merchantapi_products_v1beta {
1630
1886
 
1631
1887
  /**
1632
1888
  * 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.
1889
+ * @example
1890
+ * ```js
1891
+ * // Before running the sample:
1892
+ * // - Enable the API at:
1893
+ * // https://console.developers.google.com/apis/api/merchantapi.googleapis.com
1894
+ * // - Login into gcloud by running:
1895
+ * // ```sh
1896
+ * // $ gcloud auth application-default login
1897
+ * // ```
1898
+ * // - Install the npm module by running:
1899
+ * // ```sh
1900
+ * // $ npm install googleapis
1901
+ * // ```
1902
+ *
1903
+ * const {google} = require('googleapis');
1904
+ * const merchantapi = google.merchantapi('products_v1beta');
1905
+ *
1906
+ * async function main() {
1907
+ * const auth = new google.auth.GoogleAuth({
1908
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1909
+ * scopes: ['https://www.googleapis.com/auth/content'],
1910
+ * });
1911
+ *
1912
+ * // Acquire an auth client, and bind it to all future calls
1913
+ * const authClient = await auth.getClient();
1914
+ * google.options({auth: authClient});
1915
+ *
1916
+ * // Do the magic
1917
+ * const res = await merchantapi.accounts.products.list({
1918
+ * // 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.
1919
+ * pageSize: 'placeholder-value',
1920
+ * // 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.
1921
+ * pageToken: 'placeholder-value',
1922
+ * // Required. The account to list processed products for. Format: `accounts/{account\}`
1923
+ * parent: 'accounts/my-account',
1924
+ * });
1925
+ * console.log(res.data);
1926
+ *
1927
+ * // Example response
1928
+ * // {
1929
+ * // "nextPageToken": "my_nextPageToken",
1930
+ * // "products": []
1931
+ * // }
1932
+ * }
1933
+ *
1934
+ * main().catch(e => {
1935
+ * console.error(e);
1936
+ * throw e;
1937
+ * });
1938
+ *
1939
+ * ```
1633
1940
  *
1634
1941
  * @param params - Parameters for request
1635
1942
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1732,7 +2039,7 @@ export namespace merchantapi_products_v1beta {
1732
2039
  export interface Params$Resource$Accounts$Products$List
1733
2040
  extends StandardParameters {
1734
2041
  /**
1735
- * 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.
2042
+ * 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.
1736
2043
  */
1737
2044
  pageSize?: number;
1738
2045
  /**