@googleapis/merchantapi 17.4.0 → 19.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 +22 -0
- package/accounts_v1.ts +57 -86
- package/accounts_v1beta.ts +54 -80
- package/build/accounts_v1.d.ts +18 -6
- package/build/accounts_v1.js.map +1 -1
- package/build/accounts_v1beta.d.ts +18 -6
- package/build/accounts_v1beta.js.map +1 -1
- package/build/conversions_v1.js.map +1 -1
- package/build/conversions_v1beta.js.map +1 -1
- package/build/datasources_v1.d.ts +3 -3
- package/build/datasources_v1.js.map +1 -1
- package/build/datasources_v1beta.d.ts +3 -3
- package/build/datasources_v1beta.js.map +1 -1
- package/build/inventories_v1.d.ts +25 -0
- package/build/inventories_v1.js.map +1 -1
- package/build/inventories_v1beta.js.map +1 -1
- package/build/issueresolution_v1.d.ts +4 -4
- package/build/issueresolution_v1.js.map +1 -1
- package/build/issueresolution_v1beta.d.ts +4 -4
- package/build/issueresolution_v1beta.js.map +1 -1
- package/build/lfp_v1.js.map +1 -1
- package/build/lfp_v1beta.js.map +1 -1
- package/build/notifications_v1.d.ts +4 -4
- package/build/notifications_v1.js.map +1 -1
- package/build/notifications_v1beta.d.ts +4 -4
- package/build/notifications_v1beta.js.map +1 -1
- package/build/products_v1.d.ts +291 -0
- package/build/products_v1.js.map +1 -1
- package/build/products_v1beta.d.ts +5 -0
- package/build/products_v1beta.js.map +1 -1
- package/build/promotions_v1.js.map +1 -1
- package/build/promotions_v1beta.js.map +1 -1
- package/build/quota_v1.d.ts +1 -1
- package/build/quota_v1.js.map +1 -1
- package/build/quota_v1beta.d.ts +1 -1
- package/build/quota_v1beta.js.map +1 -1
- package/build/reports_v1.d.ts +6 -6
- package/build/reports_v1beta.d.ts +6 -6
- package/build/reviews_v1beta.js.map +1 -1
- package/build/tsconfig.tsbuildinfo +1 -1
- package/conversions_v1.ts +1 -2
- package/conversions_v1beta.ts +1 -2
- package/datasources_v1.ts +10 -17
- package/datasources_v1beta.ts +10 -17
- package/inventories_v1.ts +27 -4
- package/inventories_v1beta.ts +2 -4
- package/issueresolution_v1.ts +5 -6
- package/issueresolution_v1beta.ts +5 -6
- package/lfp_v1.ts +5 -10
- package/lfp_v1beta.ts +5 -10
- package/notifications_v1.ts +8 -12
- package/notifications_v1beta.ts +8 -12
- package/package.json +1 -1
- package/products_v1.ts +294 -6
- package/products_v1beta.ts +8 -6
- package/promotions_v1.ts +3 -6
- package/promotions_v1beta.ts +3 -6
- package/quota_v1.ts +3 -5
- package/quota_v1beta.ts +2 -3
- package/reports_v1.ts +6 -6
- package/reports_v1beta.ts +6 -6
- package/reviews_v1beta.ts +3 -6
package/notifications_v1beta.ts
CHANGED
|
@@ -154,7 +154,7 @@ export namespace merchantapi_notifications_v1beta {
|
|
|
154
154
|
*/
|
|
155
155
|
callBackUri?: string | null;
|
|
156
156
|
/**
|
|
157
|
-
* Output only. The `name` of the notification configuration. Generated by the
|
|
157
|
+
* Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account\}/notificationsubscriptions/{notification_subscription\}`
|
|
158
158
|
*/
|
|
159
159
|
name?: string | null;
|
|
160
160
|
/**
|
|
@@ -246,7 +246,7 @@ export namespace merchantapi_notifications_v1beta {
|
|
|
246
246
|
}
|
|
247
247
|
|
|
248
248
|
/**
|
|
249
|
-
* Creates a notification subscription for a business. For standalone or
|
|
249
|
+
* Creates a notification subscription for a business. For standalone or sub-accounts, the business can create a subscription for self. For advanced accounts, the business can create a subscription for all managed accounts or for a specific subaccount. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. We will allow the following types of notification subscriptions to exist together (per business as a subscriber per event type): 1. Subscription for all managed accounts + subscription for self. 2. Multiple "partial" subscriptions for managed accounts + subscription for self. we will not allow (per business as a subscriber per event type): 1. Multiple self subscriptions. 2. Multiple "all managed accounts" subscriptions. 3. "All managed accounts" subscription and partial subscriptions at the same time. 4. Multiple partial subscriptions for the same target account.
|
|
250
250
|
* @example
|
|
251
251
|
* ```js
|
|
252
252
|
* // Before running the sample:
|
|
@@ -331,8 +331,7 @@ export namespace merchantapi_notifications_v1beta {
|
|
|
331
331
|
create(
|
|
332
332
|
params: Params$Resource$Accounts$Notificationsubscriptions$Create,
|
|
333
333
|
options:
|
|
334
|
-
|
|
|
335
|
-
| BodyResponseCallback<Schema$NotificationSubscription>,
|
|
334
|
+
MethodOptions | BodyResponseCallback<Schema$NotificationSubscription>,
|
|
336
335
|
callback: BodyResponseCallback<Schema$NotificationSubscription>
|
|
337
336
|
): void;
|
|
338
337
|
create(
|
|
@@ -489,8 +488,7 @@ export namespace merchantapi_notifications_v1beta {
|
|
|
489
488
|
| BodyResponseCallback<Schema$Empty>
|
|
490
489
|
| BodyResponseCallback<Readable>,
|
|
491
490
|
callback?:
|
|
492
|
-
|
|
493
|
-
| BodyResponseCallback<Readable>
|
|
491
|
+
BodyResponseCallback<Schema$Empty> | BodyResponseCallback<Readable>
|
|
494
492
|
):
|
|
495
493
|
| void
|
|
496
494
|
| Promise<GaxiosResponseWithHTTP2<Schema$Empty>>
|
|
@@ -613,8 +611,7 @@ export namespace merchantapi_notifications_v1beta {
|
|
|
613
611
|
get(
|
|
614
612
|
params: Params$Resource$Accounts$Notificationsubscriptions$Get,
|
|
615
613
|
options:
|
|
616
|
-
|
|
|
617
|
-
| BodyResponseCallback<Schema$NotificationSubscription>,
|
|
614
|
+
MethodOptions | BodyResponseCallback<Schema$NotificationSubscription>,
|
|
618
615
|
callback: BodyResponseCallback<Schema$NotificationSubscription>
|
|
619
616
|
): void;
|
|
620
617
|
get(
|
|
@@ -865,7 +862,7 @@ export namespace merchantapi_notifications_v1beta {
|
|
|
865
862
|
*
|
|
866
863
|
* // Do the magic
|
|
867
864
|
* const res = await merchantapi.accounts.notificationsubscriptions.patch({
|
|
868
|
-
* // Output only. The `name` of the notification configuration. Generated by the
|
|
865
|
+
* // Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account\}/notificationsubscriptions/{notification_subscription\}`
|
|
869
866
|
* name: 'accounts/my-account/notificationsubscriptions/my-notificationsubscription',
|
|
870
867
|
* // List of fields being updated.
|
|
871
868
|
* updateMask: 'placeholder-value',
|
|
@@ -922,8 +919,7 @@ export namespace merchantapi_notifications_v1beta {
|
|
|
922
919
|
patch(
|
|
923
920
|
params: Params$Resource$Accounts$Notificationsubscriptions$Patch,
|
|
924
921
|
options:
|
|
925
|
-
|
|
|
926
|
-
| BodyResponseCallback<Schema$NotificationSubscription>,
|
|
922
|
+
MethodOptions | BodyResponseCallback<Schema$NotificationSubscription>,
|
|
927
923
|
callback: BodyResponseCallback<Schema$NotificationSubscription>
|
|
928
924
|
): void;
|
|
929
925
|
patch(
|
|
@@ -1033,7 +1029,7 @@ export namespace merchantapi_notifications_v1beta {
|
|
|
1033
1029
|
}
|
|
1034
1030
|
export interface Params$Resource$Accounts$Notificationsubscriptions$Patch extends StandardParameters {
|
|
1035
1031
|
/**
|
|
1036
|
-
* Output only. The `name` of the notification configuration. Generated by the
|
|
1032
|
+
* Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account\}/notificationsubscriptions/{notification_subscription\}`
|
|
1037
1033
|
*/
|
|
1038
1034
|
name?: string;
|
|
1039
1035
|
/**
|
package/package.json
CHANGED
package/products_v1.ts
CHANGED
|
@@ -286,6 +286,31 @@ export namespace merchantapi_products_v1 {
|
|
|
286
286
|
*/
|
|
287
287
|
reportingContext?: string | null;
|
|
288
288
|
}
|
|
289
|
+
/**
|
|
290
|
+
* The display address of the property.
|
|
291
|
+
*/
|
|
292
|
+
export interface Schema$DisplayAddress {
|
|
293
|
+
/**
|
|
294
|
+
* The city such as Seattle, New York, etc.
|
|
295
|
+
*/
|
|
296
|
+
city?: string | null;
|
|
297
|
+
/**
|
|
298
|
+
* The postal code, such as 94043.
|
|
299
|
+
*/
|
|
300
|
+
postalCode?: string | null;
|
|
301
|
+
/**
|
|
302
|
+
* The region(state), such as WA, OH, etc.
|
|
303
|
+
*/
|
|
304
|
+
region?: string | null;
|
|
305
|
+
/**
|
|
306
|
+
* The street name.
|
|
307
|
+
*/
|
|
308
|
+
streetName?: string | null;
|
|
309
|
+
/**
|
|
310
|
+
* The street number.
|
|
311
|
+
*/
|
|
312
|
+
streetNumber?: string | null;
|
|
313
|
+
}
|
|
289
314
|
/**
|
|
290
315
|
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
|
|
291
316
|
*/
|
|
@@ -404,6 +429,23 @@ export namespace merchantapi_products_v1 {
|
|
|
404
429
|
*/
|
|
405
430
|
severity?: string | null;
|
|
406
431
|
}
|
|
432
|
+
/**
|
|
433
|
+
* The lease term of the property.
|
|
434
|
+
*/
|
|
435
|
+
export interface Schema$LeaseTerm {
|
|
436
|
+
/**
|
|
437
|
+
* The duration unit of the lease term.
|
|
438
|
+
*/
|
|
439
|
+
durationUnit?: string | null;
|
|
440
|
+
/**
|
|
441
|
+
* The duration value of the lease term.
|
|
442
|
+
*/
|
|
443
|
+
durationValue?: string | null;
|
|
444
|
+
/**
|
|
445
|
+
* The type of lease term.
|
|
446
|
+
*/
|
|
447
|
+
type?: string | null;
|
|
448
|
+
}
|
|
407
449
|
/**
|
|
408
450
|
* Response message for the ListProducts method.
|
|
409
451
|
*/
|
|
@@ -480,6 +522,32 @@ export namespace merchantapi_products_v1 {
|
|
|
480
522
|
*/
|
|
481
523
|
value?: string | null;
|
|
482
524
|
}
|
|
525
|
+
/**
|
|
526
|
+
* The pet policy of the property.
|
|
527
|
+
*/
|
|
528
|
+
export interface Schema$PetPolicy {
|
|
529
|
+
/**
|
|
530
|
+
* Whether pets are allowed.
|
|
531
|
+
*/
|
|
532
|
+
petsAllowed?: boolean | null;
|
|
533
|
+
/**
|
|
534
|
+
* The pet types allowed.
|
|
535
|
+
*/
|
|
536
|
+
petTypes?: string[] | null;
|
|
537
|
+
}
|
|
538
|
+
/**
|
|
539
|
+
* The pickup cost of the item.
|
|
540
|
+
*/
|
|
541
|
+
export interface Schema$PickupCost {
|
|
542
|
+
/**
|
|
543
|
+
* Required. The flat rate pickup cost of the item.
|
|
544
|
+
*/
|
|
545
|
+
flatRate?: Schema$Price;
|
|
546
|
+
/**
|
|
547
|
+
* Optional. The price threshold above which pickup is free of charge.
|
|
548
|
+
*/
|
|
549
|
+
freeThreshold?: Schema$Price;
|
|
550
|
+
}
|
|
483
551
|
/**
|
|
484
552
|
* The price represented as a number and currency.
|
|
485
553
|
*/
|
|
@@ -497,6 +565,10 @@ export namespace merchantapi_products_v1 {
|
|
|
497
565
|
* 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.
|
|
498
566
|
*/
|
|
499
567
|
export interface Schema$Product {
|
|
568
|
+
/**
|
|
569
|
+
* 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).
|
|
570
|
+
*/
|
|
571
|
+
archived?: boolean | null;
|
|
500
572
|
/**
|
|
501
573
|
* Output only. The automated discounts information for the product.
|
|
502
574
|
*/
|
|
@@ -574,6 +646,10 @@ export namespace merchantapi_products_v1 {
|
|
|
574
646
|
* Target [age group](https://support.google.com/merchants/answer/6324463) of the item.
|
|
575
647
|
*/
|
|
576
648
|
ageGroup?: string | null;
|
|
649
|
+
/**
|
|
650
|
+
* The amenity features for the property.
|
|
651
|
+
*/
|
|
652
|
+
amenityFeature?: string[] | null;
|
|
577
653
|
/**
|
|
578
654
|
* A safeguard in the [automated discounts] (https://support.google.com/merchants/answer/10295759) and "Dynamic Promotions" (https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability.
|
|
579
655
|
*/
|
|
@@ -662,6 +738,10 @@ export namespace merchantapi_products_v1 {
|
|
|
662
738
|
* The date time when an offer becomes visible in search results across Google’s YouTube surfaces, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. See [Disclosure date](https://support.google.com/merchants/answer/13034208) for more information.
|
|
663
739
|
*/
|
|
664
740
|
disclosureDate?: string | null;
|
|
741
|
+
/**
|
|
742
|
+
* The display address of the property.
|
|
743
|
+
*/
|
|
744
|
+
displayAddress?: Schema$DisplayAddress;
|
|
665
745
|
/**
|
|
666
746
|
* An identifier for an item for dynamic remarketing campaigns.
|
|
667
747
|
*/
|
|
@@ -682,6 +762,10 @@ export namespace merchantapi_products_v1 {
|
|
|
682
762
|
* Offer margin for dynamic remarketing campaigns. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387).
|
|
683
763
|
*/
|
|
684
764
|
displayAdsValue?: number | null;
|
|
765
|
+
/**
|
|
766
|
+
* Optional. Contains a list of PDF [document URLs](https://support.google.com/merchants/answer/17084656) for the product. Examples are training manuals, user guides, assembly instructions, package inserts, etc. Must start with "http://" or "https://"), ASCII characters only, and RFC 3986 compliant.
|
|
767
|
+
*/
|
|
768
|
+
documentLinks?: string[] | null;
|
|
685
769
|
/**
|
|
686
770
|
* The [electric range](https://support.google.com/google-ads/answer/15162232) of the vehicle in miles/kms.
|
|
687
771
|
*/
|
|
@@ -766,6 +850,18 @@ export namespace merchantapi_products_v1 {
|
|
|
766
850
|
* Shared identifier for all variants of the same product.
|
|
767
851
|
*/
|
|
768
852
|
itemGroupId?: string | null;
|
|
853
|
+
/**
|
|
854
|
+
* Optional. Represents the [title of the product group](https://support.google.com/merchants/answer/17085146) to which this variant product belongs. This can be used along with the [item group id](https://support.google.com/merchants/answer/6324507) attribute. It lets you perform better grouping of variant products, and helps identifying common product characteristics more efficiently.
|
|
855
|
+
*/
|
|
856
|
+
itemGroupTitle?: string | null;
|
|
857
|
+
/**
|
|
858
|
+
* The latitude of the property. The value must be between -90 (inclusive) and 90 (inclusive), up to 6 decimal places.
|
|
859
|
+
*/
|
|
860
|
+
latitude?: number | null;
|
|
861
|
+
/**
|
|
862
|
+
* The lease term of the property.
|
|
863
|
+
*/
|
|
864
|
+
leaseTerm?: Schema$LeaseTerm;
|
|
769
865
|
/**
|
|
770
866
|
* Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the [Help Center article](https://support.google.com/merchants/answer/9103186) for more information.
|
|
771
867
|
*/
|
|
@@ -778,6 +874,10 @@ export namespace merchantapi_products_v1 {
|
|
|
778
874
|
* [Link template](https://support.google.com/merchants/answer/13871172) for business hosted local storefront.
|
|
779
875
|
*/
|
|
780
876
|
linkTemplate?: string | null;
|
|
877
|
+
/**
|
|
878
|
+
* The longitude of the property. The value must be between -180 (inclusive) and 180 (inclusive), up to 6 decimal places.
|
|
879
|
+
*/
|
|
880
|
+
longitude?: number | null;
|
|
781
881
|
/**
|
|
782
882
|
* Loyalty points that users receive after purchasing the item. Japan only.
|
|
783
883
|
*/
|
|
@@ -838,6 +938,22 @@ export namespace merchantapi_products_v1 {
|
|
|
838
938
|
* The number of identical products in a business-defined multipack.
|
|
839
939
|
*/
|
|
840
940
|
multipack?: string | null;
|
|
941
|
+
/**
|
|
942
|
+
* The neighborhood (locality) of the property, such as `Wallingford`, `Greenwood`, etc.
|
|
943
|
+
*/
|
|
944
|
+
neighborhood?: string | null;
|
|
945
|
+
/**
|
|
946
|
+
* The number of bathrooms in the property. The value must be greater than 0 and a multiple of 0.5.
|
|
947
|
+
*/
|
|
948
|
+
numberOfBathrooms?: number | null;
|
|
949
|
+
/**
|
|
950
|
+
* The number of bedrooms in the property. The value must be greater than or equal to 0 and a multiple of 1.0.
|
|
951
|
+
*/
|
|
952
|
+
numberOfBedrooms?: number | null;
|
|
953
|
+
/**
|
|
954
|
+
* The number of units available for a specific floor plan of the property. The value must be greater than 0.
|
|
955
|
+
*/
|
|
956
|
+
numberOfUnits?: string | null;
|
|
841
957
|
/**
|
|
842
958
|
* The item's [pattern](https://support.google.com/merchants/answer/6324483). For example, polka dots.
|
|
843
959
|
*/
|
|
@@ -846,6 +962,14 @@ export namespace merchantapi_products_v1 {
|
|
|
846
962
|
* Publication of this item will be temporarily [paused](https://support.google.com/merchants/answer/11909930).
|
|
847
963
|
*/
|
|
848
964
|
pause?: string | null;
|
|
965
|
+
/**
|
|
966
|
+
* The pet policy for the property.
|
|
967
|
+
*/
|
|
968
|
+
petPolicy?: Schema$PetPolicy;
|
|
969
|
+
/**
|
|
970
|
+
* Optional. The [pickup cost](https://support.google.com/merchants/answer/16988704) for an item when a customer buys it online and picks it up at a store.
|
|
971
|
+
*/
|
|
972
|
+
pickupCost?: Schema$PickupCost;
|
|
849
973
|
/**
|
|
850
974
|
* The [pickup](https://support.google.com/merchants/answer/14634021) option for the item.
|
|
851
975
|
*/
|
|
@@ -854,6 +978,10 @@ export namespace merchantapi_products_v1 {
|
|
|
854
978
|
* Item store pickup timeline. For more information, see [Pickup SLA](https://support.google.com/merchants/answer/14635400).
|
|
855
979
|
*/
|
|
856
980
|
pickupSla?: string | null;
|
|
981
|
+
/**
|
|
982
|
+
* Optional. Indicates the [popularity](https://support.google.com/merchants/answer/17085297) of the product in a merchant's inventory. Using a scale of 0.0 (lowest) to 100.0 (highest).
|
|
983
|
+
*/
|
|
984
|
+
popularityRank?: number | null;
|
|
857
985
|
/**
|
|
858
986
|
* Price of the item.
|
|
859
987
|
*/
|
|
@@ -862,6 +990,10 @@ export namespace merchantapi_products_v1 {
|
|
|
862
990
|
* Technical specification or additional product details.
|
|
863
991
|
*/
|
|
864
992
|
productDetails?: Schema$ProductDetail[];
|
|
993
|
+
/**
|
|
994
|
+
* The product fee for the property.
|
|
995
|
+
*/
|
|
996
|
+
productFee?: Schema$ProductFee[];
|
|
865
997
|
/**
|
|
866
998
|
* The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
|
|
867
999
|
*/
|
|
@@ -890,10 +1022,30 @@ export namespace merchantapi_products_v1 {
|
|
|
890
1022
|
* The unique ID of a promotion.
|
|
891
1023
|
*/
|
|
892
1024
|
promotionIds?: string[] | null;
|
|
1025
|
+
/**
|
|
1026
|
+
* The name of the property.
|
|
1027
|
+
*/
|
|
1028
|
+
propertyName?: string | null;
|
|
1029
|
+
/**
|
|
1030
|
+
* The type of property.
|
|
1031
|
+
*/
|
|
1032
|
+
propertyType?: string | null;
|
|
1033
|
+
/**
|
|
1034
|
+
* Optional. Contains user-, merchant-, and manufacturer-authored [questions and answers](https://support.google.com/merchants/answer/17085211) about the product. Max 30 question and answer pairs. Max 10000 characters total. Each question can have max 1000 characters. Each answer can have max 1000 characters.
|
|
1035
|
+
*/
|
|
1036
|
+
questionsAndAnswers?: Schema$QuestionAndAnswer[];
|
|
1037
|
+
/**
|
|
1038
|
+
* Optional. Specifies how other [products are related](https://support.google.com/merchants/answer/17085213) to this product.
|
|
1039
|
+
*/
|
|
1040
|
+
relatedProducts?: Schema$RelatedProduct[];
|
|
893
1041
|
/**
|
|
894
1042
|
* 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).
|
|
895
1043
|
*/
|
|
896
1044
|
returnPolicyLabel?: string | null;
|
|
1045
|
+
/**
|
|
1046
|
+
* Optional. [Return rules](https://support.google.com/merchants/answer/17081382) for the product.
|
|
1047
|
+
*/
|
|
1048
|
+
returns?: Schema$Returns[];
|
|
897
1049
|
/**
|
|
898
1050
|
* Advertised sale price of the item.
|
|
899
1051
|
*/
|
|
@@ -942,6 +1094,10 @@ export namespace merchantapi_products_v1 {
|
|
|
942
1094
|
* List of country codes [(ISO 3166-1 alpha-2)](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in data source settings.
|
|
943
1095
|
*/
|
|
944
1096
|
shoppingAdsExcludedCountries?: string[] | null;
|
|
1097
|
+
/**
|
|
1098
|
+
* The short title of the item.
|
|
1099
|
+
*/
|
|
1100
|
+
shortTitle?: string | null;
|
|
945
1101
|
/**
|
|
946
1102
|
* Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value, see [Size](https://support.google.com/merchants/answer/6324492).
|
|
947
1103
|
*/
|
|
@@ -954,6 +1110,10 @@ export namespace merchantapi_products_v1 {
|
|
|
954
1110
|
* The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided, see [Size type](https://support.google.com/merchants/answer/6324497).
|
|
955
1111
|
*/
|
|
956
1112
|
sizeTypes?: string[] | null;
|
|
1113
|
+
/**
|
|
1114
|
+
* The specialty housing type for the property.
|
|
1115
|
+
*/
|
|
1116
|
+
specialtyHousingType?: string | null;
|
|
957
1117
|
/**
|
|
958
1118
|
* Structured description, for algorithmically (AI)-generated descriptions.
|
|
959
1119
|
*/
|
|
@@ -982,6 +1142,10 @@ export namespace merchantapi_products_v1 {
|
|
|
982
1142
|
* The [Trim](https://support.google.com/google-ads/answer/14154176) of the vehicle model, such as `S`, `SV`, `SL` and others.
|
|
983
1143
|
*/
|
|
984
1144
|
trim?: string | null;
|
|
1145
|
+
/**
|
|
1146
|
+
* The unit area of the property, such as `1000 sqft`.
|
|
1147
|
+
*/
|
|
1148
|
+
unitArea?: Schema$UnitArea;
|
|
985
1149
|
/**
|
|
986
1150
|
* The preference of the denominator of the unit price.
|
|
987
1151
|
*/
|
|
@@ -990,6 +1154,14 @@ export namespace merchantapi_products_v1 {
|
|
|
990
1154
|
* The measure and dimension of an item.
|
|
991
1155
|
*/
|
|
992
1156
|
unitPricingMeasure?: Schema$UnitPricingMeasure;
|
|
1157
|
+
/**
|
|
1158
|
+
* The utilities included for the property.
|
|
1159
|
+
*/
|
|
1160
|
+
utilitiesIncluded?: string[] | null;
|
|
1161
|
+
/**
|
|
1162
|
+
* Optional. Contains the [list of all variant-identifying options](https://support.google.com/merchants/answer/17085214) of this product.
|
|
1163
|
+
*/
|
|
1164
|
+
variantOptions?: Schema$VariantOption[];
|
|
993
1165
|
/**
|
|
994
1166
|
* 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.
|
|
995
1167
|
*/
|
|
@@ -1103,6 +1275,19 @@ export namespace merchantapi_products_v1 {
|
|
|
1103
1275
|
*/
|
|
1104
1276
|
value?: number | null;
|
|
1105
1277
|
}
|
|
1278
|
+
/**
|
|
1279
|
+
* The product fee attribute containing type and amount.
|
|
1280
|
+
*/
|
|
1281
|
+
export interface Schema$ProductFee {
|
|
1282
|
+
/**
|
|
1283
|
+
* The amount of product fee.
|
|
1284
|
+
*/
|
|
1285
|
+
amount?: Schema$Price;
|
|
1286
|
+
/**
|
|
1287
|
+
* The type of product fee.
|
|
1288
|
+
*/
|
|
1289
|
+
type?: string | null;
|
|
1290
|
+
}
|
|
1106
1291
|
/**
|
|
1107
1292
|
* 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.
|
|
1108
1293
|
*/
|
|
@@ -1298,6 +1483,85 @@ export namespace merchantapi_products_v1 {
|
|
|
1298
1483
|
*/
|
|
1299
1484
|
value?: number | null;
|
|
1300
1485
|
}
|
|
1486
|
+
/**
|
|
1487
|
+
* The question and answer for the product.
|
|
1488
|
+
*/
|
|
1489
|
+
export interface Schema$QuestionAndAnswer {
|
|
1490
|
+
/**
|
|
1491
|
+
* Required. The answer text.
|
|
1492
|
+
*/
|
|
1493
|
+
answer?: string | null;
|
|
1494
|
+
/**
|
|
1495
|
+
* Required. The question text.
|
|
1496
|
+
*/
|
|
1497
|
+
question?: string | null;
|
|
1498
|
+
}
|
|
1499
|
+
/**
|
|
1500
|
+
* Specifies how other products are related to this product.
|
|
1501
|
+
*/
|
|
1502
|
+
export interface Schema$RelatedProduct {
|
|
1503
|
+
/**
|
|
1504
|
+
* Required. The identifier of the related product.
|
|
1505
|
+
*/
|
|
1506
|
+
id?: string | null;
|
|
1507
|
+
/**
|
|
1508
|
+
* Required. The type of the identifier of the related product. For example, [GTIN](https://support.google.com/merchants/answer/6219078) or [product ID](https://support.google.com/merchants/answer/6324405).
|
|
1509
|
+
*/
|
|
1510
|
+
idType?: string | null;
|
|
1511
|
+
/**
|
|
1512
|
+
* Required. The type of the relationship between this product and the related product.
|
|
1513
|
+
*/
|
|
1514
|
+
relationshipType?: string | null;
|
|
1515
|
+
}
|
|
1516
|
+
/**
|
|
1517
|
+
* The returns of the product.
|
|
1518
|
+
*/
|
|
1519
|
+
export interface Schema$Returns {
|
|
1520
|
+
/**
|
|
1521
|
+
* The [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the countries to which an item can be returned.
|
|
1522
|
+
*/
|
|
1523
|
+
countries?: string[] | null;
|
|
1524
|
+
/**
|
|
1525
|
+
* The condition the item must be in to be accepted.
|
|
1526
|
+
*/
|
|
1527
|
+
itemConditions?: string[] | null;
|
|
1528
|
+
/**
|
|
1529
|
+
* The physical methods by which the item can be returned.
|
|
1530
|
+
*/
|
|
1531
|
+
methods?: string[] | null;
|
|
1532
|
+
/**
|
|
1533
|
+
* The financial outcomes available for a return.
|
|
1534
|
+
*/
|
|
1535
|
+
outcomes?: string[] | null;
|
|
1536
|
+
/**
|
|
1537
|
+
* The URL of the return policy.
|
|
1538
|
+
*/
|
|
1539
|
+
policyUrl?: string | null;
|
|
1540
|
+
/**
|
|
1541
|
+
* A flat restocking fee penalty.
|
|
1542
|
+
*/
|
|
1543
|
+
restockingFee?: Schema$Price;
|
|
1544
|
+
/**
|
|
1545
|
+
* A percentage restocking fee penalty.
|
|
1546
|
+
*/
|
|
1547
|
+
restockingPercentageFee?: number | null;
|
|
1548
|
+
/**
|
|
1549
|
+
* The fixed cost out-of-pocket for a customer to return an item.
|
|
1550
|
+
*/
|
|
1551
|
+
shippingFee?: Schema$Price;
|
|
1552
|
+
/**
|
|
1553
|
+
* The type of return shipping fee.
|
|
1554
|
+
*/
|
|
1555
|
+
shippingFeeType?: string | null;
|
|
1556
|
+
/**
|
|
1557
|
+
* The duration of the return window in days.
|
|
1558
|
+
*/
|
|
1559
|
+
windowDays?: string | null;
|
|
1560
|
+
/**
|
|
1561
|
+
* Special return window behavior.
|
|
1562
|
+
*/
|
|
1563
|
+
windowType?: string | null;
|
|
1564
|
+
}
|
|
1301
1565
|
/**
|
|
1302
1566
|
* The Shipping of the product.
|
|
1303
1567
|
*/
|
|
@@ -1445,6 +1709,19 @@ export namespace merchantapi_products_v1 {
|
|
|
1445
1709
|
*/
|
|
1446
1710
|
periodLength?: string | null;
|
|
1447
1711
|
}
|
|
1712
|
+
/**
|
|
1713
|
+
* The unit area of the property.
|
|
1714
|
+
*/
|
|
1715
|
+
export interface Schema$UnitArea {
|
|
1716
|
+
/**
|
|
1717
|
+
* The unit of area.
|
|
1718
|
+
*/
|
|
1719
|
+
unit?: string | null;
|
|
1720
|
+
/**
|
|
1721
|
+
* The area value.
|
|
1722
|
+
*/
|
|
1723
|
+
value?: number | null;
|
|
1724
|
+
}
|
|
1448
1725
|
/**
|
|
1449
1726
|
* The UnitPricingBaseMeasure of the product.
|
|
1450
1727
|
*/
|
|
@@ -1471,6 +1748,19 @@ export namespace merchantapi_products_v1 {
|
|
|
1471
1748
|
*/
|
|
1472
1749
|
value?: number | null;
|
|
1473
1750
|
}
|
|
1751
|
+
/**
|
|
1752
|
+
* Additional product variants for the product.
|
|
1753
|
+
*/
|
|
1754
|
+
export interface Schema$VariantOption {
|
|
1755
|
+
/**
|
|
1756
|
+
* Required. The name of the variant. For example, "Color", "Memory", "Size", "Length"
|
|
1757
|
+
*/
|
|
1758
|
+
name?: string | null;
|
|
1759
|
+
/**
|
|
1760
|
+
* Required. The value of the variant. For example, "Red", "128GB", "XL", "100cm"
|
|
1761
|
+
*/
|
|
1762
|
+
value?: string | null;
|
|
1763
|
+
}
|
|
1474
1764
|
/**
|
|
1475
1765
|
* The warranty of the vehicle.
|
|
1476
1766
|
*/
|
|
@@ -1590,8 +1880,7 @@ export namespace merchantapi_products_v1 {
|
|
|
1590
1880
|
| BodyResponseCallback<Schema$Empty>
|
|
1591
1881
|
| BodyResponseCallback<Readable>,
|
|
1592
1882
|
callback?:
|
|
1593
|
-
|
|
1594
|
-
| BodyResponseCallback<Readable>
|
|
1883
|
+
BodyResponseCallback<Schema$Empty> | BodyResponseCallback<Readable>
|
|
1595
1884
|
):
|
|
1596
1885
|
| void
|
|
1597
1886
|
| Promise<GaxiosResponseWithHTTP2<Schema$Empty>>
|
|
@@ -2064,6 +2353,7 @@ export namespace merchantapi_products_v1 {
|
|
|
2064
2353
|
*
|
|
2065
2354
|
* // Example response
|
|
2066
2355
|
* // {
|
|
2356
|
+
* // "archived": false,
|
|
2067
2357
|
* // "automatedDiscounts": {},
|
|
2068
2358
|
* // "base64EncodedName": "my_base64EncodedName",
|
|
2069
2359
|
* // "contentLanguage": "my_contentLanguage",
|
|
@@ -2125,8 +2415,7 @@ export namespace merchantapi_products_v1 {
|
|
|
2125
2415
|
| BodyResponseCallback<Schema$Product>
|
|
2126
2416
|
| BodyResponseCallback<Readable>,
|
|
2127
2417
|
callback?:
|
|
2128
|
-
|
|
2129
|
-
| BodyResponseCallback<Readable>
|
|
2418
|
+
BodyResponseCallback<Schema$Product> | BodyResponseCallback<Readable>
|
|
2130
2419
|
):
|
|
2131
2420
|
| void
|
|
2132
2421
|
| Promise<GaxiosResponseWithHTTP2<Schema$Product>>
|
|
@@ -2249,8 +2538,7 @@ export namespace merchantapi_products_v1 {
|
|
|
2249
2538
|
list(
|
|
2250
2539
|
params: Params$Resource$Accounts$Products$List,
|
|
2251
2540
|
options:
|
|
2252
|
-
|
|
|
2253
|
-
| BodyResponseCallback<Schema$ListProductsResponse>,
|
|
2541
|
+
MethodOptions | BodyResponseCallback<Schema$ListProductsResponse>,
|
|
2254
2542
|
callback: BodyResponseCallback<Schema$ListProductsResponse>
|
|
2255
2543
|
): void;
|
|
2256
2544
|
list(
|
package/products_v1beta.ts
CHANGED
|
@@ -794,6 +794,10 @@ export namespace merchantapi_products_v1beta {
|
|
|
794
794
|
* 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.
|
|
795
795
|
*/
|
|
796
796
|
export interface Schema$Product {
|
|
797
|
+
/**
|
|
798
|
+
* 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).
|
|
799
|
+
*/
|
|
800
|
+
archived?: boolean | null;
|
|
797
801
|
/**
|
|
798
802
|
* Output only. A list of product attributes.
|
|
799
803
|
*/
|
|
@@ -1334,8 +1338,7 @@ export namespace merchantapi_products_v1beta {
|
|
|
1334
1338
|
| BodyResponseCallback<Schema$Empty>
|
|
1335
1339
|
| BodyResponseCallback<Readable>,
|
|
1336
1340
|
callback?:
|
|
1337
|
-
|
|
1338
|
-
| BodyResponseCallback<Readable>
|
|
1341
|
+
BodyResponseCallback<Schema$Empty> | BodyResponseCallback<Readable>
|
|
1339
1342
|
):
|
|
1340
1343
|
| void
|
|
1341
1344
|
| Promise<GaxiosResponseWithHTTP2<Schema$Empty>>
|
|
@@ -1808,6 +1811,7 @@ export namespace merchantapi_products_v1beta {
|
|
|
1808
1811
|
*
|
|
1809
1812
|
* // Example response
|
|
1810
1813
|
* // {
|
|
1814
|
+
* // "archived": false,
|
|
1811
1815
|
* // "attributes": {},
|
|
1812
1816
|
* // "automatedDiscounts": {},
|
|
1813
1817
|
* // "base64EncodedName": "my_base64EncodedName",
|
|
@@ -1869,8 +1873,7 @@ export namespace merchantapi_products_v1beta {
|
|
|
1869
1873
|
| BodyResponseCallback<Schema$Product>
|
|
1870
1874
|
| BodyResponseCallback<Readable>,
|
|
1871
1875
|
callback?:
|
|
1872
|
-
|
|
1873
|
-
| BodyResponseCallback<Readable>
|
|
1876
|
+
BodyResponseCallback<Schema$Product> | BodyResponseCallback<Readable>
|
|
1874
1877
|
):
|
|
1875
1878
|
| void
|
|
1876
1879
|
| Promise<GaxiosResponseWithHTTP2<Schema$Product>>
|
|
@@ -1993,8 +1996,7 @@ export namespace merchantapi_products_v1beta {
|
|
|
1993
1996
|
list(
|
|
1994
1997
|
params: Params$Resource$Accounts$Products$List,
|
|
1995
1998
|
options:
|
|
1996
|
-
|
|
|
1997
|
-
| BodyResponseCallback<Schema$ListProductsResponse>,
|
|
1999
|
+
MethodOptions | BodyResponseCallback<Schema$ListProductsResponse>,
|
|
1998
2000
|
callback: BodyResponseCallback<Schema$ListProductsResponse>
|
|
1999
2001
|
): void;
|
|
2000
2002
|
list(
|
package/promotions_v1.ts
CHANGED
|
@@ -654,8 +654,7 @@ export namespace merchantapi_promotions_v1 {
|
|
|
654
654
|
| BodyResponseCallback<Schema$Promotion>
|
|
655
655
|
| BodyResponseCallback<Readable>,
|
|
656
656
|
callback?:
|
|
657
|
-
|
|
658
|
-
| BodyResponseCallback<Readable>
|
|
657
|
+
BodyResponseCallback<Schema$Promotion> | BodyResponseCallback<Readable>
|
|
659
658
|
):
|
|
660
659
|
| void
|
|
661
660
|
| Promise<GaxiosResponseWithHTTP2<Schema$Promotion>>
|
|
@@ -809,8 +808,7 @@ export namespace merchantapi_promotions_v1 {
|
|
|
809
808
|
| BodyResponseCallback<Schema$Promotion>
|
|
810
809
|
| BodyResponseCallback<Readable>,
|
|
811
810
|
callback?:
|
|
812
|
-
|
|
813
|
-
| BodyResponseCallback<Readable>
|
|
811
|
+
BodyResponseCallback<Schema$Promotion> | BodyResponseCallback<Readable>
|
|
814
812
|
):
|
|
815
813
|
| void
|
|
816
814
|
| Promise<GaxiosResponseWithHTTP2<Schema$Promotion>>
|
|
@@ -932,8 +930,7 @@ export namespace merchantapi_promotions_v1 {
|
|
|
932
930
|
list(
|
|
933
931
|
params: Params$Resource$Accounts$Promotions$List,
|
|
934
932
|
options:
|
|
935
|
-
|
|
|
936
|
-
| BodyResponseCallback<Schema$ListPromotionsResponse>,
|
|
933
|
+
MethodOptions | BodyResponseCallback<Schema$ListPromotionsResponse>,
|
|
937
934
|
callback: BodyResponseCallback<Schema$ListPromotionsResponse>
|
|
938
935
|
): void;
|
|
939
936
|
list(
|
package/promotions_v1beta.ts
CHANGED
|
@@ -654,8 +654,7 @@ export namespace merchantapi_promotions_v1beta {
|
|
|
654
654
|
| BodyResponseCallback<Schema$Promotion>
|
|
655
655
|
| BodyResponseCallback<Readable>,
|
|
656
656
|
callback?:
|
|
657
|
-
|
|
658
|
-
| BodyResponseCallback<Readable>
|
|
657
|
+
BodyResponseCallback<Schema$Promotion> | BodyResponseCallback<Readable>
|
|
659
658
|
):
|
|
660
659
|
| void
|
|
661
660
|
| Promise<GaxiosResponseWithHTTP2<Schema$Promotion>>
|
|
@@ -809,8 +808,7 @@ export namespace merchantapi_promotions_v1beta {
|
|
|
809
808
|
| BodyResponseCallback<Schema$Promotion>
|
|
810
809
|
| BodyResponseCallback<Readable>,
|
|
811
810
|
callback?:
|
|
812
|
-
|
|
813
|
-
| BodyResponseCallback<Readable>
|
|
811
|
+
BodyResponseCallback<Schema$Promotion> | BodyResponseCallback<Readable>
|
|
814
812
|
):
|
|
815
813
|
| void
|
|
816
814
|
| Promise<GaxiosResponseWithHTTP2<Schema$Promotion>>
|
|
@@ -932,8 +930,7 @@ export namespace merchantapi_promotions_v1beta {
|
|
|
932
930
|
list(
|
|
933
931
|
params: Params$Resource$Accounts$Promotions$List,
|
|
934
932
|
options:
|
|
935
|
-
|
|
|
936
|
-
| BodyResponseCallback<Schema$ListPromotionsResponse>,
|
|
933
|
+
MethodOptions | BodyResponseCallback<Schema$ListPromotionsResponse>,
|
|
937
934
|
callback: BodyResponseCallback<Schema$ListPromotionsResponse>
|
|
938
935
|
): void;
|
|
939
936
|
list(
|