On the GooglePlay and App Store platforms, the devtodev service allows you to collect payment and subscription information automatically. You do not need to integrate any special SDK events into your application, but you do need to enable the appropriate module during SDK initialization, and make a number of settings in your project in devtodev and on the GooglePlay and App Store platforms. You can read how to do this in this section.

The automatic payment tracking system will help you avoid errors when integrating manually submitted data using the Real Payment and Subscription events, and will also help you avoid fraudulent transaction data, as each transaction is additionally verified on the GooglePlay and App Store platforms before being recorded in the database.

SDK integration

To initialize the service, it is necessary to call the startAutoTracking method of the DTDPurchases interface. The method call should be made after SDK initialization call:

let config = DTDAnalyticsConfiguration()
DTDAnalytics.initialize(applicationKey: "App ID", configuration: config)
DTDPurchases.startAutoTracking()

DTDAnalyticsConfiguration *config;
[DTDAnalytics applicationKey:@"App ID" configuration:config];
[DTDPurchases startAutoTracking];

DTDAnalytics.Initialize(APPKey, new DTDAnalyticsConfiguration
{
  UserId = userId,
  ApplicationVersion = Application.version,
  CurrentLevel = lvl,
  LogLevel = DTDLogLevel.No,
  TrackingAvailability = DTDTrackingStatus.Enable
});
DTDPurchases.StartPurchasesService();

Subscription restore

Subscription renewals, cancellations, and other status changes are tracked using server-to-server data from the App Store platform, which requires the settings described in the following sections.

In order to be able to track status changes for subscriptions that were issued prior to the devtodev SDK integration, the history of subscriptions previously purchased by the user must be sent to devtodev.

The SDK keeps track of the need to send this historical data so that it does not make “unnecessary” requests to the App Store. Checking whether it is necessary to send data about previously purchased subscriptions to devtodev is done by the isRestoreTransactionHistoryRequired method. The method returns a BOOL value.

Here is an example of a purchase history request with the check of its necessity:

DTDAnalytics.isRestoreTransactionHistoryRequired { isNeedRestore in
  if isNeedRestore {
    DispatchQueue.main.async {
      SKPaymentQueue.default().restoreCompletedTransactions()
    }
  }
}

[DTDAnalytics isRestoreTransactionHistoryRequiredWithCompletionHandler:^(BOOL isNeedRestore){
  if (isNeedRestore == true) {
    dispatch_async(dispatch_get_main_queue(), ^{
      [SKPaymentQueue.defaultQueue restoreCompletedTransactions];
    });
  }
}];

if (Application.platform == RuntimePlatform.IPhonePlayer || Application.platform == RuntimePlatform.OSXPlayer)
{
  var apple = storeExtensionProvider.GetExtension<IAppleExtensions>();
  DTDAnalytics.IsRestoreTransactionHistoryRequired((required) =>
  {
    if(!required) return;
    apple.RestoreTransactions((success, text) =>
    {
      Debug.Log(success ? $"Purchases restored successfully on iOS." : $"{text}");
    });
  });
}

Settings on the App Store Connect side

To get detailed information about the transaction, devtodev requires access to the App Store Server API. To grant this access, you will need to generate an In-App Purchase API key.

Generating the key:

1. Authorize on App Store Connect

2. Navigate to the Users and Access section (pic. 1).

   
3. Select the "Integrations" tab, select "In-App Purchase" from the menu on the left, and click (+) add key (pic. 2).

   
4. Specify the name of the key for example: "devtodev API Key", and click "Generate" (pic. 3).

   
5. To grant the necessary access to the devtodev service, it is necessary to pass (pic. 4):

   1. Issuer ID

   2. Key ID

   3. The generated .p8 file of the In-App Purchase key.

   4. Bundle identifier of the application

   

Settings on devtodev side

1. Go to App Settings → Payments integration → IAP auto tracking → Integrate.

   
2. Fill in the integration form with the data obtained earlier

   • App Bundle ID

   • Issuer ID

   • Key ID

   • Upload the .p8 file of the In-App Purchase key.

   
3. When the integration is complete, the status will change to Active

   
4. In order for IAP auto tracking to work correctly with subscriptions, you need to integrate with App Store Server Notification. Go to Settings → Payments integration → Subscriptions → Integrate.

   
5. Fill in the iOS Bundle ID and copy the Endpoint URL

   
6. Navigate to App Store Connect. In the left column of the menu, under General, go to App information. Paste the copied endpoint URL into the Production Server URL and Sandbox Server URL fields.

   

SDK integration

To initialize the service, it is necessary to call the startAutoTracking method of the DTDPurchases interface. The method call should be made after SDK initialization call:

val config = DTDAnalyticsConfiguration()
DTDAnalytics.initialize("App ID", config, context)
DTDGooglePurchases.initialize(context)
DTDGooglePurchases.startAutoTracking()

