blob: 7ccd6c5bf43b52db43d8af87782e30476f360e59 [file] [log] [blame]
<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="#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, &#x27;com.some.thing&#x27;). (required)
productId: string, The inapp product SKU (for example, &#x27;com.some.thing.inapp1&#x27;). (required)
token: string, The token provided to the user&#x27;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.
&quot;developerPayload&quot;: &quot;A String&quot;, # 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="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, &#x27;com.some.thing&#x27;). (required)
productId: string, The inapp product SKU (for example, &#x27;com.some.thing.inapp1&#x27;). (required)
token: string, The token provided to the user&#x27;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&#x27;s inapp
# product purchase.
&quot;consumptionState&quot;: 42, # The consumption state of the inapp product. Possible values are:
# 0. Yet to be consumed
# 1. Consumed
&quot;acknowledgementState&quot;: 42, # The acknowledgement state of the inapp product. Possible values are:
# 0. Yet to be acknowledged
# 1. Acknowledged
&quot;purchaseState&quot;: 42, # The purchase state of the order. Possible values are:
# 0. Purchased
# 1. Canceled
# 2. Pending
&quot;quantity&quot;: 42, # The quantity associated with the purchase of the inapp product.
&quot;obfuscatedExternalAccountId&quot;: &quot;A String&quot;, # An obfuscated version of the id that is uniquely associated with the
# user&#x27;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.
&quot;kind&quot;: &quot;A String&quot;, # This kind represents an inappPurchase object in the androidpublisher
# service.
&quot;purchaseToken&quot;: &quot;A String&quot;, # The purchase token generated to identify this purchase.
&quot;purchaseType&quot;: 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)
# 2. Rewarded (i.e. from watching a video ad instead of paying)
&quot;obfuscatedExternalProfileId&quot;: &quot;A String&quot;, # An obfuscated version of the id that is uniquely associated with the
# user&#x27;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.
&quot;orderId&quot;: &quot;A String&quot;, # The order id associated with the purchase of the inapp product.
&quot;productId&quot;: &quot;A String&quot;, # The inapp product SKU.
&quot;purchaseTimeMillis&quot;: &quot;A String&quot;, # The time the product was purchased, in milliseconds since the
# epoch (Jan 1, 1970).
&quot;developerPayload&quot;: &quot;A String&quot;, # A developer-specified string that contains supplemental
# information about an order.
}</pre>
</div>
</body></html>