@googleapis/merchantapi 17.3.0 → 17.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/accounts_v1.ts +180 -12
- package/accounts_v1beta.ts +179 -12
- package/build/accounts_v1.d.ts +102 -12
- package/build/accounts_v1.js +32 -0
- package/build/accounts_v1.js.map +1 -1
- package/build/accounts_v1beta.d.ts +102 -12
- package/build/accounts_v1beta.js +32 -0
- package/build/accounts_v1beta.js.map +1 -1
- package/build/datasources_v1.d.ts +4 -4
- package/build/datasources_v1beta.d.ts +4 -4
- package/build/inventories_v1.d.ts +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 +230 -11
- package/build/products_v1.js.map +1 -1
- package/build/products_v1beta.d.ts +40 -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 +230 -11
- package/products_v1beta.ts +40 -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/promotions_v1beta.ts
CHANGED
|
@@ -129,31 +129,43 @@ export namespace merchantapi_promotions_v1beta {
|
|
|
129
129
|
*/
|
|
130
130
|
export interface Schema$Attributes {
|
|
131
131
|
/**
|
|
132
|
-
* Optional.
|
|
132
|
+
* Optional. This field defines the audience a promotion will be visible to.
|
|
133
|
+
*/
|
|
134
|
+
audience?: string | null;
|
|
135
|
+
/**
|
|
136
|
+
* 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).
|
|
133
137
|
*/
|
|
134
138
|
brandExclusion?: string[] | null;
|
|
135
139
|
/**
|
|
136
|
-
* 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
|
|
140
|
+
* 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).
|
|
137
141
|
*/
|
|
138
142
|
brandInclusion?: string[] | null;
|
|
139
143
|
/**
|
|
140
|
-
* Required. The [coupon value type] (https://support.google.com/merchants/answer/13861986?ref_topic=13773355
|
|
144
|
+
* 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).
|
|
141
145
|
*/
|
|
142
146
|
couponValueType?: string | null;
|
|
143
147
|
/**
|
|
144
|
-
* Optional.
|
|
148
|
+
* Optional. The custom redemption restriction for the promotion. If the `redemption_restriction` field is set to `CUSTOM`, this field must be set.
|
|
149
|
+
*/
|
|
150
|
+
customRedemptionRestriction?: string | null;
|
|
151
|
+
/**
|
|
152
|
+
* 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.
|
|
153
|
+
*/
|
|
154
|
+
eventApplicability?: string | null;
|
|
155
|
+
/**
|
|
156
|
+
* Optional. [Free gift description](https://support.google.com/merchants/answer/13847245?ref_topic=13773355) for the promotion.
|
|
145
157
|
*/
|
|
146
158
|
freeGiftDescription?: string | null;
|
|
147
159
|
/**
|
|
148
|
-
* Optional. [Free gift item ID](https://support.google.com/merchants/answer/13857152?ref_topic=13773355
|
|
160
|
+
* Optional. [Free gift item ID](https://support.google.com/merchants/answer/13857152?ref_topic=13773355) for the promotion.
|
|
149
161
|
*/
|
|
150
162
|
freeGiftItemId?: string | null;
|
|
151
163
|
/**
|
|
152
|
-
* Optional. [Free gift value](https://support.google.com/merchants/answer/13844477?ref_topic=13773355
|
|
164
|
+
* Optional. [Free gift value](https://support.google.com/merchants/answer/13844477?ref_topic=13773355) for the promotion.
|
|
153
165
|
*/
|
|
154
166
|
freeGiftValue?: Schema$Price;
|
|
155
167
|
/**
|
|
156
|
-
* 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
|
|
168
|
+
* 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).
|
|
157
169
|
*/
|
|
158
170
|
genericRedemptionCode?: string | null;
|
|
159
171
|
/**
|
|
@@ -161,23 +173,27 @@ export namespace merchantapi_promotions_v1beta {
|
|
|
161
173
|
*/
|
|
162
174
|
getThisQuantityDiscounted?: string | null;
|
|
163
175
|
/**
|
|
164
|
-
* Optional.
|
|
176
|
+
* 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).
|
|
177
|
+
*/
|
|
178
|
+
googleProductCategories?: string[] | null;
|
|
179
|
+
/**
|
|
180
|
+
* 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.
|
|
165
181
|
*/
|
|
166
182
|
itemGroupIdExclusion?: string[] | null;
|
|
167
183
|
/**
|
|
168
|
-
* 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
|
|
184
|
+
* 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).
|
|
169
185
|
*/
|
|
170
186
|
itemGroupIdInclusion?: string[] | null;
|
|
171
187
|
/**
|
|
172
|
-
* Optional. Product filter by [item ID exclusion](https://support.google.com/merchants/answer/13863524?ref_topic=13773355
|
|
188
|
+
* 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).
|
|
173
189
|
*/
|
|
174
190
|
itemIdExclusion?: string[] | null;
|
|
175
191
|
/**
|
|
176
|
-
* Optional. Product filter by [item ID](https://support.google.com/merchants/answer/13861565?ref_topic=13773355
|
|
192
|
+
* 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).
|
|
177
193
|
*/
|
|
178
194
|
itemIdInclusion?: string[] | null;
|
|
179
195
|
/**
|
|
180
|
-
* Optional. [Maximum purchase quantity](https://support.google.com/merchants/answer/13861564?ref_topic=13773355
|
|
196
|
+
* Optional. [Maximum purchase quantity](https://support.google.com/merchants/answer/13861564?ref_topic=13773355) for the promotion.
|
|
181
197
|
*/
|
|
182
198
|
limitQuantity?: string | null;
|
|
183
199
|
/**
|
|
@@ -185,20 +201,40 @@ export namespace merchantapi_promotions_v1beta {
|
|
|
185
201
|
*/
|
|
186
202
|
limitValue?: Schema$Price;
|
|
187
203
|
/**
|
|
188
|
-
* Required. [Long title](https://support.google.com/merchants/answer/13838102?ref_topic=13773355
|
|
204
|
+
* Required. [Long title](https://support.google.com/merchants/answer/13838102?ref_topic=13773355) for the promotion.
|
|
189
205
|
*/
|
|
190
206
|
longTitle?: string | null;
|
|
191
207
|
/**
|
|
192
|
-
* Optional.
|
|
208
|
+
* Optional. The maximum monetary discount a customer can receive for the promotion. This field is only supported with the `Percent off` coupon value type.
|
|
209
|
+
*/
|
|
210
|
+
maxDiscountAmount?: Schema$Price;
|
|
211
|
+
/**
|
|
212
|
+
* 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.
|
|
213
|
+
*/
|
|
214
|
+
maxMoneyOffAmount?: Schema$Price;
|
|
215
|
+
/**
|
|
216
|
+
* 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.
|
|
217
|
+
*/
|
|
218
|
+
maxPercentOff?: string | null;
|
|
219
|
+
/**
|
|
220
|
+
* Optional. [Minimum purchase amount](https://support.google.com/merchants/answer/13837705?ref_topic=13773355) for the promotion.
|
|
193
221
|
*/
|
|
194
222
|
minimumPurchaseAmount?: Schema$Price;
|
|
195
223
|
minimumPurchaseQuantity?: string | null;
|
|
196
224
|
/**
|
|
197
|
-
* Optional.
|
|
225
|
+
* 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.
|
|
226
|
+
*/
|
|
227
|
+
minMoneyOffAmount?: Schema$Price;
|
|
228
|
+
/**
|
|
229
|
+
* 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.
|
|
230
|
+
*/
|
|
231
|
+
minPercentOff?: string | null;
|
|
232
|
+
/**
|
|
233
|
+
* Optional. The [money off amount](https://support.google.com/merchants/answer/13838101?ref_topic=13773355) offered in the promotion.
|
|
198
234
|
*/
|
|
199
235
|
moneyOffAmount?: Schema$Price;
|
|
200
236
|
/**
|
|
201
|
-
* Required. [Type](https://support.google.com/merchants/answer/13837405?ref_topic=13773355
|
|
237
|
+
* 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.
|
|
202
238
|
*/
|
|
203
239
|
offerType?: string | null;
|
|
204
240
|
/**
|
|
@@ -206,19 +242,19 @@ export namespace merchantapi_promotions_v1beta {
|
|
|
206
242
|
*/
|
|
207
243
|
percentOff?: string | null;
|
|
208
244
|
/**
|
|
209
|
-
*
|
|
245
|
+
* 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.
|
|
210
246
|
*/
|
|
211
247
|
productApplicability?: string | null;
|
|
212
248
|
/**
|
|
213
|
-
* Optional. Product filter by [product type exclusion](https://support.google.com/merchants/answer/13863746?ref_topic=13773355
|
|
249
|
+
* 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).
|
|
214
250
|
*/
|
|
215
251
|
productTypeExclusion?: string[] | null;
|
|
216
252
|
/**
|
|
217
|
-
* 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
|
|
253
|
+
* 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).
|
|
218
254
|
*/
|
|
219
255
|
productTypeInclusion?: string[] | null;
|
|
220
256
|
/**
|
|
221
|
-
* 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
|
|
257
|
+
* 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)
|
|
222
258
|
*/
|
|
223
259
|
promotionDestinations?: string[] | null;
|
|
224
260
|
/**
|
|
@@ -233,16 +269,24 @@ export namespace merchantapi_promotions_v1beta {
|
|
|
233
269
|
* 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.
|
|
234
270
|
*/
|
|
235
271
|
promotionUrl?: string | null;
|
|
272
|
+
/**
|
|
273
|
+
* Optional. A restriction customers must meet before they can redeem the promotion.
|
|
274
|
+
*/
|
|
275
|
+
redemptionRestriction?: string | null;
|
|
276
|
+
/**
|
|
277
|
+
* 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`.
|
|
278
|
+
*/
|
|
279
|
+
regionIdInclusion?: string[] | null;
|
|
236
280
|
/**
|
|
237
281
|
* 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.
|
|
238
282
|
*/
|
|
239
283
|
storeApplicability?: string | null;
|
|
240
284
|
/**
|
|
241
|
-
* Optional. [Store codes to exclude](https://support.google.com/merchants/answer/13859586?ref_topic=13773355
|
|
285
|
+
* 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).
|
|
242
286
|
*/
|
|
243
287
|
storeCodesExclusion?: string[] | null;
|
|
244
288
|
/**
|
|
245
|
-
* Optional. [Store codes to include](https://support.google.com/merchants/answer/13857470?ref_topic=13773355
|
|
289
|
+
* 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.
|
|
246
290
|
*/
|
|
247
291
|
storeCodesInclusion?: string[] | null;
|
|
248
292
|
}
|
package/reports_v1.ts
CHANGED
|
@@ -429,11 +429,11 @@ export namespace merchantapi_reports_v1 {
|
|
|
429
429
|
*/
|
|
430
430
|
export interface Schema$ItemIssueSeverity {
|
|
431
431
|
/**
|
|
432
|
-
* Aggregated severity of the issue for all reporting contexts it affects. **This field can be used for filtering the results.**
|
|
432
|
+
* Aggregated severity of the issue for all reporting contexts it affects. Reporting contexts included in the computation of the aggregated severity can be restricted using a filter on the `reporting_context` field. **This field can be used for filtering the results.**
|
|
433
433
|
*/
|
|
434
434
|
aggregatedSeverity?: string | null;
|
|
435
435
|
/**
|
|
436
|
-
* Issue severity per reporting context.
|
|
436
|
+
* Issue severity per reporting context. Reporting contexts included in this list can be restricted using a filter on the `reporting_context` field.
|
|
437
437
|
*/
|
|
438
438
|
severityPerReportingContext?: Schema$IssueSeverityPerReportingContext[];
|
|
439
439
|
}
|
|
@@ -775,6 +775,10 @@ export namespace merchantapi_reports_v1 {
|
|
|
775
775
|
* [Product type (5th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment.
|
|
776
776
|
*/
|
|
777
777
|
productTypeL5?: string | null;
|
|
778
|
+
/**
|
|
779
|
+
* Store type to which metrics apply. Can be `ONLINE_STORE` or `LOCAL_STORES`. Segment. For `LOCAL_STORES` store type, further segmentation by a specific store is not available.
|
|
780
|
+
*/
|
|
781
|
+
storeType?: string | null;
|
|
778
782
|
/**
|
|
779
783
|
* Title of the product. Segment.
|
|
780
784
|
*/
|
|
@@ -826,11 +830,11 @@ export namespace merchantapi_reports_v1 {
|
|
|
826
830
|
resourceType?: string | null;
|
|
827
831
|
}
|
|
828
832
|
/**
|
|
829
|
-
* Fields available for query in `product_view` table. Products in the current inventory. Products in this table are the same as in Products sub-API but not all product attributes from Products sub-API are available for query in this table. In contrast to Products sub-API, this table allows to filter the returned list of products by product attributes. To retrieve a single product by `id` or list all products, Products sub-API should be used. Values are only set for fields requested explicitly in the request's search query.
|
|
833
|
+
* Fields available for query in `product_view` table. Products in the current inventory. Products in this table are the same as a [Product resource in Products sub-API](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products) but not all product attributes from Products sub-API are available for query in this table. In contrast to Products sub-API, this table allows to filter the returned list of products by product attributes. To retrieve a single product by `id` or list all products, Products sub-API should be used. Values are only set for fields requested explicitly in the request's search query.
|
|
830
834
|
*/
|
|
831
835
|
export interface Schema$ProductView {
|
|
832
836
|
/**
|
|
833
|
-
* Aggregated status.
|
|
837
|
+
* Aggregated status across all reporting contexts. Reporting contexts included in the computation of the aggregated status can be restricted using a filter on the `reporting_context` field.
|
|
834
838
|
*/
|
|
835
839
|
aggregatedReportingContextStatus?: string | null;
|
|
836
840
|
/**
|
|
@@ -937,10 +941,18 @@ export namespace merchantapi_reports_v1 {
|
|
|
937
941
|
* Product type (5th level) in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324406).
|
|
938
942
|
*/
|
|
939
943
|
productTypeL5?: string | null;
|
|
944
|
+
/**
|
|
945
|
+
* Reporting context to restrict the query to. Restricts the reporting contexts returned in `status_per_reporting_context` and `item_issues`, and used to compute `aggregated_reporting_context_status`. **This field can only be used in the `WHERE` clause and cannot be selected in the `SELECT` clause.**
|
|
946
|
+
*/
|
|
947
|
+
reportingContext?: string | null;
|
|
940
948
|
/**
|
|
941
949
|
* Normalized [shipping label](https://support.google.com/merchants/answer/6324504) specified in the data source.
|
|
942
950
|
*/
|
|
943
951
|
shippingLabel?: string | null;
|
|
952
|
+
/**
|
|
953
|
+
* Detailed product status per reporting context. Reporting contexts included in this list can be restricted using a filter on the `reporting_context` field. Equivalent to `ProductStatus.destination_statuses` in Products API. **This field cannot be used for sorting or filtering the results.**
|
|
954
|
+
*/
|
|
955
|
+
statusPerReportingContext?: Schema$StatusPerReportingContext[];
|
|
944
956
|
/**
|
|
945
957
|
* Link to the processed image of the product, hosted on the Google infrastructure.
|
|
946
958
|
*/
|
|
@@ -1000,7 +1012,7 @@ export namespace merchantapi_reports_v1 {
|
|
|
1000
1012
|
*/
|
|
1001
1013
|
export interface Schema$SearchRequest {
|
|
1002
1014
|
/**
|
|
1003
|
-
* Optional. Number of `ReportRows` to retrieve in a single page. Defaults to 1000. Values above
|
|
1015
|
+
* Optional. Number of `ReportRows` to retrieve in a single page. Defaults to 1000. Values above 100,000 are coerced to 100,000.
|
|
1004
1016
|
*/
|
|
1005
1017
|
pageSize?: number | null;
|
|
1006
1018
|
/**
|
|
@@ -1008,7 +1020,7 @@ export namespace merchantapi_reports_v1 {
|
|
|
1008
1020
|
*/
|
|
1009
1021
|
pageToken?: string | null;
|
|
1010
1022
|
/**
|
|
1011
|
-
* Required. Query that defines a report to be retrieved. For details on how to construct your query, see the [Query Language guide](/merchant/api/guides/reports/query-language). For the full list of available tables and fields, see the
|
|
1023
|
+
* Required. Query that defines a report to be retrieved. For details on how to construct your query, see the [Query Language guide](/merchant/api/guides/reports/query-language). For the full list of available tables and fields, see the Available fields.
|
|
1012
1024
|
*/
|
|
1013
1025
|
query?: string | null;
|
|
1014
1026
|
}
|
|
@@ -1025,6 +1037,27 @@ export namespace merchantapi_reports_v1 {
|
|
|
1025
1037
|
*/
|
|
1026
1038
|
results?: Schema$ReportRow[];
|
|
1027
1039
|
}
|
|
1040
|
+
/**
|
|
1041
|
+
* Status of the product for a specific reporting context. Equivalent to `DestinationStatus` in Products API.
|
|
1042
|
+
*/
|
|
1043
|
+
export interface Schema$StatusPerReportingContext {
|
|
1044
|
+
/**
|
|
1045
|
+
* List of approved countries in the reporting context, represented in [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format, for example, `US`.
|
|
1046
|
+
*/
|
|
1047
|
+
approvedCountries?: string[] | null;
|
|
1048
|
+
/**
|
|
1049
|
+
* List of disapproved countries in the reporting context, represented in [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format, for example, `US`.
|
|
1050
|
+
*/
|
|
1051
|
+
disapprovedCountries?: string[] | null;
|
|
1052
|
+
/**
|
|
1053
|
+
* List of pending countries in the reporting context, represented in [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format, for example, `US`.
|
|
1054
|
+
*/
|
|
1055
|
+
pendingCountries?: string[] | null;
|
|
1056
|
+
/**
|
|
1057
|
+
* Reporting context the status applies to.
|
|
1058
|
+
*/
|
|
1059
|
+
reportingContext?: string | null;
|
|
1060
|
+
}
|
|
1028
1061
|
|
|
1029
1062
|
export class Resource$Accounts {
|
|
1030
1063
|
context: APIRequestContext;
|
package/reports_v1beta.ts
CHANGED
|
@@ -429,11 +429,11 @@ export namespace merchantapi_reports_v1beta {
|
|
|
429
429
|
*/
|
|
430
430
|
export interface Schema$ItemIssueSeverity {
|
|
431
431
|
/**
|
|
432
|
-
* Aggregated severity of the issue for all reporting contexts it affects. **This field can be used for filtering the results.**
|
|
432
|
+
* Aggregated severity of the issue for all reporting contexts it affects. Reporting contexts included in the computation of the aggregated severity can be restricted using a filter on the `reporting_context` field. **This field can be used for filtering the results.**
|
|
433
433
|
*/
|
|
434
434
|
aggregatedSeverity?: string | null;
|
|
435
435
|
/**
|
|
436
|
-
* Issue severity per reporting context.
|
|
436
|
+
* Issue severity per reporting context. Reporting contexts included in this list can be restricted using a filter on the `reporting_context` field.
|
|
437
437
|
*/
|
|
438
438
|
severityPerReportingContext?: Schema$IssueSeverityPerReportingContext[];
|
|
439
439
|
}
|
|
@@ -775,6 +775,10 @@ export namespace merchantapi_reports_v1beta {
|
|
|
775
775
|
* [Product type (5th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment.
|
|
776
776
|
*/
|
|
777
777
|
productTypeL5?: string | null;
|
|
778
|
+
/**
|
|
779
|
+
* Store type to which metrics apply. Can be `ONLINE_STORE` or `LOCAL_STORES`. Segment. For `LOCAL_STORES` store type, further segmentation by a specific store is not available.
|
|
780
|
+
*/
|
|
781
|
+
storeType?: string | null;
|
|
778
782
|
/**
|
|
779
783
|
* Title of the product. Segment.
|
|
780
784
|
*/
|
|
@@ -826,11 +830,11 @@ export namespace merchantapi_reports_v1beta {
|
|
|
826
830
|
resourceType?: string | null;
|
|
827
831
|
}
|
|
828
832
|
/**
|
|
829
|
-
* Fields available for query in `product_view` table. Products in the current inventory. Products in this table are the same as in Products sub-API but not all product attributes from Products sub-API are available for query in this table. In contrast to Products sub-API, this table allows to filter the returned list of products by product attributes. To retrieve a single product by `id` or list all products, Products sub-API should be used. Values are only set for fields requested explicitly in the request's search query.
|
|
833
|
+
* Fields available for query in `product_view` table. Products in the current inventory. Products in this table are the same as a [Product resource in Products sub-API](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products) but not all product attributes from Products sub-API are available for query in this table. In contrast to Products sub-API, this table allows to filter the returned list of products by product attributes. To retrieve a single product by `id` or list all products, Products sub-API should be used. Values are only set for fields requested explicitly in the request's search query.
|
|
830
834
|
*/
|
|
831
835
|
export interface Schema$ProductView {
|
|
832
836
|
/**
|
|
833
|
-
* Aggregated status.
|
|
837
|
+
* Aggregated status across all reporting contexts. Reporting contexts included in the computation of the aggregated status can be restricted using a filter on the `reporting_context` field.
|
|
834
838
|
*/
|
|
835
839
|
aggregatedReportingContextStatus?: string | null;
|
|
836
840
|
/**
|
|
@@ -937,10 +941,18 @@ export namespace merchantapi_reports_v1beta {
|
|
|
937
941
|
* Product type (5th level) in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324406).
|
|
938
942
|
*/
|
|
939
943
|
productTypeL5?: string | null;
|
|
944
|
+
/**
|
|
945
|
+
* Reporting context to restrict the query to. Restricts the reporting contexts returned in `status_per_reporting_context` and `item_issues`, and used to compute `aggregated_reporting_context_status`. **This field can only be used in the `WHERE` clause and cannot be selected in the `SELECT` clause.**
|
|
946
|
+
*/
|
|
947
|
+
reportingContext?: string | null;
|
|
940
948
|
/**
|
|
941
949
|
* Normalized [shipping label](https://support.google.com/merchants/answer/6324504) specified in the data source.
|
|
942
950
|
*/
|
|
943
951
|
shippingLabel?: string | null;
|
|
952
|
+
/**
|
|
953
|
+
* Detailed product status per reporting context. Reporting contexts included in this list can be restricted using a filter on the `reporting_context` field. Equivalent to `ProductStatus.destination_statuses` in Products API. **This field cannot be used for sorting or filtering the results.**
|
|
954
|
+
*/
|
|
955
|
+
statusPerReportingContext?: Schema$StatusPerReportingContext[];
|
|
944
956
|
/**
|
|
945
957
|
* Link to the processed image of the product, hosted on the Google infrastructure.
|
|
946
958
|
*/
|
|
@@ -1000,7 +1012,7 @@ export namespace merchantapi_reports_v1beta {
|
|
|
1000
1012
|
*/
|
|
1001
1013
|
export interface Schema$SearchRequest {
|
|
1002
1014
|
/**
|
|
1003
|
-
* Optional. Number of `ReportRows` to retrieve in a single page. Defaults to 1000. Values above
|
|
1015
|
+
* Optional. Number of `ReportRows` to retrieve in a single page. Defaults to 1000. Values above 100,000 are coerced to 100,000.
|
|
1004
1016
|
*/
|
|
1005
1017
|
pageSize?: number | null;
|
|
1006
1018
|
/**
|
|
@@ -1008,7 +1020,7 @@ export namespace merchantapi_reports_v1beta {
|
|
|
1008
1020
|
*/
|
|
1009
1021
|
pageToken?: string | null;
|
|
1010
1022
|
/**
|
|
1011
|
-
* Required. Query that defines a report to be retrieved. For details on how to construct your query, see the [Query Language guide](/merchant/api/guides/reports/query-language). For the full list of available tables and fields, see the
|
|
1023
|
+
* Required. Query that defines a report to be retrieved. For details on how to construct your query, see the [Query Language guide](/merchant/api/guides/reports/query-language). For the full list of available tables and fields, see the Available fields.
|
|
1012
1024
|
*/
|
|
1013
1025
|
query?: string | null;
|
|
1014
1026
|
}
|
|
@@ -1025,6 +1037,27 @@ export namespace merchantapi_reports_v1beta {
|
|
|
1025
1037
|
*/
|
|
1026
1038
|
results?: Schema$ReportRow[];
|
|
1027
1039
|
}
|
|
1040
|
+
/**
|
|
1041
|
+
* Status of the product for a specific reporting context. Equivalent to `DestinationStatus` in Products API.
|
|
1042
|
+
*/
|
|
1043
|
+
export interface Schema$StatusPerReportingContext {
|
|
1044
|
+
/**
|
|
1045
|
+
* List of approved countries in the reporting context, represented in [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format, for example, `US`.
|
|
1046
|
+
*/
|
|
1047
|
+
approvedCountries?: string[] | null;
|
|
1048
|
+
/**
|
|
1049
|
+
* List of disapproved countries in the reporting context, represented in [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format, for example, `US`.
|
|
1050
|
+
*/
|
|
1051
|
+
disapprovedCountries?: string[] | null;
|
|
1052
|
+
/**
|
|
1053
|
+
* List of pending countries in the reporting context, represented in [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format, for example, `US`.
|
|
1054
|
+
*/
|
|
1055
|
+
pendingCountries?: string[] | null;
|
|
1056
|
+
/**
|
|
1057
|
+
* Reporting context the status applies to.
|
|
1058
|
+
*/
|
|
1059
|
+
reportingContext?: string | null;
|
|
1060
|
+
}
|
|
1028
1061
|
|
|
1029
1062
|
export class Resource$Accounts {
|
|
1030
1063
|
context: APIRequestContext;
|