Digital Goods API 1.0 to 2.0 Migration Guide

getDigitalGoodsService() now rejects promises

Both DGAPI 1.0 and 2.0 use the async getDigitalGoodsService() method to retrieve the service object. In DGAPI 1.0, this method would return null if the given service URL is not supported. In DGAPI 2.0, the method throws an error instead.

In order to handle this change, use the following snippet to instantiate your service object:

if (window.getDigitalGoodsService === undefined) {
  // Digital Goods API is not supported in this context.
  return;
}

try {
  const service = await window.getDigitalGoodsService('https://play.google.com/billing');

  if (service === null) {
    // DGAPI 1.0
    // Play Billing is not available. Use another payment flow.
    return;
  }

  // Use the service here.
} catch (error) {
  // DGAPI 2.0
  // Play Billing is not available. Use another payment flow.
  return;
}

Introduced consume() for item consumption

In DGAPI 1.0, the acknowledgement and consumption of items that can be purchased multiple times is handled by calling the acknowledge() method with “repeatable” argument.

DGAPI 2.0 introduces the consume() method to mark such items as consumed.

If you offer consumable in-app purchases in your app, follow these steps:

1. Check if the DigitalGoodsService contains the acknowledge() method.
2. If yes, this means the client is running DGAPI 1.0 on Chrome 95 or earlier. Use the acknowledge() method to consume the item.
3. Otherwise, the client is running DGAPI 2.0 on Chrome 96 or later. Use the consume() method to consume the item.

Here’s a snippet:

if ('acknowledge' in service) {
  // DGAPI 1.0
  service.acknowledge(purchaseToken, 'repeatable');
} else {
  // DGAPI 2.0
  service.consume(purchaseToken);
}

Purchase acknowledgement moves to backend

DGAPI 2.0 removes the acknowledge() method. Purchase acknowledgement must be made instead on the backend using Google Play Developer API’s acknowledge methods.

If you currently acknowledge purchases on the client, follow these steps to move it to your backend:

1. Remove all references to the DGAPI acknowledge() method called with the 'onetime' purchase type in your web app.

service.acknowledge(purchaseToken, 'onetime');

2. Pass the purchaseToken and itemId to your backend.
3. On your backend, call:
   • purchases.products.acknowledge⁠ for in-app items.
   • purchases.subscriptions.acknowledge⁠ for subscriptions.

Entitlement must be granted by checking with backend

In DGAPI 1.0, the purchaseDetails object returned by the listPurchases() method includes the purchaseState field that can be used to determine whether to grant entitlements.

DGAPI 2.0 reduces the purchaseDetails object to contain only the purchaseToken and the itemId. Thus, you must grant entitlement to a purchase by checking with your backend instead.

Follow our guideline to verify purchases on your back-end server before granting entitlements to replace your client side code.