@googleapis/merchantapi 5.0.0 → 8.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 (49) hide show
  1. package/CHANGELOG.md +50 -0
  2. package/README.md +9 -0
  3. package/accounts_v1beta.ts +6487 -518
  4. package/build/accounts_v1beta.d.ts +4773 -229
  5. package/build/accounts_v1beta.js +560 -12
  6. package/build/accounts_v1beta.js.map +1 -1
  7. package/build/conversions_v1beta.d.ts +349 -14
  8. package/build/conversions_v1beta.js.map +1 -1
  9. package/build/datasources_v1beta.d.ts +427 -18
  10. package/build/datasources_v1beta.js.map +1 -1
  11. package/build/index.d.ts +11 -1
  12. package/build/index.js +7 -1
  13. package/build/index.js.map +1 -1
  14. package/build/inventories_v1beta.d.ts +349 -15
  15. package/build/inventories_v1beta.js.map +1 -1
  16. package/build/issueresolution_v1beta.d.ts +1027 -0
  17. package/build/issueresolution_v1beta.js +196 -0
  18. package/build/issueresolution_v1beta.js.map +1 -0
  19. package/build/lfp_v1beta.d.ts +451 -18
  20. package/build/lfp_v1beta.js.map +1 -1
  21. package/build/notifications_v1beta.d.ts +283 -12
  22. package/build/notifications_v1beta.js.map +1 -1
  23. package/build/ordertracking_v1beta.d.ts +459 -0
  24. package/build/ordertracking_v1beta.js +91 -0
  25. package/build/ordertracking_v1beta.js.map +1 -0
  26. package/build/products_v1beta.d.ts +358 -55
  27. package/build/products_v1beta.js.map +1 -1
  28. package/build/promotions_v1beta.d.ts +178 -11
  29. package/build/promotions_v1beta.js.map +1 -1
  30. package/build/quota_v1beta.d.ts +55 -4
  31. package/build/quota_v1beta.js.map +1 -1
  32. package/build/reports_v1beta.d.ts +61 -4
  33. package/build/reports_v1beta.js.map +1 -1
  34. package/build/reviews_v1beta.d.ts +443 -19
  35. package/build/reviews_v1beta.js.map +1 -1
  36. package/conversions_v1beta.ts +371 -21
  37. package/datasources_v1beta.ts +453 -26
  38. package/index.ts +24 -1
  39. package/inventories_v1beta.ts +367 -24
  40. package/issueresolution_v1beta.ts +1426 -0
  41. package/lfp_v1beta.ts +477 -26
  42. package/notifications_v1beta.ts +299 -21
  43. package/ordertracking_v1beta.ts +599 -0
  44. package/package.json +2 -2
  45. package/products_v1beta.ts +376 -61
  46. package/promotions_v1beta.ts +188 -15
  47. package/quota_v1beta.ts +57 -6
  48. package/reports_v1beta.ts +65 -5
  49. package/reviews_v1beta.ts +471 -29
@@ -1,5 +1,5 @@
1
1
  /// <reference types="node" />
2
- import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
2
+ import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
3
3
  import { Readable } from 'stream';
