Sending in-app purchases on Android
Testing and manually sending purchase information
AppMetrica doesn't let you segment Revenue into “test” and “not test”. If you use the main API key for debugging purchases, the test purchases are included in general statistics. If you need to debug sending Revenue, use a reporter to send statistics to an additional API key. For more information about reporters, see Usage examples.
Step 1. Create a test app in AppMetrica
Specify the app parameters: link in the app store (if the app hasn't been published yet, leave the field empty), name, category, and time zone for generating reports.
To add another app, click Add app in the drop-down list in the AppMetrica interface.
Step 2. (Optional) Enable validation
Local validation with a public key is used to validate purchases on Android.
- In the Google interface, get a license key. For more information, see the Google documentation.
- In the AppMetrica interface, go to the app settings from the menu on the left.
- Go to the Revenue tab.
- Under Revenue validation for Google Play, enter the license key.
- Click Enable validation.
Step 3. Test sending Revenue
This section outlines the steps for sending Revenue to the additional API key:
To validate purchases on Android, configure sending the Revenue.Receipt instance along with the Revenue:
- Create the
Revenue.Receipt
instance with information about the purchase and signature. You must use it when creating theRevenue
instance in Revenue.Builder.withReceipt (Revenue.Receipt receipt). - Create the
Revenue
instance using the Revenue.Builder constructor. - Send the
Revenue
instance to the test API key using IReporter. For more information about reporters, see Usage examples.
void handlePurchase(Purchase purchase) { ... // Creating the Revenue.Receipt instance. // It is used for checking purchases in Google Play. Revenue.Receipt revenueReceipt = Revenue.Receipt.newBuilder() .withData(purchase.getOriginalJson()) .withSignature(purchase.getSignature()) .build(); // Creating the Revenue instance. Revenue revenue = Revenue.newBuilderWithMicros(99000000, Currency.getInstance("RUB")) .withProductID("com.yandex.service.299") .withQuantity(2) .withReceipt(revenueReceipt) .withPayload("{\"source\":\"Google Play\"}") .build(); // Sending the Revenue instance using reporter. YandexMetrica.getReporter(getApplicationContext(), "Testing API key").reportRevenue(revenue); }
Copied to clipboard
To send information about a purchase without validation:
- Create the Revenue instance using the Revenue.Builder constructor.
- (Optional) To group purchases, specify the OrderID in the Revenue.Builder.withPayload(String payload) method.Note. If the OrderID is not specified, AppMetrica generates the ID automatically.
- Send the
Revenue
instance to the test API key using IReporter. For more information about reporters, see Usage examples.
// Creating the Revenue instance. Revenue revenue = Revenue.newBuilderWithMicros(99000000, Currency.getInstance("RUB")) .withProductID("com.yandex.service.299") .withQuantity(2) // Passing the OrderID parameter in the .withPayload(String payload) method to group purchases. .withPayload("{\"OrderID\":\"Identifier\", \"source\":\"Google Play\"}") .build(); // Sending the Revenue instance using reporter. YandexMetrica.getReporter(getApplicationContext(), "Testing API key").reportRevenue(revenue);
Copied to clipboard
Step 4. Make sure that purchases are shown in reports.
- Make in-app test purchases.
Make sure that the Revenue report shows the same number of purchases and total revenue as the ones sent.
Information in the report may be missing if:
- Validation is enabled and the purchase failed.
- Information about the purchase wasn't sent.
If there is no data in the report, export all purchases using the Logs API resource:
If there are events in the export and the is_revenue_verified field is set to false, the purchases weren't validated.curl -X GET \ 'https://api.appmetrica.yandex.ru/logs/v1/export/revenue_events.json?application_id=1111&date_since=2018-10-10&date_until=2018-10-11&fields=revenue_order_id,revenue_quantity,revenue_price,revenue_currency,is_revenue_verified' \ -H 'Authorization: OAuth oauth_token'
Copied to clipboard
Step 5. Set up sending Revenue to the main API key
After debugging, repeat steps 2-4 for the main API key.
To send the Revenue
instance to the main API key, use the YandexMetrica.reportRevenue(Revenue revenue) method.
... // Sending the Revenue instance. YandexMetrica.reportRevenue(revenue);
Copied to clipboard