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
|
<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.purchases.html">purchases</a> . <a href="androidpublisher_v3.purchases.products.html">products</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#acknowledge">acknowledge(packageName, productId, token, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Acknowledges a purchase of an inapp item.</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="#consume">consume(packageName, productId, token, x__xgafv=None)</a></code></p>
<p class="firstline">Consumes a purchase for an inapp item.</p>
<p class="toc_element">
<code><a href="#get">get(packageName, productId, token, x__xgafv=None)</a></code></p>
<p class="firstline">Checks the purchase and consumption status of an inapp item.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="acknowledge">acknowledge(packageName, productId, token, body=None, x__xgafv=None)</code>
<pre>Acknowledges a purchase of an inapp item.
Args:
packageName: string, The package name of the application the inapp product was sold in (for example, 'com.some.thing'). (required)
productId: string, The inapp product SKU (for example, 'com.some.thing.inapp1'). (required)
token: string, The token provided to the user's device when the inapp product was purchased. (required)
body: object, The request body.
The object takes the form of:
{ # Request for the product.purchases.acknowledge API.
"developerPayload": "A String", # Payload to attach to the purchase.
}
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="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="consume">consume(packageName, productId, token, x__xgafv=None)</code>
<pre>Consumes a purchase for an inapp item.
Args:
packageName: string, The package name of the application the inapp product was sold in (for example, 'com.some.thing'). (required)
productId: string, The inapp product SKU (for example, 'com.some.thing.inapp1'). (required)
token: string, The token provided to the user's device when the inapp product was purchased. (required)
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, token, x__xgafv=None)</code>
<pre>Checks the purchase and consumption status of an inapp item.
Args:
packageName: string, The package name of the application the inapp product was sold in (for example, 'com.some.thing'). (required)
productId: string, The inapp product SKU (for example, 'com.some.thing.inapp1'). (required)
token: string, The token provided to the user's device when the inapp product was purchased. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A ProductPurchase resource indicates the status of a user's inapp product purchase.
"acknowledgementState": 42, # The acknowledgement state of the inapp product. Possible values are: 0. Yet to be acknowledged 1. Acknowledged
"consumptionState": 42, # The consumption state of the inapp product. Possible values are: 0. Yet to be consumed 1. Consumed
"developerPayload": "A String", # A developer-specified string that contains supplemental information about an order.
"kind": "A String", # This kind represents an inappPurchase object in the androidpublisher service.
"obfuscatedExternalAccountId": "A String", # An obfuscated version of the id that is uniquely associated with the user's account in your app. Only present if specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid when the purchase was made.
"obfuscatedExternalProfileId": "A String", # An obfuscated version of the id that is uniquely associated with the user's profile in your app. Only present if specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid when the purchase was made.
"orderId": "A String", # The order id associated with the purchase of the inapp product.
"productId": "A String", # The inapp product SKU. May not be present.
"purchaseState": 42, # The purchase state of the order. Possible values are: 0. Purchased 1. Canceled 2. Pending
"purchaseTimeMillis": "A String", # The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970).
"purchaseToken": "A String", # The purchase token generated to identify this purchase. May not be present.
"purchaseType": 42, # The type of purchase of the inapp product. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: 0. Test (i.e. purchased from a license testing account) 1. Promo (i.e. purchased using a promo code). Does not include Play Points purchases. 2. Rewarded (i.e. from watching a video ad instead of paying)
"quantity": 42, # The quantity associated with the purchase of the inapp product. If not present, the quantity is 1.
"refundableQuantity": 42, # The quantity eligible for refund, i.e. quantity that hasn't been refunded. The value reflects quantity-based partial refunds and full refunds.
"regionCode": "A String", # ISO 3166-1 alpha-2 billing region code of the user at the time the product was granted.
}</pre>
</div>
</body></html>
|