The following steps only set up subscription measurement within the Adjust SDK. To enable the feature, Adjust need to set up app-specific information. Contact support@adjust.com or talk to your Technical Account manager to set this up.
You can record App Store subscriptions and verify their validity with the Adjust SDK. After the user purchases a subscription, create an ADJSubscription instance containing the details.
1. Instantiate a subscription object
- (nullable id)initWithPrice:(nonnull NSDecimalNumber *)price currency:(nonnull NSString *)currency transactionId:(nonnull NSString *)transactionId andReceipt:(nonnull NSData *)receipt;To get started, you need to create a subscription object containing details of the subscription purchase. To do this, initialize an ADJSubscription object using the initWithPrice method. Pass the following arguments:
| Parameter | Data type | Description |
|---|---|---|
price | NSDecimalNumber | The price of the subscription |
currency | NSString | The currency of the subscription. Formatted as the currencyCode of the priceLocale object |
transactionId | NSString | Your ID for the transaction |
receipt | NSString | The receipt information |
let subscription = ADJSubscription( price: price, currency: currency, transactionId: transactionId, andReceipt: receipt)ADJSubscription *subscription = [[ADJSubscription alloc] initWithPrice:price currency:currency transactionId:transactionId andReceipt:receipt];Record the purchase date
- (void)setTransactionDate:(nonnull NSDate *)transactionDate;You can record the date on which the user purchased a subscription. The SDK returns this data for you to report on. Call the setTransactionDate method with a timestamp to record this information.
let subscription = ADJSubscription( price: price, currency: currency, transactionId: transactionId, andReceipt: receipt)// ...subscription.setTransactionDate(transactionDate)ADJSubscription *subscription = [[ADJSubscription alloc] initWithPrice:price currency:currency transactionId:transactionId andReceipt:receipt];/// ...[subscription setTransactionDate:transactionDate];Record the purchase region
- (void)setSalesRegion:(nonnull NSString *)salesRegion;You can record the region in which the user purchased a subscription. To do this, call the setSalesRegion method on your subscription object and pass the country code as an NSString. This needs to be formatted as the countryCode of the priceLocale object.
let subscription = ADJSubscription( price: price, currency: currency, transactionId: transactionId, andReceipt: receipt)// ...subscription.setSalesRegion(salesRegion)ADJSubscription *subscription = [[ADJSubscription alloc] initWithPrice:price currency:currency transactionId:transactionId andReceipt:receipt];/// ...[subscription setSalesRegion:salesRegion];Add callback parameters
- (void)addCallbackParameter:(nonnull NSString *)key value:(nonnull NSString *)value;You can add callback parameters to your subscription object. The SDK appends these parameters to your callback URL. To add callback parameters, call the addCallbackParameter method on your subscription object. You can add multiple callback parameters by calling this method multiple times.
let subscription = ADJSubscription( price: price, currency: currency, transactionId: transactionId, andReceipt: receipt)// ...subscription.addCallbackParameter("key1", value: "value1")subscription.addCallbackParameter("key2", value: "value2")ADJSubscription *subscription = [[ADJSubscription alloc] initWithPrice:price currency:currency transactionId:transactionId andReceipt:receipt];/// ...[subscription addCallbackParameter:@"key1" value:@"value1"];[subscription addCallbackParameter:@"key2" value:@"value2"];Add partner parameters
- (void)addPartnerParameter:(nonnull NSString *)key value:(nonnull NSString *)value;You can add partner parameters to your subscription object. The SDK sends these to Adjust’s servers when the user purchases a subscription. Adjust’s servers forward the information on to your network partner. To add partner parameters, call the addPartnerParameter method on your subscription object. You can add multiple partner parameters by calling this method multiple times.
let subscription = ADJSubscription( price: price, currency: currency, transactionId: transactionId, andReceipt: receipt)// ...subscription.addParameterParameter("key1", value: "value1")subscription.addParameterParameter("key2", value: "value2")ADJSubscription *subscription = [[ADJSubscription alloc] initWithPrice:price currency:currency transactionId:transactionId andReceipt:receipt];/// ...[subscription addParameterParameter:@"key1" value:@"value1"];[subscription addParameterParameter:@"key2" value:@"value2"];2. Send subscription information
+ (void)trackSubscription:(nonnull ADJSubscription *)subscription;Once you have set up your subscription object, you can send it to Adjust using the Adjust SDK. Pass your completed object to the trackSubscription method to record the user’s subscription purchase.
let subscription = ADJSubscription( price: price, currency: currency, transactionId: transactionId, andReceipt: receipt)
subscription.setTransactionDate(transactionDate)subscription.setSalesRegion(salesRegion)
// Add callback parameters
subscription.addCallbackParameter("key1", value: "value1")subscription.addCallbackParameter("key2", value: "value2")
// Add partner parameters
subscription.addPartnerParameter("key1", value: "value1")subscription.addCallbackParameter("key2", value: "value2")
Adjust.trackSubscription(subscription)ADJSubscription *subscription = [[ADJSubscription alloc] initWithPrice:price currency:currency transactionId:transactionId andReceipt:receipt];[subscription setTransactionDate:transactionDate];[subscription setSalesRegion:salesRegion];
/// Add callback parameters[subscription addCallbackParameter:@"key1" value:@"value1"];[subscription addCallbackParameter:@"key2" value:@"value2"];
/// Add partner parameters[subscription addPartnerParameter:@"key1" value:@"value1"];[subscription addPartnerParameter:@"key2" value:@"value2"];
[Adjust trackSubscription:subscription];