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
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
|
<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="androidpublisher_v3.html">Google Play Android Developer API</a> . <a href="androidpublisher_v3.monetization.html">monetization</a> . <a href="androidpublisher_v3.monetization.onetimeproducts.html">onetimeproducts</a> . <a href="androidpublisher_v3.monetization.onetimeproducts.purchaseOptions.html">purchaseOptions</a> . <a href="androidpublisher_v3.monetization.onetimeproducts.purchaseOptions.offers.html">offers</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#activate">activate(packageName, productId, purchaseOptionId, offerId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Activates a one-time product offer.</p>
<p class="toc_element">
<code><a href="#batchDelete">batchDelete(packageName, productId, purchaseOptionId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes one or more one-time product offers.</p>
<p class="toc_element">
<code><a href="#batchGet">batchGet(packageName, productId, purchaseOptionId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Reads one or more one-time product offers.</p>
<p class="toc_element">
<code><a href="#batchUpdate">batchUpdate(packageName, productId, purchaseOptionId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates or updates one or more one-time product offers.</p>
<p class="toc_element">
<code><a href="#batchUpdateStates">batchUpdateStates(packageName, productId, purchaseOptionId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a batch of one-time product offer states.</p>
<p class="toc_element">
<code><a href="#cancel">cancel(packageName, productId, purchaseOptionId, offerId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Cancels a one-time product offer.</p>
<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="#deactivate">deactivate(packageName, productId, purchaseOptionId, offerId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deactivates a one-time product offer.</p>
<p class="toc_element">
<code><a href="#list">list(packageName, productId, purchaseOptionId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all offers under a given app, product, or purchase option.</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="activate">activate(packageName, productId, purchaseOptionId, offerId, body=None, x__xgafv=None)</code>
<pre>Activates a one-time product offer.
Args:
packageName: string, Required. The parent app (package name) of the offer to activate. (required)
productId: string, Required. The parent one-time product (ID) of the offer to activate. (required)
purchaseOptionId: string, Required. The parent purchase option (ID) of the offer to activate. (required)
offerId: string, Required. The offer ID of the offer to activate. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for ActivateOneTimeProductOffer.
"latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this update. Defaults to latency-sensitive.
"offerId": "A String", # Required. The offer ID of the offer to activate.
"packageName": "A String", # Required. The parent app (package name) of the offer to activate.
"productId": "A String", # Required. The parent one-time product (ID) of the offer to activate.
"purchaseOptionId": "A String", # Required. The parent purchase option (ID) of the offer to activate.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A single offer for a one-time product.
"discountedOffer": { # Configuration specific to discounted offers. # A discounted offer.
"endTime": "A String", # Time when the offer will stop being available.
"redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive.
"startTime": "A String", # Time when the offer will start being available.
},
"offerId": "A String", # Required. Immutable. The ID of this product offer. Must be unique within the purchase option. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.
"offerTags": [ # Optional. List of up to 20 custom tags specified for this offer, and returned to the app through the billing library.
{ # Represents a custom tag specified for a product offer.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
},
],
"packageName": "A String", # Required. Immutable. The package name of the app the parent product belongs to.
"preOrderOffer": { # Configuration specific to pre-order offers. # A pre-order offer.
"endTime": "A String", # Required. Time when the pre-order will stop being available.
"priceChangeBehavior": "A String", # Required. Immutable. Specifies how price changes affect pre-existing pre-orders.
"releaseTime": "A String", # Required. Time on which the product associated with the pre-order will be released and the pre-order orders fulfilled.
"startTime": "A String", # Required. Time when the pre-order will start being available.
},
"productId": "A String", # Required. Immutable. The ID of the parent product this offer belongs to.
"purchaseOptionId": "A String", # Required. Immutable. The ID of the purchase option to which this offer is an extension.
"regionalPricingAndAvailabilityConfigs": [ # Set of regional pricing and availability information for this offer. Must not have duplicate entries with the same region_code.
{ # Regional pricing and availability configuration for a one-time product offer.
"absoluteDiscount": { # Represents an amount of money with its currency type. # The absolute value of the discount that is subtracted from the purchase option price. It should be between 0 and the purchase option price.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"availability": "A String", # Required. The availability for this region.
"noOverride": { # Options for one-time product offers without a regional price override. # The price defined in the purchase option for this region will be used.
},
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
"relativeDiscount": 3.14, # The fraction of the purchase option price that the user pays for this offer. For example, if the purchase option price for this region is $12, then a 50% discount would correspond to a price of $6. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region.
},
],
"regionsVersion": { # The version of the available regions being used for the specified resource. # Output only. The version of the regions configuration that was used to generate the one-time product offer.
"version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
},
"state": "A String", # Output only. The current state of this offer. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
}</pre>
</div>
<div class="method">
<code class="details" id="batchDelete">batchDelete(packageName, productId, purchaseOptionId, body=None, x__xgafv=None)</code>
<pre>Deletes one or more one-time product offers.
Args:
packageName: string, Required. The parent app (package name) of the offers to delete. Must be equal to the package_name field on all the OneTimeProductOffer resources. (required)
productId: string, Required. The product ID of the parent one-time product, if all offers to delete belong to the same product. If this request spans multiple one-time products, set this field to "-". (required)
purchaseOptionId: string, Required. The parent purchase option (ID) for which the offers should be deleted. May be specified as '-' to update offers from multiple purchase options. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for BatchDeleteOneTimeProductOffers.
"requests": [ # Required. A list of update requests of up to 100 elements. All requests must correspond to different offers.
{ # Request message for deleting an one-time product offer.
"latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
"offerId": "A String", # Required. The unique offer ID of the offer to delete.
"packageName": "A String", # Required. The parent app (package name) of the offer to delete.
"productId": "A String", # Required. The parent one-time product (ID) of the offer to delete.
"purchaseOptionId": "A String", # Required. The parent purchase option (ID) of the offer to delete.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="batchGet">batchGet(packageName, productId, purchaseOptionId, body=None, x__xgafv=None)</code>
<pre>Reads one or more one-time product offers.
Args:
packageName: string, Required. The parent app (package name) of the updated offers. Must be equal to the package_name field on all the updated OneTimeProductOffer resources. (required)
productId: string, Required. The product ID of the parent one-time product, if all updated offers belong to the same product. If this request spans multiple one-time products, set this field to "-". (required)
purchaseOptionId: string, Required. The parent purchase option (ID) for which the offers should be updated. May be specified as '-' to update offers from multiple purchase options. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for the BatchGetOneTimeProductOffers endpoint.
"requests": [ # Required. A list of get requests of up to 100 elements. All requests must retrieve different offers.
{ # Request message for GetOneTimeProductOffers.
"offerId": "A String", # Required. The unique offer ID of the offer to get.
"packageName": "A String", # Required. The parent app (package name) of the offer to get.
"productId": "A String", # Required. The parent one-time product (ID) of the offer to get.
"purchaseOptionId": "A String", # Required. The parent purchase option (ID) of the offer to get.
},
],
}
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 the BatchGetOneTimeProductOffers endpoint.
"oneTimeProductOffers": [ # The list of updated one-time product offers, in the same order as the request.
{ # A single offer for a one-time product.
"discountedOffer": { # Configuration specific to discounted offers. # A discounted offer.
"endTime": "A String", # Time when the offer will stop being available.
"redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive.
"startTime": "A String", # Time when the offer will start being available.
},
"offerId": "A String", # Required. Immutable. The ID of this product offer. Must be unique within the purchase option. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.
"offerTags": [ # Optional. List of up to 20 custom tags specified for this offer, and returned to the app through the billing library.
{ # Represents a custom tag specified for a product offer.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
},
],
"packageName": "A String", # Required. Immutable. The package name of the app the parent product belongs to.
"preOrderOffer": { # Configuration specific to pre-order offers. # A pre-order offer.
"endTime": "A String", # Required. Time when the pre-order will stop being available.
"priceChangeBehavior": "A String", # Required. Immutable. Specifies how price changes affect pre-existing pre-orders.
"releaseTime": "A String", # Required. Time on which the product associated with the pre-order will be released and the pre-order orders fulfilled.
"startTime": "A String", # Required. Time when the pre-order will start being available.
},
"productId": "A String", # Required. Immutable. The ID of the parent product this offer belongs to.
"purchaseOptionId": "A String", # Required. Immutable. The ID of the purchase option to which this offer is an extension.
"regionalPricingAndAvailabilityConfigs": [ # Set of regional pricing and availability information for this offer. Must not have duplicate entries with the same region_code.
{ # Regional pricing and availability configuration for a one-time product offer.
"absoluteDiscount": { # Represents an amount of money with its currency type. # The absolute value of the discount that is subtracted from the purchase option price. It should be between 0 and the purchase option price.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"availability": "A String", # Required. The availability for this region.
"noOverride": { # Options for one-time product offers without a regional price override. # The price defined in the purchase option for this region will be used.
},
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
"relativeDiscount": 3.14, # The fraction of the purchase option price that the user pays for this offer. For example, if the purchase option price for this region is $12, then a 50% discount would correspond to a price of $6. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region.
},
],
"regionsVersion": { # The version of the available regions being used for the specified resource. # Output only. The version of the regions configuration that was used to generate the one-time product offer.
"version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
},
"state": "A String", # Output only. The current state of this offer. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="batchUpdate">batchUpdate(packageName, productId, purchaseOptionId, body=None, x__xgafv=None)</code>
<pre>Creates or updates one or more one-time product offers.
Args:
packageName: string, Required. The parent app (package name) of the updated offers. Must be equal to the package_name field on all the updated OneTimeProductOffer resources. (required)
productId: string, Required. The product ID of the parent one-time product, if all updated offers belong to the same product. If this request spans multiple one-time products, set this field to "-". (required)
purchaseOptionId: string, Required. The parent purchase option (ID) for which the offers should be updated. May be specified as '-' to update offers from multiple purchase options. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for BatchUpdateOneTimeProductOffers.
"requests": [ # Required. A list of update requests of up to 100 elements. All requests must update different offers.
{ # Request message for UpdateOneTimeProductOffer.
"allowMissing": True or False, # Optional. If set to true, and the offer with the given package_name, product_id, purchase_option_id and offer_id doesn't exist, an offer will be created. If a new offer is created, the update_mask is ignored.
"latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this offer update. Defaults to latency-sensitive.
"oneTimeProductOffer": { # A single offer for a one-time product. # Required. The one-time product offer to update.
"discountedOffer": { # Configuration specific to discounted offers. # A discounted offer.
"endTime": "A String", # Time when the offer will stop being available.
"redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive.
"startTime": "A String", # Time when the offer will start being available.
},
"offerId": "A String", # Required. Immutable. The ID of this product offer. Must be unique within the purchase option. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.
"offerTags": [ # Optional. List of up to 20 custom tags specified for this offer, and returned to the app through the billing library.
{ # Represents a custom tag specified for a product offer.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
},
],
"packageName": "A String", # Required. Immutable. The package name of the app the parent product belongs to.
"preOrderOffer": { # Configuration specific to pre-order offers. # A pre-order offer.
"endTime": "A String", # Required. Time when the pre-order will stop being available.
"priceChangeBehavior": "A String", # Required. Immutable. Specifies how price changes affect pre-existing pre-orders.
"releaseTime": "A String", # Required. Time on which the product associated with the pre-order will be released and the pre-order orders fulfilled.
"startTime": "A String", # Required. Time when the pre-order will start being available.
},
"productId": "A String", # Required. Immutable. The ID of the parent product this offer belongs to.
"purchaseOptionId": "A String", # Required. Immutable. The ID of the purchase option to which this offer is an extension.
"regionalPricingAndAvailabilityConfigs": [ # Set of regional pricing and availability information for this offer. Must not have duplicate entries with the same region_code.
{ # Regional pricing and availability configuration for a one-time product offer.
"absoluteDiscount": { # Represents an amount of money with its currency type. # The absolute value of the discount that is subtracted from the purchase option price. It should be between 0 and the purchase option price.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"availability": "A String", # Required. The availability for this region.
"noOverride": { # Options for one-time product offers without a regional price override. # The price defined in the purchase option for this region will be used.
},
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
"relativeDiscount": 3.14, # The fraction of the purchase option price that the user pays for this offer. For example, if the purchase option price for this region is $12, then a 50% discount would correspond to a price of $6. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region.
},
],
"regionsVersion": { # The version of the available regions being used for the specified resource. # Output only. The version of the regions configuration that was used to generate the one-time product offer.
"version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
},
"state": "A String", # Output only. The current state of this offer. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
},
"regionsVersion": { # The version of the available regions being used for the specified resource. # Required. The version of the available regions being used for the offer.
"version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
},
"updateMask": "A String", # Required. The list of fields to be updated.
},
],
}
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 BatchUpdateOneTimeProductOffers.
"oneTimeProductOffers": [ # The list of updated one-time product offers, in the same order as the request.
{ # A single offer for a one-time product.
"discountedOffer": { # Configuration specific to discounted offers. # A discounted offer.
"endTime": "A String", # Time when the offer will stop being available.
"redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive.
"startTime": "A String", # Time when the offer will start being available.
},
"offerId": "A String", # Required. Immutable. The ID of this product offer. Must be unique within the purchase option. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.
"offerTags": [ # Optional. List of up to 20 custom tags specified for this offer, and returned to the app through the billing library.
{ # Represents a custom tag specified for a product offer.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
},
],
"packageName": "A String", # Required. Immutable. The package name of the app the parent product belongs to.
"preOrderOffer": { # Configuration specific to pre-order offers. # A pre-order offer.
"endTime": "A String", # Required. Time when the pre-order will stop being available.
"priceChangeBehavior": "A String", # Required. Immutable. Specifies how price changes affect pre-existing pre-orders.
"releaseTime": "A String", # Required. Time on which the product associated with the pre-order will be released and the pre-order orders fulfilled.
"startTime": "A String", # Required. Time when the pre-order will start being available.
},
"productId": "A String", # Required. Immutable. The ID of the parent product this offer belongs to.
"purchaseOptionId": "A String", # Required. Immutable. The ID of the purchase option to which this offer is an extension.
"regionalPricingAndAvailabilityConfigs": [ # Set of regional pricing and availability information for this offer. Must not have duplicate entries with the same region_code.
{ # Regional pricing and availability configuration for a one-time product offer.
"absoluteDiscount": { # Represents an amount of money with its currency type. # The absolute value of the discount that is subtracted from the purchase option price. It should be between 0 and the purchase option price.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"availability": "A String", # Required. The availability for this region.
"noOverride": { # Options for one-time product offers without a regional price override. # The price defined in the purchase option for this region will be used.
},
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
"relativeDiscount": 3.14, # The fraction of the purchase option price that the user pays for this offer. For example, if the purchase option price for this region is $12, then a 50% discount would correspond to a price of $6. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region.
},
],
"regionsVersion": { # The version of the available regions being used for the specified resource. # Output only. The version of the regions configuration that was used to generate the one-time product offer.
"version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
},
"state": "A String", # Output only. The current state of this offer. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="batchUpdateStates">batchUpdateStates(packageName, productId, purchaseOptionId, body=None, x__xgafv=None)</code>
<pre>Updates a batch of one-time product offer states.
Args:
packageName: string, Required. The parent app (package name) of the updated one-time product offers. (required)
productId: string, Required. The product ID of the parent one-time product, if all updated offers belong to the same one-time product. If this batch update spans multiple one-time products, set this field to "-". (required)
purchaseOptionId: string, Required. The purchase option ID of the parent purchase option, if all updated offers belong to the same purchase option. If this batch update spans multiple purchase options, set this field to "-". (required)
body: object, The request body.
The object takes the form of:
{ # Request message for BatchUpdateOneTimeProductOfferStates.
"requests": [ # Required. The update request list of up to 100 elements. All requests must update different offers.
{ # Request message to update the state of a one-time product offer.
"activateOneTimeProductOfferRequest": { # Request message for ActivateOneTimeProductOffer. # Activates an offer. Once activated, the offer is available to users, as long as its conditions are met.
"latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this update. Defaults to latency-sensitive.
"offerId": "A String", # Required. The offer ID of the offer to activate.
"packageName": "A String", # Required. The parent app (package name) of the offer to activate.
"productId": "A String", # Required. The parent one-time product (ID) of the offer to activate.
"purchaseOptionId": "A String", # Required. The parent purchase option (ID) of the offer to activate.
},
"cancelOneTimeProductOfferRequest": { # Request message for CancelOneTimeProductOffer. # Cancels an offer. Once cancelled, the offer is not available to users. Any pending orders related to this offer will be cancelled. This state transition is specific to pre-orders.
"latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this update. Defaults to latency-sensitive.
"offerId": "A String", # Required. The offer ID of the offer to cancel.
"packageName": "A String", # Required. The parent app (package name) of the offer to cancel.
"productId": "A String", # Required. The parent one-time product (ID) of the offer to cancel.
"purchaseOptionId": "A String", # Required. The parent purchase option (ID) of the offer to cancel.
},
"deactivateOneTimeProductOfferRequest": { # Request message for DeactivateOneTimeProductOffer. # Deactivates an offer. Once deactivated, the offer is no longer available to users. This state transition is specific to discounted offers.
"latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this update. Defaults to latency-sensitive.
"offerId": "A String", # Required. The offer ID of the offer to deactivate.
"packageName": "A String", # Required. The parent app (package name) of the offer to deactivate.
"productId": "A String", # Required. The parent one-time product (ID) of the offer to deactivate.
"purchaseOptionId": "A String", # Required. The parent purchase option (ID) of the offer to deactivate.
},
},
],
}
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 BatchUpdateOneTimeProductOfferStates.
"oneTimeProductOffers": [ # The updated one-time product offers list, in the same order as the request.
{ # A single offer for a one-time product.
"discountedOffer": { # Configuration specific to discounted offers. # A discounted offer.
"endTime": "A String", # Time when the offer will stop being available.
"redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive.
"startTime": "A String", # Time when the offer will start being available.
},
"offerId": "A String", # Required. Immutable. The ID of this product offer. Must be unique within the purchase option. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.
"offerTags": [ # Optional. List of up to 20 custom tags specified for this offer, and returned to the app through the billing library.
{ # Represents a custom tag specified for a product offer.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
},
],
"packageName": "A String", # Required. Immutable. The package name of the app the parent product belongs to.
"preOrderOffer": { # Configuration specific to pre-order offers. # A pre-order offer.
"endTime": "A String", # Required. Time when the pre-order will stop being available.
"priceChangeBehavior": "A String", # Required. Immutable. Specifies how price changes affect pre-existing pre-orders.
"releaseTime": "A String", # Required. Time on which the product associated with the pre-order will be released and the pre-order orders fulfilled.
"startTime": "A String", # Required. Time when the pre-order will start being available.
},
"productId": "A String", # Required. Immutable. The ID of the parent product this offer belongs to.
"purchaseOptionId": "A String", # Required. Immutable. The ID of the purchase option to which this offer is an extension.
"regionalPricingAndAvailabilityConfigs": [ # Set of regional pricing and availability information for this offer. Must not have duplicate entries with the same region_code.
{ # Regional pricing and availability configuration for a one-time product offer.
"absoluteDiscount": { # Represents an amount of money with its currency type. # The absolute value of the discount that is subtracted from the purchase option price. It should be between 0 and the purchase option price.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"availability": "A String", # Required. The availability for this region.
"noOverride": { # Options for one-time product offers without a regional price override. # The price defined in the purchase option for this region will be used.
},
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
"relativeDiscount": 3.14, # The fraction of the purchase option price that the user pays for this offer. For example, if the purchase option price for this region is $12, then a 50% discount would correspond to a price of $6. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region.
},
],
"regionsVersion": { # The version of the available regions being used for the specified resource. # Output only. The version of the regions configuration that was used to generate the one-time product offer.
"version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
},
"state": "A String", # Output only. The current state of this offer. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="cancel">cancel(packageName, productId, purchaseOptionId, offerId, body=None, x__xgafv=None)</code>
<pre>Cancels a one-time product offer.
Args:
packageName: string, Required. The parent app (package name) of the offer to cancel. (required)
productId: string, Required. The parent one-time product (ID) of the offer to cancel. (required)
purchaseOptionId: string, Required. The parent purchase option (ID) of the offer to cancel. (required)
offerId: string, Required. The offer ID of the offer to cancel. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for CancelOneTimeProductOffer.
"latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this update. Defaults to latency-sensitive.
"offerId": "A String", # Required. The offer ID of the offer to cancel.
"packageName": "A String", # Required. The parent app (package name) of the offer to cancel.
"productId": "A String", # Required. The parent one-time product (ID) of the offer to cancel.
"purchaseOptionId": "A String", # Required. The parent purchase option (ID) of the offer to cancel.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A single offer for a one-time product.
"discountedOffer": { # Configuration specific to discounted offers. # A discounted offer.
"endTime": "A String", # Time when the offer will stop being available.
"redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive.
"startTime": "A String", # Time when the offer will start being available.
},
"offerId": "A String", # Required. Immutable. The ID of this product offer. Must be unique within the purchase option. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.
"offerTags": [ # Optional. List of up to 20 custom tags specified for this offer, and returned to the app through the billing library.
{ # Represents a custom tag specified for a product offer.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
},
],
"packageName": "A String", # Required. Immutable. The package name of the app the parent product belongs to.
"preOrderOffer": { # Configuration specific to pre-order offers. # A pre-order offer.
"endTime": "A String", # Required. Time when the pre-order will stop being available.
"priceChangeBehavior": "A String", # Required. Immutable. Specifies how price changes affect pre-existing pre-orders.
"releaseTime": "A String", # Required. Time on which the product associated with the pre-order will be released and the pre-order orders fulfilled.
"startTime": "A String", # Required. Time when the pre-order will start being available.
},
"productId": "A String", # Required. Immutable. The ID of the parent product this offer belongs to.
"purchaseOptionId": "A String", # Required. Immutable. The ID of the purchase option to which this offer is an extension.
"regionalPricingAndAvailabilityConfigs": [ # Set of regional pricing and availability information for this offer. Must not have duplicate entries with the same region_code.
{ # Regional pricing and availability configuration for a one-time product offer.
"absoluteDiscount": { # Represents an amount of money with its currency type. # The absolute value of the discount that is subtracted from the purchase option price. It should be between 0 and the purchase option price.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"availability": "A String", # Required. The availability for this region.
"noOverride": { # Options for one-time product offers without a regional price override. # The price defined in the purchase option for this region will be used.
},
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
"relativeDiscount": 3.14, # The fraction of the purchase option price that the user pays for this offer. For example, if the purchase option price for this region is $12, then a 50% discount would correspond to a price of $6. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region.
},
],
"regionsVersion": { # The version of the available regions being used for the specified resource. # Output only. The version of the regions configuration that was used to generate the one-time product offer.
"version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
},
"state": "A String", # Output only. The current state of this offer. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="deactivate">deactivate(packageName, productId, purchaseOptionId, offerId, body=None, x__xgafv=None)</code>
<pre>Deactivates a one-time product offer.
Args:
packageName: string, Required. The parent app (package name) of the offer to deactivate. (required)
productId: string, Required. The parent one-time product (ID) of the offer to deactivate. (required)
purchaseOptionId: string, Required. The parent purchase option (ID) of the offer to deactivate. (required)
offerId: string, Required. The offer ID of the offer to deactivate. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for DeactivateOneTimeProductOffer.
"latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this update. Defaults to latency-sensitive.
"offerId": "A String", # Required. The offer ID of the offer to deactivate.
"packageName": "A String", # Required. The parent app (package name) of the offer to deactivate.
"productId": "A String", # Required. The parent one-time product (ID) of the offer to deactivate.
"purchaseOptionId": "A String", # Required. The parent purchase option (ID) of the offer to deactivate.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A single offer for a one-time product.
"discountedOffer": { # Configuration specific to discounted offers. # A discounted offer.
"endTime": "A String", # Time when the offer will stop being available.
"redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive.
"startTime": "A String", # Time when the offer will start being available.
},
"offerId": "A String", # Required. Immutable. The ID of this product offer. Must be unique within the purchase option. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.
"offerTags": [ # Optional. List of up to 20 custom tags specified for this offer, and returned to the app through the billing library.
{ # Represents a custom tag specified for a product offer.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
},
],
"packageName": "A String", # Required. Immutable. The package name of the app the parent product belongs to.
"preOrderOffer": { # Configuration specific to pre-order offers. # A pre-order offer.
"endTime": "A String", # Required. Time when the pre-order will stop being available.
"priceChangeBehavior": "A String", # Required. Immutable. Specifies how price changes affect pre-existing pre-orders.
"releaseTime": "A String", # Required. Time on which the product associated with the pre-order will be released and the pre-order orders fulfilled.
"startTime": "A String", # Required. Time when the pre-order will start being available.
},
"productId": "A String", # Required. Immutable. The ID of the parent product this offer belongs to.
"purchaseOptionId": "A String", # Required. Immutable. The ID of the purchase option to which this offer is an extension.
"regionalPricingAndAvailabilityConfigs": [ # Set of regional pricing and availability information for this offer. Must not have duplicate entries with the same region_code.
{ # Regional pricing and availability configuration for a one-time product offer.
"absoluteDiscount": { # Represents an amount of money with its currency type. # The absolute value of the discount that is subtracted from the purchase option price. It should be between 0 and the purchase option price.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"availability": "A String", # Required. The availability for this region.
"noOverride": { # Options for one-time product offers without a regional price override. # The price defined in the purchase option for this region will be used.
},
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
"relativeDiscount": 3.14, # The fraction of the purchase option price that the user pays for this offer. For example, if the purchase option price for this region is $12, then a 50% discount would correspond to a price of $6. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region.
},
],
"regionsVersion": { # The version of the available regions being used for the specified resource. # Output only. The version of the regions configuration that was used to generate the one-time product offer.
"version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
},
"state": "A String", # Output only. The current state of this offer. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(packageName, productId, purchaseOptionId, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all offers under a given app, product, or purchase option.
Args:
packageName: string, Required. The parent app (package name) for which the offers should be read. (required)
productId: string, Required. The parent one-time product (ID) for which the offers should be read. May be specified as '-' to read all offers under an app. (required)
purchaseOptionId: string, Required. The parent purchase option (ID) for which the offers should be read. May be specified as '-' to read all offers under a one-time product or an app. Must be specified as '-' if product_id is specified as '-'. (required)
pageSize: integer, Optional. The maximum number of offers to return. The service may return fewer than this value. If unspecified, at most 50 offers will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Optional. A page token, received from a previous `ListOneTimeProductsOffers` call. Provide this to retrieve the subsequent page. When paginating, product_id, package_name and purchase_option_id provided to `ListOneTimeProductsOffersRequest` 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 ListOneTimeProductOffers.
"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.
"oneTimeProductOffers": [ # The one_time_product offers from the specified request.
{ # A single offer for a one-time product.
"discountedOffer": { # Configuration specific to discounted offers. # A discounted offer.
"endTime": "A String", # Time when the offer will stop being available.
"redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive.
"startTime": "A String", # Time when the offer will start being available.
},
"offerId": "A String", # Required. Immutable. The ID of this product offer. Must be unique within the purchase option. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.
"offerTags": [ # Optional. List of up to 20 custom tags specified for this offer, and returned to the app through the billing library.
{ # Represents a custom tag specified for a product offer.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
},
],
"packageName": "A String", # Required. Immutable. The package name of the app the parent product belongs to.
"preOrderOffer": { # Configuration specific to pre-order offers. # A pre-order offer.
"endTime": "A String", # Required. Time when the pre-order will stop being available.
"priceChangeBehavior": "A String", # Required. Immutable. Specifies how price changes affect pre-existing pre-orders.
"releaseTime": "A String", # Required. Time on which the product associated with the pre-order will be released and the pre-order orders fulfilled.
"startTime": "A String", # Required. Time when the pre-order will start being available.
},
"productId": "A String", # Required. Immutable. The ID of the parent product this offer belongs to.
"purchaseOptionId": "A String", # Required. Immutable. The ID of the purchase option to which this offer is an extension.
"regionalPricingAndAvailabilityConfigs": [ # Set of regional pricing and availability information for this offer. Must not have duplicate entries with the same region_code.
{ # Regional pricing and availability configuration for a one-time product offer.
"absoluteDiscount": { # Represents an amount of money with its currency type. # The absolute value of the discount that is subtracted from the purchase option price. It should be between 0 and the purchase option price.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"availability": "A String", # Required. The availability for this region.
"noOverride": { # Options for one-time product offers without a regional price override. # The price defined in the purchase option for this region will be used.
},
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
"relativeDiscount": 3.14, # The fraction of the purchase option price that the user pays for this offer. For example, if the purchase option price for this region is $12, then a 50% discount would correspond to a price of $6. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region.
},
],
"regionsVersion": { # The version of the available regions being used for the specified resource. # Output only. The version of the regions configuration that was used to generate the one-time product offer.
"version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
},
"state": "A String", # Output only. The current state of this offer. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
},
],
}</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>
|
