@googleapis/merchantapi 17.2.0 → 17.4.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 +15 -0
- package/accounts_v1.ts +180 -12
- package/accounts_v1beta.ts +179 -12
- package/build/accounts_v1.d.ts +102 -12
- package/build/accounts_v1.js +32 -0
- package/build/accounts_v1.js.map +1 -1
- package/build/accounts_v1beta.d.ts +102 -12
- 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 +67 -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/notifications_v1.d.ts +2 -2
- package/build/notifications_v1beta.d.ts +2 -2
- package/build/products_v1.d.ts +231 -12
- package/build/products_v1.js.map +1 -1
- package/build/products_v1beta.d.ts +41 -12
- 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 +67 -14
- package/inventories_v1beta.ts +26 -14
- package/issueresolution_v1.ts +3 -3
- package/issueresolution_v1beta.ts +3 -3
- package/notifications_v1.ts +2 -2
- package/notifications_v1beta.ts +2 -2
- package/package.json +1 -1
- package/products_v1.ts +231 -12
- package/products_v1beta.ts +41 -12
- 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
|
*/
|
|
@@ -343,7 +382,7 @@ export declare namespace merchantapi_products_v1 {
|
|
|
343
382
|
ratio?: number | null;
|
|
344
383
|
}
|
|
345
384
|
/**
|
|
346
|
-
*
|
|
385
|
+
* A message that represents loyalty program.
|
|
347
386
|
*/
|
|
348
387
|
export interface Schema$LoyaltyProgram {
|
|
349
388
|
/**
|
|
@@ -375,6 +414,19 @@ 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
|
+
}
|
|
378
430
|
/**
|
|
379
431
|
* The price represented as a number and currency.
|
|
380
432
|
*/
|
|
@@ -396,6 +448,10 @@ export declare namespace merchantapi_products_v1 {
|
|
|
396
448
|
* Output only. The automated discounts information for the product.
|
|
397
449
|
*/
|
|
398
450
|
automatedDiscounts?: Schema$AutomatedDiscounts;
|
|
451
|
+
/**
|
|
452
|
+
* 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).
|
|
453
|
+
*/
|
|
454
|
+
base64EncodedName?: string | null;
|
|
399
455
|
/**
|
|
400
456
|
* Output only. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product.
|
|
401
457
|
*/
|
|
@@ -477,6 +533,10 @@ export declare namespace merchantapi_products_v1 {
|
|
|
477
533
|
* The day a pre-ordered product becomes available for delivery, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
|
|
478
534
|
*/
|
|
479
535
|
availabilityDate?: string | null;
|
|
536
|
+
/**
|
|
537
|
+
* The [body style](https://support.google.com/google-ads/answer/14157085) of the vehicle.
|
|
538
|
+
*/
|
|
539
|
+
bodyStyle?: string | null;
|
|
480
540
|
/**
|
|
481
541
|
* [Brand](https://support.google.com/merchants/answer/6324351) of the item. For example, "Google".
|
|
482
542
|
*/
|
|
@@ -493,10 +553,18 @@ export declare namespace merchantapi_products_v1 {
|
|
|
493
553
|
* 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
554
|
*/
|
|
495
555
|
certifications?: Schema$ProductCertification[];
|
|
556
|
+
/**
|
|
557
|
+
* Whether the vehicle is OEM [certified pre-owned](https://support.google.com/google-ads/answer/14156475).
|
|
558
|
+
*/
|
|
559
|
+
certifiedPreOwned?: boolean | null;
|
|
496
560
|
/**
|
|
497
561
|
* Extra fields to export to the Cloud Retail program.
|
|
498
562
|
*/
|
|
499
563
|
cloudExportAdditionalProperties?: Schema$CloudExportAdditionalProperties[];
|
|
564
|
+
/**
|
|
565
|
+
* The [co2 emission](https://support.google.com/google-ads/answer/14546146) of the vehicle.
|
|
566
|
+
*/
|
|
567
|
+
co2Emissions?: Schema$Co2Emissions;
|
|
500
568
|
/**
|
|
501
569
|
* [Color](https://support.google.com/merchants/answer/6324487) of the item. For example, "red".
|
|
502
570
|
*/
|
|
@@ -529,6 +597,10 @@ export declare namespace merchantapi_products_v1 {
|
|
|
529
597
|
* [Custom label 4](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.
|
|
530
598
|
*/
|
|
531
599
|
customLabel4?: string | null;
|
|
600
|
+
/**
|
|
601
|
+
* 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.
|
|
602
|
+
*/
|
|
603
|
+
dateFirstRegistered?: string | null;
|
|
532
604
|
/**
|
|
533
605
|
* Description of the item.
|
|
534
606
|
*/
|
|
@@ -557,10 +629,26 @@ export declare namespace merchantapi_products_v1 {
|
|
|
557
629
|
* Offer margin for dynamic remarketing campaigns. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387).
|
|
558
630
|
*/
|
|
559
631
|
displayAdsValue?: number | null;
|
|
632
|
+
/**
|
|
633
|
+
* The [electric range](https://support.google.com/google-ads/answer/15162232) of the vehicle in miles/kms.
|
|
634
|
+
*/
|
|
635
|
+
electricRange?: Schema$Mileage;
|
|
636
|
+
/**
|
|
637
|
+
* The [emission standard](https://support.google.com/google-ads/answer/14869021) of the vehicle.
|
|
638
|
+
*/
|
|
639
|
+
emissionsStandard?: string | null;
|
|
640
|
+
/**
|
|
641
|
+
* The [energy consumption](https://support.google.com/google-ads/answer/14546149) of the vehicle.
|
|
642
|
+
*/
|
|
643
|
+
energyConsumption?: Schema$EnergyConsumption;
|
|
560
644
|
/**
|
|
561
645
|
* The [energy efficiency class](https://support.google.com/merchants/answer/7562785) as defined in EU directive 2010/30/EU.
|
|
562
646
|
*/
|
|
563
647
|
energyEfficiencyClass?: string | null;
|
|
648
|
+
/**
|
|
649
|
+
* The [engine](https://support.google.com/google-ads/answer/14156068) type of the vehicle.
|
|
650
|
+
*/
|
|
651
|
+
engine?: string | null;
|
|
564
652
|
/**
|
|
565
653
|
* 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
654
|
*/
|
|
@@ -577,6 +665,14 @@ export declare namespace merchantapi_products_v1 {
|
|
|
577
665
|
* Conditions to be met for a product to have free shipping.
|
|
578
666
|
*/
|
|
579
667
|
freeShippingThreshold?: Schema$FreeShippingThreshold[];
|
|
668
|
+
/**
|
|
669
|
+
* The [fuel consumption](https://support.google.com/google-ads/answer/14543580) of the vehicle.
|
|
670
|
+
*/
|
|
671
|
+
fuelConsumption?: Schema$FuelConsumption;
|
|
672
|
+
/**
|
|
673
|
+
* 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.
|
|
674
|
+
*/
|
|
675
|
+
fuelConsumptionDischargedBattery?: Schema$FuelConsumption;
|
|
580
676
|
/**
|
|
581
677
|
* Target [gender](https://support.google.com/merchants/answer/6324479) of the item.
|
|
582
678
|
*/
|
|
@@ -586,7 +682,7 @@ export declare namespace merchantapi_products_v1 {
|
|
|
586
682
|
*/
|
|
587
683
|
googleProductCategory?: string | null;
|
|
588
684
|
/**
|
|
589
|
-
* Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/
|
|
685
|
+
* Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs.
|
|
590
686
|
*/
|
|
591
687
|
gtins?: string[] | null;
|
|
592
688
|
/**
|
|
@@ -653,6 +749,10 @@ export declare namespace merchantapi_products_v1 {
|
|
|
653
749
|
* Maximum retail price (MRP) of the item. Applicable to India only.
|
|
654
750
|
*/
|
|
655
751
|
maximumRetailPrice?: Schema$Price;
|
|
752
|
+
/**
|
|
753
|
+
* The number of miles/kms on the vehicle. See the [Mileage](https://support.google.com/google-ads/answer/14156166) for more information.
|
|
754
|
+
*/
|
|
755
|
+
mileage?: Schema$Mileage;
|
|
656
756
|
/**
|
|
657
757
|
* The [energy efficiency class](https://support.google.com/merchants/answer/7562785) as defined in EU directive 2010/30/EU.
|
|
658
758
|
*/
|
|
@@ -661,6 +761,10 @@ export declare namespace merchantapi_products_v1 {
|
|
|
661
761
|
* Minimal product handling time (in business days).
|
|
662
762
|
*/
|
|
663
763
|
minHandlingTime?: string | null;
|
|
764
|
+
/**
|
|
765
|
+
* 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.
|
|
766
|
+
*/
|
|
767
|
+
minimumOrderValues?: Schema$ProductMinimumOrderValue[];
|
|
664
768
|
/**
|
|
665
769
|
* URL for the mobile-optimized version of your item's landing page.
|
|
666
770
|
*/
|
|
@@ -670,7 +774,11 @@ export declare namespace merchantapi_products_v1 {
|
|
|
670
774
|
*/
|
|
671
775
|
mobileLinkTemplate?: string | null;
|
|
672
776
|
/**
|
|
673
|
-
*
|
|
777
|
+
* The [Model](https://support.google.com/google-ads/answer/14154511) of the vehicle, such as `LX`, `EX`, and others.
|
|
778
|
+
*/
|
|
779
|
+
model?: string | null;
|
|
780
|
+
/**
|
|
781
|
+
* Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/6324482)) of the item.
|
|
674
782
|
*/
|
|
675
783
|
mpn?: string | null;
|
|
676
784
|
/**
|
|
@@ -729,6 +837,10 @@ export declare namespace merchantapi_products_v1 {
|
|
|
729
837
|
* The unique ID of a promotion.
|
|
730
838
|
*/
|
|
731
839
|
promotionIds?: string[] | null;
|
|
840
|
+
/**
|
|
841
|
+
* 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).
|
|
842
|
+
*/
|
|
843
|
+
returnPolicyLabel?: string | null;
|
|
732
844
|
/**
|
|
733
845
|
* Advertised sale price of the item.
|
|
734
846
|
*/
|
|
@@ -754,7 +866,7 @@ export declare namespace merchantapi_products_v1 {
|
|
|
754
866
|
*/
|
|
755
867
|
shippingHeight?: Schema$ShippingDimension;
|
|
756
868
|
/**
|
|
757
|
-
* The shipping label of the product, used to group
|
|
869
|
+
* 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
870
|
*/
|
|
759
871
|
shippingLabel?: string | null;
|
|
760
872
|
/**
|
|
@@ -813,6 +925,10 @@ export declare namespace merchantapi_products_v1 {
|
|
|
813
925
|
* The transit time label of the product, used to group product in account-level transit time tables.
|
|
814
926
|
*/
|
|
815
927
|
transitTimeLabel?: string | null;
|
|
928
|
+
/**
|
|
929
|
+
* The [Trim](https://support.google.com/google-ads/answer/14154176) of the vehicle model, such as `S`, `SV`, `SL` and others.
|
|
930
|
+
*/
|
|
931
|
+
trim?: string | null;
|
|
816
932
|
/**
|
|
817
933
|
* The preference of the denominator of the unit price.
|
|
818
934
|
*/
|
|
@@ -821,10 +937,46 @@ export declare namespace merchantapi_products_v1 {
|
|
|
821
937
|
* The measure and dimension of an item.
|
|
822
938
|
*/
|
|
823
939
|
unitPricingMeasure?: Schema$UnitPricingMeasure;
|
|
940
|
+
/**
|
|
941
|
+
* 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.
|
|
942
|
+
*/
|
|
943
|
+
vehicleAllInPrice?: Schema$Price;
|
|
944
|
+
/**
|
|
945
|
+
* 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.
|
|
946
|
+
*/
|
|
947
|
+
vehicleExpenses?: Schema$Price;
|
|
948
|
+
/**
|
|
949
|
+
* 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.`
|
|
950
|
+
*/
|
|
951
|
+
vehicleMandatoryInspectionIncluded?: boolean | null;
|
|
952
|
+
/**
|
|
953
|
+
* 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.
|
|
954
|
+
*/
|
|
955
|
+
vehicleMsrp?: Schema$Price;
|
|
956
|
+
/**
|
|
957
|
+
* The [price type](https://support.google.com/google-ads/answer/14592783) of the vehicle.
|
|
958
|
+
*/
|
|
959
|
+
vehiclePriceType?: string | null;
|
|
960
|
+
/**
|
|
961
|
+
* 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.
|
|
962
|
+
*/
|
|
963
|
+
videoLinks?: string[] | null;
|
|
964
|
+
/**
|
|
965
|
+
* The [Vehicle Identification Number (VIN)](https://support.google.com/google-ads/answer/14154510) of the vehicle.
|
|
966
|
+
*/
|
|
967
|
+
vin?: string | null;
|
|
824
968
|
/**
|
|
825
969
|
* URL of the 3D image of the item. See the [Help Center article](https://support.google.com/merchants/answer/13674896) for more information.
|
|
826
970
|
*/
|
|
827
971
|
virtualModelLink?: string | null;
|
|
972
|
+
/**
|
|
973
|
+
* The [warranty](https://support.google.com/google-ads/answer/15957626) of the vehicle.
|
|
974
|
+
*/
|
|
975
|
+
warranty?: Schema$Warranty;
|
|
976
|
+
/**
|
|
977
|
+
* The [Year](https://support.google.com/google-ads/answer/14152816) of the vehicle model.
|
|
978
|
+
*/
|
|
979
|
+
year?: string | null;
|
|
828
980
|
}
|
|
829
981
|
/**
|
|
830
982
|
* Product [certification](https://support.google.com/merchants/answer/13528839), initially introduced for EU energy efficiency labeling compliance using the EU EPREL database.
|
|
@@ -902,6 +1054,14 @@ export declare namespace merchantapi_products_v1 {
|
|
|
902
1054
|
* 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
1055
|
*/
|
|
904
1056
|
export interface Schema$ProductInput {
|
|
1057
|
+
/**
|
|
1058
|
+
* 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).
|
|
1059
|
+
*/
|
|
1060
|
+
base64EncodedName?: string | null;
|
|
1061
|
+
/**
|
|
1062
|
+
* 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).
|
|
1063
|
+
*/
|
|
1064
|
+
base64EncodedProduct?: string | null;
|
|
905
1065
|
/**
|
|
906
1066
|
* Required. Immutable. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product.
|
|
907
1067
|
*/
|
|
@@ -919,7 +1079,7 @@ export declare namespace merchantapi_products_v1 {
|
|
|
919
1079
|
*/
|
|
920
1080
|
legacyLocal?: boolean | null;
|
|
921
1081
|
/**
|
|
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-
|
|
1082
|
+
* 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
1083
|
*/
|
|
924
1084
|
name?: string | null;
|
|
925
1085
|
/**
|
|
@@ -947,6 +1107,10 @@ export declare namespace merchantapi_products_v1 {
|
|
|
947
1107
|
* The amount the buyer has to pay per month.
|
|
948
1108
|
*/
|
|
949
1109
|
amount?: Schema$Price;
|
|
1110
|
+
/**
|
|
1111
|
+
* Optional. Annual percentage rate for `credit_type` finance
|
|
1112
|
+
*/
|
|
1113
|
+
annualPercentageRate?: number | null;
|
|
950
1114
|
/**
|
|
951
1115
|
* Type of installment payments.
|
|
952
1116
|
*/
|
|
@@ -959,6 +1123,31 @@ export declare namespace merchantapi_products_v1 {
|
|
|
959
1123
|
* The number of installments the buyer has to pay.
|
|
960
1124
|
*/
|
|
961
1125
|
months?: string | null;
|
|
1126
|
+
/**
|
|
1127
|
+
* Optional. Total amount the buyer has to pay, including interest.
|
|
1128
|
+
*/
|
|
1129
|
+
totalAmount?: Schema$Price;
|
|
1130
|
+
}
|
|
1131
|
+
/**
|
|
1132
|
+
* The minimum order value in the cart before the checkout is permitted.
|
|
1133
|
+
*/
|
|
1134
|
+
export interface Schema$ProductMinimumOrderValue {
|
|
1135
|
+
/**
|
|
1136
|
+
* 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.
|
|
1137
|
+
*/
|
|
1138
|
+
country?: string | null;
|
|
1139
|
+
/**
|
|
1140
|
+
* Required. The minimum cart or basket value before the checkout is permitted.
|
|
1141
|
+
*/
|
|
1142
|
+
price?: Schema$Price;
|
|
1143
|
+
/**
|
|
1144
|
+
* A free-form description of the service class or delivery speed. This should match the service value set for the Shipping attribute. See service.
|
|
1145
|
+
*/
|
|
1146
|
+
service?: string | null;
|
|
1147
|
+
/**
|
|
1148
|
+
* The surface to which the minimum order value applies. Defaults to `ONLINE_LOCAL` if not configured.
|
|
1149
|
+
*/
|
|
1150
|
+
surface?: string | null;
|
|
962
1151
|
}
|
|
963
1152
|
/**
|
|
964
1153
|
* The status of a product, data validation issues, that is, information about a product computed asynchronously.
|
|
@@ -1080,6 +1269,14 @@ export declare namespace merchantapi_products_v1 {
|
|
|
1080
1269
|
* 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
1270
|
*/
|
|
1082
1271
|
locationId?: string | null;
|
|
1272
|
+
/**
|
|
1273
|
+
* 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.
|
|
1274
|
+
*/
|
|
1275
|
+
loyaltyProgramLabel?: string | null;
|
|
1276
|
+
/**
|
|
1277
|
+
* 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.
|
|
1278
|
+
*/
|
|
1279
|
+
loyaltyTierLabel?: string | null;
|
|
1083
1280
|
/**
|
|
1084
1281
|
* 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
1282
|
*/
|
|
@@ -1221,6 +1418,19 @@ export declare namespace merchantapi_products_v1 {
|
|
|
1221
1418
|
*/
|
|
1222
1419
|
value?: number | null;
|
|
1223
1420
|
}
|
|
1421
|
+
/**
|
|
1422
|
+
* The warranty of the vehicle.
|
|
1423
|
+
*/
|
|
1424
|
+
export interface Schema$Warranty {
|
|
1425
|
+
/**
|
|
1426
|
+
* The warranty duration in months.
|
|
1427
|
+
*/
|
|
1428
|
+
duration?: string | null;
|
|
1429
|
+
/**
|
|
1430
|
+
* The warranty mileage.
|
|
1431
|
+
*/
|
|
1432
|
+
mileage?: Schema$Mileage;
|
|
1433
|
+
}
|
|
1224
1434
|
export class Resource$Accounts {
|
|
1225
1435
|
context: APIRequestContext;
|
|
1226
1436
|
productInputs: Resource$Accounts$Productinputs;
|
|
@@ -1263,7 +1473,7 @@ export declare namespace merchantapi_products_v1 {
|
|
|
1263
1473
|
* const res = await merchantapi.accounts.productInputs.delete({
|
|
1264
1474
|
* // 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
1475
|
* 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-
|
|
1476
|
+
* // 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
1477
|
* name: 'accounts/my-account/productInputs/my-productInput',
|
|
1268
1478
|
* });
|
|
1269
1479
|
* console.log(res.data);
|
|
@@ -1330,6 +1540,8 @@ export declare namespace merchantapi_products_v1 {
|
|
|
1330
1540
|
* requestBody: {
|
|
1331
1541
|
* // request body parameters
|
|
1332
1542
|
* // {
|
|
1543
|
+
* // "base64EncodedName": "my_base64EncodedName",
|
|
1544
|
+
* // "base64EncodedProduct": "my_base64EncodedProduct",
|
|
1333
1545
|
* // "contentLanguage": "my_contentLanguage",
|
|
1334
1546
|
* // "customAttributes": [],
|
|
1335
1547
|
* // "feedLabel": "my_feedLabel",
|
|
@@ -1346,6 +1558,8 @@ export declare namespace merchantapi_products_v1 {
|
|
|
1346
1558
|
*
|
|
1347
1559
|
* // Example response
|
|
1348
1560
|
* // {
|
|
1561
|
+
* // "base64EncodedName": "my_base64EncodedName",
|
|
1562
|
+
* // "base64EncodedProduct": "my_base64EncodedProduct",
|
|
1349
1563
|
* // "contentLanguage": "my_contentLanguage",
|
|
1350
1564
|
* // "customAttributes": [],
|
|
1351
1565
|
* // "feedLabel": "my_feedLabel",
|
|
@@ -1409,7 +1623,7 @@ export declare namespace merchantapi_products_v1 {
|
|
|
1409
1623
|
* const res = await merchantapi.accounts.productInputs.patch({
|
|
1410
1624
|
* // 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
1625
|
* 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-
|
|
1626
|
+
* // 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
1627
|
* name: 'accounts/my-account/productInputs/my-productInput',
|
|
1414
1628
|
* // 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
1629
|
* updateMask: 'placeholder-value',
|
|
@@ -1418,6 +1632,8 @@ export declare namespace merchantapi_products_v1 {
|
|
|
1418
1632
|
* requestBody: {
|
|
1419
1633
|
* // request body parameters
|
|
1420
1634
|
* // {
|
|
1635
|
+
* // "base64EncodedName": "my_base64EncodedName",
|
|
1636
|
+
* // "base64EncodedProduct": "my_base64EncodedProduct",
|
|
1421
1637
|
* // "contentLanguage": "my_contentLanguage",
|
|
1422
1638
|
* // "customAttributes": [],
|
|
1423
1639
|
* // "feedLabel": "my_feedLabel",
|
|
@@ -1434,6 +1650,8 @@ export declare namespace merchantapi_products_v1 {
|
|
|
1434
1650
|
*
|
|
1435
1651
|
* // Example response
|
|
1436
1652
|
* // {
|
|
1653
|
+
* // "base64EncodedName": "my_base64EncodedName",
|
|
1654
|
+
* // "base64EncodedProduct": "my_base64EncodedProduct",
|
|
1437
1655
|
* // "contentLanguage": "my_contentLanguage",
|
|
1438
1656
|
* // "customAttributes": [],
|
|
1439
1657
|
* // "feedLabel": "my_feedLabel",
|
|
@@ -1471,7 +1689,7 @@ export declare namespace merchantapi_products_v1 {
|
|
|
1471
1689
|
*/
|
|
1472
1690
|
dataSource?: string;
|
|
1473
1691
|
/**
|
|
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-
|
|
1692
|
+
* 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
1693
|
*/
|
|
1476
1694
|
name?: string;
|
|
1477
1695
|
}
|
|
@@ -1495,7 +1713,7 @@ export declare namespace merchantapi_products_v1 {
|
|
|
1495
1713
|
*/
|
|
1496
1714
|
dataSource?: string;
|
|
1497
1715
|
/**
|
|
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-
|
|
1716
|
+
* 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
1717
|
*/
|
|
1500
1718
|
name?: string;
|
|
1501
1719
|
/**
|
|
@@ -1541,7 +1759,7 @@ export declare namespace merchantapi_products_v1 {
|
|
|
1541
1759
|
*
|
|
1542
1760
|
* // Do the magic
|
|
1543
1761
|
* 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-
|
|
1762
|
+
* // 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
1763
|
* name: 'accounts/my-account/products/my-product',
|
|
1546
1764
|
* });
|
|
1547
1765
|
* console.log(res.data);
|
|
@@ -1549,6 +1767,7 @@ export declare namespace merchantapi_products_v1 {
|
|
|
1549
1767
|
* // Example response
|
|
1550
1768
|
* // {
|
|
1551
1769
|
* // "automatedDiscounts": {},
|
|
1770
|
+
* // "base64EncodedName": "my_base64EncodedName",
|
|
1552
1771
|
* // "contentLanguage": "my_contentLanguage",
|
|
1553
1772
|
* // "customAttributes": [],
|
|
1554
1773
|
* // "dataSource": "my_dataSource",
|
|
@@ -1648,7 +1867,7 @@ export declare namespace merchantapi_products_v1 {
|
|
|
1648
1867
|
}
|
|
1649
1868
|
export interface Params$Resource$Accounts$Products$Get extends StandardParameters {
|
|
1650
1869
|
/**
|
|
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-
|
|
1870
|
+
* 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
1871
|
*/
|
|
1653
1872
|
name?: string;
|
|
1654
1873
|
}
|
package/build/products_v1.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"products_v1.js","sourceRoot":"","sources":["../products_v1.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,gDAAgD;AAChD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;;AAEjC,uDAAuD;AACvD,sDAAsD;AACtD,0DAA0D;AAC1D,oDAAoD;AACpD,4CAA4C;AAE5C,yDAe2B;AAG3B,IAAiB,uBAAuB,
|
|
1
|
+
{"version":3,"file":"products_v1.js","sourceRoot":"","sources":["../products_v1.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,gDAAgD;AAChD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;;AAEjC,uDAAuD;AACvD,sDAAsD;AACtD,0DAA0D;AAC1D,oDAAoD;AACpD,4CAA4C;AAE5C,yDAe2B;AAG3B,IAAiB,uBAAuB,CAgwEvC;AAhwED,WAAiB,uBAAuB;IAgEtC;;;;;;;;;;OAUG;IACH,MAAa,WAAW;QACtB,OAAO,CAAoB;QAC3B,QAAQ,CAAoB;QAE5B,YAAY,OAAsB,EAAE,MAA2B;YAC7D,IAAI,CAAC,OAAO,GAAG;gBACb,QAAQ,EAAE,OAAO,IAAI,EAAE;gBACvB,MAAM;aACP,CAAC;YAEF,IAAI,CAAC,QAAQ,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtD,CAAC;KACF;IAZY,mCAAW,cAYvB,CAAA;IAm1CD,MAAa,iBAAiB;QAC5B,OAAO,CAAoB;QAC3B,aAAa,CAAkC;QAC/C,QAAQ,CAA6B;QACrC,YAAY,OAA0B;YACpC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;YACvB,IAAI,CAAC,aAAa,GAAG,IAAI,+BAA+B,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACvE,IAAI,CAAC,QAAQ,GAAG,IAAI,0BAA0B,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/D,CAAC;KACF;IATY,yCAAiB,oBAS7B,CAAA;IAED,MAAa,+BAA+B;QAC1C,OAAO,CAAoB;QAC3B,YAAY,OAA0B;YACpC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACzB,CAAC;QA+ED,MAAM,CACJ,gBAGkC,EAClC,iBAIkC,EAClC,QAEkC;YAKlC,IAAI,MAAM,GAAG,CAAC,gBAAgB;gBAC5B,EAAE,CAAkD,CAAC;YACvD,IAAI,OAAO,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAkB,CAAC;YAEzD,IAAI,OAAO,gBAAgB,KAAK,UAAU,EAAE,CAAC;gBAC3C,QAAQ,GAAG,gBAAgB,CAAC;gBAC5B,MAAM,GAAG,EAAmD,CAAC;gBAC7D,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;YAED,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE,CAAC;gBAC5C,QAAQ,GAAG,iBAAiB,CAAC;gBAC7B,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;YAED,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,qCAAqC,CAAC;YACzE,MAAM,UAAU,GAAG;gBACjB,OAAO,EAAE,MAAM,CAAC,MAAM,CACpB;oBACE,GAAG,EAAE,CAAC,OAAO,GAAG,sBAAsB,CAAC,CAAC,OAAO,CAC7C,cAAc,EACd,IAAI,CACL;oBACD,MAAM,EAAE,QAAQ;oBAChB,UAAU,EAAE,EAAE;iBACf,EACD,OAAO,CACR;gBACD,MAAM;gBACN,cAAc,EAAE,CAAC,MAAM,CAAC;gBACxB,UAAU,EAAE,CAAC,MAAM,CAAC;gBACpB,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,CAAC;YACF,IAAI,QAAQ,EAAE,CAAC;gBACb,IAAA,oCAAgB,EACd,UAAU,EACV,QAAyC,CAC1C,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAA,oCAAgB,EAAe,UAAU,CAAC,CAAC;YACpD,CAAC;QACH,CAAC;QA6GD,MAAM,CACJ,gBAGkC,EAClC,iBAIkC,EAClC,QAEkC;YAKlC,IAAI,MAAM,GAAG,CAAC,gBAAgB;gBAC5B,EAAE,CAAkD,CAAC;YACvD,IAAI,OAAO,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAkB,CAAC;YAEzD,IAAI,OAAO,gBAAgB,KAAK,UAAU,EAAE,CAAC;gBAC3C,QAAQ,GAAG,gBAAgB,CAAC;gBAC5B,MAAM,GAAG,EAAmD,CAAC;gBAC7D,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;YAED,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE,CAAC;gBAC5C,QAAQ,GAAG,iBAAiB,CAAC;gBAC7B,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;YAED,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,qCAAqC,CAAC;YACzE,MAAM,UAAU,GAAG;gBACjB,OAAO,EAAE,MAAM,CAAC,MAAM,CACpB;oBACE,GAAG,EAAE,CACH,OAAO,GAAG,6CAA6C,CACxD,CAAC,OAAO,CAAC,cAAc,EAAE,IAAI,CAAC;oBAC/B,MAAM,EAAE,MAAM;oBACd,UAAU,EAAE,EAAE;iBACf,EACD,OAAO,CACR;gBACD,MAAM;gBACN,cAAc,EAAE,CAAC,QAAQ,CAAC;gBAC1B,UAAU,EAAE,CAAC,QAAQ,CAAC;gBACtB,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,CAAC;YACF,IAAI,QAAQ,EAAE,CAAC;gBACb,IAAA,oCAAgB,EACd,UAAU,EACV,QAAyC,CAC1C,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAA,oCAAgB,EAAsB,UAAU,CAAC,CAAC;YAC3D,CAAC;QACH,CAAC;QA+GD,KAAK,CACH,gBAGkC,EAClC,iBAIkC,EAClC,QAEkC;YAKlC,IAAI,MAAM,GAAG,CAAC,gBAAgB;gBAC5B,EAAE,CAAiD,CAAC;YACtD,IAAI,OAAO,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAkB,CAAC;YAEzD,IAAI,OAAO,gBAAgB,KAAK,UAAU,EAAE,CAAC;gBAC3C,QAAQ,GAAG,gBAAgB,CAAC;gBAC5B,MAAM,GAAG,EAAkD,CAAC;gBAC5D,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;YAED,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE,CAAC;gBAC5C,QAAQ,GAAG,iBAAiB,CAAC;gBAC7B,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;YAED,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,qCAAqC,CAAC;YACzE,MAAM,UAAU,GAAG;gBACjB,OAAO,EAAE,MAAM,CAAC,MAAM,CACpB;oBACE,GAAG,EAAE,CAAC,OAAO,GAAG,sBAAsB,CAAC,CAAC,OAAO,CAC7C,cAAc,EACd,IAAI,CACL;oBACD,MAAM,EAAE,OAAO;oBACf,UAAU,EAAE,EAAE;iBACf,EACD,OAAO,CACR;gBACD,MAAM;gBACN,cAAc,EAAE,CAAC,MAAM,CAAC;gBACxB,UAAU,EAAE,CAAC,MAAM,CAAC;gBACpB,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,CAAC;YACF,IAAI,QAAQ,EAAE,CAAC;gBACb,IAAA,oCAAgB,EACd,UAAU,EACV,QAAyC,CAC1C,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAA,oCAAgB,EAAsB,UAAU,CAAC,CAAC;YAC3D,CAAC;QACH,CAAC;KACF;IA7dY,uDAA+B,kCA6d3C,CAAA;IA+CD,MAAa,0BAA0B;QACrC,OAAO,CAAoB;QAC3B,YAAY,OAA0B;YACpC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACzB,CAAC;QA0FD,GAAG,CACD,gBAGkC,EAClC,iBAIkC,EAClC,QAEkC;YAKlC,IAAI,MAAM,GAAG,CAAC,gBAAgB;gBAC5B,EAAE,CAA0C,CAAC;YAC/C,IAAI,OAAO,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAkB,CAAC;YAEzD,IAAI,OAAO,gBAAgB,KAAK,UAAU,EAAE,CAAC;gBAC3C,QAAQ,GAAG,gBAAgB,CAAC;gBAC5B,MAAM,GAAG,EAA2C,CAAC;gBACrD,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;YAED,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE,CAAC;gBAC5C,QAAQ,GAAG,iBAAiB,CAAC;gBAC7B,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;YAED,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,qCAAqC,CAAC;YACzE,MAAM,UAAU,GAAG;gBACjB,OAAO,EAAE,MAAM,CAAC,MAAM,CACpB;oBACE,GAAG,EAAE,CAAC,OAAO,GAAG,sBAAsB,CAAC,CAAC,OAAO,CAC7C,cAAc,EACd,IAAI,CACL;oBACD,MAAM,EAAE,KAAK;oBACb,UAAU,EAAE,EAAE;iBACf,EACD,OAAO,CACR;gBACD,MAAM;gBACN,cAAc,EAAE,CAAC,MAAM,CAAC;gBACxB,UAAU,EAAE,CAAC,MAAM,CAAC;gBACpB,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,CAAC;YACF,IAAI,QAAQ,EAAE,CAAC;gBACb,IAAA,oCAAgB,EACd,UAAU,EACV,QAAyC,CAC1C,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAA,oCAAgB,EAAiB,UAAU,CAAC,CAAC;YACtD,CAAC;QACH,CAAC;QAsFD,IAAI,CACF,gBAGkC,EAClC,iBAIkC,EAClC,QAEkC;YAKlC,IAAI,MAAM,GAAG,CAAC,gBAAgB;gBAC5B,EAAE,CAA2C,CAAC;YAChD,IAAI,OAAO,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAkB,CAAC;YAEzD,IAAI,OAAO,gBAAgB,KAAK,UAAU,EAAE,CAAC;gBAC3C,QAAQ,GAAG,gBAAgB,CAAC;gBAC5B,MAAM,GAAG,EAA4C,CAAC;gBACtD,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;YAED,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE,CAAC;gBAC5C,QAAQ,GAAG,iBAAiB,CAAC;gBAC7B,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;YAED,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,qCAAqC,CAAC;YACzE,MAAM,UAAU,GAAG;gBACjB,OAAO,EAAE,MAAM,CAAC,MAAM,CACpB;oBACE,GAAG,EAAE,CAAC,OAAO,GAAG,iCAAiC,CAAC,CAAC,OAAO,CACxD,cAAc,EACd,IAAI,CACL;oBACD,MAAM,EAAE,KAAK;oBACb,UAAU,EAAE,EAAE;iBACf,EACD,OAAO,CACR;gBACD,MAAM;gBACN,cAAc,EAAE,CAAC,QAAQ,CAAC;gBAC1B,UAAU,EAAE,CAAC,QAAQ,CAAC;gBACtB,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,CAAC;YACF,IAAI,QAAQ,EAAE,CAAC;gBACb,IAAA,oCAAgB,EACd,UAAU,EACV,QAAyC,CAC1C,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAA,oCAAgB,EAA8B,UAAU,CAAC,CAAC;YACnE,CAAC;QACH,CAAC;KACF;IAzSY,kDAA0B,6BAyStC,CAAA;AAsBH,CAAC,EAhwEgB,uBAAuB,uCAAvB,uBAAuB,QAgwEvC"}
|