Purchase Connector

Prerequisites

iOS version 9 and higher.
Unity AppsFlyer plugin 6.15.3.
Unity version 2020.3 and higher.
Google Billing Play version 5.x.x and 6.x.x

To use the module with earlier Unity AppsFlyer plugin versions, check the previous versions of this module, for instance, v1.0.0 supports versions 6.8.1 and higher.

Adding The Connector To Your Project

Clone / download Purchase Connector repository.
Import appsflyer-unity-purchase-connector-x.x.x.unitypackage into your Unity project.
- Go to Assets >> Import Package >> Custom Package
- Select appsflyer-unity-adrepurchase-connector-x.x.x.unitypackage.

Note: You must have the AppsFlyer Unity plugin already in your project. In addition, make sure to init AppsFlyer SDK before Purchase Connector.

ProGuard Rules

Android Only - If you are using ProGuard, add the following keep rules to your proguard-rules.pro file:

-keep class com.appsflyer.** { *; }
-keep class kotlin.jvm.internal.Intrinsics{ *; }
-keep class kotlin.collections.**{ *; }

Strict Mode

The module supports a Strict Mode which completely removes the IDFA collection functionality and AdSupport framework dependencies. Use the Strict Mode when developing apps for kids, for example.
Make sure to use strict mode module with AppsFlyer Unity strict mode plugin.

Basic Integration

Note: before the implementation of the Purchase connector, please make sure to set up AppsFlyer appId and devKey

Set up Purchase Connector

Notes:

The AppsFlyerPurchaseConnector.init api initialized the connector for both iOS and Android. However, the store parameter is only for Android stores.

You only need to call the API AppsFlyerPurchaseConnector.init once with the android store as parameter and it will work for both platforms.

For now, the only Android store available is Google.

    using AppsFlyerSDK;
    using AppsFlyerConnector;

// Default SDK Implementation
   AppsFlyer.initSDK(devKey, appID, getConversionData ? this : null);

// Purchase connector implementation 
    AppsFlyerPurchaseConnector.init(this, AppsFlyerConnector.Store.GOOGLE);
    AppsFlyerPurchaseConnector.setIsSandbox(true);
    AppsFlyerPurchaseConnector.setAutoLogPurchaseRevenue(AppsFlyerAutoLogPurchaseRevenueOptions.AppsFlyerAutoLogPurchaseRevenueOptionsAutoRenewableSubscriptions, AppsFlyerAutoLogPurchaseRevenueOptions.AppsFlyerAutoLogPurchaseRevenueOptionsInAppPurchases);
    AppsFlyerPurchaseConnector.setPurchaseRevenueValidationListeners(true);
    AppsFlyerPurchaseConnector.build();

Log Auto-Renewable Subscriptions and In-App Purchases

Enables automatic logging of In-App purchases and Auto-renewable subscriptions.

AppsFlyerPurchaseConnector.setAutoLogPurchaseRevenue(AppsFlyerAutoLogPurchaseRevenueOptions.AppsFlyerAutoLogPurchaseRevenueOptionsAutoRenewableSubscriptions, AppsFlyerAutoLogPurchaseRevenueOptions.AppsFlyerAutoLogPurchaseRevenueOptionsInAppPurchases);

Note: if autoLogPurchaseRevenue has not been set, it is disabled by default. The value is an option set, so you can choose what kind of user purchases you want to observe.

Get purchase validation callback

In order to receive purchase validation event callbacks, you should conform to the purchase validation listener and implement both callbacks

AppsFlyerPurchaseConnector.setPurchaseRevenueValidationListeners(true);
/*  ... */

public void didReceivePurchaseRevenueValidationInfo(string validationInfo)
{
    AppsFlyer.AFLog("didReceivePurchaseRevenueValidationInfo", validationInfo);
    // deserialize the string as a dictionnary, easy to manipulate
    Dictionary<string, object> dictionary = AFMiniJSON.Json.Deserialize(validationInfo) as Dictionary<string, object>;

    // if the platform is Android, you can create an object from the dictionnary 
#if UNITY_ANDROID
    if (dictionary.ContainsKey("productPurchase") && dictionary["productPurchase"] != null)
    {
            // Create an object from the JSON string.
            InAppPurchaseValidationResult iapObject = JsonUtility.FromJson<InAppPurchaseValidationResult>(validationInfo);
    } 
    else if (dictionary.ContainsKey("subscriptionPurchase") && dictionary["subscriptionPurchase"] != null) 
    {
            SubscriptionValidationResult iapObject = JsonUtility.FromJson<SubscriptionValidationResult>(validationInfo);
    }
#endif
}

public void didReceivePurchaseRevenueError(string error)
{
    AppsFlyer.AFLog("didReceivePurchaseRevenueError", error);
    // Handle validation error
    Debug.LogError("Purchase validation failed: " + error);
}

Error Data Structure

The didReceivePurchaseRevenueError callback receives simple string messages on both platforms:

Android Error Structure:
On Android, the error callback receives simple string messages for network/connection failures:

"Connection timeout"

iOS Error Structure:
On iOS, the error callback receives the localized error description string:

"The purchase could not be validated"

Important Note:
Detailed validation failure information (like invalid purchase tokens) is sent to the success callback (didReceivePurchaseRevenueValidationInfo) with success: false, not to the error callback. The error callback is primarily for network/connection issues.

Validation Failure Example (sent to success callback):

{
  "success": false,
  "failureData": {
    "status": "INVALID_PURCHASE", 
    "description": "Purchase token is invalid or expired"
  }
}