DTDAnalyticsConfiguration config = new DTDAnalyticsConfiguration();
DTDAnalytics.INSTANCE.initialize(appKey, config, context);
DTDGooglePurchases.INSTANCE.initialize(context);
DTDGooglePurchases.INSTANCE.startAutoTracking();

DTDAnalytics.Initialize(APPKey, new DTDAnalyticsConfiguration
{
  UserId = userId,
  ApplicationVersion = Application.version,
  CurrentLevel = lvl,
  LogLevel = DTDLogLevel.No,
  TrackingAvailability = DTDTrackingStatus.Enable
});
DTDPurchases.StartAutoTracking();

Subscription restore

SDK will automatically restore the list of previously purchased subscriptions at the first launch of the autotracking service. No additional integration is required.

Settings in Google Cloud Platform Console

Google Play Android Developer API

1. Go to Google Cloud Console under your Google account. Select the project for which you want to configure Google Play Developer API. Then go to the APIs and services section.

1. Go to the Library section.

1. Find the Google Play Developer API section.

1. Press the ENABLE button.

Service account

To create a service account, click the link https://console.cloud.google.com/apis/credentials/serviceaccountkey

If you already have selected an active project, then skip the project selection block below.

1. Select the project that you will link to the service account and for which you will collect subscription data later. If the project is not listed, create it.

   
2. In the list of available service keys, click on the Create service account link.

   
3. In the provided free form, fill in the Service account name field, the Service Account ID field will be filled in automatically (use the screenshot below as an example) and click CREATE AND CONTINUE button.

   
4. Steps 2 and 3 are not needed, just click the Done button at the end of the form.

   
5. After creating a service account, you will be returned to the list of available accounts. Select the created account and open the KEYS tab, click the ADD KEY button, and then select the JSON option in the pop-up window. Confirm your choice by clicking the Create button. The generated private key file will be automatically downloaded. You will need to upload this key into the analysis connection forms. This will be explained in the following sections.

   
6. Go to the IAM section in the Permissions tab and click GRANT ACCESS to add roles to the service account in New principals section. In the appeared form, enter the service account address and give it the Pub/Sub Subscriber role. If you don’t have this role, you need to activate the Pub/Sub service in the Cloud Platform. Save the changes.

   

Pub/Sub service

Go to the list of topics in the Pub/Sub service https://console.cloud.google.com/cloudpubsub/topic/list

1. Select the project on which you want to collect subscription data if it is not selected yet, then click the CREATE TOPIC link and create a topic.

   
2. To do this, fill in the Topic ID (use the screenshot below as an example), disable Add a default subscription option and confirm the topic creation.

   
3. As shown in the example below, select from the pop-up menu View permissions.

   
4. Click on the button ADD PRINCIPAL.

   
5. Add the service account google-play-developer-notifications@system.gserviceaccount.com, and grant it the role of Pub/Sub Publisher. Save the changes.

   
6. After that, open the list of subscriptions and click CREATE SUBSCRIPTION.

   
7. In the appeared form, specify the Subscription ID in the field below Select a Cloud Pub/Sub topic specify the topic you’ve just created, in the Delivery type choose Push and in the Endpoint URL field insert the link obtained from the devtodev subscription integration window that described on the next session (Settings on devtodev side). All other parameters remain unchanged. Save the changes.

   
8. To get Endpoint URL go to devtodev, select the same app and open the app settings (Settings -> Payments integration -> Subscriptions). Click on the button Integrate.

   
9. In the next form copy the Endpoint URL.

   

Settings on devtodev side

1. Go to Settings → Payments integration → IAP auto tracking → Integrate.

   
2. Fill in the integration form with the data obtained earlier:

   • Android App ID

   • Upload the Private key file obtained in Step 1.

   Save changes

   
3. When the integration is complete, the status will change to Active

   

Settings in Google Play Console

Service account and User permissions

To set up user permission, you need to log into your Google Play Console account and invite your previously created service account.

1. Sign into the Google Play Developer Console.

   
2. In the Users and permissions section, you can add users and manage their permissions.

   • Click Users and permissions.

   • Click the Invite new users button.

     
3. Add Service Account

   • Put an email address for your service account in the email address field and grant the necessary rights to perform actions. How to create a service account see Step 1. Service account.

   • In the Permissions section select the apps this service account has access to. Click Apply. Grant permissions to individual apps, or use account permissions to grant access to all apps in your developer account.

     
4. You must grant the following permissions:

   • View app information

   • View app quality information

   • View financial data

   • Click on Apply button.

   Please note that the specified settings may not work immediately!

   
5. After creating a subscription in the Pub/Sub service, you'll need to register the created topic as a target for RTDN (Real-time developer notifications). To do this, go to the app’s Monetise with Play → Monetisation setup section and enter the full name of the topic in the Topic name field. After that, send a test notification using the link below. If everything is configured correctly, then the test notification will change the integration status of the Subscriptions in devtodev to Active.