@googleapis/merchantapi 17.3.0 → 18.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.
- package/CHANGELOG.md +19 -0
- package/accounts_v1.ts +181 -13
- package/accounts_v1beta.ts +180 -13
- package/build/accounts_v1.d.ts +103 -13
- package/build/accounts_v1.js +32 -0
- package/build/accounts_v1.js.map +1 -1
- package/build/accounts_v1beta.d.ts +103 -13
- package/build/accounts_v1beta.js +32 -0
- package/build/accounts_v1beta.js.map +1 -1
- package/build/datasources_v1.d.ts +4 -4
- package/build/datasources_v1beta.d.ts +4 -4
- package/build/inventories_v1.d.ts +26 -14
- package/build/inventories_v1.js.map +1 -1
- package/build/inventories_v1beta.d.ts +26 -14
- package/build/inventories_v1beta.js.map +1 -1
- package/build/issueresolution_v1.d.ts +3 -3
- package/build/issueresolution_v1beta.d.ts +3 -3
- package/build/products_v1.d.ts +319 -11
- package/build/products_v1.js.map +1 -1
- package/build/products_v1beta.d.ts +45 -11
- package/build/products_v1beta.js.map +1 -1
- package/build/promotions_v1.d.ts +66 -22
- package/build/promotions_v1.js.map +1 -1
- package/build/promotions_v1beta.d.ts +66 -22
- package/build/promotions_v1beta.js.map +1 -1
- package/build/reports_v1.d.ts +39 -6
- package/build/reports_v1.js.map +1 -1
- package/build/reports_v1beta.d.ts +39 -6
- package/build/reports_v1beta.js.map +1 -1
- package/build/tsconfig.tsbuildinfo +1 -1
- package/datasources_v1.ts +4 -4
- package/datasources_v1beta.ts +4 -4
- package/inventories_v1.ts +26 -14
- package/inventories_v1beta.ts +26 -14
- package/issueresolution_v1.ts +3 -3
- package/issueresolution_v1beta.ts +3 -3
- package/package.json +1 -1
- package/products_v1.ts +319 -11
- package/products_v1beta.ts +45 -11
- package/promotions_v1.ts +66 -22
- package/promotions_v1beta.ts +66 -22
- package/reports_v1.ts +39 -6
- package/reports_v1beta.ts +39 -6
package/products_v1.ts
CHANGED
|
@@ -235,6 +235,19 @@ export namespace merchantapi_products_v1 {
|
|
|
235
235
|
*/
|
|
236
236
|
unitCode?: string | null;
|
|
237
237
|
}
|
|
238
|
+
/**
|
|
239
|
+
* The co2 emission of the vehicle.
|
|
240
|
+
*/
|
|
241
|
+
export interface Schema$Co2Emissions {
|
|
242
|
+
/**
|
|
243
|
+
* The unit of the co2 emission.
|
|
244
|
+
*/
|
|
245
|
+
unit?: string | null;
|
|
246
|
+
/**
|
|
247
|
+
* The co2 emission value.
|
|
248
|
+
*/
|
|
249
|
+
value?: string | null;
|
|
250
|
+
}
|
|
238
251
|
/**
|
|
239
252
|
* A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
|
|
240
253
|
*/
|
|
@@ -253,7 +266,7 @@ export namespace merchantapi_products_v1 {
|
|
|
253
266
|
value?: string | null;
|
|
254
267
|
}
|
|
255
268
|
/**
|
|
256
|
-
* The destination status of the product status.
|
|
269
|
+
* The destination status of the product status. Equivalent to `StatusPerReportingContext` in Reports API.
|
|
257
270
|
*/
|
|
258
271
|
export interface Schema$DestinationStatus {
|
|
259
272
|
/**
|
|
@@ -277,6 +290,19 @@ export namespace merchantapi_products_v1 {
|
|
|
277
290
|
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
|
|
278
291
|
*/
|
|
279
292
|
export interface Schema$Empty {}
|
|
293
|
+
/**
|
|
294
|
+
* The energy consumption of the vehicle.
|
|
295
|
+
*/
|
|
296
|
+
export interface Schema$EnergyConsumption {
|
|
297
|
+
/**
|
|
298
|
+
* The unit of the energy consumption.
|
|
299
|
+
*/
|
|
300
|
+
unit?: string | null;
|
|
301
|
+
/**
|
|
302
|
+
* The energy consumption value.
|
|
303
|
+
*/
|
|
304
|
+
value?: number | null;
|
|
305
|
+
}
|
|
280
306
|
/**
|
|
281
307
|
* Conditions to be met for a product to have free shipping.
|
|
282
308
|
*/
|
|
@@ -290,6 +316,19 @@ export namespace merchantapi_products_v1 {
|
|
|
290
316
|
*/
|
|
291
317
|
priceThreshold?: Schema$Price;
|
|
292
318
|
}
|
|
319
|
+
/**
|
|
320
|
+
* The fuel consumption of the vehicle.
|
|
321
|
+
*/
|
|
322
|
+
export interface Schema$FuelConsumption {
|
|
323
|
+
/**
|
|
324
|
+
* The unit of the fuel consumption.
|
|
325
|
+
*/
|
|
326
|
+
unit?: string | null;
|
|
327
|
+
/**
|
|
328
|
+
* The fuel consumption value.
|
|
329
|
+
*/
|
|
330
|
+
value?: number | null;
|
|
331
|
+
}
|
|
293
332
|
/**
|
|
294
333
|
* Configuration for offer or offer-country level shipping handling cutoff time.
|
|
295
334
|
*/
|
|
@@ -428,6 +467,32 @@ export namespace merchantapi_products_v1 {
|
|
|
428
467
|
*/
|
|
429
468
|
tierLabel?: string | null;
|
|
430
469
|
}
|
|
470
|
+
/**
|
|
471
|
+
* The mileage of the vehicle.
|
|
472
|
+
*/
|
|
473
|
+
export interface Schema$Mileage {
|
|
474
|
+
/**
|
|
475
|
+
* The unit of the mileage.
|
|
476
|
+
*/
|
|
477
|
+
unit?: string | null;
|
|
478
|
+
/**
|
|
479
|
+
* The distance value.
|
|
480
|
+
*/
|
|
481
|
+
value?: string | null;
|
|
482
|
+
}
|
|
483
|
+
/**
|
|
484
|
+
* The pickup cost of the item.
|
|
485
|
+
*/
|
|
486
|
+
export interface Schema$PickupCost {
|
|
487
|
+
/**
|
|
488
|
+
* Required. The flat rate pickup cost of the item.
|
|
489
|
+
*/
|
|
490
|
+
flatRate?: Schema$Price;
|
|
491
|
+
/**
|
|
492
|
+
* Optional. The price threshold above which pickup is free of charge.
|
|
493
|
+
*/
|
|
494
|
+
freeThreshold?: Schema$Price;
|
|
495
|
+
}
|
|
431
496
|
/**
|
|
432
497
|
* The price represented as a number and currency.
|
|
433
498
|
*/
|
|
@@ -445,10 +510,18 @@ export namespace merchantapi_products_v1 {
|
|
|
445
510
|
* The processed product, built from multiple product inputs after applying rules and supplemental data sources. This processed product matches what is shown in your Merchant Center account. Each product is built from exactly one primary data source product input, and multiple supplemental data source inputs. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved. All fields in the processed product and its sub-messages match the name of their corresponding attribute in the [Product data specification](https://support.google.com/merchants/answer/7052112) with some exceptions.
|
|
446
511
|
*/
|
|
447
512
|
export interface Schema$Product {
|
|
513
|
+
/**
|
|
514
|
+
* Output only. Determines whether the product is [archived](https://support.google.com/merchants/answer/11909930). To archive or restore your product, visit Merchant Center products page. Learn also more about [offer visibility](https://support.google.com/merchants/answer/12488713).
|
|
515
|
+
*/
|
|
516
|
+
archived?: boolean | null;
|
|
448
517
|
/**
|
|
449
518
|
* Output only. The automated discounts information for the product.
|
|
450
519
|
*/
|
|
451
520
|
automatedDiscounts?: Schema$AutomatedDiscounts;
|
|
521
|
+
/**
|
|
522
|
+
* Output only. The **unpadded base64url encoded name** of the product. Format: `accounts/{account\}/products/{product\}` where the last section `product` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw` for the decoded product name `accounts/123/products/en~US~sku/123`. This field can be used directly as input to the API methods that require the product name to be encoded if it contains special characters, for example [`GetProduct`](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products/get).
|
|
523
|
+
*/
|
|
524
|
+
base64EncodedName?: string | null;
|
|
452
525
|
/**
|
|
453
526
|
* Output only. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product.
|
|
454
527
|
*/
|
|
@@ -530,6 +603,10 @@ export namespace merchantapi_products_v1 {
|
|
|
530
603
|
* The day a pre-ordered product becomes available for delivery, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
|
|
531
604
|
*/
|
|
532
605
|
availabilityDate?: string | null;
|
|
606
|
+
/**
|
|
607
|
+
* The [body style](https://support.google.com/google-ads/answer/14157085) of the vehicle.
|
|
608
|
+
*/
|
|
609
|
+
bodyStyle?: string | null;
|
|
533
610
|
/**
|
|
534
611
|
* [Brand](https://support.google.com/merchants/answer/6324351) of the item. For example, "Google".
|
|
535
612
|
*/
|
|
@@ -546,10 +623,18 @@ export namespace merchantapi_products_v1 {
|
|
|
546
623
|
* Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. See the [Help Center](https://support.google.com/merchants/answer/13528839) article for more information.
|
|
547
624
|
*/
|
|
548
625
|
certifications?: Schema$ProductCertification[];
|
|
626
|
+
/**
|
|
627
|
+
* Whether the vehicle is OEM [certified pre-owned](https://support.google.com/google-ads/answer/14156475).
|
|
628
|
+
*/
|
|
629
|
+
certifiedPreOwned?: boolean | null;
|
|
549
630
|
/**
|
|
550
631
|
* Extra fields to export to the Cloud Retail program.
|
|
551
632
|
*/
|
|
552
633
|
cloudExportAdditionalProperties?: Schema$CloudExportAdditionalProperties[];
|
|
634
|
+
/**
|
|
635
|
+
* The [co2 emission](https://support.google.com/google-ads/answer/14546146) of the vehicle.
|
|
636
|
+
*/
|
|
637
|
+
co2Emissions?: Schema$Co2Emissions;
|
|
553
638
|
/**
|
|
554
639
|
* [Color](https://support.google.com/merchants/answer/6324487) of the item. For example, "red".
|
|
555
640
|
*/
|
|
@@ -582,6 +667,10 @@ export namespace merchantapi_products_v1 {
|
|
|
582
667
|
* [Custom label 4](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.
|
|
583
668
|
*/
|
|
584
669
|
customLabel4?: string | null;
|
|
670
|
+
/**
|
|
671
|
+
* The date the vehicle was first registered. Format: `YYYY-MM`. See the [Date first registered](https://support.google.com/google-ads/answer/14546138) for more information.
|
|
672
|
+
*/
|
|
673
|
+
dateFirstRegistered?: string | null;
|
|
585
674
|
/**
|
|
586
675
|
* Description of the item.
|
|
587
676
|
*/
|
|
@@ -610,10 +699,30 @@ export namespace merchantapi_products_v1 {
|
|
|
610
699
|
* Offer margin for dynamic remarketing campaigns. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387).
|
|
611
700
|
*/
|
|
612
701
|
displayAdsValue?: number | null;
|
|
702
|
+
/**
|
|
703
|
+
* Optional. Contains a list of PDF [document URLs](https://support.google.com/merchants/answer/17084656) for the product. Examples are training manuals, user guides, assembly instructions, package inserts, etc. Must start with "http://" or "https://"), ASCII characters only, and RFC 3986 compliant.
|
|
704
|
+
*/
|
|
705
|
+
documentLinks?: string[] | null;
|
|
706
|
+
/**
|
|
707
|
+
* The [electric range](https://support.google.com/google-ads/answer/15162232) of the vehicle in miles/kms.
|
|
708
|
+
*/
|
|
709
|
+
electricRange?: Schema$Mileage;
|
|
710
|
+
/**
|
|
711
|
+
* The [emission standard](https://support.google.com/google-ads/answer/14869021) of the vehicle.
|
|
712
|
+
*/
|
|
713
|
+
emissionsStandard?: string | null;
|
|
714
|
+
/**
|
|
715
|
+
* The [energy consumption](https://support.google.com/google-ads/answer/14546149) of the vehicle.
|
|
716
|
+
*/
|
|
717
|
+
energyConsumption?: Schema$EnergyConsumption;
|
|
613
718
|
/**
|
|
614
719
|
* The [energy efficiency class](https://support.google.com/merchants/answer/7562785) as defined in EU directive 2010/30/EU.
|
|
615
720
|
*/
|
|
616
721
|
energyEfficiencyClass?: string | null;
|
|
722
|
+
/**
|
|
723
|
+
* The [engine](https://support.google.com/google-ads/answer/14156068) type of the vehicle.
|
|
724
|
+
*/
|
|
725
|
+
engine?: string | null;
|
|
617
726
|
/**
|
|
618
727
|
* 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.
|
|
619
728
|
*/
|
|
@@ -630,6 +739,14 @@ export namespace merchantapi_products_v1 {
|
|
|
630
739
|
* Conditions to be met for a product to have free shipping.
|
|
631
740
|
*/
|
|
632
741
|
freeShippingThreshold?: Schema$FreeShippingThreshold[];
|
|
742
|
+
/**
|
|
743
|
+
* The [fuel consumption](https://support.google.com/google-ads/answer/14543580) of the vehicle.
|
|
744
|
+
*/
|
|
745
|
+
fuelConsumption?: Schema$FuelConsumption;
|
|
746
|
+
/**
|
|
747
|
+
* The fuel consumption of the vehicle when the hybrid battery is discharged. See the [Help Center article](https://support.google.com/google-ads/answer/15162033) for more information.
|
|
748
|
+
*/
|
|
749
|
+
fuelConsumptionDischargedBattery?: Schema$FuelConsumption;
|
|
633
750
|
/**
|
|
634
751
|
* Target [gender](https://support.google.com/merchants/answer/6324479) of the item.
|
|
635
752
|
*/
|
|
@@ -639,7 +756,7 @@ export namespace merchantapi_products_v1 {
|
|
|
639
756
|
*/
|
|
640
757
|
googleProductCategory?: string | null;
|
|
641
758
|
/**
|
|
642
|
-
* Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/
|
|
759
|
+
* Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs.
|
|
643
760
|
*/
|
|
644
761
|
gtins?: string[] | null;
|
|
645
762
|
/**
|
|
@@ -670,6 +787,10 @@ export namespace merchantapi_products_v1 {
|
|
|
670
787
|
* Shared identifier for all variants of the same product.
|
|
671
788
|
*/
|
|
672
789
|
itemGroupId?: string | null;
|
|
790
|
+
/**
|
|
791
|
+
* Optional. Represents the [title of the product group](https://support.google.com/merchants/answer/17085146) to which this variant product belongs. This can be used along with the [item group id](https://support.google.com/merchants/answer/6324507) attribute. It lets you perform better grouping of variant products, and helps identifying common product characteristics more efficiently.
|
|
792
|
+
*/
|
|
793
|
+
itemGroupTitle?: string | null;
|
|
673
794
|
/**
|
|
674
795
|
* Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the [Help Center article](https://support.google.com/merchants/answer/9103186) for more information.
|
|
675
796
|
*/
|
|
@@ -706,6 +827,10 @@ export namespace merchantapi_products_v1 {
|
|
|
706
827
|
* Maximum retail price (MRP) of the item. Applicable to India only.
|
|
707
828
|
*/
|
|
708
829
|
maximumRetailPrice?: Schema$Price;
|
|
830
|
+
/**
|
|
831
|
+
* The number of miles/kms on the vehicle. See the [Mileage](https://support.google.com/google-ads/answer/14156166) for more information.
|
|
832
|
+
*/
|
|
833
|
+
mileage?: Schema$Mileage;
|
|
709
834
|
/**
|
|
710
835
|
* The [energy efficiency class](https://support.google.com/merchants/answer/7562785) as defined in EU directive 2010/30/EU.
|
|
711
836
|
*/
|
|
@@ -714,6 +839,10 @@ export namespace merchantapi_products_v1 {
|
|
|
714
839
|
* Minimal product handling time (in business days).
|
|
715
840
|
*/
|
|
716
841
|
minHandlingTime?: string | null;
|
|
842
|
+
/**
|
|
843
|
+
* The [minimum value](https://support.google.com/merchants/answer/16989009) in the cart before a customer can initiate checkout. Supports multiple minimum order values. Different minimum order values can be specified per country, service and surface. Maximum entries: 100.
|
|
844
|
+
*/
|
|
845
|
+
minimumOrderValues?: Schema$ProductMinimumOrderValue[];
|
|
717
846
|
/**
|
|
718
847
|
* URL for the mobile-optimized version of your item's landing page.
|
|
719
848
|
*/
|
|
@@ -723,7 +852,11 @@ export namespace merchantapi_products_v1 {
|
|
|
723
852
|
*/
|
|
724
853
|
mobileLinkTemplate?: string | null;
|
|
725
854
|
/**
|
|
726
|
-
*
|
|
855
|
+
* The [Model](https://support.google.com/google-ads/answer/14154511) of the vehicle, such as `LX`, `EX`, and others.
|
|
856
|
+
*/
|
|
857
|
+
model?: string | null;
|
|
858
|
+
/**
|
|
859
|
+
* Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/6324482)) of the item.
|
|
727
860
|
*/
|
|
728
861
|
mpn?: string | null;
|
|
729
862
|
/**
|
|
@@ -738,6 +871,10 @@ export namespace merchantapi_products_v1 {
|
|
|
738
871
|
* Publication of this item will be temporarily [paused](https://support.google.com/merchants/answer/11909930).
|
|
739
872
|
*/
|
|
740
873
|
pause?: string | null;
|
|
874
|
+
/**
|
|
875
|
+
* Optional. The [pickup cost](https://support.google.com/merchants/answer/16988704) for an item when a customer buys it online and picks it up at a store.
|
|
876
|
+
*/
|
|
877
|
+
pickupCost?: Schema$PickupCost;
|
|
741
878
|
/**
|
|
742
879
|
* The [pickup](https://support.google.com/merchants/answer/14634021) option for the item.
|
|
743
880
|
*/
|
|
@@ -746,6 +883,10 @@ export namespace merchantapi_products_v1 {
|
|
|
746
883
|
* Item store pickup timeline. For more information, see [Pickup SLA](https://support.google.com/merchants/answer/14635400).
|
|
747
884
|
*/
|
|
748
885
|
pickupSla?: string | null;
|
|
886
|
+
/**
|
|
887
|
+
* Optional. Indicates the [popularity](https://support.google.com/merchants/answer/17085297) of the product in a merchant's inventory. Using a scale of 0.0 (lowest) to 100.0 (highest).
|
|
888
|
+
*/
|
|
889
|
+
popularityRank?: number | null;
|
|
749
890
|
/**
|
|
750
891
|
* Price of the item.
|
|
751
892
|
*/
|
|
@@ -782,6 +923,18 @@ export namespace merchantapi_products_v1 {
|
|
|
782
923
|
* The unique ID of a promotion.
|
|
783
924
|
*/
|
|
784
925
|
promotionIds?: string[] | null;
|
|
926
|
+
/**
|
|
927
|
+
* Optional. Contains user-, merchant-, and manufacturer-authored [questions and answers](https://support.google.com/merchants/answer/17085211) about the product. Max 30 question and answer pairs. Max 5000 characters total. Each question can have max 1000 characters. Each answer can have max 1000 characters.
|
|
928
|
+
*/
|
|
929
|
+
questionsAndAnswers?: Schema$QuestionAndAnswer[];
|
|
930
|
+
/**
|
|
931
|
+
* Optional. Specifies how other [products are related](https://support.google.com/merchants/answer/17085213) to this product.
|
|
932
|
+
*/
|
|
933
|
+
relatedProducts?: Schema$RelatedProduct[];
|
|
934
|
+
/**
|
|
935
|
+
* The return label of the product, used to group products in account-level return policies. Max. 100 characters. For more information, see [Return policy label](https://support.google.com/merchants/answer/9445425).
|
|
936
|
+
*/
|
|
937
|
+
returnPolicyLabel?: string | null;
|
|
785
938
|
/**
|
|
786
939
|
* Advertised sale price of the item.
|
|
787
940
|
*/
|
|
@@ -807,7 +960,7 @@ export namespace merchantapi_products_v1 {
|
|
|
807
960
|
*/
|
|
808
961
|
shippingHeight?: Schema$ShippingDimension;
|
|
809
962
|
/**
|
|
810
|
-
* The shipping label of the product, used to group
|
|
963
|
+
* The shipping label of the product, used to group products in account-level shipping rules. Max. 100 characters. For more information, see [Shipping label](https://support.google.com/merchants/answer/6324504).
|
|
811
964
|
*/
|
|
812
965
|
shippingLabel?: string | null;
|
|
813
966
|
/**
|
|
@@ -866,6 +1019,10 @@ export namespace merchantapi_products_v1 {
|
|
|
866
1019
|
* The transit time label of the product, used to group product in account-level transit time tables.
|
|
867
1020
|
*/
|
|
868
1021
|
transitTimeLabel?: string | null;
|
|
1022
|
+
/**
|
|
1023
|
+
* The [Trim](https://support.google.com/google-ads/answer/14154176) of the vehicle model, such as `S`, `SV`, `SL` and others.
|
|
1024
|
+
*/
|
|
1025
|
+
trim?: string | null;
|
|
869
1026
|
/**
|
|
870
1027
|
* The preference of the denominator of the unit price.
|
|
871
1028
|
*/
|
|
@@ -874,10 +1031,50 @@ export namespace merchantapi_products_v1 {
|
|
|
874
1031
|
* The measure and dimension of an item.
|
|
875
1032
|
*/
|
|
876
1033
|
unitPricingMeasure?: Schema$UnitPricingMeasure;
|
|
1034
|
+
/**
|
|
1035
|
+
* Optional. Contains the [list of all variant-identifying options](https://support.google.com/merchants/answer/17085214) of this product.
|
|
1036
|
+
*/
|
|
1037
|
+
variantOptions?: Schema$VariantOption[];
|
|
1038
|
+
/**
|
|
1039
|
+
* The all-in advertised price for a vehicle, which includes costs for the following – any accessories attached to the vehicle, environmental levies, extra warranty, fuel, freight, pre-delivery inspection (PDI), dealer fees for handling licensing, provincial regulatory fees, miscellaneous dealer charges for security etching and nitrogen tire fill, and factory-to-customer or dealer-to-customer discounts or incentives. See the [Vehicle all-in price](https://support.google.com/google-ads/answer/14156981) for more information.
|
|
1040
|
+
*/
|
|
1041
|
+
vehicleAllInPrice?: Schema$Price;
|
|
1042
|
+
/**
|
|
1043
|
+
* The miscellaneous expenses like insurance and registration fees of the vehicle. See the [Vehicle expenses](https://support.google.com/google-ads/answer/15957154) for more information.
|
|
1044
|
+
*/
|
|
1045
|
+
vehicleExpenses?: Schema$Price;
|
|
1046
|
+
/**
|
|
1047
|
+
* Whether the vehicle is sold with mandatory inspection and maintenance performed before delivery. See the [Vehicle mandatory inspection included](https://support.google.com/google-ads/answer/15956630) for more information.`
|
|
1048
|
+
*/
|
|
1049
|
+
vehicleMandatoryInspectionIncluded?: boolean | null;
|
|
1050
|
+
/**
|
|
1051
|
+
* The MSRP (Manufacturer Suggested Retail Price) for the vehicle in its current configuration. See the [Vehicle MSRP](https://support.google.com/google-ads/answer/14154171) for more information.
|
|
1052
|
+
*/
|
|
1053
|
+
vehicleMsrp?: Schema$Price;
|
|
1054
|
+
/**
|
|
1055
|
+
* The [price type](https://support.google.com/google-ads/answer/14592783) of the vehicle.
|
|
1056
|
+
*/
|
|
1057
|
+
vehiclePriceType?: string | null;
|
|
1058
|
+
/**
|
|
1059
|
+
* Optional. A list of video URLs for the item. Use this attribute to provide more visuals for your product beyond your image attributes. See the [Help Center article](https://support.google.com/merchants/answer/15216925) for more information.
|
|
1060
|
+
*/
|
|
1061
|
+
videoLinks?: string[] | null;
|
|
1062
|
+
/**
|
|
1063
|
+
* The [Vehicle Identification Number (VIN)](https://support.google.com/google-ads/answer/14154510) of the vehicle.
|
|
1064
|
+
*/
|
|
1065
|
+
vin?: string | null;
|
|
877
1066
|
/**
|
|
878
1067
|
* URL of the 3D image of the item. See the [Help Center article](https://support.google.com/merchants/answer/13674896) for more information.
|
|
879
1068
|
*/
|
|
880
1069
|
virtualModelLink?: string | null;
|
|
1070
|
+
/**
|
|
1071
|
+
* The [warranty](https://support.google.com/google-ads/answer/15957626) of the vehicle.
|
|
1072
|
+
*/
|
|
1073
|
+
warranty?: Schema$Warranty;
|
|
1074
|
+
/**
|
|
1075
|
+
* The [Year](https://support.google.com/google-ads/answer/14152816) of the vehicle model.
|
|
1076
|
+
*/
|
|
1077
|
+
year?: string | null;
|
|
881
1078
|
}
|
|
882
1079
|
/**
|
|
883
1080
|
* Product [certification](https://support.google.com/merchants/answer/13528839), initially introduced for EU energy efficiency labeling compliance using the EU EPREL database.
|
|
@@ -955,6 +1152,14 @@ export namespace merchantapi_products_v1 {
|
|
|
955
1152
|
* 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.
|
|
956
1153
|
*/
|
|
957
1154
|
export interface Schema$ProductInput {
|
|
1155
|
+
/**
|
|
1156
|
+
* Output only. The **unpadded base64url encoded name** of the product input. Format: `accounts/{account\}/productInputs/{productinput\}` where the last section `productinput` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw` for the decoded product input name `accounts/123/productInputs/en~US~sku/123`. This field can be used directly as input to the API methods that require the product input name to be encoded if it contains special characters, for example [`GetProductInput`](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.productInputs/get).
|
|
1157
|
+
*/
|
|
1158
|
+
base64EncodedName?: string | null;
|
|
1159
|
+
/**
|
|
1160
|
+
* Output only. The **unpadded base64url encoded name** of the processed product. Format: `accounts/{account\}/products/{product\}` where the last section `product` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw` for the decoded product name `accounts/123/products/en~US~sku/123`. This field can be used directly as input to the API methods that require the product name to be encoded if it contains special characters, for example [`GetProduct`](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products/get).
|
|
1161
|
+
*/
|
|
1162
|
+
base64EncodedProduct?: string | null;
|
|
958
1163
|
/**
|
|
959
1164
|
* Required. Immutable. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product.
|
|
960
1165
|
*/
|
|
@@ -972,7 +1177,7 @@ export namespace merchantapi_products_v1 {
|
|
|
972
1177
|
*/
|
|
973
1178
|
legacyLocal?: boolean | null;
|
|
974
1179
|
/**
|
|
975
|
-
* Identifier. The name of the product. Format: `accounts/{account\}/productInputs/{productinput\}` The {productinput\} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput\} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput\}` segment must be the base64url encoding of this string, which is `ZW5-
|
|
1180
|
+
* Identifier. The name of the product. Format: `accounts/{account\}/productInputs/{productinput\}` The {productinput\} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput\} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput\}` segment must be the unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productinput\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput\}` segment is used to differentiate between the two formats.
|
|
976
1181
|
*/
|
|
977
1182
|
name?: string | null;
|
|
978
1183
|
/**
|
|
@@ -1000,6 +1205,10 @@ export namespace merchantapi_products_v1 {
|
|
|
1000
1205
|
* The amount the buyer has to pay per month.
|
|
1001
1206
|
*/
|
|
1002
1207
|
amount?: Schema$Price;
|
|
1208
|
+
/**
|
|
1209
|
+
* Optional. Annual percentage rate for `credit_type` finance
|
|
1210
|
+
*/
|
|
1211
|
+
annualPercentageRate?: number | null;
|
|
1003
1212
|
/**
|
|
1004
1213
|
* Type of installment payments.
|
|
1005
1214
|
*/
|
|
@@ -1012,6 +1221,31 @@ export namespace merchantapi_products_v1 {
|
|
|
1012
1221
|
* The number of installments the buyer has to pay.
|
|
1013
1222
|
*/
|
|
1014
1223
|
months?: string | null;
|
|
1224
|
+
/**
|
|
1225
|
+
* Optional. Total amount the buyer has to pay, including interest.
|
|
1226
|
+
*/
|
|
1227
|
+
totalAmount?: Schema$Price;
|
|
1228
|
+
}
|
|
1229
|
+
/**
|
|
1230
|
+
* The minimum order value in the cart before the checkout is permitted.
|
|
1231
|
+
*/
|
|
1232
|
+
export interface Schema$ProductMinimumOrderValue {
|
|
1233
|
+
/**
|
|
1234
|
+
* Required. The [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the country to which an item will ship.
|
|
1235
|
+
*/
|
|
1236
|
+
country?: string | null;
|
|
1237
|
+
/**
|
|
1238
|
+
* Required. The minimum cart or basket value before the checkout is permitted.
|
|
1239
|
+
*/
|
|
1240
|
+
price?: Schema$Price;
|
|
1241
|
+
/**
|
|
1242
|
+
* A free-form description of the service class or delivery speed. This should match the service value set for the Shipping attribute. See service.
|
|
1243
|
+
*/
|
|
1244
|
+
service?: string | null;
|
|
1245
|
+
/**
|
|
1246
|
+
* The surface to which the minimum order value applies. Defaults to `ONLINE_LOCAL` if not configured.
|
|
1247
|
+
*/
|
|
1248
|
+
surface?: string | null;
|
|
1015
1249
|
}
|
|
1016
1250
|
/**
|
|
1017
1251
|
* The status of a product, data validation issues, that is, information about a product computed asynchronously.
|
|
@@ -1109,6 +1343,36 @@ export namespace merchantapi_products_v1 {
|
|
|
1109
1343
|
*/
|
|
1110
1344
|
value?: number | null;
|
|
1111
1345
|
}
|
|
1346
|
+
/**
|
|
1347
|
+
* The question and answer for the product.
|
|
1348
|
+
*/
|
|
1349
|
+
export interface Schema$QuestionAndAnswer {
|
|
1350
|
+
/**
|
|
1351
|
+
* Required. The answer text.
|
|
1352
|
+
*/
|
|
1353
|
+
answer?: string | null;
|
|
1354
|
+
/**
|
|
1355
|
+
* Required. The question text.
|
|
1356
|
+
*/
|
|
1357
|
+
question?: string | null;
|
|
1358
|
+
}
|
|
1359
|
+
/**
|
|
1360
|
+
* Specifies how other products are related to this product.
|
|
1361
|
+
*/
|
|
1362
|
+
export interface Schema$RelatedProduct {
|
|
1363
|
+
/**
|
|
1364
|
+
* Required. The identifier of the related product.
|
|
1365
|
+
*/
|
|
1366
|
+
id?: string | null;
|
|
1367
|
+
/**
|
|
1368
|
+
* Required. The type of the identifier of the related product. For example, [GTIN](https://support.google.com/merchants/answer/6219078) or [product ID](https://support.google.com/merchants/answer/6324405).
|
|
1369
|
+
*/
|
|
1370
|
+
idType?: string | null;
|
|
1371
|
+
/**
|
|
1372
|
+
* Required. The type of the relationship between this product and the related product.
|
|
1373
|
+
*/
|
|
1374
|
+
relationshipType?: string | null;
|
|
1375
|
+
}
|
|
1112
1376
|
/**
|
|
1113
1377
|
* The Shipping of the product.
|
|
1114
1378
|
*/
|
|
@@ -1133,6 +1397,14 @@ export namespace merchantapi_products_v1 {
|
|
|
1133
1397
|
* The numeric ID of a location that the shipping rate applies to as defined in the [AdWords API](https://developers.google.com/adwords/api/docs/appendix/geotargeting).
|
|
1134
1398
|
*/
|
|
1135
1399
|
locationId?: string | null;
|
|
1400
|
+
/**
|
|
1401
|
+
* Optional. The label of the [loyalty program](https://support.google.com/merchants/answer/6324484). Must match one of the program labels set in loyalty_programs. When set (in combination with [loyalty_tier_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier.
|
|
1402
|
+
*/
|
|
1403
|
+
loyaltyProgramLabel?: string | null;
|
|
1404
|
+
/**
|
|
1405
|
+
* Optional. The label of the [loyalty tier](https://support.google.com/merchants/answer/6324484) within the loyalty program. Must match one of the tiers set in the loyalty_programs. When set (in combination with [loyalty_program_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier.
|
|
1406
|
+
*/
|
|
1407
|
+
loyaltyTierLabel?: string | null;
|
|
1136
1408
|
/**
|
|
1137
1409
|
* Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minHandlingTime is optional if maxHandlingTime is present.
|
|
1138
1410
|
*/
|
|
@@ -1274,6 +1546,32 @@ export namespace merchantapi_products_v1 {
|
|
|
1274
1546
|
*/
|
|
1275
1547
|
value?: number | null;
|
|
1276
1548
|
}
|
|
1549
|
+
/**
|
|
1550
|
+
* Additional product variants for the product.
|
|
1551
|
+
*/
|
|
1552
|
+
export interface Schema$VariantOption {
|
|
1553
|
+
/**
|
|
1554
|
+
* Required. The name of the variant. For example, "Color", "Memory", "Size", "Length"
|
|
1555
|
+
*/
|
|
1556
|
+
name?: string | null;
|
|
1557
|
+
/**
|
|
1558
|
+
* Required. The value of the variant. For example, "Red", "128GB", "XL", "100cm"
|
|
1559
|
+
*/
|
|
1560
|
+
value?: string | null;
|
|
1561
|
+
}
|
|
1562
|
+
/**
|
|
1563
|
+
* The warranty of the vehicle.
|
|
1564
|
+
*/
|
|
1565
|
+
export interface Schema$Warranty {
|
|
1566
|
+
/**
|
|
1567
|
+
* The warranty duration in months.
|
|
1568
|
+
*/
|
|
1569
|
+
duration?: string | null;
|
|
1570
|
+
/**
|
|
1571
|
+
* The warranty mileage.
|
|
1572
|
+
*/
|
|
1573
|
+
mileage?: Schema$Mileage;
|
|
1574
|
+
}
|
|
1277
1575
|
|
|
1278
1576
|
export class Resource$Accounts {
|
|
1279
1577
|
context: APIRequestContext;
|
|
@@ -1325,7 +1623,7 @@ export namespace merchantapi_products_v1 {
|
|
|
1325
1623
|
* const res = await merchantapi.accounts.productInputs.delete({
|
|
1326
1624
|
* // 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`.
|
|
1327
1625
|
* dataSource: 'placeholder-value',
|
|
1328
|
-
* // Required. The name of the product input to delete. Format: `accounts/{account\}/productInputs/{productInput\}` The {productInput\} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productInput\} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productInput\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productInput\}` segment must be the base64url encoding of this string, which is `ZW5-
|
|
1626
|
+
* // Required. The name of the product input to delete. Format: `accounts/{account\}/productInputs/{productInput\}` The {productInput\} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productInput\} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productInput\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productInput\}` segment must be the unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productInput\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productInput\}` segment is used to differentiate between the two formats.
|
|
1329
1627
|
* name: 'accounts/my-account/productInputs/my-productInput',
|
|
1330
1628
|
* });
|
|
1331
1629
|
* console.log(res.data);
|
|
@@ -1469,6 +1767,8 @@ export namespace merchantapi_products_v1 {
|
|
|
1469
1767
|
* requestBody: {
|
|
1470
1768
|
* // request body parameters
|
|
1471
1769
|
* // {
|
|
1770
|
+
* // "base64EncodedName": "my_base64EncodedName",
|
|
1771
|
+
* // "base64EncodedProduct": "my_base64EncodedProduct",
|
|
1472
1772
|
* // "contentLanguage": "my_contentLanguage",
|
|
1473
1773
|
* // "customAttributes": [],
|
|
1474
1774
|
* // "feedLabel": "my_feedLabel",
|
|
@@ -1485,6 +1785,8 @@ export namespace merchantapi_products_v1 {
|
|
|
1485
1785
|
*
|
|
1486
1786
|
* // Example response
|
|
1487
1787
|
* // {
|
|
1788
|
+
* // "base64EncodedName": "my_base64EncodedName",
|
|
1789
|
+
* // "base64EncodedProduct": "my_base64EncodedProduct",
|
|
1488
1790
|
* // "contentLanguage": "my_contentLanguage",
|
|
1489
1791
|
* // "customAttributes": [],
|
|
1490
1792
|
* // "feedLabel": "my_feedLabel",
|
|
@@ -1624,7 +1926,7 @@ export namespace merchantapi_products_v1 {
|
|
|
1624
1926
|
* const res = await merchantapi.accounts.productInputs.patch({
|
|
1625
1927
|
* // 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`.
|
|
1626
1928
|
* dataSource: 'placeholder-value',
|
|
1627
|
-
* // Identifier. The name of the product. Format: `accounts/{account\}/productInputs/{productinput\}` The {productinput\} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput\} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput\}` segment must be the base64url encoding of this string, which is `ZW5-
|
|
1929
|
+
* // Identifier. The name of the product. Format: `accounts/{account\}/productInputs/{productinput\}` The {productinput\} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput\} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput\}` segment must be the unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productinput\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput\}` segment is used to differentiate between the two formats.
|
|
1628
1930
|
* name: 'accounts/my-account/productInputs/my-productInput',
|
|
1629
1931
|
* // 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.
|
|
1630
1932
|
* updateMask: 'placeholder-value',
|
|
@@ -1633,6 +1935,8 @@ export namespace merchantapi_products_v1 {
|
|
|
1633
1935
|
* requestBody: {
|
|
1634
1936
|
* // request body parameters
|
|
1635
1937
|
* // {
|
|
1938
|
+
* // "base64EncodedName": "my_base64EncodedName",
|
|
1939
|
+
* // "base64EncodedProduct": "my_base64EncodedProduct",
|
|
1636
1940
|
* // "contentLanguage": "my_contentLanguage",
|
|
1637
1941
|
* // "customAttributes": [],
|
|
1638
1942
|
* // "feedLabel": "my_feedLabel",
|
|
@@ -1649,6 +1953,8 @@ export namespace merchantapi_products_v1 {
|
|
|
1649
1953
|
*
|
|
1650
1954
|
* // Example response
|
|
1651
1955
|
* // {
|
|
1956
|
+
* // "base64EncodedName": "my_base64EncodedName",
|
|
1957
|
+
* // "base64EncodedProduct": "my_base64EncodedProduct",
|
|
1652
1958
|
* // "contentLanguage": "my_contentLanguage",
|
|
1653
1959
|
* // "customAttributes": [],
|
|
1654
1960
|
* // "feedLabel": "my_feedLabel",
|
|
@@ -1763,7 +2069,7 @@ export namespace merchantapi_products_v1 {
|
|
|
1763
2069
|
*/
|
|
1764
2070
|
dataSource?: string;
|
|
1765
2071
|
/**
|
|
1766
|
-
* Required. The name of the product input to delete. Format: `accounts/{account\}/productInputs/{productInput\}` The {productInput\} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productInput\} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productInput\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productInput\}` segment must be the base64url encoding of this string, which is `ZW5-
|
|
2072
|
+
* Required. The name of the product input to delete. Format: `accounts/{account\}/productInputs/{productInput\}` The {productInput\} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productInput\} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productInput\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productInput\}` segment must be the unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productInput\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productInput\}` segment is used to differentiate between the two formats.
|
|
1767
2073
|
*/
|
|
1768
2074
|
name?: string;
|
|
1769
2075
|
}
|
|
@@ -1788,7 +2094,7 @@ export namespace merchantapi_products_v1 {
|
|
|
1788
2094
|
*/
|
|
1789
2095
|
dataSource?: string;
|
|
1790
2096
|
/**
|
|
1791
|
-
* Identifier. The name of the product. Format: `accounts/{account\}/productInputs/{productinput\}` The {productinput\} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput\} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput\}` segment must be the base64url encoding of this string, which is `ZW5-
|
|
2097
|
+
* Identifier. The name of the product. Format: `accounts/{account\}/productInputs/{productinput\}` The {productinput\} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput\} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput\}` segment must be the unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productinput\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput\}` segment is used to differentiate between the two formats.
|
|
1792
2098
|
*/
|
|
1793
2099
|
name?: string;
|
|
1794
2100
|
/**
|
|
@@ -1839,14 +2145,16 @@ export namespace merchantapi_products_v1 {
|
|
|
1839
2145
|
*
|
|
1840
2146
|
* // Do the magic
|
|
1841
2147
|
* const res = await merchantapi.accounts.products.get({
|
|
1842
|
-
* // Required. The name of the product. Format: `accounts/{account\}/products/{product\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-
|
|
2148
|
+
* // Required. The name of the product. Format: `accounts/{account\}/products/{product\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product\}` segment must be the unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.
|
|
1843
2149
|
* name: 'accounts/my-account/products/my-product',
|
|
1844
2150
|
* });
|
|
1845
2151
|
* console.log(res.data);
|
|
1846
2152
|
*
|
|
1847
2153
|
* // Example response
|
|
1848
2154
|
* // {
|
|
2155
|
+
* // "archived": false,
|
|
1849
2156
|
* // "automatedDiscounts": {},
|
|
2157
|
+
* // "base64EncodedName": "my_base64EncodedName",
|
|
1850
2158
|
* // "contentLanguage": "my_contentLanguage",
|
|
1851
2159
|
* // "customAttributes": [],
|
|
1852
2160
|
* // "dataSource": "my_dataSource",
|
|
@@ -2102,7 +2410,7 @@ export namespace merchantapi_products_v1 {
|
|
|
2102
2410
|
|
|
2103
2411
|
export interface Params$Resource$Accounts$Products$Get extends StandardParameters {
|
|
2104
2412
|
/**
|
|
2105
|
-
* Required. The name of the product. Format: `accounts/{account\}/products/{product\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-
|
|
2413
|
+
* Required. The name of the product. Format: `accounts/{account\}/products/{product\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product\}` segment must be the unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.
|
|
2106
2414
|
*/
|
|
2107
2415
|
name?: string;
|
|
2108
2416
|
}
|