@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/build/products_v1.d.ts
CHANGED
|
@@ -181,6 +181,19 @@ export declare namespace merchantapi_products_v1 {
|
|
|
181
181
|
*/
|
|
182
182
|
unitCode?: string | null;
|
|
183
183
|
}
|
|
184
|
+
/**
|
|
185
|
+
* The co2 emission of the vehicle.
|
|
186
|
+
*/
|
|
187
|
+
export interface Schema$Co2Emissions {
|
|
188
|
+
/**
|
|
189
|
+
* The unit of the co2 emission.
|
|
190
|
+
*/
|
|
191
|
+
unit?: string | null;
|
|
192
|
+
/**
|
|
193
|
+
* The co2 emission value.
|
|
194
|
+
*/
|
|
195
|
+
value?: string | null;
|
|
196
|
+
}
|
|
184
197
|
/**
|
|
185
198
|
* A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
|
|
186
199
|
*/
|
|
@@ -199,7 +212,7 @@ export declare namespace merchantapi_products_v1 {
|
|
|
199
212
|
value?: string | null;
|
|
200
213
|
}
|
|
201
214
|
/**
|
|
202
|
-
* The destination status of the product status.
|
|
215
|
+
* The destination status of the product status. Equivalent to `StatusPerReportingContext` in Reports API.
|
|
203
216
|
*/
|
|
204
217
|
export interface Schema$DestinationStatus {
|
|
205
218
|
/**
|
|
@@ -224,6 +237,19 @@ export declare namespace merchantapi_products_v1 {
|
|
|
224
237
|
*/
|
|
225
238
|
export interface Schema$Empty {
|
|
226
239
|
}
|
|
240
|
+
/**
|
|
241
|
+
* The energy consumption of the vehicle.
|
|
242
|
+
*/
|
|
243
|
+
export interface Schema$EnergyConsumption {
|
|
244
|
+
/**
|
|
245
|
+
* The unit of the energy consumption.
|
|
246
|
+
*/
|
|
247
|
+
unit?: string | null;
|
|
248
|
+
/**
|
|
249
|
+
* The energy consumption value.
|
|
250
|
+
*/
|
|
251
|
+
value?: number | null;
|
|
252
|
+
}
|
|
227
253
|
/**
|
|
228
254
|
* Conditions to be met for a product to have free shipping.
|
|
229
255
|
*/
|
|
@@ -237,6 +263,19 @@ export declare namespace merchantapi_products_v1 {
|
|
|
237
263
|
*/
|
|
238
264
|
priceThreshold?: Schema$Price;
|
|
239
265
|
}
|
|
266
|
+
/**
|
|
267
|
+
* The fuel consumption of the vehicle.
|
|
268
|
+
*/
|
|
269
|
+
export interface Schema$FuelConsumption {
|
|
270
|
+
/**
|
|
271
|
+
* The unit of the fuel consumption.
|
|
272
|
+
*/
|
|
273
|
+
unit?: string | null;
|
|
274
|
+
/**
|
|
275
|
+
* The fuel consumption value.
|
|
276
|
+
*/
|
|
277
|
+
value?: number | null;
|
|
278
|
+
}
|
|
240
279
|
/**
|
|
241
280
|
* Configuration for offer or offer-country level shipping handling cutoff time.
|
|
242
281
|
*/
|
|
@@ -375,6 +414,32 @@ export declare namespace merchantapi_products_v1 {
|
|
|
375
414
|
*/
|
|
376
415
|
tierLabel?: string | null;
|
|
377
416
|
}
|
|
417
|
+
/**
|
|
418
|
+
* The mileage of the vehicle.
|
|
419
|
+
*/
|
|
420
|
+
export interface Schema$Mileage {
|
|
421
|
+
/**
|
|
422
|
+
* The unit of the mileage.
|
|
423
|
+
*/
|
|
424
|
+
unit?: string | null;
|
|
425
|
+
/**
|
|
426
|
+
* The distance value.
|
|
427
|
+
*/
|
|
428
|
+
value?: string | null;
|
|
429
|
+
}
|
|
430
|
+
/**
|
|
431
|
+
* The pickup cost of the item.
|
|
432
|
+
*/
|
|
433
|
+
export interface Schema$PickupCost {
|
|
434
|
+
/**
|
|
435
|
+
* Required. The flat rate pickup cost of the item.
|
|
436
|
+
*/
|
|
437
|
+
flatRate?: Schema$Price;
|
|
438
|
+
/**
|
|
439
|
+
* Optional. The price threshold above which pickup is free of charge.
|
|
440
|
+
*/
|
|
441
|
+
freeThreshold?: Schema$Price;
|
|
442
|
+
}
|
|
378
443
|
/**
|
|
379
444
|
* The price represented as a number and currency.
|
|
380
445
|
*/
|
|
@@ -392,10 +457,18 @@ export declare namespace merchantapi_products_v1 {
|
|
|
392
457
|
* 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.
|
|
393
458
|
*/
|
|
394
459
|
export interface Schema$Product {
|
|
460
|
+
/**
|
|
461
|
+
* 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).
|
|
462
|
+
*/
|
|
463
|
+
archived?: boolean | null;
|
|
395
464
|
/**
|
|
396
465
|
* Output only. The automated discounts information for the product.
|
|
397
466
|
*/
|
|
398
467
|
automatedDiscounts?: Schema$AutomatedDiscounts;
|
|
468
|
+
/**
|
|
469
|
+
* 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).
|
|
470
|
+
*/
|
|
471
|
+
base64EncodedName?: string | null;
|
|
399
472
|
/**
|
|
400
473
|
* Output only. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product.
|
|
401
474
|
*/
|
|
@@ -477,6 +550,10 @@ export declare namespace merchantapi_products_v1 {
|
|
|
477
550
|
* The day a pre-ordered product becomes available for delivery, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
|
|
478
551
|
*/
|
|
479
552
|
availabilityDate?: string | null;
|
|
553
|
+
/**
|
|
554
|
+
* The [body style](https://support.google.com/google-ads/answer/14157085) of the vehicle.
|
|
555
|
+
*/
|
|
556
|
+
bodyStyle?: string | null;
|
|
480
557
|
/**
|
|
481
558
|
* [Brand](https://support.google.com/merchants/answer/6324351) of the item. For example, "Google".
|
|
482
559
|
*/
|
|
@@ -493,10 +570,18 @@ export declare namespace merchantapi_products_v1 {
|
|
|
493
570
|
* 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.
|
|
494
571
|
*/
|
|
495
572
|
certifications?: Schema$ProductCertification[];
|
|
573
|
+
/**
|
|
574
|
+
* Whether the vehicle is OEM [certified pre-owned](https://support.google.com/google-ads/answer/14156475).
|
|
575
|
+
*/
|
|
576
|
+
certifiedPreOwned?: boolean | null;
|
|
496
577
|
/**
|
|
497
578
|
* Extra fields to export to the Cloud Retail program.
|
|
498
579
|
*/
|
|
499
580
|
cloudExportAdditionalProperties?: Schema$CloudExportAdditionalProperties[];
|
|
581
|
+
/**
|
|
582
|
+
* The [co2 emission](https://support.google.com/google-ads/answer/14546146) of the vehicle.
|
|
583
|
+
*/
|
|
584
|
+
co2Emissions?: Schema$Co2Emissions;
|
|
500
585
|
/**
|
|
501
586
|
* [Color](https://support.google.com/merchants/answer/6324487) of the item. For example, "red".
|
|
502
587
|
*/
|
|
@@ -529,6 +614,10 @@ export declare namespace merchantapi_products_v1 {
|
|
|
529
614
|
* [Custom label 4](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.
|
|
530
615
|
*/
|
|
531
616
|
customLabel4?: string | null;
|
|
617
|
+
/**
|
|
618
|
+
* 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.
|
|
619
|
+
*/
|
|
620
|
+
dateFirstRegistered?: string | null;
|
|
532
621
|
/**
|
|
533
622
|
* Description of the item.
|
|
534
623
|
*/
|
|
@@ -557,10 +646,30 @@ export declare namespace merchantapi_products_v1 {
|
|
|
557
646
|
* Offer margin for dynamic remarketing campaigns. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387).
|
|
558
647
|
*/
|
|
559
648
|
displayAdsValue?: number | null;
|
|
649
|
+
/**
|
|
650
|
+
* 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.
|
|
651
|
+
*/
|
|
652
|
+
documentLinks?: string[] | null;
|
|
653
|
+
/**
|
|
654
|
+
* The [electric range](https://support.google.com/google-ads/answer/15162232) of the vehicle in miles/kms.
|
|
655
|
+
*/
|
|
656
|
+
electricRange?: Schema$Mileage;
|
|
657
|
+
/**
|
|
658
|
+
* The [emission standard](https://support.google.com/google-ads/answer/14869021) of the vehicle.
|
|
659
|
+
*/
|
|
660
|
+
emissionsStandard?: string | null;
|
|
661
|
+
/**
|
|
662
|
+
* The [energy consumption](https://support.google.com/google-ads/answer/14546149) of the vehicle.
|
|
663
|
+
*/
|
|
664
|
+
energyConsumption?: Schema$EnergyConsumption;
|
|
560
665
|
/**
|
|
561
666
|
* The [energy efficiency class](https://support.google.com/merchants/answer/7562785) as defined in EU directive 2010/30/EU.
|
|
562
667
|
*/
|
|
563
668
|
energyEfficiencyClass?: string | null;
|
|
669
|
+
/**
|
|
670
|
+
* The [engine](https://support.google.com/google-ads/answer/14156068) type of the vehicle.
|
|
671
|
+
*/
|
|
672
|
+
engine?: string | null;
|
|
564
673
|
/**
|
|
565
674
|
* 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.
|
|
566
675
|
*/
|
|
@@ -577,6 +686,14 @@ export declare namespace merchantapi_products_v1 {
|
|
|
577
686
|
* Conditions to be met for a product to have free shipping.
|
|
578
687
|
*/
|
|
579
688
|
freeShippingThreshold?: Schema$FreeShippingThreshold[];
|
|
689
|
+
/**
|
|
690
|
+
* The [fuel consumption](https://support.google.com/google-ads/answer/14543580) of the vehicle.
|
|
691
|
+
*/
|
|
692
|
+
fuelConsumption?: Schema$FuelConsumption;
|
|
693
|
+
/**
|
|
694
|
+
* 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.
|
|
695
|
+
*/
|
|
696
|
+
fuelConsumptionDischargedBattery?: Schema$FuelConsumption;
|
|
580
697
|
/**
|
|
581
698
|
* Target [gender](https://support.google.com/merchants/answer/6324479) of the item.
|
|
582
699
|
*/
|
|
@@ -586,7 +703,7 @@ export declare namespace merchantapi_products_v1 {
|
|
|
586
703
|
*/
|
|
587
704
|
googleProductCategory?: string | null;
|
|
588
705
|
/**
|
|
589
|
-
* Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/
|
|
706
|
+
* Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs.
|
|
590
707
|
*/
|
|
591
708
|
gtins?: string[] | null;
|
|
592
709
|
/**
|
|
@@ -617,6 +734,10 @@ export declare namespace merchantapi_products_v1 {
|
|
|
617
734
|
* Shared identifier for all variants of the same product.
|
|
618
735
|
*/
|
|
619
736
|
itemGroupId?: string | null;
|
|
737
|
+
/**
|
|
738
|
+
* 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.
|
|
739
|
+
*/
|
|
740
|
+
itemGroupTitle?: string | null;
|
|
620
741
|
/**
|
|
621
742
|
* 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.
|
|
622
743
|
*/
|
|
@@ -653,6 +774,10 @@ export declare namespace merchantapi_products_v1 {
|
|
|
653
774
|
* Maximum retail price (MRP) of the item. Applicable to India only.
|
|
654
775
|
*/
|
|
655
776
|
maximumRetailPrice?: Schema$Price;
|
|
777
|
+
/**
|
|
778
|
+
* The number of miles/kms on the vehicle. See the [Mileage](https://support.google.com/google-ads/answer/14156166) for more information.
|
|
779
|
+
*/
|
|
780
|
+
mileage?: Schema$Mileage;
|
|
656
781
|
/**
|
|
657
782
|
* The [energy efficiency class](https://support.google.com/merchants/answer/7562785) as defined in EU directive 2010/30/EU.
|
|
658
783
|
*/
|
|
@@ -661,6 +786,10 @@ export declare namespace merchantapi_products_v1 {
|
|
|
661
786
|
* Minimal product handling time (in business days).
|
|
662
787
|
*/
|
|
663
788
|
minHandlingTime?: string | null;
|
|
789
|
+
/**
|
|
790
|
+
* 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.
|
|
791
|
+
*/
|
|
792
|
+
minimumOrderValues?: Schema$ProductMinimumOrderValue[];
|
|
664
793
|
/**
|
|
665
794
|
* URL for the mobile-optimized version of your item's landing page.
|
|
666
795
|
*/
|
|
@@ -670,7 +799,11 @@ export declare namespace merchantapi_products_v1 {
|
|
|
670
799
|
*/
|
|
671
800
|
mobileLinkTemplate?: string | null;
|
|
672
801
|
/**
|
|
673
|
-
*
|
|
802
|
+
* The [Model](https://support.google.com/google-ads/answer/14154511) of the vehicle, such as `LX`, `EX`, and others.
|
|
803
|
+
*/
|
|
804
|
+
model?: string | null;
|
|
805
|
+
/**
|
|
806
|
+
* Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/6324482)) of the item.
|
|
674
807
|
*/
|
|
675
808
|
mpn?: string | null;
|
|
676
809
|
/**
|
|
@@ -685,6 +818,10 @@ export declare namespace merchantapi_products_v1 {
|
|
|
685
818
|
* Publication of this item will be temporarily [paused](https://support.google.com/merchants/answer/11909930).
|
|
686
819
|
*/
|
|
687
820
|
pause?: string | null;
|
|
821
|
+
/**
|
|
822
|
+
* 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.
|
|
823
|
+
*/
|
|
824
|
+
pickupCost?: Schema$PickupCost;
|
|
688
825
|
/**
|
|
689
826
|
* The [pickup](https://support.google.com/merchants/answer/14634021) option for the item.
|
|
690
827
|
*/
|
|
@@ -693,6 +830,10 @@ export declare namespace merchantapi_products_v1 {
|
|
|
693
830
|
* Item store pickup timeline. For more information, see [Pickup SLA](https://support.google.com/merchants/answer/14635400).
|
|
694
831
|
*/
|
|
695
832
|
pickupSla?: string | null;
|
|
833
|
+
/**
|
|
834
|
+
* 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).
|
|
835
|
+
*/
|
|
836
|
+
popularityRank?: number | null;
|
|
696
837
|
/**
|
|
697
838
|
* Price of the item.
|
|
698
839
|
*/
|
|
@@ -729,6 +870,18 @@ export declare namespace merchantapi_products_v1 {
|
|
|
729
870
|
* The unique ID of a promotion.
|
|
730
871
|
*/
|
|
731
872
|
promotionIds?: string[] | null;
|
|
873
|
+
/**
|
|
874
|
+
* 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.
|
|
875
|
+
*/
|
|
876
|
+
questionsAndAnswers?: Schema$QuestionAndAnswer[];
|
|
877
|
+
/**
|
|
878
|
+
* Optional. Specifies how other [products are related](https://support.google.com/merchants/answer/17085213) to this product.
|
|
879
|
+
*/
|
|
880
|
+
relatedProducts?: Schema$RelatedProduct[];
|
|
881
|
+
/**
|
|
882
|
+
* 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).
|
|
883
|
+
*/
|
|
884
|
+
returnPolicyLabel?: string | null;
|
|
732
885
|
/**
|
|
733
886
|
* Advertised sale price of the item.
|
|
734
887
|
*/
|
|
@@ -754,7 +907,7 @@ export declare namespace merchantapi_products_v1 {
|
|
|
754
907
|
*/
|
|
755
908
|
shippingHeight?: Schema$ShippingDimension;
|
|
756
909
|
/**
|
|
757
|
-
* The shipping label of the product, used to group
|
|
910
|
+
* 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).
|
|
758
911
|
*/
|
|
759
912
|
shippingLabel?: string | null;
|
|
760
913
|
/**
|
|
@@ -813,6 +966,10 @@ export declare namespace merchantapi_products_v1 {
|
|
|
813
966
|
* The transit time label of the product, used to group product in account-level transit time tables.
|
|
814
967
|
*/
|
|
815
968
|
transitTimeLabel?: string | null;
|
|
969
|
+
/**
|
|
970
|
+
* The [Trim](https://support.google.com/google-ads/answer/14154176) of the vehicle model, such as `S`, `SV`, `SL` and others.
|
|
971
|
+
*/
|
|
972
|
+
trim?: string | null;
|
|
816
973
|
/**
|
|
817
974
|
* The preference of the denominator of the unit price.
|
|
818
975
|
*/
|
|
@@ -821,10 +978,50 @@ export declare namespace merchantapi_products_v1 {
|
|
|
821
978
|
* The measure and dimension of an item.
|
|
822
979
|
*/
|
|
823
980
|
unitPricingMeasure?: Schema$UnitPricingMeasure;
|
|
981
|
+
/**
|
|
982
|
+
* Optional. Contains the [list of all variant-identifying options](https://support.google.com/merchants/answer/17085214) of this product.
|
|
983
|
+
*/
|
|
984
|
+
variantOptions?: Schema$VariantOption[];
|
|
985
|
+
/**
|
|
986
|
+
* 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.
|
|
987
|
+
*/
|
|
988
|
+
vehicleAllInPrice?: Schema$Price;
|
|
989
|
+
/**
|
|
990
|
+
* 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.
|
|
991
|
+
*/
|
|
992
|
+
vehicleExpenses?: Schema$Price;
|
|
993
|
+
/**
|
|
994
|
+
* 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.`
|
|
995
|
+
*/
|
|
996
|
+
vehicleMandatoryInspectionIncluded?: boolean | null;
|
|
997
|
+
/**
|
|
998
|
+
* 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.
|
|
999
|
+
*/
|
|
1000
|
+
vehicleMsrp?: Schema$Price;
|
|
1001
|
+
/**
|
|
1002
|
+
* The [price type](https://support.google.com/google-ads/answer/14592783) of the vehicle.
|
|
1003
|
+
*/
|
|
1004
|
+
vehiclePriceType?: string | null;
|
|
1005
|
+
/**
|
|
1006
|
+
* 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.
|
|
1007
|
+
*/
|
|
1008
|
+
videoLinks?: string[] | null;
|
|
1009
|
+
/**
|
|
1010
|
+
* The [Vehicle Identification Number (VIN)](https://support.google.com/google-ads/answer/14154510) of the vehicle.
|
|
1011
|
+
*/
|
|
1012
|
+
vin?: string | null;
|
|
824
1013
|
/**
|
|
825
1014
|
* URL of the 3D image of the item. See the [Help Center article](https://support.google.com/merchants/answer/13674896) for more information.
|
|
826
1015
|
*/
|
|
827
1016
|
virtualModelLink?: string | null;
|
|
1017
|
+
/**
|
|
1018
|
+
* The [warranty](https://support.google.com/google-ads/answer/15957626) of the vehicle.
|
|
1019
|
+
*/
|
|
1020
|
+
warranty?: Schema$Warranty;
|
|
1021
|
+
/**
|
|
1022
|
+
* The [Year](https://support.google.com/google-ads/answer/14152816) of the vehicle model.
|
|
1023
|
+
*/
|
|
1024
|
+
year?: string | null;
|
|
828
1025
|
}
|
|
829
1026
|
/**
|
|
830
1027
|
* Product [certification](https://support.google.com/merchants/answer/13528839), initially introduced for EU energy efficiency labeling compliance using the EU EPREL database.
|
|
@@ -902,6 +1099,14 @@ export declare namespace merchantapi_products_v1 {
|
|
|
902
1099
|
* 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.
|
|
903
1100
|
*/
|
|
904
1101
|
export interface Schema$ProductInput {
|
|
1102
|
+
/**
|
|
1103
|
+
* 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).
|
|
1104
|
+
*/
|
|
1105
|
+
base64EncodedName?: string | null;
|
|
1106
|
+
/**
|
|
1107
|
+
* 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).
|
|
1108
|
+
*/
|
|
1109
|
+
base64EncodedProduct?: string | null;
|
|
905
1110
|
/**
|
|
906
1111
|
* Required. Immutable. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product.
|
|
907
1112
|
*/
|
|
@@ -919,7 +1124,7 @@ export declare namespace merchantapi_products_v1 {
|
|
|
919
1124
|
*/
|
|
920
1125
|
legacyLocal?: boolean | null;
|
|
921
1126
|
/**
|
|
922
|
-
* 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-
|
|
1127
|
+
* 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.
|
|
923
1128
|
*/
|
|
924
1129
|
name?: string | null;
|
|
925
1130
|
/**
|
|
@@ -947,6 +1152,10 @@ export declare namespace merchantapi_products_v1 {
|
|
|
947
1152
|
* The amount the buyer has to pay per month.
|
|
948
1153
|
*/
|
|
949
1154
|
amount?: Schema$Price;
|
|
1155
|
+
/**
|
|
1156
|
+
* Optional. Annual percentage rate for `credit_type` finance
|
|
1157
|
+
*/
|
|
1158
|
+
annualPercentageRate?: number | null;
|
|
950
1159
|
/**
|
|
951
1160
|
* Type of installment payments.
|
|
952
1161
|
*/
|
|
@@ -959,6 +1168,31 @@ export declare namespace merchantapi_products_v1 {
|
|
|
959
1168
|
* The number of installments the buyer has to pay.
|
|
960
1169
|
*/
|
|
961
1170
|
months?: string | null;
|
|
1171
|
+
/**
|
|
1172
|
+
* Optional. Total amount the buyer has to pay, including interest.
|
|
1173
|
+
*/
|
|
1174
|
+
totalAmount?: Schema$Price;
|
|
1175
|
+
}
|
|
1176
|
+
/**
|
|
1177
|
+
* The minimum order value in the cart before the checkout is permitted.
|
|
1178
|
+
*/
|
|
1179
|
+
export interface Schema$ProductMinimumOrderValue {
|
|
1180
|
+
/**
|
|
1181
|
+
* 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.
|
|
1182
|
+
*/
|
|
1183
|
+
country?: string | null;
|
|
1184
|
+
/**
|
|
1185
|
+
* Required. The minimum cart or basket value before the checkout is permitted.
|
|
1186
|
+
*/
|
|
1187
|
+
price?: Schema$Price;
|
|
1188
|
+
/**
|
|
1189
|
+
* A free-form description of the service class or delivery speed. This should match the service value set for the Shipping attribute. See service.
|
|
1190
|
+
*/
|
|
1191
|
+
service?: string | null;
|
|
1192
|
+
/**
|
|
1193
|
+
* The surface to which the minimum order value applies. Defaults to `ONLINE_LOCAL` if not configured.
|
|
1194
|
+
*/
|
|
1195
|
+
surface?: string | null;
|
|
962
1196
|
}
|
|
963
1197
|
/**
|
|
964
1198
|
* The status of a product, data validation issues, that is, information about a product computed asynchronously.
|
|
@@ -1056,6 +1290,36 @@ export declare namespace merchantapi_products_v1 {
|
|
|
1056
1290
|
*/
|
|
1057
1291
|
value?: number | null;
|
|
1058
1292
|
}
|
|
1293
|
+
/**
|
|
1294
|
+
* The question and answer for the product.
|
|
1295
|
+
*/
|
|
1296
|
+
export interface Schema$QuestionAndAnswer {
|
|
1297
|
+
/**
|
|
1298
|
+
* Required. The answer text.
|
|
1299
|
+
*/
|
|
1300
|
+
answer?: string | null;
|
|
1301
|
+
/**
|
|
1302
|
+
* Required. The question text.
|
|
1303
|
+
*/
|
|
1304
|
+
question?: string | null;
|
|
1305
|
+
}
|
|
1306
|
+
/**
|
|
1307
|
+
* Specifies how other products are related to this product.
|
|
1308
|
+
*/
|
|
1309
|
+
export interface Schema$RelatedProduct {
|
|
1310
|
+
/**
|
|
1311
|
+
* Required. The identifier of the related product.
|
|
1312
|
+
*/
|
|
1313
|
+
id?: string | null;
|
|
1314
|
+
/**
|
|
1315
|
+
* 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).
|
|
1316
|
+
*/
|
|
1317
|
+
idType?: string | null;
|
|
1318
|
+
/**
|
|
1319
|
+
* Required. The type of the relationship between this product and the related product.
|
|
1320
|
+
*/
|
|
1321
|
+
relationshipType?: string | null;
|
|
1322
|
+
}
|
|
1059
1323
|
/**
|
|
1060
1324
|
* The Shipping of the product.
|
|
1061
1325
|
*/
|
|
@@ -1080,6 +1344,14 @@ export declare namespace merchantapi_products_v1 {
|
|
|
1080
1344
|
* 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).
|
|
1081
1345
|
*/
|
|
1082
1346
|
locationId?: string | null;
|
|
1347
|
+
/**
|
|
1348
|
+
* 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.
|
|
1349
|
+
*/
|
|
1350
|
+
loyaltyProgramLabel?: string | null;
|
|
1351
|
+
/**
|
|
1352
|
+
* 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.
|
|
1353
|
+
*/
|
|
1354
|
+
loyaltyTierLabel?: string | null;
|
|
1083
1355
|
/**
|
|
1084
1356
|
* 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.
|
|
1085
1357
|
*/
|
|
@@ -1221,6 +1493,32 @@ export declare namespace merchantapi_products_v1 {
|
|
|
1221
1493
|
*/
|
|
1222
1494
|
value?: number | null;
|
|
1223
1495
|
}
|
|
1496
|
+
/**
|
|
1497
|
+
* Additional product variants for the product.
|
|
1498
|
+
*/
|
|
1499
|
+
export interface Schema$VariantOption {
|
|
1500
|
+
/**
|
|
1501
|
+
* Required. The name of the variant. For example, "Color", "Memory", "Size", "Length"
|
|
1502
|
+
*/
|
|
1503
|
+
name?: string | null;
|
|
1504
|
+
/**
|
|
1505
|
+
* Required. The value of the variant. For example, "Red", "128GB", "XL", "100cm"
|
|
1506
|
+
*/
|
|
1507
|
+
value?: string | null;
|
|
1508
|
+
}
|
|
1509
|
+
/**
|
|
1510
|
+
* The warranty of the vehicle.
|
|
1511
|
+
*/
|
|
1512
|
+
export interface Schema$Warranty {
|
|
1513
|
+
/**
|
|
1514
|
+
* The warranty duration in months.
|
|
1515
|
+
*/
|
|
1516
|
+
duration?: string | null;
|
|
1517
|
+
/**
|
|
1518
|
+
* The warranty mileage.
|
|
1519
|
+
*/
|
|
1520
|
+
mileage?: Schema$Mileage;
|
|
1521
|
+
}
|
|
1224
1522
|
export class Resource$Accounts {
|
|
1225
1523
|
context: APIRequestContext;
|
|
1226
1524
|
productInputs: Resource$Accounts$Productinputs;
|
|
@@ -1263,7 +1561,7 @@ export declare namespace merchantapi_products_v1 {
|
|
|
1263
1561
|
* const res = await merchantapi.accounts.productInputs.delete({
|
|
1264
1562
|
* // 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`.
|
|
1265
1563
|
* dataSource: 'placeholder-value',
|
|
1266
|
-
* // 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-
|
|
1564
|
+
* // 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.
|
|
1267
1565
|
* name: 'accounts/my-account/productInputs/my-productInput',
|
|
1268
1566
|
* });
|
|
1269
1567
|
* console.log(res.data);
|
|
@@ -1330,6 +1628,8 @@ export declare namespace merchantapi_products_v1 {
|
|
|
1330
1628
|
* requestBody: {
|
|
1331
1629
|
* // request body parameters
|
|
1332
1630
|
* // {
|
|
1631
|
+
* // "base64EncodedName": "my_base64EncodedName",
|
|
1632
|
+
* // "base64EncodedProduct": "my_base64EncodedProduct",
|
|
1333
1633
|
* // "contentLanguage": "my_contentLanguage",
|
|
1334
1634
|
* // "customAttributes": [],
|
|
1335
1635
|
* // "feedLabel": "my_feedLabel",
|
|
@@ -1346,6 +1646,8 @@ export declare namespace merchantapi_products_v1 {
|
|
|
1346
1646
|
*
|
|
1347
1647
|
* // Example response
|
|
1348
1648
|
* // {
|
|
1649
|
+
* // "base64EncodedName": "my_base64EncodedName",
|
|
1650
|
+
* // "base64EncodedProduct": "my_base64EncodedProduct",
|
|
1349
1651
|
* // "contentLanguage": "my_contentLanguage",
|
|
1350
1652
|
* // "customAttributes": [],
|
|
1351
1653
|
* // "feedLabel": "my_feedLabel",
|
|
@@ -1409,7 +1711,7 @@ export declare namespace merchantapi_products_v1 {
|
|
|
1409
1711
|
* const res = await merchantapi.accounts.productInputs.patch({
|
|
1410
1712
|
* // 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`.
|
|
1411
1713
|
* dataSource: 'placeholder-value',
|
|
1412
|
-
* // 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-
|
|
1714
|
+
* // 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.
|
|
1413
1715
|
* name: 'accounts/my-account/productInputs/my-productInput',
|
|
1414
1716
|
* // 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.
|
|
1415
1717
|
* updateMask: 'placeholder-value',
|
|
@@ -1418,6 +1720,8 @@ export declare namespace merchantapi_products_v1 {
|
|
|
1418
1720
|
* requestBody: {
|
|
1419
1721
|
* // request body parameters
|
|
1420
1722
|
* // {
|
|
1723
|
+
* // "base64EncodedName": "my_base64EncodedName",
|
|
1724
|
+
* // "base64EncodedProduct": "my_base64EncodedProduct",
|
|
1421
1725
|
* // "contentLanguage": "my_contentLanguage",
|
|
1422
1726
|
* // "customAttributes": [],
|
|
1423
1727
|
* // "feedLabel": "my_feedLabel",
|
|
@@ -1434,6 +1738,8 @@ export declare namespace merchantapi_products_v1 {
|
|
|
1434
1738
|
*
|
|
1435
1739
|
* // Example response
|
|
1436
1740
|
* // {
|
|
1741
|
+
* // "base64EncodedName": "my_base64EncodedName",
|
|
1742
|
+
* // "base64EncodedProduct": "my_base64EncodedProduct",
|
|
1437
1743
|
* // "contentLanguage": "my_contentLanguage",
|
|
1438
1744
|
* // "customAttributes": [],
|
|
1439
1745
|
* // "feedLabel": "my_feedLabel",
|
|
@@ -1471,7 +1777,7 @@ export declare namespace merchantapi_products_v1 {
|
|
|
1471
1777
|
*/
|
|
1472
1778
|
dataSource?: string;
|
|
1473
1779
|
/**
|
|
1474
|
-
* 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-
|
|
1780
|
+
* 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.
|
|
1475
1781
|
*/
|
|
1476
1782
|
name?: string;
|
|
1477
1783
|
}
|
|
@@ -1495,7 +1801,7 @@ export declare namespace merchantapi_products_v1 {
|
|
|
1495
1801
|
*/
|
|
1496
1802
|
dataSource?: string;
|
|
1497
1803
|
/**
|
|
1498
|
-
* 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-
|
|
1804
|
+
* 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.
|
|
1499
1805
|
*/
|
|
1500
1806
|
name?: string;
|
|
1501
1807
|
/**
|
|
@@ -1541,14 +1847,16 @@ export declare namespace merchantapi_products_v1 {
|
|
|
1541
1847
|
*
|
|
1542
1848
|
* // Do the magic
|
|
1543
1849
|
* const res = await merchantapi.accounts.products.get({
|
|
1544
|
-
* // 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-
|
|
1850
|
+
* // 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`.
|
|
1545
1851
|
* name: 'accounts/my-account/products/my-product',
|
|
1546
1852
|
* });
|
|
1547
1853
|
* console.log(res.data);
|
|
1548
1854
|
*
|
|
1549
1855
|
* // Example response
|
|
1550
1856
|
* // {
|
|
1857
|
+
* // "archived": false,
|
|
1551
1858
|
* // "automatedDiscounts": {},
|
|
1859
|
+
* // "base64EncodedName": "my_base64EncodedName",
|
|
1552
1860
|
* // "contentLanguage": "my_contentLanguage",
|
|
1553
1861
|
* // "customAttributes": [],
|
|
1554
1862
|
* // "dataSource": "my_dataSource",
|
|
@@ -1648,7 +1956,7 @@ export declare namespace merchantapi_products_v1 {
|
|
|
1648
1956
|
}
|
|
1649
1957
|
export interface Params$Resource$Accounts$Products$Get extends StandardParameters {
|
|
1650
1958
|
/**
|
|
1651
|
-
* 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-
|
|
1959
|
+
* 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`.
|
|
1652
1960
|
*/
|
|
1653
1961
|
name?: string;
|
|
1654
1962
|
}
|