4
4
  export declare namespace merchantapi_products_v1beta {
5
5
  export interface Options extends GlobalOptions {
@@ -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
  /**
@@ -228,7 +228,7 @@ export declare namespace merchantapi_products_v1beta {
228
228
  */
229
229
  imageLink?: string | null;
230
230
  /**
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`.
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`. 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
232
  */
233
233
  includedDestinations?: string[] | null;
234
234
  /**
@@ -236,7 +236,7 @@ export declare namespace merchantapi_products_v1beta {
236
236
  */
237
237
  installment?: Schema$Installment;
238
238
  /**
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.
239
+ * 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
240
  */
241
241
  isBundle?: boolean | null;
242
242
  /**
@@ -252,7 +252,7 @@ export declare namespace merchantapi_products_v1beta {
252
252
  */
253
253
  link?: string | null;
254
254
  /**
255
- * Link template for merchant hosted local storefront.
255
+ * [Link template](https://support.google.com/merchants/answer/13871172) for business hosted local storefront.
256
256
  */
257
257
  linkTemplate?: string | null;
258
258
  /**
@@ -264,7 +264,7 @@ export declare namespace merchantapi_products_v1beta {
264
264
  */
265
265
  loyaltyPrograms?: Schema$LoyaltyProgram[];
266
266
  /**
267
- * The material of which the item is made.
267
+ * The [material](https://support.google.com/merchants/answer/6324410) of which the item is made. For example, "Leather" or "Cotton".
268
268
  */
269
269
  material?: string | null;
270
270
  /**
@@ -275,6 +275,10 @@ export declare namespace merchantapi_products_v1beta {
275
275
  * Maximal product handling time (in business days).
276
276
  */
277
277
  maxHandlingTime?: string | null;
278
+ /**
279
+ * Maximum retail price (MRP) of the item. Applicable to India only.
280
+ */
281
+ maximumRetailPrice?: Schema$Price;
278
282
  /**
279
283
  * The energy efficiency class as defined in EU directive 2010/30/EU.
280
284
  */
@@ -288,7 +292,7 @@ export declare namespace merchantapi_products_v1beta {
288
292
  */
289
293
  mobileLink?: string | null;
290
294
  /**
291
- * Link template for merchant hosted local storefront optimized for mobile devices.
295
+ * [Link template](https://support.google.com/merchants/answer/13870216) for business hosted local storefront optimized for mobile devices.
292
296
  */
293
297
  mobileLinkTemplate?: string | null;
294
298
  /**
@@ -296,11 +300,11 @@ export declare namespace merchantapi_products_v1beta {
296
300
  */
297
301
  mpn?: string | null;
298
302
  /**
299
- * The number of identical products in a merchant-defined multipack.
303
+ * The number of identical products in a business-defined multipack.
300
304
  */
301
305
  multipack?: string | null;
302
306
  /**
303
- * The item's pattern (for example, polka dots).
307
+ * The item's [pattern](https://support.google.com/merchants/answer/6324483). For example, polka dots.
304
308
  */
305
309
  pattern?: string | null;
306
310
  /**
@@ -308,11 +312,11 @@ export declare namespace merchantapi_products_v1beta {
308
312
  */
309
313
  pause?: string | null;
310
314
  /**
311
- * The pick up option for the item.
315
+ * The [pickup](https://support.google.com/merchants/answer/14634021) option for the item.
312
316
  */
313
317
  pickupMethod?: string | null;
314
318
  /**
315
- * Item store pickup timeline.
319
+ * Item store pickup timeline. For more information, see [Pickup SLA](https://support.google.com/merchants/answer/14635400).
316
320
  */
317
321
  pickupSla?: string | null;
318
322
  /**
@@ -328,7 +332,7 @@ export declare namespace merchantapi_products_v1beta {
328
332
  */
329
333
  productHeight?: Schema$ProductDimension;
330
334
  /**
331
- * Bullet points describing the most relevant highlights of a product.
335
+ * Bullet points describing the most relevant [product highlights](https://support.google.com/merchants/answer/9216100).
332
336
  */
333
337
  productHighlights?: string[] | null;
334
338
  /**
@@ -336,7 +340,7 @@ export declare namespace merchantapi_products_v1beta {
336
340
  */
337
341
  productLength?: Schema$ProductDimension;
338
342
  /**
339
- * Categories of the item (formatted as in [product data specification](https://support.google.com/merchants/answer/188494#product_type)).
343
+ * Categories of the item (formatted as in [product data specification](https://support.google.com/merchants/answer/7052112#product_category)).
340
344
  */
341
345
  productTypes?: string[] | null;
342
346
  /**
@@ -356,7 +360,7 @@ export declare namespace merchantapi_products_v1beta {
356
360
  */
357
361
  salePrice?: Schema$Price;
358
362
  /**
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)).
363
+ * Date range during which the item is on sale, see [product data specification](https://support.google.com/merchants/answer/7052112#price_and_availability).
360
364
  */
361
365
  salePriceEffectiveDate?: Schema$Interval;
362
366
  /**
@@ -388,19 +392,19 @@ export declare namespace merchantapi_products_v1beta {
388
392
  */
389
393
  shippingWidth?: Schema$ShippingDimension;
390
394
  /**
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.
395
+ * 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
396
  */
393
397
  shoppingAdsExcludedCountries?: string[] | null;
394
398
  /**
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)).
399
+ * 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
400
  */
397
401
  size?: string | null;
398
402
  /**
399
- * System in which the size is specified. Recommended for apparel items.
403
+ * 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
404
  */
401
405
  sizeSystem?: string | null;
402
406
  /**
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)).
407
+ * 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
408
  */
405
409
  sizeTypes?: string[] | null;
406
410
  /**
@@ -420,7 +424,7 @@ export declare namespace merchantapi_products_v1beta {
420
424
  */
421
425
  sustainabilityIncentives?: Schema$ProductSustainabilityIncentive[];
422
426
  /**
423
- * The tax category of the product.
427
+ * The [tax category](https://support.google.com/merchants/answer/7569847) of the product.
424
428
  */
425
429
  taxCategory?: string | null;
426
430
  /**
@@ -646,7 +650,7 @@ export declare namespace merchantapi_products_v1beta {
646
650
  */
647
651
  reportingContext?: string | null;
648
652
  /**
649
- * Whether the issue can be resolved by the merchant.
653
+ * Whether the issue can be resolved by the business.
650
654
  */
651
655
  resolution?: string | null;
652
656
  /**
@@ -705,7 +709,7 @@ export declare namespace merchantapi_products_v1beta {
705
709
  */
706
710
  price?: Schema$Price;
707
711
  /**
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.
712
+ * 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
713
  */
710
714
  programLabel?: string | null;
711
715
  /**
@@ -759,7 +763,7 @@ export declare namespace merchantapi_products_v1beta {
759
763
  */
760
764
  dataSource?: string | null;
761
765
  /**
762
- * Output only. The feed label for the product.
766
+ * 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
767
  */
764
768
  feedLabel?: string | null;
765
769
  /**
@@ -831,7 +835,7 @@ export declare namespace merchantapi_products_v1beta {
831
835
  value?: number | null;
832
836
  }
833
837
  /**
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.
838
+ * 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
839
  */
836
840
  export interface Schema$ProductInput {
837
841
  /**
@@ -851,7 +855,7 @@ export declare namespace merchantapi_products_v1beta {
851
855
  */
852
856
  customAttributes?: Schema$CustomAttribute[];
853
857
  /**
854
- * Required. Immutable. The [feed label](https://developers.google.com/shopping-content/guides/products/feed-labels) for the product.
858
+ * 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
859
  */
856
860
  feedLabel?: string | null;
857
861
  /**
@@ -917,7 +921,7 @@ export declare namespace merchantapi_products_v1beta {
917
921
  */
918
922
  eventTime?: string | null;
919
923
  /**
920
- * Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event.
924
+ * Optional. The product expiration time. This field will not be set if the notification is sent for a product deletion event.
921
925
  */
922
926
  expirationTime?: string | null;
923
927
  /**
@@ -1151,42 +1155,234 @@ export declare namespace merchantapi_products_v1beta {
1151
1155
  constructor(context: APIRequestContext);
1152
1156
  /**
1153
1157
  * 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.
1158
+ * @example
1159
+ * ```js
1160
+ * // Before running the sample:
1161
+ * // - Enable the API at:
1162
+ * // https://console.developers.google.com/apis/api/merchantapi.googleapis.com
1163
+ * // - Login into gcloud by running:
1164
+ * // ```sh
1165
+ * // $ gcloud auth application-default login
1166
+ * // ```
1167
+ * // - Install the npm module by running:
1168
+ * // ```sh
1169
+ * // $ npm install googleapis
1170
+ * // ```
1171
+ *
1172
+ * const {google} = require('googleapis');
1173
+ * const merchantapi = google.merchantapi('products_v1beta');
1174
+ *
1175
+ * async function main() {
1176
+ * const auth = new google.auth.GoogleAuth({
1177
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1178
+ * scopes: ['https://www.googleapis.com/auth/content'],
1179
+ * });
1180
+ *
1181
+ * // Acquire an auth client, and bind it to all future calls
1182
+ * const authClient = await auth.getClient();
1183
+ * google.options({auth: authClient});
1184
+ *
1185
+ * // Do the magic
1186
+ * const res = await merchantapi.accounts.productInputs.delete({
1187
+ * // 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`.
1188
+ * dataSource: 'placeholder-value',
1189
+ * // 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`.
1190
+ * name: 'accounts/my-account/productInputs/my-productInput',
1191
+ * });
1192
+ * console.log(res.data);
1193
+ *
1194
+ * // Example response
1195
+ * // {}
1196
+ * }
1197
+ *
1198
+ * main().catch(e => {
1199
+ * console.error(e);
1200
+ * throw e;
1201
+ * });
1202
+ *
1203
+ * ```
1154
1204
  *
1155
1205
  * @param params - Parameters for request
1156
1206
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
1157
1207
  * @param callback - Optional callback that handles the response.
1158
1208
  * @returns A promise if used with async/await, or void if used with a callback.
1159
1209
  */
1160
- delete(params: Params$Resource$Accounts$Productinputs$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
1161
- delete(params?: Params$Resource$Accounts$Productinputs$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
1210
+ delete(params: Params$Resource$Accounts$Productinputs$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
1211
+ delete(params?: Params$Resource$Accounts$Productinputs$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Empty>>;
1162
1212
  delete(params: Params$Resource$Accounts$Productinputs$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
1163
1213
  delete(params: Params$Resource$Accounts$Productinputs$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
1164
1214
  delete(params: Params$Resource$Accounts$Productinputs$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
1165
1215
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
1166
1216
  /**
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.
1217
+ * [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.
1218
+ * @example
1219
+ * ```js
1220
+ * // Before running the sample:
1221
+ * // - Enable the API at:
1222
+ * // https://console.developers.google.com/apis/api/merchantapi.googleapis.com
1223
+ * // - Login into gcloud by running:
1224
+ * // ```sh
1225
+ * // $ gcloud auth application-default login
1226
+ * // ```
1227
+ * // - Install the npm module by running:
1228
+ * // ```sh
1229
+ * // $ npm install googleapis
1230
+ * // ```
1231
+ *
1232
+ * const {google} = require('googleapis');
1233
+ * const merchantapi = google.merchantapi('products_v1beta');
1234
+ *
1235
+ * async function main() {
1236
+ * const auth = new google.auth.GoogleAuth({
1237
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1238
+ * scopes: ['https://www.googleapis.com/auth/content'],
1239
+ * });
1240
+ *
1241
+ * // Acquire an auth client, and bind it to all future calls
1242
+ * const authClient = await auth.getClient();
1243
+ * google.options({auth: authClient});
1244
+ *
1245
+ * // Do the magic
1246
+ * const res = await merchantapi.accounts.productInputs.insert({
1247
+ * // 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`.
1248
+ * dataSource: 'placeholder-value',
1249
+ * // Required. The account where this product will be inserted. Format: `accounts/{account\}`
1250
+ * parent: 'accounts/my-account',
1251
+ *
1252
+ * // Request body metadata
1253
+ * requestBody: {
1254
+ * // request body parameters
1255
+ * // {
1256
+ * // "attributes": {},
1257
+ * // "channel": "my_channel",
1258
+ * // "contentLanguage": "my_contentLanguage",
1259
+ * // "customAttributes": [],
1260
+ * // "feedLabel": "my_feedLabel",
1261
+ * // "name": "my_name",
1262
+ * // "offerId": "my_offerId",
1263
+ * // "product": "my_product",
1264
+ * // "versionNumber": "my_versionNumber"
1265
+ * // }
1266
+ * },
1267
+ * });
1268
+ * console.log(res.data);
1269
+ *
1270
+ * // Example response
1271
+ * // {
1272
+ * // "attributes": {},
1273
+ * // "channel": "my_channel",
1274
+ * // "contentLanguage": "my_contentLanguage",
1275
+ * // "customAttributes": [],
1276
+ * // "feedLabel": "my_feedLabel",
1277
+ * // "name": "my_name",
1278
+ * // "offerId": "my_offerId",
1279
+ * // "product": "my_product",
1280
+ * // "versionNumber": "my_versionNumber"
1281
+ * // }
1282
+ * }
1283
+ *
1284
+ * main().catch(e => {
1285
+ * console.error(e);
1286
+ * throw e;
1287
+ * });
1288
+ *
1289
+ * ```
1168
1290
  *
1169
1291
  * @param params - Parameters for request
1170
1292
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
1171
1293
  * @param callback - Optional callback that handles the response.
1172
1294
  * @returns A promise if used with async/await, or void if used with a callback.
1173
1295
  */
1174
- insert(params: Params$Resource$Accounts$Productinputs$Insert, options: StreamMethodOptions): GaxiosPromise<Readable>;
1175
- insert(params?: Params$Resource$Accounts$Productinputs$Insert, options?: MethodOptions): GaxiosPromise<Schema$ProductInput>;
1296
+ insert(params: Params$Resource$Accounts$Productinputs$Insert, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
1297
+ insert(params?: Params$Resource$Accounts$Productinputs$Insert, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ProductInput>>;
1176
1298
  insert(params: Params$Resource$Accounts$Productinputs$Insert, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
1177
1299
  insert(params: Params$Resource$Accounts$Productinputs$Insert, options: MethodOptions | BodyResponseCallback<Schema$ProductInput>, callback: BodyResponseCallback<Schema$ProductInput>): void;
1178
1300
  insert(params: Params$Resource$Accounts$Productinputs$Insert, callback: BodyResponseCallback<Schema$ProductInput>): void;
1179
1301
  insert(callback: BodyResponseCallback<Schema$ProductInput>): void;
1180
1302
  /**
1181
1303
  * 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.
1304
+ * @example
1305
+ * ```js
1306
+ * // Before running the sample:
1307
+ * // - Enable the API at:
1308
+ * // https://console.developers.google.com/apis/api/merchantapi.googleapis.com
1309
+ * // - Login into gcloud by running:
1310
+ * // ```sh
1311
+ * // $ gcloud auth application-default login
1312
+ * // ```
1313
+ * // - Install the npm module by running:
1314
+ * // ```sh
1315
+ * // $ npm install googleapis
1316
+ * // ```
1317
+ *
1318
+ * const {google} = require('googleapis');
1319
+ * const merchantapi = google.merchantapi('products_v1beta');
1320
+ *
1321
+ * async function main() {
1322
+ * const auth = new google.auth.GoogleAuth({
1323
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1324
+ * scopes: ['https://www.googleapis.com/auth/content'],
1325
+ * });
1326
+ *
1327
+ * // Acquire an auth client, and bind it to all future calls
1328
+ * const authClient = await auth.getClient();
1329
+ * google.options({auth: authClient});
1330
+ *
1331
+ * // Do the magic
1332
+ * const res = await merchantapi.accounts.productInputs.patch({
1333
+ * // 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`.
1334
+ * dataSource: 'placeholder-value',
1335
+ * // 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`
1336
+ * name: 'accounts/my-account/productInputs/my-productInput',
1337
+ * // 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.
1338
+ * updateMask: 'placeholder-value',
1339
+ *
1340
+ * // Request body metadata
1341
+ * requestBody: {
1342
+ * // request body parameters
1343
+ * // {
1344
+ * // "attributes": {},
1345
+ * // "channel": "my_channel",
1346
+ * // "contentLanguage": "my_contentLanguage",
1347
+ * // "customAttributes": [],
1348
+ * // "feedLabel": "my_feedLabel",
1349
+ * // "name": "my_name",
1350
+ * // "offerId": "my_offerId",
1351
+ * // "product": "my_product",
1352
+ * // "versionNumber": "my_versionNumber"
1353
+ * // }
1354
+ * },
1355
+ * });
1356
+ * console.log(res.data);
1357
+ *
1358
+ * // Example response
1359
+ * // {
1360
+ * // "attributes": {},
1361
+ * // "channel": "my_channel",
1362
+ * // "contentLanguage": "my_contentLanguage",
1363
+ * // "customAttributes": [],
1364
+ * // "feedLabel": "my_feedLabel",
1365
+ * // "name": "my_name",
1366
+ * // "offerId": "my_offerId",
1367
+ * // "product": "my_product",
1368
+ * // "versionNumber": "my_versionNumber"
1369
+ * // }
1370
+ * }
1371
+ *
1372
+ * main().catch(e => {
1373
+ * console.error(e);
1374
+ * throw e;
1375
+ * });
1376
+ *
1377
+ * ```
1182
1378
  *
1183
1379
  * @param params - Parameters for request
1184
1380
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
1185
1381
  * @param callback - Optional callback that handles the response.
1186
1382
  * @returns A promise if used with async/await, or void if used with a callback.
1187
1383
  */
1188
- patch(params: Params$Resource$Accounts$Productinputs$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
1189
- patch(params?: Params$Resource$Accounts$Productinputs$Patch, options?: MethodOptions): GaxiosPromise<Schema$ProductInput>;
1384
+ patch(params: Params$Resource$Accounts$Productinputs$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
1385
+ patch(params?: Params$Resource$Accounts$Productinputs$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ProductInput>>;
1190
1386
  patch(params: Params$Resource$Accounts$Productinputs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
1191
1387
  patch(params: Params$Resource$Accounts$Productinputs$Patch, options: MethodOptions | BodyResponseCallback<Schema$ProductInput>, callback: BodyResponseCallback<Schema$ProductInput>): void;
1192
1388
  patch(params: Params$Resource$Accounts$Productinputs$Patch, callback: BodyResponseCallback<Schema$ProductInput>): void;
@@ -1194,7 +1390,7 @@ export declare namespace merchantapi_products_v1beta {
1194
1390
  }
1195
1391
  export interface Params$Resource$Accounts$Productinputs$Delete extends StandardParameters {
1196
1392
  /**
1197
- * Required. The primary or supplemental data source from which the product input should be deleted. Format: `accounts/{account\}/dataSources/{datasource\}`.
1393
+ * 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
1394
  */
1199
1395
  dataSource?: string;
1200
1396
  /**
@@ -1204,7 +1400,7 @@ export declare namespace merchantapi_products_v1beta {
1204
1400
  }
1205
1401
  export interface Params$Resource$Accounts$Productinputs$Insert extends StandardParameters {
1206
1402
  /**
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\}`.
1403
+ * 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
1404
  */
1209
1405
  dataSource?: string;
1210
1406
  /**
@@ -1218,7 +1414,7 @@ export declare namespace merchantapi_products_v1beta {
1218
1414
  }
1219
1415
  export interface Params$Resource$Accounts$Productinputs$Patch extends StandardParameters {
1220
1416
  /**
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\}`.
1417
+ * 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
1418
  */
1223
1419
  dataSource?: string;
1224
1420
  /**
@@ -1239,28 +1435,135 @@ export declare namespace merchantapi_products_v1beta {
1239
1435
  constructor(context: APIRequestContext);
1240
1436
  /**
1241
1437
  * 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.
1438
+ * @example
1439
+ * ```js
1440
+ * // Before running the sample:
1441
+ * // - Enable the API at:
1442
+ * // https://console.developers.google.com/apis/api/merchantapi.googleapis.com
1443
+ * // - Login into gcloud by running:
1444
+ * // ```sh
1445
+ * // $ gcloud auth application-default login
1446
+ * // ```
1447
+ * // - Install the npm module by running:
1448
+ * // ```sh
1449
+ * // $ npm install googleapis
1450
+ * // ```
1451
+ *
1452
+ * const {google} = require('googleapis');
1453
+ * const merchantapi = google.merchantapi('products_v1beta');
1454
+ *
1455
+ * async function main() {
1456
+ * const auth = new google.auth.GoogleAuth({
1457
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1458
+ * scopes: ['https://www.googleapis.com/auth/content'],
1459
+ * });
1460
+ *
1461
+ * // Acquire an auth client, and bind it to all future calls
1462
+ * const authClient = await auth.getClient();
1463
+ * google.options({auth: authClient});
1464
+ *
1465
+ * // Do the magic
1466
+ * const res = await merchantapi.accounts.products.get({
1467
+ * // 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`
1468
+ * name: 'accounts/my-account/products/my-product',
1469
+ * });
1470
+ * console.log(res.data);
1471
+ *
1472
+ * // Example response
1473
+ * // {
1474
+ * // "attributes": {},
1475
+ * // "automatedDiscounts": {},
1476
+ * // "channel": "my_channel",
1477
+ * // "contentLanguage": "my_contentLanguage",
1478
+ * // "customAttributes": [],
1479
+ * // "dataSource": "my_dataSource",
1480
+ * // "feedLabel": "my_feedLabel",
1481
+ * // "name": "my_name",
1482
+ * // "offerId": "my_offerId",
1483
+ * // "productStatus": {},
1484
+ * // "versionNumber": "my_versionNumber"
1485
+ * // }
1486
+ * }
1487
+ *
1488
+ * main().catch(e => {
1489
+ * console.error(e);
1490
+ * throw e;
1491
+ * });
1492
+ *
1493
+ * ```
1242
1494
  *
1243
1495
  * @param params - Parameters for request
1244
1496
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
1245
1497
  * @param callback - Optional callback that handles the response.
1246
1498
  * @returns A promise if used with async/await, or void if used with a callback.
1247
1499
  */
1248
- get(params: Params$Resource$Accounts$Products$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
1249
- get(params?: Params$Resource$Accounts$Products$Get, options?: MethodOptions): GaxiosPromise<Schema$Product>;
1500
+ get(params: Params$Resource$Accounts$Products$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
1501
+ get(params?: Params$Resource$Accounts$Products$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Product>>;
1250
1502
  get(params: Params$Resource$Accounts$Products$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
1251
1503
  get(params: Params$Resource$Accounts$Products$Get, options: MethodOptions | BodyResponseCallback<Schema$Product>, callback: BodyResponseCallback<Schema$Product>): void;
1252
1504
  get(params: Params$Resource$Accounts$Products$Get, callback: BodyResponseCallback<Schema$Product>): void;
1253
1505
  get(callback: BodyResponseCallback<Schema$Product>): void;
1254
1506
  /**
1255
1507
  * 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.
1508
+ * @example
1509
+ * ```js
1510
+ * // Before running the sample:
1511
+ * // - Enable the API at:
1512
+ * // https://console.developers.google.com/apis/api/merchantapi.googleapis.com
1513
+ * // - Login into gcloud by running:
1514
+ * // ```sh
1515
+ * // $ gcloud auth application-default login
1516
+ * // ```
1517
+ * // - Install the npm module by running:
1518
+ * // ```sh
1519
+ * // $ npm install googleapis
1520
+ * // ```
1521
+ *
1522
+ * const {google} = require('googleapis');
1523
+ * const merchantapi = google.merchantapi('products_v1beta');
1524
+ *
1525
+ * async function main() {
1526
+ * const auth = new google.auth.GoogleAuth({
1527
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1528
+ * scopes: ['https://www.googleapis.com/auth/content'],
1529
+ * });
1530
+ *
1531
+ * // Acquire an auth client, and bind it to all future calls
1532
+ * const authClient = await auth.getClient();
1533
+ * google.options({auth: authClient});
1534
+ *
1535
+ * // Do the magic
1536
+ * const res = await merchantapi.accounts.products.list({
1537
+ * // 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.
1538
+ * pageSize: 'placeholder-value',
1539
+ * // 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.
1540
+ * pageToken: 'placeholder-value',
1541
+ * // Required. The account to list processed products for. Format: `accounts/{account\}`
1542
+ * parent: 'accounts/my-account',
1543
+ * });
1544
+ * console.log(res.data);
1545
+ *
1546
+ * // Example response
1547
+ * // {
1548
+ * // "nextPageToken": "my_nextPageToken",
1549
+ * // "products": []
1550
+ * // }
1551
+ * }
1552
+ *
1553
+ * main().catch(e => {
1554
+ * console.error(e);
1555
+ * throw e;
1556
+ * });
1557
+ *
1558
+ * ```
1256
1559
  *
1257
1560
  * @param params - Parameters for request
1258
1561
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
1259
1562
  * @param callback - Optional callback that handles the response.
1260
1563
  * @returns A promise if used with async/await, or void if used with a callback.
1261
1564
  */
1262
- list(params: Params$Resource$Accounts$Products$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
1263
- list(params?: Params$Resource$Accounts$Products$List, options?: MethodOptions): GaxiosPromise<Schema$ListProductsResponse>;
1565
+ list(params: Params$Resource$Accounts$Products$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
1566
+ list(params?: Params$Resource$Accounts$Products$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ListProductsResponse>>;
1264
1567
  list(params: Params$Resource$Accounts$Products$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
1265
1568
  list(params: Params$Resource$Accounts$Products$List, options: MethodOptions | BodyResponseCallback<Schema$ListProductsResponse>, callback: BodyResponseCallback<Schema$ListProductsResponse>): void;
1266
1569
  list(params: Params$Resource$Accounts$Products$List, callback: BodyResponseCallback<Schema$ListProductsResponse>): void;
@@ -1274,7 +1577,7 @@ export declare namespace merchantapi_products_v1beta {
1274
1577
  }
1275
1578
  export interface Params$Resource$Accounts$Products$List extends StandardParameters {
1276
1579
  /**
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.
1580
+ * 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
1581
  */
1279
1582
  pageSize?: number;
1280
1583
  /**