@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.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,CAy1EvC;AAz1ED,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;IA26CD,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;QA2FD,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;IA1SY,kDAA0B,6BA0StC,CAAA;AAsBH,CAAC,EAz1EgB,uBAAuB,uCAAvB,uBAAuB,QAy1EvC"}
|
|
@@ -215,11 +215,11 @@ export declare namespace merchantapi_products_v1beta {
|
|
|
215
215
|
*/
|
|
216
216
|
googleProductCategory?: string | null;
|
|
217
217
|
/**
|
|
218
|
-
* Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/
|
|
218
|
+
* Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs. Deprecated: Use `gtins` instead.
|
|
219
219
|
*/
|
|
220
220
|
gtin?: string[] | null;
|
|
221
221
|
/**
|
|
222
|
-
* A list of Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/
|
|
222
|
+
* A list of Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs.
|
|
223
223
|
*/
|
|
224
224
|
gtins?: string[] | null;
|
|
225
225
|
/**
|
|
@@ -299,7 +299,7 @@ export declare namespace merchantapi_products_v1beta {
|
|
|
299
299
|
*/
|
|
300
300
|
mobileLinkTemplate?: string | null;
|
|
301
301
|
/**
|
|
302
|
-
* Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/
|
|
302
|
+
* Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/6324482)) of the item.
|
|
303
303
|
*/
|
|
304
304
|
mpn?: string | null;
|
|
305
305
|
/**
|
|
@@ -548,7 +548,7 @@ export declare namespace merchantapi_products_v1beta {
|
|
|
548
548
|
value?: string | null;
|
|
549
549
|
}
|
|
550
550
|
/**
|
|
551
|
-
* The destination status of the product status.
|
|
551
|
+
* The destination status of the product status. Equivalent to `StatusPerReportingContext` in Reports API.
|
|
552
552
|
*/
|
|
553
553
|
export interface Schema$DestinationStatus {
|
|
554
554
|
/**
|
|
@@ -741,6 +741,10 @@ export declare namespace merchantapi_products_v1beta {
|
|
|
741
741
|
* 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.
|
|
742
742
|
*/
|
|
743
743
|
export interface Schema$Product {
|
|
744
|
+
/**
|
|
745
|
+
* 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).
|
|
746
|
+
*/
|
|
747
|
+
archived?: boolean | null;
|
|
744
748
|
/**
|
|
745
749
|
* Output only. A list of product attributes.
|
|
746
750
|
*/
|
|
@@ -749,6 +753,10 @@ export declare namespace merchantapi_products_v1beta {
|
|
|
749
753
|
* Output only. The automated discounts information for the product.
|
|
750
754
|
*/
|
|
751
755
|
automatedDiscounts?: Schema$AutomatedDiscounts;
|
|
756
|
+
/**
|
|
757
|
+
* 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_v1beta/accounts.products/get).
|
|
758
|
+
*/
|
|
759
|
+
base64EncodedName?: string | null;
|
|
752
760
|
/**
|
|
753
761
|
* Output only. The [channel](https://support.google.com/merchants/answer/7361332) of the product.
|
|
754
762
|
*/
|
|
@@ -845,6 +853,14 @@ export declare namespace merchantapi_products_v1beta {
|
|
|
845
853
|
* Optional. A list of product attributes.
|
|
846
854
|
*/
|
|
847
855
|
attributes?: Schema$Attributes;
|
|
856
|
+
/**
|
|
857
|
+
* 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_v1beta/accounts.productInputs/get).
|
|
858
|
+
*/
|
|
859
|
+
base64EncodedName?: string | null;
|
|
860
|
+
/**
|
|
861
|
+
* 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_v1beta/accounts.products/get).
|
|
862
|
+
*/
|
|
863
|
+
base64EncodedProduct?: string | null;
|
|
848
864
|
/**
|
|
849
865
|
* Immutable. The [channel](https://support.google.com/merchants/answer/7361332) of the product.
|
|
850
866
|
*/
|
|
@@ -862,7 +878,7 @@ export declare namespace merchantapi_products_v1beta {
|
|
|
862
878
|
*/
|
|
863
879
|
feedLabel?: string | null;
|
|
864
880
|
/**
|
|
865
|
-
* 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-
|
|
881
|
+
* 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.
|
|
866
882
|
*/
|
|
867
883
|
name?: string | null;
|
|
868
884
|
/**
|
|
@@ -1024,6 +1040,14 @@ export declare namespace merchantapi_products_v1beta {
|
|
|
1024
1040
|
* 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).
|
|
1025
1041
|
*/
|
|
1026
1042
|
locationId?: string | null;
|
|
1043
|
+
/**
|
|
1044
|
+
* 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.
|
|
1045
|
+
*/
|
|
1046
|
+
loyaltyProgramLabel?: string | null;
|
|
1047
|
+
/**
|
|
1048
|
+
* 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.
|
|
1049
|
+
*/
|
|
1050
|
+
loyaltyTierLabel?: string | null;
|
|
1027
1051
|
/**
|
|
1028
1052
|
* 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.
|
|
1029
1053
|
*/
|
|
@@ -1197,7 +1221,7 @@ export declare namespace merchantapi_products_v1beta {
|
|
|
1197
1221
|
* const res = await merchantapi.accounts.productInputs.delete({
|
|
1198
1222
|
* // 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`.
|
|
1199
1223
|
* dataSource: 'placeholder-value',
|
|
1200
|
-
* // 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-
|
|
1224
|
+
* // 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.
|
|
1201
1225
|
* name: 'accounts/my-account/productInputs/my-productInput',
|
|
1202
1226
|
* });
|
|
1203
1227
|
* console.log(res.data);
|
|
@@ -1265,6 +1289,8 @@ export declare namespace merchantapi_products_v1beta {
|
|
|
1265
1289
|
* // request body parameters
|
|
1266
1290
|
* // {
|
|
1267
1291
|
* // "attributes": {},
|
|
1292
|
+
* // "base64EncodedName": "my_base64EncodedName",
|
|
1293
|
+
* // "base64EncodedProduct": "my_base64EncodedProduct",
|
|
1268
1294
|
* // "channel": "my_channel",
|
|
1269
1295
|
* // "contentLanguage": "my_contentLanguage",
|
|
1270
1296
|
* // "customAttributes": [],
|
|
@@ -1281,6 +1307,8 @@ export declare namespace merchantapi_products_v1beta {
|
|
|
1281
1307
|
* // Example response
|
|
1282
1308
|
* // {
|
|
1283
1309
|
* // "attributes": {},
|
|
1310
|
+
* // "base64EncodedName": "my_base64EncodedName",
|
|
1311
|
+
* // "base64EncodedProduct": "my_base64EncodedProduct",
|
|
1284
1312
|
* // "channel": "my_channel",
|
|
1285
1313
|
* // "contentLanguage": "my_contentLanguage",
|
|
1286
1314
|
* // "customAttributes": [],
|
|
@@ -1343,7 +1371,7 @@ export declare namespace merchantapi_products_v1beta {
|
|
|
1343
1371
|
* const res = await merchantapi.accounts.productInputs.patch({
|
|
1344
1372
|
* // 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`.
|
|
1345
1373
|
* dataSource: 'placeholder-value',
|
|
1346
|
-
* // 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-
|
|
1374
|
+
* // 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.
|
|
1347
1375
|
* name: 'accounts/my-account/productInputs/my-productInput',
|
|
1348
1376
|
* // 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.
|
|
1349
1377
|
* updateMask: 'placeholder-value',
|
|
@@ -1353,6 +1381,8 @@ export declare namespace merchantapi_products_v1beta {
|
|
|
1353
1381
|
* // request body parameters
|
|
1354
1382
|
* // {
|
|
1355
1383
|
* // "attributes": {},
|
|
1384
|
+
* // "base64EncodedName": "my_base64EncodedName",
|
|
1385
|
+
* // "base64EncodedProduct": "my_base64EncodedProduct",
|
|
1356
1386
|
* // "channel": "my_channel",
|
|
1357
1387
|
* // "contentLanguage": "my_contentLanguage",
|
|
1358
1388
|
* // "customAttributes": [],
|
|
@@ -1369,6 +1399,8 @@ export declare namespace merchantapi_products_v1beta {
|
|
|
1369
1399
|
* // Example response
|
|
1370
1400
|
* // {
|
|
1371
1401
|
* // "attributes": {},
|
|
1402
|
+
* // "base64EncodedName": "my_base64EncodedName",
|
|
1403
|
+
* // "base64EncodedProduct": "my_base64EncodedProduct",
|
|
1372
1404
|
* // "channel": "my_channel",
|
|
1373
1405
|
* // "contentLanguage": "my_contentLanguage",
|
|
1374
1406
|
* // "customAttributes": [],
|
|
@@ -1405,7 +1437,7 @@ export declare namespace merchantapi_products_v1beta {
|
|
|
1405
1437
|
*/
|
|
1406
1438
|
dataSource?: string;
|
|
1407
1439
|
/**
|
|
1408
|
-
* 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-
|
|
1440
|
+
* 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.
|
|
1409
1441
|
*/
|
|
1410
1442
|
name?: string;
|
|
1411
1443
|
}
|
|
@@ -1429,7 +1461,7 @@ export declare namespace merchantapi_products_v1beta {
|
|
|
1429
1461
|
*/
|
|
1430
1462
|
dataSource?: string;
|
|
1431
1463
|
/**
|
|
1432
|
-
* 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-
|
|
1464
|
+
* 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.
|
|
1433
1465
|
*/
|
|
1434
1466
|
name?: string;
|
|
1435
1467
|
/**
|
|
@@ -1475,15 +1507,17 @@ export declare namespace merchantapi_products_v1beta {
|
|
|
1475
1507
|
*
|
|
1476
1508
|
* // Do the magic
|
|
1477
1509
|
* const res = await merchantapi.accounts.products.get({
|
|
1478
|
-
* // 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-
|
|
1510
|
+
* // 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`.
|
|
1479
1511
|
* name: 'accounts/my-account/products/my-product',
|
|
1480
1512
|
* });
|
|
1481
1513
|
* console.log(res.data);
|
|
1482
1514
|
*
|
|
1483
1515
|
* // Example response
|
|
1484
1516
|
* // {
|
|
1517
|
+
* // "archived": false,
|
|
1485
1518
|
* // "attributes": {},
|
|
1486
1519
|
* // "automatedDiscounts": {},
|
|
1520
|
+
* // "base64EncodedName": "my_base64EncodedName",
|
|
1487
1521
|
* // "channel": "my_channel",
|
|
1488
1522
|
* // "contentLanguage": "my_contentLanguage",
|
|
1489
1523
|
* // "customAttributes": [],
|
|
@@ -1582,7 +1616,7 @@ export declare namespace merchantapi_products_v1beta {
|
|
|
1582
1616
|
}
|
|
1583
1617
|
export interface Params$Resource$Accounts$Products$Get extends StandardParameters {
|
|
1584
1618
|
/**
|
|
1585
|
-
* 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-
|
|
1619
|
+
* 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`.
|
|
1586
1620
|
*/
|
|
1587
1621
|
name?: string;
|
|
1588
1622
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"products_v1beta.js","sourceRoot":"","sources":["../products_v1beta.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,2BAA2B,
|
|
1
|
+
{"version":3,"file":"products_v1beta.js","sourceRoot":"","sources":["../products_v1beta.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,2BAA2B,CAqgE3C;AArgED,WAAiB,2BAA2B;IAgE1C;;;;;;;;;;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,uCAAW,cAYvB,CAAA;IAulCD,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,6CAAiB,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,0BAA0B,CAAC,CAAC,OAAO,CACjD,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,iDAAiD,CAC5D,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,0BAA0B,CAAC,CAAC,OAAO,CACjD,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,2DAA+B,kCA6d3C,CAAA;IA+CD,MAAa,0BAA0B;QACrC,OAAO,CAAoB;QAC3B,YAAY,OAA0B;YACpC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACzB,CAAC;QA2FD,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,0BAA0B,CAAC,CAAC,OAAO,CACjD,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,qCAAqC,CAAC,CAAC,OAAO,CAC5D,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;IA1SY,sDAA0B,6BA0StC,CAAA;AAsBH,CAAC,EArgEgB,2BAA2B,2CAA3B,2BAA2B,QAqgE3C"}
|
package/build/promotions_v1.d.ts
CHANGED
|
@@ -75,31 +75,43 @@ export declare namespace merchantapi_promotions_v1 {
|
|
|
75
75
|
*/
|
|
76
76
|
export interface Schema$Attributes {
|
|
77
77
|
/**
|
|
78
|
-
* Optional.
|
|
78
|
+
* Optional. This field defines the audience a promotion will be visible to.
|
|
79
|
+
*/
|
|
80
|
+
audience?: string | null;
|
|
81
|
+
/**
|
|
82
|
+
* Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
|
|
79
83
|
*/
|
|
80
84
|
brandExclusion?: string[] | null;
|
|
81
85
|
/**
|
|
82
|
-
* Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355
|
|
86
|
+
* Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
|
|
83
87
|
*/
|
|
84
88
|
brandInclusion?: string[] | null;
|
|
85
89
|
/**
|
|
86
|
-
* Required. The [coupon value type] (https://support.google.com/merchants/answer/13861986?ref_topic=13773355
|
|
90
|
+
* Required. The [coupon value type] (https://support.google.com/merchants/answer/13861986?ref_topic=13773355) attribute to signal the type of promotion that you are running. Depending on type of the selected coupon value [some attributes are required](https://support.google.com/merchants/answer/6393006?ref_topic=7322920).
|
|
87
91
|
*/
|
|
88
92
|
couponValueType?: string | null;
|
|
89
93
|
/**
|
|
90
|
-
* Optional.
|
|
94
|
+
* Optional. The custom redemption restriction for the promotion. If the `redemption_restriction` field is set to `CUSTOM`, this field must be set.
|
|
95
|
+
*/
|
|
96
|
+
customRedemptionRestriction?: string | null;
|
|
97
|
+
/**
|
|
98
|
+
* Optional. Event applicability for this promotion. When present, this field indicates you are creating a [sales event](https://support.google.com/merchants/answer/15523289) and not a product promotion. Exactly one of `product_applicability` or `event_applicability` must be set.
|
|
99
|
+
*/
|
|
100
|
+
eventApplicability?: string | null;
|
|
101
|
+
/**
|
|
102
|
+
* Optional. [Free gift description](https://support.google.com/merchants/answer/13847245?ref_topic=13773355) for the promotion.
|
|
91
103
|
*/
|
|
92
104
|
freeGiftDescription?: string | null;
|
|
93
105
|
/**
|
|
94
|
-
* Optional. [Free gift item ID](https://support.google.com/merchants/answer/13857152?ref_topic=13773355
|
|
106
|
+
* Optional. [Free gift item ID](https://support.google.com/merchants/answer/13857152?ref_topic=13773355) for the promotion.
|
|
95
107
|
*/
|
|
96
108
|
freeGiftItemId?: string | null;
|
|
97
109
|
/**
|
|
98
|
-
* Optional. [Free gift value](https://support.google.com/merchants/answer/13844477?ref_topic=13773355
|
|
110
|
+
* Optional. [Free gift value](https://support.google.com/merchants/answer/13844477?ref_topic=13773355) for the promotion.
|
|
99
111
|
*/
|
|
100
112
|
freeGiftValue?: Schema$Price;
|
|
101
113
|
/**
|
|
102
|
-
* Optional. Generic redemption code for the promotion. To be used with the `offerType` field and must meet the [minimum requirements](https://support.google.com/merchants/answer/13837405?ref_topic=13773355
|
|
114
|
+
* Optional. Generic redemption code for the promotion. To be used with the `offerType` field and must meet the [minimum requirements](https://support.google.com/merchants/answer/13837405?ref_topic=13773355).
|
|
103
115
|
*/
|
|
104
116
|
genericRedemptionCode?: string | null;
|
|
105
117
|
/**
|
|
@@ -107,23 +119,27 @@ export declare namespace merchantapi_promotions_v1 {
|
|
|
107
119
|
*/
|
|
108
120
|
getThisQuantityDiscounted?: string | null;
|
|
109
121
|
/**
|
|
110
|
-
* Optional.
|
|
122
|
+
* Optional. A list of Google product categories for this promotion. Set if `EventApplicability` is `SPECIFIC_CATEGORIES`. Up to 5 product categories can be specified. For more details on eligible values for product categories, checkout the `google_product_category` attribute in the [Promotion data specification](https://support.google.com/merchants/answer/2906014).
|
|
123
|
+
*/
|
|
124
|
+
googleProductCategories?: string[] | null;
|
|
125
|
+
/**
|
|
126
|
+
* Optional. Product filter by [item group ID](https://support.google.com/merchants/answer/13837298?ref_topic=13773355). The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). exclusion for the promotion.
|
|
111
127
|
*/
|
|
112
128
|
itemGroupIdExclusion?: string[] | null;
|
|
113
129
|
/**
|
|
114
|
-
* Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355
|
|
130
|
+
* Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
|
|
115
131
|
*/
|
|
116
132
|
itemGroupIdInclusion?: string[] | null;
|
|
117
133
|
/**
|
|
118
|
-
* Optional. Product filter by [item ID exclusion](https://support.google.com/merchants/answer/13863524?ref_topic=13773355
|
|
134
|
+
* Optional. Product filter by [item ID exclusion](https://support.google.com/merchants/answer/13863524?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
|
|
119
135
|
*/
|
|
120
136
|
itemIdExclusion?: string[] | null;
|
|
121
137
|
/**
|
|
122
|
-
* Optional. Product filter by [item ID](https://support.google.com/merchants/answer/13861565?ref_topic=13773355
|
|
138
|
+
* Optional. Product filter by [item ID](https://support.google.com/merchants/answer/13861565?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
|
|
123
139
|
*/
|
|
124
140
|
itemIdInclusion?: string[] | null;
|
|
125
141
|
/**
|
|
126
|
-
* Optional. [Maximum purchase quantity](https://support.google.com/merchants/answer/13861564?ref_topic=13773355
|
|
142
|
+
* Optional. [Maximum purchase quantity](https://support.google.com/merchants/answer/13861564?ref_topic=13773355) for the promotion.
|
|
127
143
|
*/
|
|
128
144
|
limitQuantity?: string | null;
|
|
129
145
|
/**
|
|
@@ -131,20 +147,40 @@ export declare namespace merchantapi_promotions_v1 {
|
|
|
131
147
|
*/
|
|
132
148
|
limitValue?: Schema$Price;
|
|
133
149
|
/**
|
|
134
|
-
* Required. [Long title](https://support.google.com/merchants/answer/13838102?ref_topic=13773355
|
|
150
|
+
* Required. [Long title](https://support.google.com/merchants/answer/13838102?ref_topic=13773355) for the promotion.
|
|
135
151
|
*/
|
|
136
152
|
longTitle?: string | null;
|
|
137
153
|
/**
|
|
138
|
-
* Optional.
|
|
154
|
+
* Optional. The maximum monetary discount a customer can receive for the promotion. This field is only supported with the `Percent off` coupon value type.
|
|
155
|
+
*/
|
|
156
|
+
maxDiscountAmount?: Schema$Price;
|
|
157
|
+
/**
|
|
158
|
+
* Optional. Maximum money off amount for a promotion with `MONEY_OFF_RANGE` coupon value type. At least one of `min_money_off_amount` or `max_money_off_amount` must be present when the coupon value type is `MONEY_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned.
|
|
159
|
+
*/
|
|
160
|
+
maxMoneyOffAmount?: Schema$Price;
|
|
161
|
+
/**
|
|
162
|
+
* Optional. Maximum percent off for a promotion with `PERCENT_OFF_RANGE` coupon value type. At least one of `min_percent_off` or `max_percent_off` must be present when the coupon value type is `PERCENT_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned.
|
|
163
|
+
*/
|
|
164
|
+
maxPercentOff?: string | null;
|
|
165
|
+
/**
|
|
166
|
+
* Optional. [Minimum purchase amount](https://support.google.com/merchants/answer/13837705?ref_topic=13773355) for the promotion.
|
|
139
167
|
*/
|
|
140
168
|
minimumPurchaseAmount?: Schema$Price;
|
|
141
169
|
minimumPurchaseQuantity?: string | null;
|
|
142
170
|
/**
|
|
143
|
-
* Optional.
|
|
171
|
+
* Optional. Minimum money off amount for a promotion with `MONEY_OFF_RANGE` coupon value type. At least one of `min_money_off_amount` or `max_money_off_amount` must be present when the coupon value type is `MONEY_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned.
|
|
172
|
+
*/
|
|
173
|
+
minMoneyOffAmount?: Schema$Price;
|
|
174
|
+
/**
|
|
175
|
+
* Optional. Minimum percent off for a promotion with `PERCENT_OFF_RANGE` coupon value type. At least one of `min_percent_off` or `max_percent_off` must be present when the coupon value type is `PERCENT_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned.
|
|
176
|
+
*/
|
|
177
|
+
minPercentOff?: string | null;
|
|
178
|
+
/**
|
|
179
|
+
* Optional. The [money off amount](https://support.google.com/merchants/answer/13838101?ref_topic=13773355) offered in the promotion.
|
|
144
180
|
*/
|
|
145
181
|
moneyOffAmount?: Schema$Price;
|
|
146
182
|
/**
|
|
147
|
-
* Required. [Type](https://support.google.com/merchants/answer/13837405?ref_topic=13773355
|
|
183
|
+
* Required. [Type](https://support.google.com/merchants/answer/13837405?ref_topic=13773355) of the promotion. Use this attribute to indicate whether or not customers need a coupon code to redeem your promotion.
|
|
148
184
|
*/
|
|
149
185
|
offerType?: string | null;
|
|
150
186
|
/**
|
|
@@ -152,19 +188,19 @@ export declare namespace merchantapi_promotions_v1 {
|
|
|
152
188
|
*/
|
|
153
189
|
percentOff?: string | null;
|
|
154
190
|
/**
|
|
155
|
-
*
|
|
191
|
+
* Optional. Applicability of the promotion to either all products or [only specific products](https://support.google.com/merchants/answer/6396257). Exactly one of `product_applicability` or `event_applicability` must be set.
|
|
156
192
|
*/
|
|
157
193
|
productApplicability?: string | null;
|
|
158
194
|
/**
|
|
159
|
-
* Optional. Product filter by [product type exclusion](https://support.google.com/merchants/answer/13863746?ref_topic=13773355
|
|
195
|
+
* Optional. Product filter by [product type exclusion](https://support.google.com/merchants/answer/13863746?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
|
|
160
196
|
*/
|
|
161
197
|
productTypeExclusion?: string[] | null;
|
|
162
198
|
/**
|
|
163
|
-
* Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355
|
|
199
|
+
* Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
|
|
164
200
|
*/
|
|
165
201
|
productTypeInclusion?: string[] | null;
|
|
166
202
|
/**
|
|
167
|
-
* Required. The list of destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default. You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use `FREE_LISTINGS`, `FREE_LOCAL_LISTINGS`, `LOCAL_INVENTORY_ADS`. For more details see [Promotion destination](https://support.google.com/merchants/answer/13837465
|
|
203
|
+
* Required. The list of destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default. You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use `FREE_LISTINGS`, `FREE_LOCAL_LISTINGS`, `LOCAL_INVENTORY_ADS`. For more details see [Promotion destination](https://support.google.com/merchants/answer/13837465)
|
|
168
204
|
*/
|
|
169
205
|
promotionDestinations?: string[] | null;
|
|
170
206
|
/**
|
|
@@ -179,16 +215,24 @@ export declare namespace merchantapi_promotions_v1 {
|
|
|
179
215
|
* Optional. URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no `promotion_url` is included. URL is used to confirm that the promotion is valid and can be redeemed.
|
|
180
216
|
*/
|
|
181
217
|
promotionUrl?: string | null;
|
|
218
|
+
/**
|
|
219
|
+
* Optional. A restriction customers must meet before they can redeem the promotion.
|
|
220
|
+
*/
|
|
221
|
+
redemptionRestriction?: string | null;
|
|
222
|
+
/**
|
|
223
|
+
* Optional. A list of [regions](https://support.google.com/merchants/answer/15406457?#howregionswork) where the promotion is applicable. Must be set if `audience` is set to `LOCATION`.
|
|
224
|
+
*/
|
|
225
|
+
regionIdInclusion?: string[] | null;
|
|
182
226
|
/**
|
|
183
227
|
* Optional. Whether the promotion applies to [all stores, or only specified stores](https://support.google.com/merchants/answer/13857563?sjid=17642868584668136159-NC). Local Inventory ads promotions throw an error if no store applicability is included. An `INVALID_ARGUMENT` error is thrown if `store_applicability` is set to `ALL_STORES` and `store_codes_inclusion` or `score_code_exclusion` is set to a value.
|
|
184
228
|
*/
|
|
185
229
|
storeApplicability?: string | null;
|
|
186
230
|
/**
|
|
187
|
-
* Optional. [Store codes to exclude](https://support.google.com/merchants/answer/13859586?ref_topic=13773355
|
|
231
|
+
* Optional. [Store codes to exclude](https://support.google.com/merchants/answer/13859586?ref_topic=13773355) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355).
|
|
188
232
|
*/
|
|
189
233
|
storeCodesExclusion?: string[] | null;
|
|
190
234
|
/**
|
|
191
|
-
* Optional. [Store codes to include](https://support.google.com/merchants/answer/13857470?ref_topic=13773355
|
|
235
|
+
* Optional. [Store codes to include](https://support.google.com/merchants/answer/13857470?ref_topic=13773355) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355). Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the [Local product inventory data specification](https://support.google.com/merchants/answer/3061342) for more information.
|
|
192
236
|
*/
|
|
193
237
|
storeCodesInclusion?: string[] | null;
|
|
194
238
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"promotions_v1.js","sourceRoot":"","sources":["../promotions_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,yBAAyB,
|
|
1
|
+
{"version":3,"file":"promotions_v1.js","sourceRoot":"","sources":["../promotions_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,yBAAyB,CAs+BzC;AAt+BD,WAAiB,yBAAyB;IAgExC;;;;;;;;;;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,qCAAW,cAYvB,CAAA;IAoaD,MAAa,iBAAiB;QAC5B,OAAO,CAAoB;QAC3B,UAAU,CAA+B;QACzC,YAAY,OAA0B;YACpC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;YACvB,IAAI,CAAC,UAAU,GAAG,IAAI,4BAA4B,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,CAAC;KACF;IAPY,2CAAiB,oBAO7B,CAAA;IAED,MAAa,4BAA4B;QACvC,OAAO,CAAoB;QAC3B,YAAY,OAA0B;YACpC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACzB,CAAC;QAwFD,GAAG,CACD,gBAGkC,EAClC,iBAIkC,EAClC,QAEkC;YAKlC,IAAI,MAAM,GAAG,CAAC,gBAAgB;gBAC5B,EAAE,CAA4C,CAAC;YACjD,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,EAA6C,CAAC;gBACvD,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,wBAAwB,CAAC,CAAC,OAAO,CAC/C,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,EAAmB,UAAU,CAAC,CAAC;YACxD,CAAC;QACH,CAAC;QAiGD,MAAM,CACJ,gBAGkC,EAClC,iBAIkC,EAClC,QAEkC;YAKlC,IAAI,MAAM,GAAG,CAAC,gBAAgB;gBAC5B,EAAE,CAA+C,CAAC;YACpD,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,EAAgD,CAAC;gBAC1D,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,4CAA4C,CACvD,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,EAAmB,UAAU,CAAC,CAAC;YACxD,CAAC;QACH,CAAC;QAsFD,IAAI,CACF,gBAGkC,EAClC,iBAIkC,EAClC,QAEkC;YAKlC,IAAI,MAAM,GAAG,CAAC,gBAAgB;gBAC5B,EAAE,CAA6C,CAAC;YAClD,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,EAA8C,CAAC;gBACxD,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,qCAAqC,CAAC,CAAC,OAAO,CAC5D,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,EAAgC,UAAU,CAAC,CAAC;YACrE,CAAC;QACH,CAAC;KACF;IAjcY,sDAA4B,+BAicxC,CAAA;AAiCH,CAAC,EAt+BgB,yBAAyB,yCAAzB,yBAAyB,QAs+BzC"}
|