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 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867
|
<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></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="androidpublisher_v3.monetization.onetimeproducts.purchaseOptions.html">purchaseOptions()</a></code>
</p>
<p class="firstline">Returns the purchaseOptions Resource.</p>
<p class="toc_element">
<code><a href="#batchDelete">batchDelete(packageName, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes one or more one-time products.</p>
<p class="toc_element">
<code><a href="#batchGet">batchGet(packageName, productIds=None, x__xgafv=None)</a></code></p>
<p class="firstline">Reads one or more one-time products.</p>
<p class="toc_element">
<code><a href="#batchUpdate">batchUpdate(packageName, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates or updates one or more one-time products.</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="#delete">delete(packageName, productId, latencyTolerance=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a one-time product.</p>
<p class="toc_element">
<code><a href="#get">get(packageName, productId, x__xgafv=None)</a></code></p>
<p class="firstline">Reads a single one-time product.</p>
<p class="toc_element">
<code><a href="#list">list(packageName, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all one-time products under a given app.</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>
<p class="toc_element">
<code><a href="#patch">patch(packageName, productId, allowMissing=None, body=None, latencyTolerance=None, regionsVersion_version=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates or updates a one-time product.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchDelete">batchDelete(packageName, body=None, x__xgafv=None)</code>
<pre>Deletes one or more one-time products.
Args:
packageName: string, Required. The parent app (package name) for which the one-time products should be deleted. Must be equal to the package_name field on all the OneTimeProduct resources. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for BatchDeleteOneTimeProduct.
"requests": [ # Required. A list of delete requests of up to 100 elements. All requests must delete different one-time products.
{ # Request message for deleting a one-time product.
"latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
"packageName": "A String", # Required. The parent app (package name) of the one-time product to delete.
"productId": "A String", # Required. The one-time product ID of the one-time product 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, productIds=None, x__xgafv=None)</code>
<pre>Reads one or more one-time products.
Args:
packageName: string, Required. The parent app (package name) for which the products should be retrieved. Must be equal to the package_name field on all requests. (required)
productIds: string, Required. A list of up to 100 product IDs to retrieve. All IDs must be different. (repeated)
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 BatchGetOneTimeProducts endpoint.
"oneTimeProducts": [ # The list of requested one-time products, in the same order as the request.
{ # A single one-time product for an app.
"listings": [ # Required. Set of localized title and description data. Must not have duplicate entries with the same language_code.
{ # Regional store listing for a one-time product.
"description": "A String", # Required. The description of this product in the language of this listing. The maximum length is 200 characters.
"languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g., "en-US".
"title": "A String", # Required. The title of this product in the language of this listing. The maximum length is 55 characters.
},
],
"offerTags": [ # Optional. List of up to 20 custom tags specified for this one-time product, and returned to the app through the billing library. Purchase options and offers for this product will also receive these tags in 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. Package name of the parent app.
"productId": "A String", # Required. Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must start with a number or lowercase letter, and can contain numbers (0-9), lowercase letters (a-z), underscores (_), and periods (.).
"purchaseOptions": [ # Required. The set of purchase options for this one-time product.
{ # A single purchase option for a one-time product.
"buyOption": { # A purchase option that can be bought. # A purchase option that can be bought.
"legacyCompatible": True or False, # Optional. Whether this purchase option will be available in legacy PBL flows that do not support one-time products model. Up to one "buy" purchase option can be marked as backwards compatible.
"multiQuantityEnabled": True or False, # Optional. Whether this purchase option allows multi-quantity. Multi-quantity allows buyer to purchase more than one item in a single checkout.
},
"newRegionsConfig": { # Pricing information for any new regions Play may launch in the future. # Pricing information for any new locations Play may launch in the future. If omitted, the purchase option will not be automatically available in any new locations Play may launch in the future.
"availability": "A String", # Required. The regional availability for the new regions config. When set to AVAILABLE, the pricing information will be used for any new regions Play may launch in the future.
"eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new regions Play may launch in.
"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.
},
"usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new regions Play may launch in.
"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.
},
},
"offerTags": [ # Optional. List of up to 20 custom tags specified for this purchase option, and returned to the app through the billing library. Offers for this purchase option will also receive these tags in 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.
},
],
"purchaseOptionId": "A String", # Required. Immutable. The unique identifier of this purchase option. Must be unique within the one-time product. 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.
"regionalPricingAndAvailabilityConfigs": [ # Regional pricing and availability information for this purchase option.
{ # Regional pricing and availability configuration for a purchase option.
"availability": "A String", # The availability of the purchase option.
"price": { # Represents an amount of money with its currency type. # The price of the purchase option in the specified region. Must be set in the currency that is linked to the specified region.
"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.
},
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
},
],
"rentOption": { # A purchase option that can be rented. # A purchase option that can be rented.
"expirationPeriod": "A String", # Optional. The amount of time the user has after starting consuming the entitlement before it is revoked. Specified in ISO 8601 format.
"rentalPeriod": "A String", # Required. The amount of time a user has the entitlement for. Starts at purchase flow completion. Specified in ISO 8601 format.
},
"state": "A String", # Output only. The state of the purchase option, i.e., whether it's active. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time product purchase options. # Optional. Details about taxes and legal compliance.
"withdrawalRightType": "A String", # Optional. Digital content or service classification for products distributed to users in eligible regions. If unset, it defaults to `WITHDRAWAL_RIGHT_DIGITAL_CONTENT`. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
},
},
],
"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.
"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.
},
"restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this one-time product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
"regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
"A String",
],
},
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time products. # Details about taxes and legal compliance.
"isTokenizedDigitalAsset": True or False, # Whether this one-time product is declared as a product representing a tokenized digital asset.
"regionalTaxConfigs": [ # Regional tax configuration.
{ # Details about taxation in a given geographical region.
"eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States.
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
"streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
"taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
},
],
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="batchUpdate">batchUpdate(packageName, body=None, x__xgafv=None)</code>
<pre>Creates or updates one or more one-time products.
Args:
packageName: string, Required. The parent app (package name) for which the one-time products should be updated. Must be equal to the package_name field on all the OneTimeProduct resources. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for BatchUpdateOneTimeProduct.
"requests": [ # Required. A list of update requests of up to 100 elements. All requests must update different one-time products.
{ # Request message for UpdateOneTimeProduct.
"allowMissing": True or False, # Optional. If set to true, and the one-time product with the given package_name and product_id doesn't exist, the one-time product will be created. If a new one-time product is created, update_mask is ignored.
"latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product upsert. Defaults to latency-sensitive.
"oneTimeProduct": { # A single one-time product for an app. # Required. The one-time product to upsert.
"listings": [ # Required. Set of localized title and description data. Must not have duplicate entries with the same language_code.
{ # Regional store listing for a one-time product.
"description": "A String", # Required. The description of this product in the language of this listing. The maximum length is 200 characters.
"languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g., "en-US".
"title": "A String", # Required. The title of this product in the language of this listing. The maximum length is 55 characters.
},
],
"offerTags": [ # Optional. List of up to 20 custom tags specified for this one-time product, and returned to the app through the billing library. Purchase options and offers for this product will also receive these tags in 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. Package name of the parent app.
"productId": "A String", # Required. Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must start with a number or lowercase letter, and can contain numbers (0-9), lowercase letters (a-z), underscores (_), and periods (.).
"purchaseOptions": [ # Required. The set of purchase options for this one-time product.
{ # A single purchase option for a one-time product.
"buyOption": { # A purchase option that can be bought. # A purchase option that can be bought.
"legacyCompatible": True or False, # Optional. Whether this purchase option will be available in legacy PBL flows that do not support one-time products model. Up to one "buy" purchase option can be marked as backwards compatible.
"multiQuantityEnabled": True or False, # Optional. Whether this purchase option allows multi-quantity. Multi-quantity allows buyer to purchase more than one item in a single checkout.
},
"newRegionsConfig": { # Pricing information for any new regions Play may launch in the future. # Pricing information for any new locations Play may launch in the future. If omitted, the purchase option will not be automatically available in any new locations Play may launch in the future.
"availability": "A String", # Required. The regional availability for the new regions config. When set to AVAILABLE, the pricing information will be used for any new regions Play may launch in the future.
"eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new regions Play may launch in.
"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.
},
"usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new regions Play may launch in.
"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.
},
},
"offerTags": [ # Optional. List of up to 20 custom tags specified for this purchase option, and returned to the app through the billing library. Offers for this purchase option will also receive these tags in 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.
},
],
"purchaseOptionId": "A String", # Required. Immutable. The unique identifier of this purchase option. Must be unique within the one-time product. 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.
"regionalPricingAndAvailabilityConfigs": [ # Regional pricing and availability information for this purchase option.
{ # Regional pricing and availability configuration for a purchase option.
"availability": "A String", # The availability of the purchase option.
"price": { # Represents an amount of money with its currency type. # The price of the purchase option in the specified region. Must be set in the currency that is linked to the specified region.
"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.
},
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
},
],
"rentOption": { # A purchase option that can be rented. # A purchase option that can be rented.
"expirationPeriod": "A String", # Optional. The amount of time the user has after starting consuming the entitlement before it is revoked. Specified in ISO 8601 format.
"rentalPeriod": "A String", # Required. The amount of time a user has the entitlement for. Starts at purchase flow completion. Specified in ISO 8601 format.
},
"state": "A String", # Output only. The state of the purchase option, i.e., whether it's active. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time product purchase options. # Optional. Details about taxes and legal compliance.
"withdrawalRightType": "A String", # Optional. Digital content or service classification for products distributed to users in eligible regions. If unset, it defaults to `WITHDRAWAL_RIGHT_DIGITAL_CONTENT`. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
},
},
],
"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.
"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.
},
"restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this one-time product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
"regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
"A String",
],
},
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time products. # Details about taxes and legal compliance.
"isTokenizedDigitalAsset": True or False, # Whether this one-time product is declared as a product representing a tokenized digital asset.
"regionalTaxConfigs": [ # Regional tax configuration.
{ # Details about taxation in a given geographical region.
"eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States.
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
"streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
"taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
},
],
},
},
"regionsVersion": { # The version of the available regions being used for the specified resource. # Required. The version of the available regions being used for the one-time product.
"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 BatchUpdateOneTimeProduct.
"oneTimeProducts": [ # The list of updated one-time products list, in the same order as the request.
{ # A single one-time product for an app.
"listings": [ # Required. Set of localized title and description data. Must not have duplicate entries with the same language_code.
{ # Regional store listing for a one-time product.
"description": "A String", # Required. The description of this product in the language of this listing. The maximum length is 200 characters.
"languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g., "en-US".
"title": "A String", # Required. The title of this product in the language of this listing. The maximum length is 55 characters.
},
],
"offerTags": [ # Optional. List of up to 20 custom tags specified for this one-time product, and returned to the app through the billing library. Purchase options and offers for this product will also receive these tags in 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. Package name of the parent app.
"productId": "A String", # Required. Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must start with a number or lowercase letter, and can contain numbers (0-9), lowercase letters (a-z), underscores (_), and periods (.).
"purchaseOptions": [ # Required. The set of purchase options for this one-time product.
{ # A single purchase option for a one-time product.
"buyOption": { # A purchase option that can be bought. # A purchase option that can be bought.
"legacyCompatible": True or False, # Optional. Whether this purchase option will be available in legacy PBL flows that do not support one-time products model. Up to one "buy" purchase option can be marked as backwards compatible.
"multiQuantityEnabled": True or False, # Optional. Whether this purchase option allows multi-quantity. Multi-quantity allows buyer to purchase more than one item in a single checkout.
},
"newRegionsConfig": { # Pricing information for any new regions Play may launch in the future. # Pricing information for any new locations Play may launch in the future. If omitted, the purchase option will not be automatically available in any new locations Play may launch in the future.
"availability": "A String", # Required. The regional availability for the new regions config. When set to AVAILABLE, the pricing information will be used for any new regions Play may launch in the future.
"eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new regions Play may launch in.
"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.
},
"usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new regions Play may launch in.
"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.
},
},
"offerTags": [ # Optional. List of up to 20 custom tags specified for this purchase option, and returned to the app through the billing library. Offers for this purchase option will also receive these tags in 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.
},
],
"purchaseOptionId": "A String", # Required. Immutable. The unique identifier of this purchase option. Must be unique within the one-time product. 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.
"regionalPricingAndAvailabilityConfigs": [ # Regional pricing and availability information for this purchase option.
{ # Regional pricing and availability configuration for a purchase option.
"availability": "A String", # The availability of the purchase option.
"price": { # Represents an amount of money with its currency type. # The price of the purchase option in the specified region. Must be set in the currency that is linked to the specified region.
"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.
},
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
},
],
"rentOption": { # A purchase option that can be rented. # A purchase option that can be rented.
"expirationPeriod": "A String", # Optional. The amount of time the user has after starting consuming the entitlement before it is revoked. Specified in ISO 8601 format.
"rentalPeriod": "A String", # Required. The amount of time a user has the entitlement for. Starts at purchase flow completion. Specified in ISO 8601 format.
},
"state": "A String", # Output only. The state of the purchase option, i.e., whether it's active. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time product purchase options. # Optional. Details about taxes and legal compliance.
"withdrawalRightType": "A String", # Optional. Digital content or service classification for products distributed to users in eligible regions. If unset, it defaults to `WITHDRAWAL_RIGHT_DIGITAL_CONTENT`. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
},
},
],
"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.
"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.
},
"restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this one-time product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
"regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
"A String",
],
},
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time products. # Details about taxes and legal compliance.
"isTokenizedDigitalAsset": True or False, # Whether this one-time product is declared as a product representing a tokenized digital asset.
"regionalTaxConfigs": [ # Regional tax configuration.
{ # Details about taxation in a given geographical region.
"eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States.
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
"streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
"taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
},
],
},
},
],
}</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="delete">delete(packageName, productId, latencyTolerance=None, x__xgafv=None)</code>
<pre>Deletes a one-time product.
Args:
packageName: string, Required. The parent app (package name) of the one-time product to delete. (required)
productId: string, Required. The one-time product ID of the one-time product to delete. (required)
latencyTolerance: string, Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
Allowed values
PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED - Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.
PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE - The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.
PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT - The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods.
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="get">get(packageName, productId, x__xgafv=None)</code>
<pre>Reads a single one-time product.
Args:
packageName: string, Required. The parent app (package name) of the product to retrieve. (required)
productId: string, Required. The product ID of the product 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:
{ # A single one-time product for an app.
"listings": [ # Required. Set of localized title and description data. Must not have duplicate entries with the same language_code.
{ # Regional store listing for a one-time product.
"description": "A String", # Required. The description of this product in the language of this listing. The maximum length is 200 characters.
"languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g., "en-US".
"title": "A String", # Required. The title of this product in the language of this listing. The maximum length is 55 characters.
},
],
"offerTags": [ # Optional. List of up to 20 custom tags specified for this one-time product, and returned to the app through the billing library. Purchase options and offers for this product will also receive these tags in 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. Package name of the parent app.
"productId": "A String", # Required. Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must start with a number or lowercase letter, and can contain numbers (0-9), lowercase letters (a-z), underscores (_), and periods (.).
"purchaseOptions": [ # Required. The set of purchase options for this one-time product.
{ # A single purchase option for a one-time product.
"buyOption": { # A purchase option that can be bought. # A purchase option that can be bought.
"legacyCompatible": True or False, # Optional. Whether this purchase option will be available in legacy PBL flows that do not support one-time products model. Up to one "buy" purchase option can be marked as backwards compatible.
"multiQuantityEnabled": True or False, # Optional. Whether this purchase option allows multi-quantity. Multi-quantity allows buyer to purchase more than one item in a single checkout.
},
"newRegionsConfig": { # Pricing information for any new regions Play may launch in the future. # Pricing information for any new locations Play may launch in the future. If omitted, the purchase option will not be automatically available in any new locations Play may launch in the future.
"availability": "A String", # Required. The regional availability for the new regions config. When set to AVAILABLE, the pricing information will be used for any new regions Play may launch in the future.
"eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new regions Play may launch in.
"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.
},
"usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new regions Play may launch in.
"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.
},
},
"offerTags": [ # Optional. List of up to 20 custom tags specified for this purchase option, and returned to the app through the billing library. Offers for this purchase option will also receive these tags in 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.
},
],
"purchaseOptionId": "A String", # Required. Immutable. The unique identifier of this purchase option. Must be unique within the one-time product. 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.
"regionalPricingAndAvailabilityConfigs": [ # Regional pricing and availability information for this purchase option.
{ # Regional pricing and availability configuration for a purchase option.
"availability": "A String", # The availability of the purchase option.
"price": { # Represents an amount of money with its currency type. # The price of the purchase option in the specified region. Must be set in the currency that is linked to the specified region.
"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.
},
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
},
],
"rentOption": { # A purchase option that can be rented. # A purchase option that can be rented.
"expirationPeriod": "A String", # Optional. The amount of time the user has after starting consuming the entitlement before it is revoked. Specified in ISO 8601 format.
"rentalPeriod": "A String", # Required. The amount of time a user has the entitlement for. Starts at purchase flow completion. Specified in ISO 8601 format.
},
"state": "A String", # Output only. The state of the purchase option, i.e., whether it's active. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time product purchase options. # Optional. Details about taxes and legal compliance.
"withdrawalRightType": "A String", # Optional. Digital content or service classification for products distributed to users in eligible regions. If unset, it defaults to `WITHDRAWAL_RIGHT_DIGITAL_CONTENT`. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
},
},
],
"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.
"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.
},
"restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this one-time product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
"regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
"A String",
],
},
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time products. # Details about taxes and legal compliance.
"isTokenizedDigitalAsset": True or False, # Whether this one-time product is declared as a product representing a tokenized digital asset.
"regionalTaxConfigs": [ # Regional tax configuration.
{ # Details about taxation in a given geographical region.
"eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States.
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
"streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
"taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
},
],
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(packageName, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all one-time products under a given app.
Args:
packageName: string, Required. The parent app (package name) for which the one-time product should be read. (required)
pageSize: integer, Optional. The maximum number of one-time product to return. The service may return fewer than this value. If unspecified, at most 50 one-time products 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 `ListOneTimeProducts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListOneTimeProducts` 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 ListOneTimeProducts.
"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.
"oneTimeProducts": [ # The one-time products from the specified app.
{ # A single one-time product for an app.
"listings": [ # Required. Set of localized title and description data. Must not have duplicate entries with the same language_code.
{ # Regional store listing for a one-time product.
"description": "A String", # Required. The description of this product in the language of this listing. The maximum length is 200 characters.
"languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g., "en-US".
"title": "A String", # Required. The title of this product in the language of this listing. The maximum length is 55 characters.
},
],
"offerTags": [ # Optional. List of up to 20 custom tags specified for this one-time product, and returned to the app through the billing library. Purchase options and offers for this product will also receive these tags in 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. Package name of the parent app.
"productId": "A String", # Required. Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must start with a number or lowercase letter, and can contain numbers (0-9), lowercase letters (a-z), underscores (_), and periods (.).
"purchaseOptions": [ # Required. The set of purchase options for this one-time product.
{ # A single purchase option for a one-time product.
"buyOption": { # A purchase option that can be bought. # A purchase option that can be bought.
"legacyCompatible": True or False, # Optional. Whether this purchase option will be available in legacy PBL flows that do not support one-time products model. Up to one "buy" purchase option can be marked as backwards compatible.
"multiQuantityEnabled": True or False, # Optional. Whether this purchase option allows multi-quantity. Multi-quantity allows buyer to purchase more than one item in a single checkout.
},
"newRegionsConfig": { # Pricing information for any new regions Play may launch in the future. # Pricing information for any new locations Play may launch in the future. If omitted, the purchase option will not be automatically available in any new locations Play may launch in the future.
"availability": "A String", # Required. The regional availability for the new regions config. When set to AVAILABLE, the pricing information will be used for any new regions Play may launch in the future.
"eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new regions Play may launch in.
"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.
},
"usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new regions Play may launch in.
"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.
},
},
"offerTags": [ # Optional. List of up to 20 custom tags specified for this purchase option, and returned to the app through the billing library. Offers for this purchase option will also receive these tags in 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.
},
],
"purchaseOptionId": "A String", # Required. Immutable. The unique identifier of this purchase option. Must be unique within the one-time product. 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.
"regionalPricingAndAvailabilityConfigs": [ # Regional pricing and availability information for this purchase option.
{ # Regional pricing and availability configuration for a purchase option.
"availability": "A String", # The availability of the purchase option.
"price": { # Represents an amount of money with its currency type. # The price of the purchase option in the specified region. Must be set in the currency that is linked to the specified region.
"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.
},
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
},
],
"rentOption": { # A purchase option that can be rented. # A purchase option that can be rented.
"expirationPeriod": "A String", # Optional. The amount of time the user has after starting consuming the entitlement before it is revoked. Specified in ISO 8601 format.
"rentalPeriod": "A String", # Required. The amount of time a user has the entitlement for. Starts at purchase flow completion. Specified in ISO 8601 format.
},
"state": "A String", # Output only. The state of the purchase option, i.e., whether it's active. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time product purchase options. # Optional. Details about taxes and legal compliance.
"withdrawalRightType": "A String", # Optional. Digital content or service classification for products distributed to users in eligible regions. If unset, it defaults to `WITHDRAWAL_RIGHT_DIGITAL_CONTENT`. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
},
},
],
"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.
"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.
},
"restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this one-time product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
"regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
"A String",
],
},
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time products. # Details about taxes and legal compliance.
"isTokenizedDigitalAsset": True or False, # Whether this one-time product is declared as a product representing a tokenized digital asset.
"regionalTaxConfigs": [ # Regional tax configuration.
{ # Details about taxation in a given geographical region.
"eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States.
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
"streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
"taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
},
],
},
},
],
}</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>
<div class="method">
<code class="details" id="patch">patch(packageName, productId, allowMissing=None, body=None, latencyTolerance=None, regionsVersion_version=None, updateMask=None, x__xgafv=None)</code>
<pre>Creates or updates a one-time product.
Args:
packageName: string, Required. Immutable. Package name of the parent app. (required)
productId: string, Required. Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must start with a number or lowercase letter, and can contain numbers (0-9), lowercase letters (a-z), underscores (_), and periods (.). (required)
body: object, The request body.
The object takes the form of:
{ # A single one-time product for an app.
"listings": [ # Required. Set of localized title and description data. Must not have duplicate entries with the same language_code.
{ # Regional store listing for a one-time product.
"description": "A String", # Required. The description of this product in the language of this listing. The maximum length is 200 characters.
"languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g., "en-US".
"title": "A String", # Required. The title of this product in the language of this listing. The maximum length is 55 characters.
},
],
"offerTags": [ # Optional. List of up to 20 custom tags specified for this one-time product, and returned to the app through the billing library. Purchase options and offers for this product will also receive these tags in 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. Package name of the parent app.
"productId": "A String", # Required. Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must start with a number or lowercase letter, and can contain numbers (0-9), lowercase letters (a-z), underscores (_), and periods (.).
"purchaseOptions": [ # Required. The set of purchase options for this one-time product.
{ # A single purchase option for a one-time product.
"buyOption": { # A purchase option that can be bought. # A purchase option that can be bought.
"legacyCompatible": True or False, # Optional. Whether this purchase option will be available in legacy PBL flows that do not support one-time products model. Up to one "buy" purchase option can be marked as backwards compatible.
"multiQuantityEnabled": True or False, # Optional. Whether this purchase option allows multi-quantity. Multi-quantity allows buyer to purchase more than one item in a single checkout.
},
"newRegionsConfig": { # Pricing information for any new regions Play may launch in the future. # Pricing information for any new locations Play may launch in the future. If omitted, the purchase option will not be automatically available in any new locations Play may launch in the future.
"availability": "A String", # Required. The regional availability for the new regions config. When set to AVAILABLE, the pricing information will be used for any new regions Play may launch in the future.
"eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new regions Play may launch in.
"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.
},
"usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new regions Play may launch in.
"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.
},
},
"offerTags": [ # Optional. List of up to 20 custom tags specified for this purchase option, and returned to the app through the billing library. Offers for this purchase option will also receive these tags in 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.
},
],
"purchaseOptionId": "A String", # Required. Immutable. The unique identifier of this purchase option. Must be unique within the one-time product. 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.
"regionalPricingAndAvailabilityConfigs": [ # Regional pricing and availability information for this purchase option.
{ # Regional pricing and availability configuration for a purchase option.
"availability": "A String", # The availability of the purchase option.
"price": { # Represents an amount of money with its currency type. # The price of the purchase option in the specified region. Must be set in the currency that is linked to the specified region.
"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.
},
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
},
],
"rentOption": { # A purchase option that can be rented. # A purchase option that can be rented.
"expirationPeriod": "A String", # Optional. The amount of time the user has after starting consuming the entitlement before it is revoked. Specified in ISO 8601 format.
"rentalPeriod": "A String", # Required. The amount of time a user has the entitlement for. Starts at purchase flow completion. Specified in ISO 8601 format.
},
"state": "A String", # Output only. The state of the purchase option, i.e., whether it's active. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time product purchase options. # Optional. Details about taxes and legal compliance.
"withdrawalRightType": "A String", # Optional. Digital content or service classification for products distributed to users in eligible regions. If unset, it defaults to `WITHDRAWAL_RIGHT_DIGITAL_CONTENT`. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
},
},
],
"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.
"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.
},
"restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this one-time product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
"regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
"A String",
],
},
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time products. # Details about taxes and legal compliance.
"isTokenizedDigitalAsset": True or False, # Whether this one-time product is declared as a product representing a tokenized digital asset.
"regionalTaxConfigs": [ # Regional tax configuration.
{ # Details about taxation in a given geographical region.
"eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States.
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
"streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
"taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
},
],
},
}
allowMissing: boolean, Optional. If set to true, and the one-time product with the given package_name and product_id doesn't exist, the one-time product will be created. If a new one-time product is created, update_mask is ignored.
latencyTolerance: string, Optional. The latency tolerance for the propagation of this product upsert. Defaults to latency-sensitive.
Allowed values
PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED - Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.
PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE - The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.
PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT - The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods.
regionsVersion_version: 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: 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:
{ # A single one-time product for an app.
"listings": [ # Required. Set of localized title and description data. Must not have duplicate entries with the same language_code.
{ # Regional store listing for a one-time product.
"description": "A String", # Required. The description of this product in the language of this listing. The maximum length is 200 characters.
"languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g., "en-US".
"title": "A String", # Required. The title of this product in the language of this listing. The maximum length is 55 characters.
},
],
"offerTags": [ # Optional. List of up to 20 custom tags specified for this one-time product, and returned to the app through the billing library. Purchase options and offers for this product will also receive these tags in 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. Package name of the parent app.
"productId": "A String", # Required. Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must start with a number or lowercase letter, and can contain numbers (0-9), lowercase letters (a-z), underscores (_), and periods (.).
"purchaseOptions": [ # Required. The set of purchase options for this one-time product.
{ # A single purchase option for a one-time product.
"buyOption": { # A purchase option that can be bought. # A purchase option that can be bought.
"legacyCompatible": True or False, # Optional. Whether this purchase option will be available in legacy PBL flows that do not support one-time products model. Up to one "buy" purchase option can be marked as backwards compatible.
"multiQuantityEnabled": True or False, # Optional. Whether this purchase option allows multi-quantity. Multi-quantity allows buyer to purchase more than one item in a single checkout.
},
"newRegionsConfig": { # Pricing information for any new regions Play may launch in the future. # Pricing information for any new locations Play may launch in the future. If omitted, the purchase option will not be automatically available in any new locations Play may launch in the future.
"availability": "A String", # Required. The regional availability for the new regions config. When set to AVAILABLE, the pricing information will be used for any new regions Play may launch in the future.
"eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new regions Play may launch in.
"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.
},
"usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new regions Play may launch in.
"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.
},
},
"offerTags": [ # Optional. List of up to 20 custom tags specified for this purchase option, and returned to the app through the billing library. Offers for this purchase option will also receive these tags in 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.
},
],
"purchaseOptionId": "A String", # Required. Immutable. The unique identifier of this purchase option. Must be unique within the one-time product. 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.
"regionalPricingAndAvailabilityConfigs": [ # Regional pricing and availability information for this purchase option.
{ # Regional pricing and availability configuration for a purchase option.
"availability": "A String", # The availability of the purchase option.
"price": { # Represents an amount of money with its currency type. # The price of the purchase option in the specified region. Must be set in the currency that is linked to the specified region.
"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.
},
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
},
],
"rentOption": { # A purchase option that can be rented. # A purchase option that can be rented.
"expirationPeriod": "A String", # Optional. The amount of time the user has after starting consuming the entitlement before it is revoked. Specified in ISO 8601 format.
"rentalPeriod": "A String", # Required. The amount of time a user has the entitlement for. Starts at purchase flow completion. Specified in ISO 8601 format.
},
"state": "A String", # Output only. The state of the purchase option, i.e., whether it's active. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time product purchase options. # Optional. Details about taxes and legal compliance.
"withdrawalRightType": "A String", # Optional. Digital content or service classification for products distributed to users in eligible regions. If unset, it defaults to `WITHDRAWAL_RIGHT_DIGITAL_CONTENT`. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
},
},
],
"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.
"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.
},
"restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this one-time product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
"regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
"A String",
],
},
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time products. # Details about taxes and legal compliance.
"isTokenizedDigitalAsset": True or False, # Whether this one-time product is declared as a product representing a tokenized digital asset.
"regionalTaxConfigs": [ # Regional tax configuration.
{ # Details about taxation in a given geographical region.
"eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States.
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
"streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
"taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
},
],
},
}</pre>
</div>
</body></html>
|