1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.promotions.html">promotions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(merchantId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a promotion for your Merchant Center account. If the promotion already exists, then it updates the promotion instead. To [end or delete] (https://developers.google.com/shopping-content/guides/promotions#end_a_promotion) a promotion update the time period of the promotion to a time that has already passed.</p>
<p class="toc_element">
<code><a href="#get">get(merchantId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a promotion from your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#list">list(merchantId, countryCode=None, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List all promotions from your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(merchantId, body=None, x__xgafv=None)</code>
<pre>Inserts a promotion for your Merchant Center account. If the promotion already exists, then it updates the promotion instead. To [end or delete] (https://developers.google.com/shopping-content/guides/promotions#end_a_promotion) a promotion update the time period of the promotion to a time that has already passed.
Args:
merchantId: string, Required. The ID of the account that contains the collection. (required)
body: object, The request body.
The object takes the form of:
{ # Represents a promotion. See the following articles for more details. * [Promotions feed specification](https://support.google.com/merchants/answer/2906014) * [Local promotions feed specification](https://support.google.com/merchants/answer/10146130) * [Promotions on Buy on Google product data specification](https://support.google.com/merchants/answer/9173673)
"brand": [ # Product filter by brand for the promotion.
"A String",
],
"brandExclusion": [ # Product filter by brand exclusion for the promotion.
"A String",
],
"contentLanguage": "A String", # Required. The content language used as part of the unique identifier. `en` content language is available for all target countries. `fr` content language is available for `CA` and `FR` target countries. `de` content language is available for `DE` target country. `nl` content language is available for `NL` target country. `it` content language is available for `IT` target country. `pt` content language is available for `BR` target country. `ja` content language is available for `JP` target country. `ko` content language is available for `KR` target country.
"couponValueType": "A String", # Required. Coupon value type for the promotion.
"customRedemptionRestriction": "A String", # The custom redemption restriction for the promotion. If the `redemption_restriction` field is set to `CUSTOM`, this field must be set.
"freeGiftDescription": "A String", # Free gift description for the promotion.
"freeGiftItemId": "A String", # Free gift item ID for the promotion.
"freeGiftValue": { # The price represented as a number and currency. # Free gift value for the promotion.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"genericRedemptionCode": "A String", # Generic redemption code for the promotion. To be used with the `offerType` field.
"getThisQuantityDiscounted": 42, # The number of items discounted in the promotion.
"id": "A String", # Output only. The REST promotion ID to uniquely identify the promotion. Content API methods that operate on promotions take this as their `promotionId` parameter. The REST ID for a promotion is of the form channel:contentLanguage:targetCountry:promotionId The `channel` field has a value of `"online"`, `"in_store"`, or `"online_in_store"`.
"itemGroupId": [ # Product filter by item group ID for the promotion.
"A String",
],
"itemGroupIdExclusion": [ # Product filter by item group ID exclusion for the promotion.
"A String",
],
"itemId": [ # Product filter by item ID for the promotion.
"A String",
],
"itemIdExclusion": [ # Product filter by item ID exclusion for the promotion.
"A String",
],
"limitQuantity": 42, # Maximum purchase quantity for the promotion.
"limitValue": { # The price represented as a number and currency. # Maximum purchase value for the promotion.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"longTitle": "A String", # Required. Long title for the promotion.
"maxDiscountAmount": { # The price represented as a number and currency. # The maximum monetary discount a customer can receive for the promotion. This field is only supported with the `Percent off` coupon value type.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"minimumPurchaseAmount": { # The price represented as a number and currency. # Minimum purchase amount for the promotion.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"minimumPurchaseQuantity": 42, # Minimum purchase quantity for the promotion.
"moneyBudget": { # The price represented as a number and currency. # Cost cap for the promotion.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"moneyOffAmount": { # The price represented as a number and currency. # The money off amount offered in the promotion.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"offerType": "A String", # Required. Type of the promotion.
"orderLimit": 42, # Order limit for the promotion.
"percentOff": 42, # The percentage discount offered in the promotion.
"productApplicability": "A String", # Required. Applicability of the promotion to either all products or only specific products.
"productType": [ # Product filter by product type for the promotion.
"A String",
],
"productTypeExclusion": [ # Product filter by product type exclusion for the promotion.
"A String",
],
"promotionDestinationIds": [ # Destination ID for the promotion.
"A String",
],
"promotionDisplayDates": "A String", # String representation of the promotion display dates. Deprecated. Use `promotion_display_time_period` instead.
"promotionDisplayTimePeriod": { # A message that represents a time period. # `TimePeriod` representation of the promotion's display dates.
"endTime": "A String", # The ending timestamp.
"startTime": "A String", # The starting timestamp.
},
"promotionEffectiveDates": "A String", # String representation of the promotion effective dates. Deprecated. Use `promotion_effective_time_period` instead.
"promotionEffectiveTimePeriod": { # A message that represents a time period. # Required. `TimePeriod` representation of the promotion's effective dates.
"endTime": "A String", # The ending timestamp.
"startTime": "A String", # The starting timestamp.
},
"promotionId": "A String", # Required. The user provided promotion ID to uniquely identify the promotion.
"promotionStatus": { # The status of the promotion. # Output only. The current status of the promotion.
"creationDate": "A String", # Date on which the promotion has been created in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z"
"destinationStatuses": [ # The intended destinations for the promotion.
{ # The destination status of the promotion.
"destination": "A String", # The name of the destination.
"status": "A String", # The status for the specified destination.
},
],
"lastUpdateDate": "A String", # Date on which the promotion status has been last updated in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z"
"promotionIssue": [ # A list of issues associated with the promotion.
{ # The issue associated with the promotion.
"code": "A String", # Code of the issue.
"detail": "A String", # Explanation of the issue.
},
],
},
"promotionUrl": "A String", # URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no promo url is included. URL is used to confirm that the promotion is valid and can be redeemed.
"redemptionChannel": [ # Required. Redemption channel for the promotion. At least one channel is required.
"A String",
],
"redemptionRestriction": "A String", # The redemption restriction for the promotion.
"shippingServiceNames": [ # Shipping service names for the promotion.
"A String",
],
"storeApplicability": "A String", # Whether the promotion applies to all stores, or only specified stores. 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_code or score_code_exclusion is set to a value.
"storeCode": [ # Store codes to include for the promotion.
"A String",
],
"storeCodeExclusion": [ # Store codes to exclude for the promotion.
"A String",
],
"targetCountry": "A String", # Required. The target country used as part of the unique identifier. Can be `AU`, `CA`, `DE`, `FR`, `GB`, `IN`, `US`, `BR`, `ES`, `NL`, `JP`, `IT` or `KR`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a promotion. See the following articles for more details. * [Promotions feed specification](https://support.google.com/merchants/answer/2906014) * [Local promotions feed specification](https://support.google.com/merchants/answer/10146130) * [Promotions on Buy on Google product data specification](https://support.google.com/merchants/answer/9173673)
"brand": [ # Product filter by brand for the promotion.
"A String",
],
"brandExclusion": [ # Product filter by brand exclusion for the promotion.
"A String",
],
"contentLanguage": "A String", # Required. The content language used as part of the unique identifier. `en` content language is available for all target countries. `fr` content language is available for `CA` and `FR` target countries. `de` content language is available for `DE` target country. `nl` content language is available for `NL` target country. `it` content language is available for `IT` target country. `pt` content language is available for `BR` target country. `ja` content language is available for `JP` target country. `ko` content language is available for `KR` target country.
"couponValueType": "A String", # Required. Coupon value type for the promotion.
"customRedemptionRestriction": "A String", # The custom redemption restriction for the promotion. If the `redemption_restriction` field is set to `CUSTOM`, this field must be set.
"freeGiftDescription": "A String", # Free gift description for the promotion.
"freeGiftItemId": "A String", # Free gift item ID for the promotion.
"freeGiftValue": { # The price represented as a number and currency. # Free gift value for the promotion.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"genericRedemptionCode": "A String", # Generic redemption code for the promotion. To be used with the `offerType` field.
"getThisQuantityDiscounted": 42, # The number of items discounted in the promotion.
"id": "A String", # Output only. The REST promotion ID to uniquely identify the promotion. Content API methods that operate on promotions take this as their `promotionId` parameter. The REST ID for a promotion is of the form channel:contentLanguage:targetCountry:promotionId The `channel` field has a value of `"online"`, `"in_store"`, or `"online_in_store"`.
"itemGroupId": [ # Product filter by item group ID for the promotion.
"A String",
],
"itemGroupIdExclusion": [ # Product filter by item group ID exclusion for the promotion.
"A String",
],
"itemId": [ # Product filter by item ID for the promotion.
"A String",
],
"itemIdExclusion": [ # Product filter by item ID exclusion for the promotion.
"A String",
],
"limitQuantity": 42, # Maximum purchase quantity for the promotion.
"limitValue": { # The price represented as a number and currency. # Maximum purchase value for the promotion.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"longTitle": "A String", # Required. Long title for the promotion.
"maxDiscountAmount": { # The price represented as a number and currency. # The maximum monetary discount a customer can receive for the promotion. This field is only supported with the `Percent off` coupon value type.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"minimumPurchaseAmount": { # The price represented as a number and currency. # Minimum purchase amount for the promotion.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"minimumPurchaseQuantity": 42, # Minimum purchase quantity for the promotion.
"moneyBudget": { # The price represented as a number and currency. # Cost cap for the promotion.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"moneyOffAmount": { # The price represented as a number and currency. # The money off amount offered in the promotion.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"offerType": "A String", # Required. Type of the promotion.
"orderLimit": 42, # Order limit for the promotion.
"percentOff": 42, # The percentage discount offered in the promotion.
"productApplicability": "A String", # Required. Applicability of the promotion to either all products or only specific products.
"productType": [ # Product filter by product type for the promotion.
"A String",
],
"productTypeExclusion": [ # Product filter by product type exclusion for the promotion.
"A String",
],
"promotionDestinationIds": [ # Destination ID for the promotion.
"A String",
],
"promotionDisplayDates": "A String", # String representation of the promotion display dates. Deprecated. Use `promotion_display_time_period` instead.
"promotionDisplayTimePeriod": { # A message that represents a time period. # `TimePeriod` representation of the promotion's display dates.
"endTime": "A String", # The ending timestamp.
"startTime": "A String", # The starting timestamp.
},
"promotionEffectiveDates": "A String", # String representation of the promotion effective dates. Deprecated. Use `promotion_effective_time_period` instead.
"promotionEffectiveTimePeriod": { # A message that represents a time period. # Required. `TimePeriod` representation of the promotion's effective dates.
"endTime": "A String", # The ending timestamp.
"startTime": "A String", # The starting timestamp.
},
"promotionId": "A String", # Required. The user provided promotion ID to uniquely identify the promotion.
"promotionStatus": { # The status of the promotion. # Output only. The current status of the promotion.
"creationDate": "A String", # Date on which the promotion has been created in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z"
"destinationStatuses": [ # The intended destinations for the promotion.
{ # The destination status of the promotion.
"destination": "A String", # The name of the destination.
"status": "A String", # The status for the specified destination.
},
],
"lastUpdateDate": "A String", # Date on which the promotion status has been last updated in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z"
"promotionIssue": [ # A list of issues associated with the promotion.
{ # The issue associated with the promotion.
"code": "A String", # Code of the issue.
"detail": "A String", # Explanation of the issue.
},
],
},
"promotionUrl": "A String", # URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no promo url is included. URL is used to confirm that the promotion is valid and can be redeemed.
"redemptionChannel": [ # Required. Redemption channel for the promotion. At least one channel is required.
"A String",
],
"redemptionRestriction": "A String", # The redemption restriction for the promotion.
"shippingServiceNames": [ # Shipping service names for the promotion.
"A String",
],
"storeApplicability": "A String", # Whether the promotion applies to all stores, or only specified stores. 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_code or score_code_exclusion is set to a value.
"storeCode": [ # Store codes to include for the promotion.
"A String",
],
"storeCodeExclusion": [ # Store codes to exclude for the promotion.
"A String",
],
"targetCountry": "A String", # Required. The target country used as part of the unique identifier. Can be `AU`, `CA`, `DE`, `FR`, `GB`, `IN`, `US`, `BR`, `ES`, `NL`, `JP`, `IT` or `KR`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(merchantId, id, x__xgafv=None)</code>
<pre>Retrieves a promotion from your Merchant Center account.
Args:
merchantId: string, Required. The ID of the account that contains the collection. (required)
id: string, Required. REST ID of the promotion to retrieve. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a promotion. See the following articles for more details. * [Promotions feed specification](https://support.google.com/merchants/answer/2906014) * [Local promotions feed specification](https://support.google.com/merchants/answer/10146130) * [Promotions on Buy on Google product data specification](https://support.google.com/merchants/answer/9173673)
"brand": [ # Product filter by brand for the promotion.
"A String",
],
"brandExclusion": [ # Product filter by brand exclusion for the promotion.
"A String",
],
"contentLanguage": "A String", # Required. The content language used as part of the unique identifier. `en` content language is available for all target countries. `fr` content language is available for `CA` and `FR` target countries. `de` content language is available for `DE` target country. `nl` content language is available for `NL` target country. `it` content language is available for `IT` target country. `pt` content language is available for `BR` target country. `ja` content language is available for `JP` target country. `ko` content language is available for `KR` target country.
"couponValueType": "A String", # Required. Coupon value type for the promotion.
"customRedemptionRestriction": "A String", # The custom redemption restriction for the promotion. If the `redemption_restriction` field is set to `CUSTOM`, this field must be set.
"freeGiftDescription": "A String", # Free gift description for the promotion.
"freeGiftItemId": "A String", # Free gift item ID for the promotion.
"freeGiftValue": { # The price represented as a number and currency. # Free gift value for the promotion.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"genericRedemptionCode": "A String", # Generic redemption code for the promotion. To be used with the `offerType` field.
"getThisQuantityDiscounted": 42, # The number of items discounted in the promotion.
"id": "A String", # Output only. The REST promotion ID to uniquely identify the promotion. Content API methods that operate on promotions take this as their `promotionId` parameter. The REST ID for a promotion is of the form channel:contentLanguage:targetCountry:promotionId The `channel` field has a value of `"online"`, `"in_store"`, or `"online_in_store"`.
"itemGroupId": [ # Product filter by item group ID for the promotion.
"A String",
],
"itemGroupIdExclusion": [ # Product filter by item group ID exclusion for the promotion.
"A String",
],
"itemId": [ # Product filter by item ID for the promotion.
"A String",
],
"itemIdExclusion": [ # Product filter by item ID exclusion for the promotion.
"A String",
],
"limitQuantity": 42, # Maximum purchase quantity for the promotion.
"limitValue": { # The price represented as a number and currency. # Maximum purchase value for the promotion.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"longTitle": "A String", # Required. Long title for the promotion.
"maxDiscountAmount": { # The price represented as a number and currency. # The maximum monetary discount a customer can receive for the promotion. This field is only supported with the `Percent off` coupon value type.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"minimumPurchaseAmount": { # The price represented as a number and currency. # Minimum purchase amount for the promotion.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"minimumPurchaseQuantity": 42, # Minimum purchase quantity for the promotion.
"moneyBudget": { # The price represented as a number and currency. # Cost cap for the promotion.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"moneyOffAmount": { # The price represented as a number and currency. # The money off amount offered in the promotion.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"offerType": "A String", # Required. Type of the promotion.
"orderLimit": 42, # Order limit for the promotion.
"percentOff": 42, # The percentage discount offered in the promotion.
"productApplicability": "A String", # Required. Applicability of the promotion to either all products or only specific products.
"productType": [ # Product filter by product type for the promotion.
"A String",
],
"productTypeExclusion": [ # Product filter by product type exclusion for the promotion.
"A String",
],
"promotionDestinationIds": [ # Destination ID for the promotion.
"A String",
],
"promotionDisplayDates": "A String", # String representation of the promotion display dates. Deprecated. Use `promotion_display_time_period` instead.
"promotionDisplayTimePeriod": { # A message that represents a time period. # `TimePeriod` representation of the promotion's display dates.
"endTime": "A String", # The ending timestamp.
"startTime": "A String", # The starting timestamp.
},
"promotionEffectiveDates": "A String", # String representation of the promotion effective dates. Deprecated. Use `promotion_effective_time_period` instead.
"promotionEffectiveTimePeriod": { # A message that represents a time period. # Required. `TimePeriod` representation of the promotion's effective dates.
"endTime": "A String", # The ending timestamp.
"startTime": "A String", # The starting timestamp.
},
"promotionId": "A String", # Required. The user provided promotion ID to uniquely identify the promotion.
"promotionStatus": { # The status of the promotion. # Output only. The current status of the promotion.
"creationDate": "A String", # Date on which the promotion has been created in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z"
"destinationStatuses": [ # The intended destinations for the promotion.
{ # The destination status of the promotion.
"destination": "A String", # The name of the destination.
"status": "A String", # The status for the specified destination.
},
],
"lastUpdateDate": "A String", # Date on which the promotion status has been last updated in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z"
"promotionIssue": [ # A list of issues associated with the promotion.
{ # The issue associated with the promotion.
"code": "A String", # Code of the issue.
"detail": "A String", # Explanation of the issue.
},
],
},
"promotionUrl": "A String", # URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no promo url is included. URL is used to confirm that the promotion is valid and can be redeemed.
"redemptionChannel": [ # Required. Redemption channel for the promotion. At least one channel is required.
"A String",
],
"redemptionRestriction": "A String", # The redemption restriction for the promotion.
"shippingServiceNames": [ # Shipping service names for the promotion.
"A String",
],
"storeApplicability": "A String", # Whether the promotion applies to all stores, or only specified stores. 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_code or score_code_exclusion is set to a value.
"storeCode": [ # Store codes to include for the promotion.
"A String",
],
"storeCodeExclusion": [ # Store codes to exclude for the promotion.
"A String",
],
"targetCountry": "A String", # Required. The target country used as part of the unique identifier. Can be `AU`, `CA`, `DE`, `FR`, `GB`, `IN`, `US`, `BR`, `ES`, `NL`, `JP`, `IT` or `KR`.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(merchantId, countryCode=None, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List all promotions from your Merchant Center account.
Args:
merchantId: string, Required. The ID of the account that contains the collection. (required)
countryCode: string, [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (for example, "US"), used as a filter on promotions target country.
languageCode: string, The two-letter ISO 639-1 language code associated with the promotions, used as a filter.
pageSize: integer, The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, A page token, received from a previous `ListPromotion` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPromotion` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for Promotions.List method.
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"promotions": [ # List of all available promotions for the merchant.
{ # Represents a promotion. See the following articles for more details. * [Promotions feed specification](https://support.google.com/merchants/answer/2906014) * [Local promotions feed specification](https://support.google.com/merchants/answer/10146130) * [Promotions on Buy on Google product data specification](https://support.google.com/merchants/answer/9173673)
"brand": [ # Product filter by brand for the promotion.
"A String",
],
"brandExclusion": [ # Product filter by brand exclusion for the promotion.
"A String",
],
"contentLanguage": "A String", # Required. The content language used as part of the unique identifier. `en` content language is available for all target countries. `fr` content language is available for `CA` and `FR` target countries. `de` content language is available for `DE` target country. `nl` content language is available for `NL` target country. `it` content language is available for `IT` target country. `pt` content language is available for `BR` target country. `ja` content language is available for `JP` target country. `ko` content language is available for `KR` target country.
"couponValueType": "A String", # Required. Coupon value type for the promotion.
"customRedemptionRestriction": "A String", # The custom redemption restriction for the promotion. If the `redemption_restriction` field is set to `CUSTOM`, this field must be set.
"freeGiftDescription": "A String", # Free gift description for the promotion.
"freeGiftItemId": "A String", # Free gift item ID for the promotion.
"freeGiftValue": { # The price represented as a number and currency. # Free gift value for the promotion.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"genericRedemptionCode": "A String", # Generic redemption code for the promotion. To be used with the `offerType` field.
"getThisQuantityDiscounted": 42, # The number of items discounted in the promotion.
"id": "A String", # Output only. The REST promotion ID to uniquely identify the promotion. Content API methods that operate on promotions take this as their `promotionId` parameter. The REST ID for a promotion is of the form channel:contentLanguage:targetCountry:promotionId The `channel` field has a value of `"online"`, `"in_store"`, or `"online_in_store"`.
"itemGroupId": [ # Product filter by item group ID for the promotion.
"A String",
],
"itemGroupIdExclusion": [ # Product filter by item group ID exclusion for the promotion.
"A String",
],
"itemId": [ # Product filter by item ID for the promotion.
"A String",
],
"itemIdExclusion": [ # Product filter by item ID exclusion for the promotion.
"A String",
],
"limitQuantity": 42, # Maximum purchase quantity for the promotion.
"limitValue": { # The price represented as a number and currency. # Maximum purchase value for the promotion.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"longTitle": "A String", # Required. Long title for the promotion.
"maxDiscountAmount": { # The price represented as a number and currency. # The maximum monetary discount a customer can receive for the promotion. This field is only supported with the `Percent off` coupon value type.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"minimumPurchaseAmount": { # The price represented as a number and currency. # Minimum purchase amount for the promotion.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"minimumPurchaseQuantity": 42, # Minimum purchase quantity for the promotion.
"moneyBudget": { # The price represented as a number and currency. # Cost cap for the promotion.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"moneyOffAmount": { # The price represented as a number and currency. # The money off amount offered in the promotion.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"offerType": "A String", # Required. Type of the promotion.
"orderLimit": 42, # Order limit for the promotion.
"percentOff": 42, # The percentage discount offered in the promotion.
"productApplicability": "A String", # Required. Applicability of the promotion to either all products or only specific products.
"productType": [ # Product filter by product type for the promotion.
"A String",
],
"productTypeExclusion": [ # Product filter by product type exclusion for the promotion.
"A String",
],
"promotionDestinationIds": [ # Destination ID for the promotion.
"A String",
],
"promotionDisplayDates": "A String", # String representation of the promotion display dates. Deprecated. Use `promotion_display_time_period` instead.
"promotionDisplayTimePeriod": { # A message that represents a time period. # `TimePeriod` representation of the promotion's display dates.
"endTime": "A String", # The ending timestamp.
"startTime": "A String", # The starting timestamp.
},
"promotionEffectiveDates": "A String", # String representation of the promotion effective dates. Deprecated. Use `promotion_effective_time_period` instead.
"promotionEffectiveTimePeriod": { # A message that represents a time period. # Required. `TimePeriod` representation of the promotion's effective dates.
"endTime": "A String", # The ending timestamp.
"startTime": "A String", # The starting timestamp.
},
"promotionId": "A String", # Required. The user provided promotion ID to uniquely identify the promotion.
"promotionStatus": { # The status of the promotion. # Output only. The current status of the promotion.
"creationDate": "A String", # Date on which the promotion has been created in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z"
"destinationStatuses": [ # The intended destinations for the promotion.
{ # The destination status of the promotion.
"destination": "A String", # The name of the destination.
"status": "A String", # The status for the specified destination.
},
],
"lastUpdateDate": "A String", # Date on which the promotion status has been last updated in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z"
"promotionIssue": [ # A list of issues associated with the promotion.
{ # The issue associated with the promotion.
"code": "A String", # Code of the issue.
"detail": "A String", # Explanation of the issue.
},
],
},
"promotionUrl": "A String", # URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no promo url is included. URL is used to confirm that the promotion is valid and can be redeemed.
"redemptionChannel": [ # Required. Redemption channel for the promotion. At least one channel is required.
"A String",
],
"redemptionRestriction": "A String", # The redemption restriction for the promotion.
"shippingServiceNames": [ # Shipping service names for the promotion.
"A String",
],
"storeApplicability": "A String", # Whether the promotion applies to all stores, or only specified stores. 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_code or score_code_exclusion is set to a value.
"storeCode": [ # Store codes to include for the promotion.
"A String",
],
"storeCodeExclusion": [ # Store codes to exclude for the promotion.
"A String",
],
"targetCountry": "A String", # Required. The target country used as part of the unique identifier. Can be `AU`, `CA`, `DE`, `FR`, `GB`, `IN`, `US`, `BR`, `ES`, `NL`, `JP`, `IT` or `KR`.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
