Skip to main content

products

Overview

Nameproducts
TypeResource
Idgoogledevelopers.androidpublisher.products

Fields

NameDatatypeDescription
orderIdstringThe order id associated with the purchase of the inapp product.
productIdstringThe inapp product SKU. May not be present.
consumptionStateintegerThe consumption state of the inapp product. Possible values are: 0. Yet to be consumed 1. Consumed
quantityintegerThe quantity associated with the purchase of the inapp product. If not present, the quantity is 1.
regionCodestringISO 3166-1 alpha-2 billing region code of the user at the time the product was granted.
obfuscatedExternalProfileIdstringAn 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.
purchaseTimeMillisstringThe time the product was purchased, in milliseconds since the epoch (Jan 1, 1970).
purchaseTypeintegerThe 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)
developerPayloadstringA developer-specified string that contains supplemental information about an order.
kindstringThis kind represents an inappPurchase object in the androidpublisher service.
acknowledgementStateintegerThe acknowledgement state of the inapp product. Possible values are: 0. Yet to be acknowledged 1. Acknowledged
obfuscatedExternalAccountIdstringAn 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.
purchaseStateintegerThe purchase state of the order. Possible values are: 0. Purchased 1. Canceled 2. Pending
purchaseTokenstringThe purchase token generated to identify this purchase. May not be present.

Methods

NameAccessible byRequired ParamsDescription
purchases_products_getSELECTpackageName, productId, tokenChecks the purchase and consumption status of an inapp item.
purchases_products_acknowledgeEXECpackageName, productId, tokenAcknowledges a purchase of an inapp item.