react-native-apple-ads-attribution

Fetches Apple attribution data via the AdServices API.

Requirements

• AdServices Framework
• React Native TurboModules (New Architecture) compatible

Installation

npm install @hexigames/react-native-apple-ads-attribution

Usage

import AppleAdsAttribution from "@hexigames/react-native-apple-ads-attribution";

const attributionData = await AppleAdsAttribution.getAttributionData();
const adServicesAttributionToken = await AppleAdsAttribution.getAdServicesAttributionToken();
const adServicesAttributionData = await AppleAdsAttribution.getAdServicesAttributionData();

Note from version 1.0 the above functions propagates errors, so they should be wrapped in try/catch.

Documentation

getAttributionData()

Gets install attribution data using the AdServices API (iOS 14.3+).
Throws error if data couldn't be retrieved (e.g. if user rejected permission for app tracking or AdServices is unavailable).

getAdServicesAttributionToken()

Generates a AdServices token valid for 24 hours that then can be used to request attribution data from Apples AdServices API, see https://developer.apple.com/documentation/adservices
Throws error if token couldn't be generated

Example

try {
  const adServicesAttributionToken = await AppleAdsAttribution.getAdServicesAttributionToken()
  console.log(adServicesAttributionToken) // -->
    // KG6LvapO97gCkOfUqi412/n8v8fu8AMTB.....
} catch (error) {
  const { message } = error
  console.log(message) // --> Some error message
}

getAdServicesAttributionData()

Generates a AdServices token and uses it to request attribution data from Apples AdServices API, see https://developer.apple.com/documentation/adservices
Throws error if data couldn't be fetched.

Example

try {
  const adServicesAttributionData = await AppleAdsAttribution.getAdServicesAttributionData()
  console.log(adServicesAttributionData) // -->
    // {
    //   "keywordId": 12323222,
    //   "campaignId": 1234567890,
    //   "conversionType": "Download",
    //   "creativeSetId": 1234567890,
    //   "orgId": 1234567890,
    //   "countryOrRegion": "US",
    //   "adGroupId": 1234567890,
    //   "clickDate": "2021-04-08T07:45Z",
    //   "attribution": true
    // }
} catch (error) {
  const { message } = error
  console.log(message) // --> Some error message
}

License

MIT