iOS Purchase verification migration guide

This guide shows you how to migrate from Adjust’s Purchase verification SDK to SDK v5’s built-in purchase verification features. The SDK v5 purchase verification workflow is a streamlined approach to purchase verification.

With the Purchase Verification SDK, verification is split into three steps:

1. Initialize the Purchase Verification SDK.

1
#import "AdjustPurchase.h"
2
// or #import <AdjustPurchaseSdk/AdjustPurchase.h>
3

4
NSString *yourAppToken = @"{YourAppToken}";
5
NSString *environment = ADJPEnvironmentSandbox;
6

7
ADJPConfig *config = [[ADJPConfig alloc] initWithAppToken:yourAppToken andEnvironment:environment];
8
[AdjustPurchase init:config];

2. Verify your purchase.

1
[AdjustPurchase verifyPurchase:receipt
2
                forTransaction:transaction
3
                     productId:@"product-id"
4
             withResponseBlock:^(ADJPVerificationInfo *info) {
5
    // process ADJPVerificationInfo object
6
}];

3. Depending on the outcome of the verification, configure an AdjustEvent object and send it to Adjust.

1
NSURL *receiptURL = [[NSBundle mainBundle] appStoreReceiptURL];
2
NSData *receipt = [NSData dataWithContentsOfURL:receiptURL];
3
ADJEvent *event = [ADJEvent eventWithEventToken::@"your-event-token"];
4
[event setRevenue:6.0 currency:@"EUR"];
5
[event setTransactionId:@"transaction-id"];
6
[event setProductId:@"product-id"];
7
[event setReceipt:receipt];
8
[Adjust trackEvent:event];

In SDK v5, this workflow is simplified. The [Adjust verifyAndTrackAppStorePurchase] method allows you to send an event to Adjust’s servers and receive the verification status as a callback. Adjust records the event and the verification status automatically.

Guide

Follow the steps in this guide to migrate from the Purchase Verification SDK to SDK v5 built-in purchase verification.

1. Uninstall the Purchase Verification SDK

To get started, uninstall the Adjust Purchase Verification SDK.

2. Remove Purchase Verification SDK code

Once you’ve uninstalled the Adjust Purchase Verification SDK, you must remove all Purchase Verification code from your project.

3. Migrate to SDK v5 purchase verification

Once you’ve removed the existing purchase verification code, you can replace it with SDK v5’s built-in purchase verification methods. There are two ways to verify purchases with the Adjust SDK:

1. Create an ADJEvent object that represents your purchase and add the following properties:
   • productId (NSString): The product identifier of the item that was successfully purchased.
   • transactionId (NSString): The ID of the transaction you want to verify.
2. Create an ADJAppStorePurchase object with your product ID, transaction ID, and receipt.

Record event and verify purchase

To send a revenue event for verification and listen for the purchase verification status, follow these steps:

1. Instantiate an ADJEvent object with the your event token and set the following parameters:
   • productId (NSString): The product identifier of the item that was successfully purchased.
   • transactionId (NSString): The ID of the transaction you want to verify.
2. Call the Adjust.verifyAndTrackPlayStorePurchase method with the following arguments:
   • event (ADJEvent): Your instantiated event object.
   • callback (ADJVerificationResultBlock): A delegate callback function that receives an ADJPurchaseVerificationResult object as an argument.

In this example, the purchase verification response is output to the logging daemon.

1
guard let event = ADJEvent(eventToken: "g3mfiw") else { return }
2
event.setProductId("product-id")
3
event.setTransactionId("transaction-id")
4

5
Adjust.verifyAndTrackAppStorePurchase(event) { verificationResult in
6
   print("Verification status: \(verificationResult.verificationStatus)")
7
   print("Code: \(verificationResult.code)")
8
   print("Message: \(verificationResult.message)")
9
}

1
ADJEvent *event = [[ADJEvent alloc] initWithEventToken:yourEventToken];
2
[event setProductId:@"product-id"];
3
[event setTransactionId:@"transaction-id"];
4

5
[Adjust verifyAndTrackAppStorePurchase:event withCompletionHandler:^(ADJPurchaseVerificationResult * _Nonnull verificationResult) {
6
      NSLog(@"Verification status: %@", verificationResult.verificationStatus);
7
      NSLog(@"Code: %d", verificationResult.code);
8
      NSLog(@"Message: %@", verificationResult.message);
9
}];

Only verify purchase

To send a standalone purchase and listen for the purchase verification status, follow these steps:

1. Instantiate an ADJAppStorePurchase with the following arguments:
   • transactionId (NSString): The ID of the transaction you want to verify.
   • productId (NSString): The product identifier of the item that was successfully purchased.
2. Call the Adjust.verifyAppStorePurchase method with the following arguments:
   • purchase (ADJAppStorePurchase): Your instantiated purchase object.
   • callback (ADJVerificationResultBlock): A delegate callback function that receives an ADJPurchaseVerificationResult object as an argument.

In this example, the purchase verification response is output to the logging daemon.

1
 guard let appStorePurchase = ADJAppStorePurchase(transactionId: yourTransactionId,
2
                                                         productId: yourProductId) else { return }
3

4
Adjust.verifyAppStorePurchase(appStorePurchase) { verificationResult in
5
   print("Verification status: \(verificationResult.verificationStatus)")
6
   print("Code: \(verificationResult.code)")
7
   print("Message: \(verificationResult.message)")
8
}

1
ADJAppStorePurchase *appStorePurchase = [[ADJAppStorePurchase alloc]
2
                                             initWithTransactionId:yourTranscationId
3
                                             productId:yourProductId];
4

5
[Adjust verifyAppStorePurchase:appStorePurchase withCompletionHandler:^(ADJPurchaseVerificationResult * _Nonnull verificationResult) {
6
     NSLog(@"Verification status: %@", verificationResult.verificationStatus);
7
     NSLog(@"Code: %d", verificationResult.code);
8
     NSLog(@"Message: %@", verificationResult.message);
9
}];