com.android.vending.billing

Interface IInAppBillingService

All Superinterfaces:

android.os.IInterface

All Known Implementing Classes:

IInAppBillingService.Stub

public interface IInAppBillingService
extends android.os.IInterface

InAppBillingService is the service that provides in-app billing version 3 and beyond. This service provides the following features: 1. Provides a new API to get details of in-app items published for the app including price, type, title and description. 2. The purchase flow is synchronous and purchase information is available immediately after it completes. 3. Purchase information of in-app purchases is maintained within the Google Play system till the purchase is consumed. 4. An API to consume a purchase of an inapp item. All purchases of one-time in-app items are consumable and thereafter can be purchased again. 5. An API to get current purchases of the user immediately. This will not contain any consumed purchases. All calls will give a response code with the following possible values RESULT_OK = 0 - success RESULT_USER_CANCELED = 1 - user pressed back or canceled a dialog RESULT_BILLING_UNAVAILABLE = 3 - this billing API version is not supported for the type requested RESULT_ITEM_UNAVAILABLE = 4 - requested SKU is not available for purchase RESULT_DEVELOPER_ERROR = 5 - invalid arguments provided to the API RESULT_ERROR = 6 - Fatal error during the API action RESULT_ITEM_ALREADY_OWNED = 7 - Failure to purchase since item is already owned RESULT_ITEM_NOT_OWNED = 8 - Failure to consume since item is not owned

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IInAppBillingService.Stub Local-side IPC implementation stub class.

Method Summary

Methods

Modifier and Type	Method and Description
int	consumePurchase(int apiVersion, String packageName, String purchaseToken) Consume the last purchase of the given SKU.
android.os.Bundle	getBuyIntent(int apiVersion, String packageName, String sku, String type, String developerPayload) Returns a pending intent to launch the purchase flow for an in-app item by providing a SKU, the type, a unique purchase token and an optional developer payload.
android.os.Bundle	getPurchases(int apiVersion, String packageName, String type, String continuationToken) Returns the current SKUs owned by the user of the type and package name specified along with purchase information and a signature of the data to be validated.
android.os.Bundle	getSkuDetails(int apiVersion, String packageName, String type, android.os.Bundle skusBundle) Provides details of a list of SKUs Given a list of SKUs of a valid type in the skusBundle, this returns a bundle with a list JSON strings containing the productId, price, title and description.
int	isBillingSupported(int apiVersion, String packageName, String type) Checks support for the requested billing API version, package and in-app type.

Methods inherited from interface android.os.IInterface

asBinder

Method Detail

isBillingSupported

int isBillingSupported(int apiVersion,
                     String packageName,
                     String type)
                       throws android.os.RemoteException

Checks support for the requested billing API version, package and in-app type. Minimum API version supported by this interface is 3.

Parameters:

apiVersion - the billing version which the app is using

packageName - the package name of the calling app

type - type of the in-app item being purchased "inapp" for one-time purchases and "subs" for subscription.

Returns:

RESULT_OK(0) on success, corresponding result code on failures

Throws:

android.os.RemoteException

getSkuDetails

android.os.Bundle getSkuDetails(int apiVersion,
                              String packageName,
                              String type,
                              android.os.Bundle skusBundle)
                                throws android.os.RemoteException

Provides details of a list of SKUs Given a list of SKUs of a valid type in the skusBundle, this returns a bundle with a list JSON strings containing the productId, price, title and description. This API can be called with a maximum of 20 SKUs.

Parameters:

apiVersion - billing API version that the Third-party is using

packageName - the package name of the calling app

skusBundle - bundle containing a StringArrayList of SKUs with key "ITEM_ID_LIST"

Returns:

Bundle containing the following key-value pairs "RESPONSE_CODE" with int value, RESULT_OK(0) if success, other response codes on failure as listed above. "DETAILS_LIST" with a StringArrayList containing purchase information in JSON format similar to: '{ "productId" : "exampleSku", "type" : "inapp", "price" : "$5.00", "title : "Example Title", "description" : "This is an example description" }'

Throws:

android.os.RemoteException

getBuyIntent

android.os.Bundle getBuyIntent(int apiVersion,
                             String packageName,
                             String sku,
                             String type,
                             String developerPayload)
                               throws android.os.RemoteException

Returns a pending intent to launch the purchase flow for an in-app item by providing a SKU, the type, a unique purchase token and an optional developer payload.

Parameters:

apiVersion - billing API version that the app is using

packageName - package name of the calling app

sku - the SKU of the in-app item as published in the developer console

type - the type of the in-app item ("inapp" for one-time purchases and "subs" for subscription).

developerPayload - optional argument to be sent back with the purchase information

Returns:

Bundle containing the following key-value pairs "RESPONSE_CODE" with int value, RESULT_OK(0) if success, other response codes on failure as listed above. "BUY_INTENT" - PendingIntent to start the purchase flow The Pending intent should be launched with startIntentSenderForResult. When purchase flow has completed, the onActivityResult() will give a resultCode of OK or CANCELED. If the purchase is successful, the result data will contain the following key-value pairs "RESPONSE_CODE" with int value, RESULT_OK(0) if success, other response codes on failure as listed above. "INAPP_PURCHASE_DATA" - String in JSON format similar to '{"orderId":"12999763169054705758.1371079406387615", "packageName":"com.example.app", "productId":"exampleSku", "purchaseTime":1345678900000, "purchaseToken" : "122333444455555", "developerPayload":"example developer payload" }' "INAPP_DATA_SIGNATURE" - String containing the signature of the purchase data that was signed with the private key of the developer TODO: change this to app-specific keys.

Throws:

android.os.RemoteException

getPurchases

android.os.Bundle getPurchases(int apiVersion,
                             String packageName,
                             String type,
                             String continuationToken)
                               throws android.os.RemoteException

Returns the current SKUs owned by the user of the type and package name specified along with purchase information and a signature of the data to be validated. This will return all SKUs that have been purchased in V3 and managed items purchased using V1 and V2 that have not been consumed.

Parameters:

apiVersion - billing API version that the app is using

packageName - package name of the calling app

type - the type of the in-app items being requested ("inapp" for one-time purchases and "subs" for subscription).

continuationToken - to be set as null for the first call, if the number of owned skus are too many, a continuationToken is returned in the response bundle. This method can be called again with the continuation token to get the next set of owned skus.

Returns:

Bundle containing the following key-value pairs "RESPONSE_CODE" with int value, RESULT_OK(0) if success, other response codes on failure as listed above. "INAPP_PURCHASE_ITEM_LIST" - StringArrayList containing the list of SKUs "INAPP_PURCHASE_DATA_LIST" - StringArrayList containing the purchase information "INAPP_DATA_SIGNATURE_LIST"- StringArrayList containing the signatures of the purchase information "INAPP_CONTINUATION_TOKEN" - String containing a continuation token for the next set of in-app purchases. Only set if the user has more owned skus than the current list.

Throws:

android.os.RemoteException

consumePurchase

int consumePurchase(int apiVersion,
                  String packageName,
                  String purchaseToken)
                    throws android.os.RemoteException

Consume the last purchase of the given SKU. This will result in this item being removed from all subsequent responses to getPurchases() and allow re-purchase of this item.

Parameters:

apiVersion - billing API version that the app is using

packageName - package name of the calling app

purchaseToken - token in the purchase information JSON that identifies the purchase to be consumed

Returns:

0 if consumption succeeded. Appropriate error values for failures.

Throws:

android.os.RemoteException