Common Error Callback Scenarios:

Network Issues: Connection timeout or server unavailable
Configuration Issues: Incorrect initialization or setup problems

Validation Data Structure

The didReceivePurchaseRevenueValidationInfo callback receives JSON strings with different structures based on platform and purchase type:

Android - In-App Purchase Success:

{
  "token": "purchase_token_here",
  "success": "true",
  "productPurchase": {
    "productId": "com.example.product",
    "purchaseState": 1,
    "kind": "androidpublisher#productPurchase",
    "purchaseTimeMillis": "1640995200000",
    "consumptionState": 0,
    "orderId": "GPA.1234-5678-9012-34567",
    "purchaseType": 0,
    "acknowledgementState": 1,
    "purchaseToken": "token_here",
    "quantity": 1,
    "regionCode": "US"
  }
}

Android - Subscription Success:

{
  "productId": "com.example.subscription",
  "success": "true",
  "subscriptionPurchase": {
    "acknowledgementState": 1,
    "kind": "androidpublisher#subscriptionPurchase",
    "latestOrderId": "GPA.1234-5678-9012-34567",
    "regionCode": "US",
    "subscriptionState": 1,
    "startTime": "1640995200000",
    "lineItems": [
      {
        "productId": "com.example.subscription",
        "expiryTime": "1643673600000",
        "autoRenewingPlan": {
          "autoRenewEnabled": "true"
        },
        "offerDetails": {
          "basePlanId": "base-plan",
          "offerId": "offer-id"
        }
      }
    ]
  }
}

Android - Validation Failure:

{
  "success": "false",
  "failureData": {
    "status": "INVALID_PURCHASE",
    "description": "Purchase token is invalid or expired"
  }
}

iOS - Validation Success:
iOS validation data follows the native AppsFlyer iOS SDK format:

{
  "receipt-data": "base64_encoded_receipt",
  "price": "1.99",
  "currency": "USD",
  "transaction_id": "1000000123456789",
  "product_id": "com.example.product"
}

Important Notes

Callback Behavior:

Mutually Exclusive: Only one callback will be triggered per validation attempt - either didReceivePurchaseRevenueValidationInfo (success/detailed failure) or didReceivePurchaseRevenueError (network/connection issues).
Success Callback: didReceivePurchaseRevenueValidationInfo is called for both successful validations AND detailed validation failures (with success: false).
Error Callback: didReceivePurchaseRevenueError is called only for network issues, connection problems, or configuration errors.

When Each Callback is Triggered:

Success Callback → Purchase validated successfully OR validation failed with detailed error info
Error Callback → Network timeout, connection issues, or SDK configuration problems

Interface Implementation Required:
Your MonoBehaviour class must implement the IAppsFlyerPurchaseValidation interface to receive these callbacks:

public class YourScript : MonoBehaviour, IAppsFlyerPurchaseValidation
{
    // Both methods are required
    public void didReceivePurchaseRevenueValidationInfo(string validationInfo) { }
    public void didReceivePurchaseRevenueError(string error) { }
}

Start Observing Transactions

startObservingTransactions should be called to start observing transactions.

    AppsFlyerPurchaseConnector.startObservingTransactions();

Stop Observing Transactions

To stop observing transactions, you need to call stopObservingTransactions.

    AppsFlyerPurchaseConnector.stopObservingTransactions();

Note: if you called stopObservingTransactions API, you should set autoLogPurchaseRevenue value before you call startObservingTransactions next time.
Note: The Purchase Connector for Unity currently does not support adding Custom Parameters to purchase events

Testing the implementation in Sandbox

To set the sandbox environnment, you need to set isSandbox to true.

For iOS, it will allow you to test in Xcode environment on a real device with TestFlight sandbox account.

And for Android, it should be used while testing your Google Play Billing Library integration.

    AppsFlyerPurchaseConnector.setIsSandbox(true);

IMPORTANT NOTE: Before releasing your app to production please be sure to remove isSandbox or set it to false. If the production purchase event will be sent in sandbox mode, your event will not be validated properly!

Full Code Example

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using AppsFlyerSDK;
using UnityEngine.UI;
using AppsFlyerConnector;

void Start()
    { 
        AppsFlyer.initSDK(devKey, appID, getConversionData ? this : null);
        AppsFlyer.setIsDebug(isDebug);
        AppsFlyerPurchaseConnector.init(this, AppsFlyerConnector.Store.GOOGLE);
        AppsFlyerPurchaseConnector.setIsSandbox(true);
        AppsFlyerPurchaseConnector.setAutoLogPurchaseRevenue(AppsFlyerAutoLogPurchaseRevenueOptions.AppsFlyerAutoLogPurchaseRevenueOptionsAutoRenewableSubscriptions, AppsFlyerAutoLogPurchaseRevenueOptions.AppsFlyerAutoLogPurchaseRevenueOptionsInAppPurchases);
        AppsFlyerPurchaseConnector.setPurchaseRevenueValidationListeners(true);
        AppsFlyerPurchaseConnector.build();
        AppsFlyerPurchaseConnector.startObservingTransactions();
        AppsFlyer.startSDK();
    }

    public void didReceivePurchaseRevenueValidationInfo(string validationInfo)
    {
        AppsFlyer.AFLog("didReceivePurchaseRevenueValidationInfo", validationInfo);
    }

    public void didReceivePurchaseRevenueError(string error)
    {
        AppsFlyer.AFLog("didReceivePurchaseRevenueError", error);
        Debug.LogError("Purchase validation failed: " + error);
    }
}