Airbridge Expo SDK

https://help.airbridge.io/en/developers/expo-sdk-v4
Admin
The Airbridge Expo SDK is a software development kit that enables developers to integrate...
Tokens:14,057
Snippets:64
Trust Score:9.8
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install Airbridge Expo SDK

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Installs the necessary Airbridge SDK packages for Expo projects using npm. This includes the core Expo SDK and the React Native SDK.

```bash
npm install --save airbridge-expo-sdk
npm install --save airbridge-react-native-sdk
```

--------------------------------

### Track Start Trial Event

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Logs the initiation of a trial period, including a transaction ID, currency, the duration of the trial (e.g., 'P1M' for one month), and details of any associated products.

```javascript
import { Airbridge, AirbridgeCategory, AirbridgeAttribute } from 'airbridge-react-native-sdk'
...
Airbridge.trackEvent(
    AirbridgeCategory.START_TRIAL, 
    {
        [AirbridgeAttribute.TRANSACTION_ID]: 'ef1e5271-0370-407c-b1e9-669a8df1dc2c',
        [AirbridgeAttribute.CURRENCY]: 'USD',
        [AirbridgeAttribute.PERIOD]: 'P1M',
        [AirbridgeAttribute.PRODUCTS]: [
            {
                [AirbridgeAttribute.PRODUCT_ID]: '306a57cb-f653-4220-a208-8405d8e4d506',
                [AirbridgeAttribute.PRODUCT_NAME]: 'MusicStreamingMemebership',
                [AirbridgeAttribute.PRODUCT_PRICE]: 15,
                [AirbridgeAttribute.PRODUCT_CURRENCY]: 'USD',
            },
        ],
    },
)
```

--------------------------------

### Configure ATT Prompt Delay

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Details on configuring the delay for collecting install events in relation to the App Tracking Transparency (ATT) prompt on iOS. This ensures that user consent is obtained before collecting identifiers like IDFA, which is crucial for accurate performance measurement.

```APIDOC
ATT Prompt Configuration:

  Purpose:
    - To ensure compliance with privacy policies and accurately measure app installs by delaying event collection until the user provides consent via the App Tracking Transparency (ATT) prompt on iOS.

  Process:
    1. Prepare the text for the ATT prompt.
    2. Provide the ATT prompt following Apple's guidelines.
    3. Configure the `autoDetermineTrackingAuthorizationTimeoutInSecond` SDK setting to specify the delay.

  SDK Behavior:
    - If the install event is not collected, the Airbridge Expo SDK delays collecting install events for a specified duration (default 30 seconds) until the user allows tracking each time the app is launched.
    - If the user exits the app before deciding on tracking, the SDK will not collect the install event and will attempt again on the next app launch.

  Configuration Parameter:
    - `autoDetermineTrackingAuthorizationTimeoutInSecond`: number
      - Description: Sets a sufficient delay time for collecting install events. The default value is 30 seconds, and it can be set up to 3600 seconds (1 hour).
      - Importance: Setting an adequate delay is critical. If the SDK collects install events before users can allow tracking via the ATT prompt, the IDFA will not be collected along with the install events, hindering performance measurement.
      - Reference: [Configure ATT prompt](https://help.airbridge.io/en/developers/expo-sdk-v4#configure-att-prompt)

  Dependencies:
    - iOS environment.
    - User interaction with the App Tracking Transparency (ATT) prompt.

  Limitations:
    - The effectiveness relies on user consent through the ATT prompt.
    - Functions necessary for privacy compliance should be reviewed with legal counsel.

```

--------------------------------

### Get Attribution Results

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Retrieves attribution data for install events using the `Airbridge.setOnAttributionReceived` function. Note that attribution results may take time to become available and are not recommended for real-time processing. Data is passed based on the existence of attribution results.

```javascript
import { Airbridge } from 'airbridge-react-native-sdk'
...
Airbridge.setOnAttributionReceived((attribution) => {
    // when attribution is received
})
```

--------------------------------

### Airbridge SDK API Reference

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Documentation for key Airbridge SDK functions related to device alias and tracking management.

```APIDOC
Airbridge:
  setDeviceAlias(key: string, value: string)
    Description: Sends user consent data and user location data to the Airbridge SDK.
    Parameters:
      key: The Airbridge field name. Supported keys include 'eea', 'adPersonalization', 'adUserData'.
        - 'eea': Data indicating user location (EEA status). '0' for Non-EEA, '1' for EEA.
        - 'adPersonalization': User consent for ad personalization. '0' for not allowed, '1' for allowed.
        - 'adUserData': User consent for data sharing with Google. '0' for not allowed, '1' for allowed.
      value: The data value corresponding to the key.
    Returns: void

  startTracking()
    Description: Explicitly starts the Airbridge SDK tracking after consent data has been provided.
    Returns: void

  isSDKEnabled(): boolean
    Description: Checks if the Airbridge SDK is currently enabled.
    Returns: True if the SDK is enabled, false otherwise.

  enableSDK()
    Description: Enables all functions of the Airbridge SDK.
    Returns: void

  disableSDK()
    Description: Disables all functions of the Airbridge SDK.
    Returns: void
```

--------------------------------

### Track Tutorial Completion with Airbridge SDK

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

This snippet illustrates tracking the completion of a tutorial within your application. It uses the `COMPLETE_TUTORIAL` category and allows for an optional description to provide context.

```javascript
import { Airbridge, AirbridgeCategory, AirbridgeAttribute } from 'airbridge-react-native-sdk'
...
Airbridge.trackEvent(
    AirbridgeCategory.COMPLETE_TUTORIAL, 
    {
        [AirbridgeAttribute.DESCRIPTION]: 'Finish Initial Tutorial',
    },
)
```

--------------------------------

### Track Ad Click with Airbridge SDK

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

This example shows how to track an ad click event using the Airbridge SDK. It allows for detailed reporting of ad click data, including partner-specific information and revenue attribution.

```javascript
import { Airbridge, AirbridgeCategory, AirbridgeAttribute } from 'airbridge-react-native-sdk'
...
Airbridge.trackEvent(
    AirbridgeCategory.AD_CLICK, 
    {
        [AirbridgeAttribute.VALUE]: 0.1,
        [AirbridgeAttribute.AD_PARTNERS]: {
            'mopub': {
                'app_version': '5.18.0',
                'adunit_id': '12345',
                'adunit_name': '12345',
                'adunit_format': 'Banner',
                'id': '12345',
                'currency': 'USD',
                'publisher_revenue': 12345.123,
                'adgroup_id': '12345',
                'adgroup_name': '12345',
                'adgroup_type': '12345',
                'adgroup_priority': '12345',
                'country': 'kr',
                'precision': 'publisher_defined',
                'network_name': '12345',
                'network_placement_id': '12345',
                'demand_partner_data': '12345',
            },
        },
    },
)
```

--------------------------------

### Configure SDK Auto Start Tracking

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Disables automatic tracking upon SDK initialization. This is a configuration setting for the Airbridge SDK.

```json
{
    "autoStartTrackingEnabled": false
}
```

--------------------------------

### Track Level Achievement with Airbridge SDK

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

This example demonstrates tracking when a user achieves a new level in the application. It utilizes the `ACHIEVE_LEVEL` category and requires the `LEVEL` attribute to specify the achieved level number.

```javascript
import { Airbridge, AirbridgeCategory, AirbridgeAttribute } from 'airbridge-react-native-sdk'
...
Airbridge.trackEvent(
    AirbridgeCategory.ACHIEVE_LEVEL, 
    {
        [AirbridgeAttribute.LEVEL]: 13,
    },
)
```

--------------------------------

### Explicitly Start Airbridge Tracking

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

This JavaScript function call is used to explicitly start the Airbridge SDK tracking after user consent data has been stored, typically when `autoStartTrackingEnabled` is set to `false` in the SDK settings.

```javascript
// Explicitly start tracking
Airbridge.startTracking()
```

--------------------------------

### Airbridge SDK Configuration Schema

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Defines the structure for configuring Airbridge SDK settings in an airbridge.json file. This allows customization of tracking behavior, session management, and data collection parameters.

```json
{
    "sdkEnabled": boolean,
    "logLevel": "debug" | "info" | "warning" | "error" | "fault",
    "autoStartTrackingEnabled": boolean,
    "autoDetermineTrackingAuthorizationTimeoutInSecond": number,
    "trackMetaDeferredAppLinkEnabled": boolean,
    "sessionTimeoutInSecond": number,
    "metaInstallReferrerAppID": string,
    "trackAirbridgeDeeplinkOnlyEnabled": boolean,
    "trackInSessionLifecycleEventEnabled": boolean,
    "trackingLinkCustomDomains": [string],
    "hashUserInformationEnabled": boolean,
    "sdkSignatureID": string,
    "sdkSignatureSecret": string,
    "clearEventBufferOnInitializeEnabled": boolean,
    "eventBufferCountLimit": number,
    "eventBufferSizeLimitInGibibyte": number,
    "eventTransmitIntervalInSecond": number,
    "isHandleAirbridgeDeeplinkOnly": boolean,
    "collectTCFDataEnabled": boolean,
    "trackingBlocklist": [string]
}
```

--------------------------------

### Generate SHA256 Certificate Fingerprint

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Command to list certificate details from a keystore file, used to obtain the SHA256 fingerprint required for Android App Links.

```shell
keytool -list -v -keystore YOUR_KEYSTORE.keystore
```

--------------------------------

### Track Initiate Checkout Event

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Tracks the initiate checkout event, providing details about the transaction, currency, and products involved. This is crucial for understanding user intent before purchase.

```javascript
import { Airbridge, AirbridgeCategory, AirbridgeAttribute } from 'airbridge-react-native-sdk'
...
Airbridge.trackEvent(
    AirbridgeCategory.INITIATE_CHECKOUT, 
    {
        [AirbridgeAttribute.TRANSACTION_ID]: '0a7ee1ec-33da-4ffb-b775-89e80e75978a',
        [AirbridgeAttribute.CURRENCY]: 'USD',
        [AirbridgeAttribute.PRODUCTS]: [
            {
                [AirbridgeAttribute.PRODUCT_ID]: '0117b32a-5a6c-4d4c-b64c-7858e07dba78',
                [AirbridgeAttribute.PRODUCT_NAME]: 'PlasticHammer',
                [AirbridgeAttribute.PRODUCT_PRICE]: 10,
                [AirbridgeAttribute.PRODUCT_QUANTITY]: 1,
                [AirbridgeAttribute.PRODUCT_CURRENCY]: 'USD',
            },
            {
                [AirbridgeAttribute.PRODUCT_ID]: 'd6ab2fbe-decc-4362-b719-d257a131e91e',
                [AirbridgeAttribute.PRODUCT_NAME]: 'PlasticFork',
                [AirbridgeAttribute.PRODUCT_PRICE]: 1,
                [AirbridgeAttribute.PRODUCT_QUANTITY]: 1,
                [AirbridgeAttribute.PRODUCT_CURRENCY]: 'USD',
            },
        ],
    },
)
```

--------------------------------

### Track Share Event with Airbridge Expo SDK

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Tracks a sharing event, specifying the channel and a description. This helps in understanding user engagement with sharing features.

```javascript
import { Airbridge, AirbridgeCategory, AirbridgeAttribute } from 'airbridge-react-native-sdk'
...
Airbridge.trackEvent(
    AirbridgeCategory.SHARE, 
    {
        [AirbridgeAttribute.DESCRIPTION]: 'Share Promotion',
        [AirbridgeAttribute.SHARED_CHANNEL]: 'CopyLink',
    },
)
```

--------------------------------

### Track Standard and Custom Events

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Demonstrates how to track predefined standard events using `AirbridgeCategory` and custom events by providing event names directly to the `Airbridge.trackEvent` function.

```TypeScript
import { Airbridge, AirbridgeCategory } from 'airbridge-react-native-sdk'
...
// track standard event (provided by sdk)
Airbridge.trackEvent(AirbridgeCategory.ORDER_COMPLETED)
// track standard event (not provided by sdk)
Airbridge.trackEvent('airbridge.ecommerce.order.canceled')
// track custom event
Airbridge.trackEvent('eventViewed')
```

--------------------------------

### Manage User Data with Airbridge Expo SDK

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Provides methods to manage user identification and aliases for accurate ad performance measurement. This includes setting, clearing, and aliasing user identifiers.

```APIDOC
Airbridge User Data Management:

- `Airbridge.setUserID(userID: string)`
  - Description: Sets the primary user identifier for tracking.
  - Parameters:
    - `userID`: The unique identifier for the user (string).

- `Airbridge.clearUserID()`
  - Description: Deletes the currently set primary user identifier.

- `Airbridge.setUserAlias(key: string, value: string)`
  - Description: Adds or updates an additional user identifier (alias).
  - Parameters:
    - `key`: The alias key (string, max 128 characters, must start with a letter or underscore, followed by letters, numbers, or underscores: `^[a-zA-Z_][a-zA-Z0-9_]*$`).
    - `value`: The alias value (string, max 1024 characters).
  - Limitations: Up to 10 aliases can be added per user.

- `Airbridge.removeUserAlias(key: string)`
  - Description: Deletes a specific user alias by its key.
  - Parameters:
    - `key`: The key of the alias to remove (string).

- `Airbridge.clearUserAlias()`
  - Description: Deletes all additional user aliases for the current user.

Example Usage:
```javascript
import { Airbridge } from 'airbridge-react-native-sdk'
...
// Set primary user ID
Airbridge.setUserID('user12345');

// Clear primary user ID
Airbridge.clearUserID();

// Add an alias
Airbridge.setUserAlias('email', 'user@example.com');

// Remove a specific alias
Airbridge.removeUserAlias('email');

// Clear all aliases
Airbridge.clearUserAlias();
```
```

--------------------------------

### Airbridge SDK Consent and Location Tracking

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Collects user consent and location data using `Airbridge.setDeviceAlias` and starts tracking explicitly with `Airbridge.startTracking`. This method is used to send user consent preferences and location information to the Airbridge SDK.

```javascript
import { Airbridge } from 'airbridge-react-native-sdk'
...
// deliver informations to sdk using device alias
// based on actual region
Airbridge.setDeviceAlias('eea', '0' or '1')
// based on actual user consent
Airbridge.setDeviceAlias('adPersonalization', '0' or '1')
Airbridge.setDeviceAlias('adUserData', '0' or '1')

// Explicitly start tracking
Airbridge.startTracking()
```

--------------------------------

### Enable Opt-in Tracking with Airbridge Expo SDK

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Configure the Airbridge SDK for an opt-in tracking policy. Set `autoStartTrackingEnabled` to `false` and manually call `startTracking()` when user consent is obtained to begin event collection.

```javascript
import { Airbridge } from 'airbridge-react-native-sdk'
...
Airbridge.startTracking()
```

--------------------------------

### Configure Airbridge SDK Environment

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Sets the Airbridge SDK's operating environment by specifying a configuration file based on the AIRBRIDGE_ENVIRONMENT variable. This allows for different SDK settings across development, staging, and production builds.

```bash
# Set environment for development builds
$ AIRBRIDGE_ENVIRONMENT=development; npx expo run:android
$ AIRBRIDGE_ENVIRONMENT=development; npx expo run:ios

# Default behavior (if AIRBRIDGE_ENVIRONMENT is not specified)
# Uses airbridge.json in the root folder.
# $ npx expo run:android
```

--------------------------------

### Airbridge Expo SDK Configuration Settings

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Configuration parameters for the Airbridge Expo SDK, allowing customization of tracking, deep linking, session management, and event handling. These settings are typically applied during SDK initialization or via configuration objects.

```APIDOC
SDK Configuration Settings:

  sdkEnabled: boolean
    - Enables or disables all Airbridge SDK functions.
    - Reference: [Initialize the Airbridge SDK with all functions disabled](https://help.airbridge.io/en/developers/expo-sdk-v4#initialize-the-airbridge-sdk-with-all-functions-disabled)

  logLevel: string
    - Controls the verbosity of SDK logs. Possible values might include 'debug', 'info', 'warn', 'error'.
    - Reference: [SDK logs](https://help.airbridge.io/en/developers/expo-sdk-v4#sdk-logs)

  autoStartTrackingEnabled: boolean
    - Automatically starts tracking when the app launches.
    - Reference: [Opt-in setup](https://help.airbridge.io/en/developers/expo-sdk-v4#opt-in-setup), [Opt-out setup](https://help.airbridge.io/en/developers/expo-sdk-v4#opt-out-setup)

  autoDetermineTrackingAuthorizationTimeoutInSecond: number
    - Sets the delay time (in seconds) for collecting install events, allowing users to respond to the ATT prompt. Default is 30 seconds, max is 3600 seconds (1 hour).
    - Reference: [Configure ATT prompt](https://help.airbridge.io/en/developers/expo-sdk-v4#configure-att-prompt)

  trackMetaDeferredAppLinkEnabled: boolean
    - Enables or disables the tracking of Meta deferred app links.
    - Reference: [Set up Meta deferred app links](https://help.airbridge.io/en/developers/expo-sdk-v4#set-up-meta-deferred-app-links)

  sessionTimeoutInSecond: number
    - Configures the duration (in seconds) of an in-app event session.
    - Reference: [Configure in-app event sessions](https://help.airbridge.io/en/developers/expo-sdk-v4#configure-in-app-event-sessions)

  metaInstallReferrerAppID: string
    - Specifies the App ID for Meta Install Referrer collection.
    - Reference: [Set up Meta Install Referrer collection](https://help.airbridge.io/en/developers/expo-sdk-v4#set-up-meta-install-referrer-collection)

  trackAirbridgeDeeplinkOnlyEnabled: boolean
    - Enables tracking of only Airbridge Deep Links.
    - Reference: [Track only Airbridge Deep Links](https://help.airbridge.io/en/developers/expo-sdk-v4#track-only-airbridge-deep-links)

  trackInSessionLifecycleEventEnabled: boolean
    - Enables the collection of in-session lifecycle events.
    - Reference: [Collect in-session lifecycle events](https://help.airbridge.io/en/developers/expo-sdk-v4#collect-in-session-lifecycle-events)

  trackingLinkCustomDomains: string[]
    - An array of custom domains to be used for tracking links.
    - Reference: [Set up custom domain](https://help.airbridge.io/en/developers/expo-sdk-v4#set-up-custom-domain)

  hashUserInformationEnabled: boolean
    - Enables hashing of user information for privacy compliance.
    - Reference: [Hash user information](https://help.airbridge.io/en/developers/expo-sdk-v4#hash-user-information)

  sdkSignatureID: string
    - The ID component of the SDK Signature for authentication.
    - Reference: [SDK Signature](https://help.airbridge.io/en/developers/expo-sdk-v4#sdk-signature)

  sdkSignatureSecret: string
    - The secret component of the SDK Signature for authentication.
    - Reference: [SDK Signature](https://help.airbridge.io/en/developers/expo-sdk-v4#sdk-signature)

  clearEventBufferOnInitializeEnabled: boolean
    - Clears unsent in-app events from the buffer upon SDK initialization.
    - Reference: [Clear unsent in-app events](https://help.airbridge.io/en/developers/expo-sdk-v4#clear-unsent-in-app-events)

  eventBufferCountLimit: number
    - Sets the maximum number of events that can be stored in the in-app event buffer.
    - Reference: [Configure in-app event storage](https://help.airbridge.io/en/developers/expo-sdk-v4#configure-in-app-event-storage)

  eventBufferSizeLimitInGibibyte: number
    - Sets the maximum size (in GiB) for the in-app event storage buffer.
    - Reference: [Configure in-app event storage](https://help.airbridge.io/en/developers/expo-sdk-v4#configure-in-app-event-storage)

  eventTransmitIntervalInSecond: number
    - Configures the frequency (in seconds) at which events are transmitted from the buffer.
    - Reference: [Configure in-app event transmission frequency](https://help.airbridge.io/en/developers/expo-sdk-v4#configure-in-app-event-transmission-frequency)

  isHandleAirbridgeDeeplinkOnly: boolean
    - Configures the SDK to receive only Airbridge Deep Links.
    - Reference: [Receive Airbridge Deep Links only](https://help.airbridge.io/en/developers/expo-sdk-v4#receive-airbridge-deep-links-only)

  collectTCFDataEnabled: boolean
    - Enables or disables the collection of TCF (Transparency and Consent Framework) data for compliance with regulations like Google DMA.
    - Reference: [Compliance with Google DMA](https://help.airbridge.io/en/developers/expo-sdk-v4#compliance-with-google-dma)

```

--------------------------------

### Airbridge SDK Control Functions

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Provides methods to check the activation status of the Airbridge SDK and to enable or disable all its functions programmatically.

```javascript
import { Airbridge } from 'airbridge-react-native-sdk'
...
Airbridge.isSDKEnabled()
Airbridge.enableSDK()
Airbridge.disableSDK()
```

--------------------------------

### Track Sign Up Event (Airbridge RN SDK)

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Tracks the user sign-up event using the Airbridge SDK. This event is crucial for monitoring user acquisition and onboarding funnels. It requires the Airbridge SDK to be initialized and the user to have performed a sign-up action.

```javascript
import { Airbridge, AirbridgeCategory } from 'airbridge-react-native-sdk'

Airbridge.trackEvent(
    AirbridgeCategory.SIGN_UP,
)
```

--------------------------------

### Track Product View Event - Airbridge Expo SDK

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Tracks the PRODUCT_VIEWED event, used when a user views a specific product's detail page. Requires currency and product information to be passed.

```javascript
import { Airbridge, AirbridgeCategory, AirbridgeAttribute } from 'airbridge-react-native-sdk'
...
Airbridge.trackEvent(
    AirbridgeCategory.PRODUCT_VIEWED, 
    {
        [AirbridgeAttribute.CURRENCY]: 'USD',
        [AirbridgeAttribute.PRODUCTS]: [
            {
                [AirbridgeAttribute.PRODUCT_ID]: '0117b32a-5a6c-4d4c-b64c-7858e07dba78',
                [AirbridgeAttribute.PRODUCT_NAME]: 'PlasticHammer',
                [AirbridgeAttribute.PRODUCT_PRICE]: 10,
                [AirbridgeAttribute.PRODUCT_QUANTITY]: 1,
                [AirbridgeAttribute.PRODUCT_CURRENCY]: 'USD',
            },
        ],
    },
)
```

--------------------------------

### Track Rate Event with Airbridge Expo SDK

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Tracks a user's rating event, including product details and currency. This is useful for measuring user satisfaction with specific items or services.

```javascript
import { Airbridge, AirbridgeCategory, AirbridgeAttribute } from 'airbridge-react-native-sdk'
...
Airbridge.trackEvent(
    AirbridgeCategory.RATE, 
    {
        [AirbridgeAttribute.RATE_ID]: '531c64b3-4704-4780-a306-89014ec18daf',
        [AirbridgeAttribute.RATE]: 4.5,
        [AirbridgeAttribute.MAX_RATE]: 5,
        [AirbridgeAttribute.CURRENCY]: 'USD',
        [AirbridgeAttribute.PRODUCTS]: [
            {
                [AirbridgeAttribute.PRODUCT_ID]: '0117b32a-5a6c-4d4c-b64c-7858e07dba78',
                [AirbridgeAttribute.PRODUCT_NAME]: 'PlasticHammer',
                [AirbridgeAttribute.PRODUCT_PRICE]: 10,
                [AirbridgeAttribute.PRODUCT_CURRENCY]: 'USD',
            },
        ],
    },
)
```

--------------------------------

### Configure Expo app.json for Airbridge

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Configures the Airbridge Expo SDK as a plugin within the app.json file. This step is crucial for the Expo build process to recognize and integrate the SDK, requiring the app name and token.

```json
{
  "expo": {
    ...
    "plugins": [
      ...
      [
        "airbridge-expo-sdk",
        {
          "appName": "APP_NAME",
          "appToken": "APP_TOKEN"
        }
      ]
    ]
  }
}
```

--------------------------------

### Track Product List View Event (Airbridge RN SDK)

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Tracks the event when a list of products is viewed by the user. This snippet demonstrates how to include product details, currency, and list identifiers for richer analytics. It requires the Airbridge SDK to be initialized and product data.

```javascript
import { Airbridge, AirbridgeCategory, AirbridgeAttribute } from 'airbridge-react-native-sdk'

Airbridge.trackEvent(
    AirbridgeCategory.PRODUCT_LIST_VIEWED, 
    {
        [AirbridgeAttribute.LIST_ID]: '84e6e236-38c4-48db-9b49-16e4cc064386',
        [AirbridgeAttribute.CURRENCY]: 'USD',
        [AirbridgeAttribute.PRODUCTS]: [
            {
                [AirbridgeAttribute.PRODUCT_ID]: '0117b32a-5a6c-4d4c-b64c-7858e07dba78',
                [AirbridgeAttribute.PRODUCT_NAME]: 'PlasticHammer',
                [AirbridgeAttribute.PRODUCT_PRICE]: 10,
                [AirbridgeAttribute.PRODUCT_QUANTITY]: 1,
                [AirbridgeAttribute.PRODUCT_CURRENCY]: 'USD',
            },
            {
                [AirbridgeAttribute.PRODUCT_ID]: 'd6ab2fbe-decc-4362-b719-d257a131e91e',
                [AirbridgeAttribute.PRODUCT_NAME]: 'PlasticFork',
                [AirbridgeAttribute.PRODUCT_PRICE]: 1,
                [AirbridgeAttribute.PRODUCT_QUANTITY]: 1,
                [AirbridgeAttribute.PRODUCT_CURRENCY]: 'USD',
            },
        ],
    },
)
```

--------------------------------

### Airbridge SDK Semantic Attributes Reference

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Provides a comprehensive list of semantic attributes supported by the Airbridge SDK for enriching event data. Each attribute is mapped to its corresponding data type for clear usage.

```APIDOC
AirbridgeAttribute:
  ACTION: string
  LABEL: string
  VALUE: float
  CURRENCY: string
  PRODUCTS: array
  PRODUCT_ID: string
  PRODUCT_NAME: string
  PRODUCT_PRICE: float
  PRODUCT_QUANTITY: int
  PRODUCT_CURRENCY: string
  PRODUCT_POSITION: int
  PRODUCT_CATEGORY_ID: string
  PRODUCT_CATEGORY_NAME: string
  PRODUCT_BRAND_ID: string
  PRODUCT_BRAND_NAME: string
  PERIOD: string
  IS_RENEWAL: boolean
  RENEWAL_COUNT: int
  PRODUCT_LIST_ID: string
  CART_ID: string
  TRANSACTION_ID: string
  TRANSACTION_TYPE: string
  TRANSACTION_PAIRED_EVENT_CATEGORY: string
  TRANSACTION_PAIRED_EVENT_TIMESTAMP: int
  TOTAL_QUANTITY: int
  QUERY: string
  IN_APP_PURCHASED: boolean
  CONTRIBUTION_MARGIN: float
  LIST_ID: string
  RATE_ID: string
  RATE: float
  MAX_RATE: float
  ACHIEVEMENT_ID: string
  SHARED_CHANNEL: string
  DATE_TIME: string
  DESCRIPTION: string
  IS_REVENUE: boolean
  PLACE: string
  SCHEDULE_ID: string
  TYPE: string
  LEVEL: string
  SCORE: float
  AD_PARTNERS: array
  IS_FIRST_PER_USER: boolean
```

--------------------------------

### Track Add to Wishlist Event - Airbridge Expo SDK

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Tracks the ADD_TO_WISHLIST event when a user adds a product to their wishlist. This event includes the list ID, currency, and detailed product information.

```javascript
import { Airbridge, AirbridgeCategory, AirbridgeAttribute } from 'airbridge-react-native-sdk'
...
Airbridge.trackEvent(
    AirbridgeCategory.ADD_TO_WISHLIST, 
    {
        [AirbridgeAttribute.LIST_ID]: '189a2f8b-83ee-4074-8158-726be54e57d4',
        [AirbridgeAttribute.CURRENCY]: 'USD',
        [AirbridgeAttribute.PRODUCTS]: [
            {
                [AirbridgeAttribute.PRODUCT_ID]: '0117b32a-5a6c-4d4c-b64c-7858e07dba78',
                [AirbridgeAttribute.PRODUCT_NAME]: 'PlasticHammer',
                [AirbridgeAttribute.PRODUCT_PRICE]: 10,
                [AirbridgeAttribute.PRODUCT_QUANTITY]: 1,
                [AirbridgeAttribute.PRODUCT_CURRENCY]: 'USD',
            },
        ],
    },
)
```

--------------------------------

### Airbridge SDK In-App Event Configuration

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Details configuration options for managing in-app events within the Airbridge SDK. This includes setting session timeouts, adjusting event transmission frequency, and defining storage limits.

```APIDOC
SDK Settings:

setSessionTimeout(timeoutInSeconds: number):
  - Configures the session timeout duration for in-app events.
  - Default: 300 seconds (5 minutes).
  - Maximum: 604,800 seconds (7 days).

setEventTransmitInterval(intervalInSeconds: number):
  - Sets the frequency for transmitting batched events.
  - Default: 0 seconds (immediate transmission).
  - Maximum: 86,400 seconds (1 day).

eventBufferCountLimit(limit: number):
  - Limits the maximum number of events stored locally by the SDK.
  - Default: INT_MAX.

eventBufferSizeLimitInGibibyte(limitInGibibyte: number):
  - Limits the maximum storage size (in GiB) for events stored locally.
  - Default: 1024 GiB.
```

--------------------------------

### Track Home Screen View Event (Airbridge RN SDK)

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Tracks the event when the user views the home screen of the application. This helps in analyzing user entry points and engagement with the main interface. It requires the Airbridge SDK to be initialized.

```javascript
import { Airbridge, AirbridgeCategory } from 'airbridge-react-native-sdk'

Airbridge.trackEvent(
    AirbridgeCategory.HOME_VIEWED,
)
```

--------------------------------

### Airbridge Clear User Data

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Resets all user-specific information tracked by the Airbridge SDK. This function is useful for clearing all previously set user identifiers and attributes.

```APIDOC
Airbridge.clearUser()
  - Resets all user information, including email, phone, and attributes.
```

```javascript
import { Airbridge } from 'airbridge-react-native-sdk';

Airbridge.clearUser();
```

--------------------------------

### Device ID Management API

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Provides methods to manage device identifiers (aliases) for event transmission. These methods allow adding, removing, or clearing custom device identifiers associated with events.

```APIDOC
Airbridge SDK Device ID Management:

`Airbridge.setDeviceAlias(key: String, value: String)`
  - Adds additional device identifiers. Up to 10 identifiers can be entered.
  - Parameters:
    - key: Up to 128 characters. Must satisfy the regular expression `^[a-zA-Z_][a-zA-Z0-9_]*$`.
    - value: Up to 128 characters.

`Airbridge.removeDeviceAlias(key: String)`
  - Deletes only specified device identifiers.
  - Parameters:
    - key: The key of the device alias to remove.

`Airbridge.clearDeviceAlias()`
  - Deletes all device identifiers.

Example Usage:
```javascript
import { Airbridge } from 'airbridge-react-native-sdk'
...
Airbridge.setDeviceAlias('string', 'string')
Airbridge.removeDeviceAlias('string')
Airbridge.clearDeviceAlias()
```
```

--------------------------------

### Track Ad Impression with Airbridge SDK

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

This snippet demonstrates how to track an ad impression event using the Airbridge SDK. It includes details for ad partners like MoPub, specifying parameters such as ad unit ID, revenue, and country.

```javascript
import { Airbridge, AirbridgeCategory, AirbridgeAttribute } from 'airbridge-react-native-sdk'
...
Airbridge.trackEvent(
    AirbridgeCategory.AD_IMPRESSION, 
    {
        [AirbridgeAttribute.VALUE]: 0.01,
        [AirbridgeAttribute.AD_PARTNERS]: {
            'mopub': {
                'app_version': '5.18.0',
                'adunit_id': '12345',
                'adunit_name': '12345',
                'adunit_format': 'Banner',
                'id': '12345',
                'currency': 'USD',
                'publisher_revenue': 12345.123,
                'adgroup_id': '12345',
                'adgroup_name': '12345',
                'adgroup_type': '12345',
                'adgroup_priority': '12345',
                'country': 'kr',
                'precision': 'publisher_defined',
                'network_name': '12345',
                'network_placement_id': '12345',
                'demand_partner_data': '12345',
            },
        },
    },
)
```

--------------------------------

### Track Custom Events with Airbridge Expo SDK

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Tracks custom events defined by users to monitor unique service actions. This allows for flexible tracking of any user behavior not covered by predefined event categories.

```javascript
import { Airbridge, AirbridgeAttribute } from 'airbridge-react-native-sdk'
...
Airbridge.trackEvent(
    'event',
    {
        [AirbridgeAttribute.VALUE]: 10,
    },
    {
        'string': 'string',
        'number': 1000,
        'boolean': true,
        'object': {'key': 'value'},
        'array': ['value'],
    },
)
```

--------------------------------

### Unattributed Result JSON

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

This JSON object is passed to the callback when no attribution result is found for the app. It indicates an 'unattributed' status and is sent after the app is relaunched at least 3 hours post-initialization.

```json
{
    "attributedChannel": "unattributed"
}
```

--------------------------------

### Track Credit Use Event with Airbridge Expo SDK

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Tracks the spending of credits, including transaction details, currency, and products involved. This is crucial for analyzing credit-based transactions and user spending habits.

```javascript
import { Airbridge, AirbridgeCategory, AirbridgeAttribute } from 'airbridge-react-native-sdk'
...
Airbridge.trackEvent(
    AirbridgeCategory.SPEND_CREDITS, 
    {
        [AirbridgeAttribute.TRANSACTION_ID]: '22eb193d-be11-4fe4-95da-c91a196faf1c',
        [AirbridgeAttribute.CURRENCY]: 'USD',
        [AirbridgeAttribute.PRODUCTS]: [
            {
                [AirbridgeAttribute.PRODUCT_ID]: '0117b32a-5a6c-4d4c-b64c-7858e07dba78',
                [AirbridgeAttribute.PRODUCT_NAME]: 'PlasticHammer',
                [AirbridgeAttribute.PRODUCT_PRICE]: 10,
                [AirbridgeAttribute.PRODUCT_CURRENCY]: 'USD',
            },
        ],
    },
)
```

--------------------------------

### Airbridge SDK In-App Event Tracking

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Provides details on sending in-app events using the Airbridge SDK. The `trackEvent` method allows logging user actions with optional semantic and custom attributes for analytics.

```APIDOC
Airbridge.trackEvent

Overloads:
static trackEvent(category: string): void
static trackEvent(category: string, semanticAttributes: Record<string, any>): void
static trackEvent(category: string, semanticAttributes: Record<string, any>, customAttributes: Record<string, any>): void

Parameters:
- category: Required. string. The name of the event.
- semanticAttributes: Optional. Record<string, any>. Semantic attributes of the events.
- customAttributes: Optional. Record<string, any>. Custom attributes of the event.

Description:
Collects user actions from the app as in-app events and sends them to Airbridge based on the configured settings. The method supports different overloads to include varying levels of event detail.
```

--------------------------------

### Track Order Completed Event

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Logs an order completion event, including the total transaction value, currency, transaction ID, and detailed product information. It also flags the purchase as an in-app purchase.

```javascript
import { Airbridge, AirbridgeCategory, AirbridgeAttribute } from 'airbridge-react-native-sdk'
...
Airbridge.trackEvent(
    AirbridgeCategory.ORDER_COMPLETED, 
    {
        [AirbridgeAttribute.VALUE]: 11,
        [AirbridgeAttribute.TRANSACTION_ID]: '8065ef16-162b-4a82-b683-e51aefdda7d5',
        [AirbridgeAttribute.CURRENCY]: 'USD',
        [AirbridgeAttribute.IN_APP_PURCHASED]: true,
        [AirbridgeAttribute.PRODUCTS]: [
            {
                [AirbridgeAttribute.PRODUCT_ID]: '0117b32a-5a6c-4d4c-b64c-7858e07dba78',
                [AirbridgeAttribute.PRODUCT_NAME]: 'PlasticHammer',
                [AirbridgeAttribute.PRODUCT_PRICE]: 10,
                [AirbridgeAttribute.PRODUCT_QUANTITY]: 1,
                [AirbridgeAttribute.PRODUCT_CURRENCY]: 'USD',
            },
            {
                [AirbridgeAttribute.PRODUCT_ID]: 'd6ab2fbe-decc-4362-b719-d257a131e91e',
                [AirbridgeAttribute.PRODUCT_NAME]: 'PlasticFork',
                [AirbridgeAttribute.PRODUCT_PRICE]: 1,
                [AirbridgeAttribute.PRODUCT_QUANTITY]: 1,
                [AirbridgeAttribute.PRODUCT_CURRENCY]: 'USD',
            },
        ],
    },
)
```

--------------------------------

### Enable Clearing Unsent Events on Init

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Configures the Airbridge SDK to clear any unsent in-app events upon initialization when the event deletion option is activated. This is controlled by the `setClearEventBufferOnInitializeEnabled` setting.

```Swift
import Airbridge
...
let option = AirbridgeOptionBuilder(name: "YOUR_APP_NAME", token: "YOUR_APP_TOKEN")
    .setClearEventBufferOnInitializeEnabled(true)
    .build()
Airbridge.initializeSDK(option: option)
```

```Objective-C
#import <Airbridge/Airbridge>
...
AirbridgeOptionBuilder* optionBuilder = [[AirbridgeOptionBuilder alloc] initWithName:@"YOUR_APP_NAME"
                                                                               token:@"YOUR_APP_TOKEN"];
[optionBuilder setClearEventBufferOnInitializeEnabled:YES];
AirbridgeOption* option = [optionBuilder build];
[Airbridge initializeSDKWithOption:option]
```

--------------------------------

### Track Task/Achievement Unlock with Airbridge SDK

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

This snippet shows how to track the unlocking of an achievement or completion of a task. It uses the `UNLOCK_ACHIEVEMENT` category and supports attributes like `ACHIEVEMENT_ID`, `DESCRIPTION`, and `SCORE`.

```javascript
import { Airbridge, AirbridgeCategory, AirbridgeAttribute } from 'airbridge-react-native-sdk'
...
Airbridge.trackEvent(
    AirbridgeCategory.UNLOCK_ACHIEVEMENT, 
    {
        [AirbridgeAttribute.ACHIEVEMENT_ID]: '36a0f0bb-b153-4be1-a3e0-3cb5b2b076c1',
        [AirbridgeAttribute.DESCRIPTION]: 'Get Score Over 50',
        [AirbridgeAttribute.SCORE]: 80,
    },
)
```

--------------------------------

### Enable Opt-out Tracking with Airbridge Expo SDK

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Configure the Airbridge SDK for an opt-out tracking policy. Set `autoStartTrackingEnabled` to `true` and call `stopTracking()` when users explicitly decline to cease event collection.

```javascript
import { Airbridge } from 'airbridge-react-native-sdk'
...
Airbridge.stopTracking()
```

--------------------------------

### Track Sign In Event (Airbridge RN SDK)

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Tracks the user sign-in event using the Airbridge SDK. This event helps in understanding user engagement and session frequency. It requires the Airbridge SDK to be initialized and the user to have successfully logged in.

```javascript
import { Airbridge, AirbridgeCategory } from 'airbridge-react-native-sdk'

Airbridge.trackEvent(
    AirbridgeCategory.SIGN_IN,
)
```

--------------------------------

### Expo App Configuration for Deep Linking

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Configuration within the app.json file to enable app launch with Airbridge Deep Links. This includes setting the custom URI scheme and configuring associated domains for both Android intent filters and iOS associated domains.

```json
{
  "expo": {
    "...": "...",
    "scheme": "YOUR_SCHEME",
    "android": {
      "...": "...",
      "intentFilters": [
        {
          "autoVerify": true,
          "action": "VIEW",
          "data": { "scheme": "https", "host": "APP_NAME.airbridge.io" },
          "category": ["BROWSABLE", "DEFAULT"]
        },
        {
          "autoVerify": true,
          "action": "VIEW",
          "data": { "scheme": "https", "host": "APP_NAME.abr.ge" },
          "category": ["BROWSABLE", "DEFAULT"]
        },
        {
          "autoVerify": true,
          "action": "VIEW",
          "data": { "scheme": "http", "host": "APP_NAME.airbridge.io" },
          "category": ["BROWSABLE", "DEFAULT"]
        },
        {
          "autoVerify": true,
          "action": "VIEW",
          "data": { "scheme": "http", "host": "APP_NAME.abr.ge" },
          "category": ["BROWSABLE", "DEFAULT"]
        }
      ]
    },
    "ios": {
      "...": "...",
      "associatedDomains": [
        "applinks:APP_NAME.airbridge.io",
        "applinks:APP_NAME.abr.ge"
      ]
    }
  }
}
```

--------------------------------

### Track Add to Cart Event - Airbridge Expo SDK

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Tracks the ADDED_TO_CART event when a user adds an item to their shopping cart. This event requires a cart ID, currency, and product details.

```javascript
import { Airbridge, AirbridgeCategory, AirbridgeAttribute } from 'airbridge-react-native-sdk'
...
Airbridge.trackEvent(
    AirbridgeCategory.ADDED_TO_CART, 
    {
        [AirbridgeAttribute.CART_ID]: '421eaeb7-6e80-4694-933e-f2e1a55e9cbd',
        [AirbridgeAttribute.CURRENCY]: 'USD',
        [AirbridgeAttribute.PRODUCTS]: [
            {
                [AirbridgeAttribute.PRODUCT_ID]: '0117b32a-5a6c-4d4c-b64c-7858e07dba78',
                [AirbridgeAttribute.PRODUCT_NAME]: 'PlasticHammer',
                [AirbridgeAttribute.PRODUCT_PRICE]: 10,
                [AirbridgeAttribute.PRODUCT_QUANTITY]: 1,
                [AirbridgeAttribute.PRODUCT_CURRENCY]: 'USD',
            },
        ],
    },
)
```

--------------------------------

### Configure Custom Domain Settings

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Configures custom domain addresses for Airbridge tracking links within the SDK settings. This requires matching configuration in the Airbridge dashboard to ensure custom domains are correctly used for tracking links.

```json
{
    "trackingLinkCustomDomains": ["YOUR_APP_CUSTOM_DOMAIN"]
}
```

--------------------------------

### Track Schedule Reservation Event with Airbridge Expo SDK

Source: https://help.airbridge.io/en/developers/expo-sdk-v4/index

Tracks a schedule reservation event, including details like schedule ID, date, time, place, and associated products. This is useful for tracking booking or appointment-related actions.

```javascript
import { Airbridge, AirbridgeCategory, AirbridgeAttribute } from 'airbridge-react-native-sdk'
...
Airbridge.trackEvent(
    AirbridgeCategory.SCHEDULE, 
    {
        [AirbridgeAttribute.SCHEDULE_ID]: '75712915-2cd9-4e42-a85e-8d42f356f4c6',
        [AirbridgeAttribute.DATE_TIME]: '2024-01-01T00:00:00+00:00',
        [AirbridgeAttribute.PLACE]: 'ConferenceRoom',
        [AirbridgeAttribute.PRODUCTS]: [
            {
                [AirbridgeAttribute.PRODUCT_ID]: 'abb3e65d-17bc-4b28-89e3-5e356c0ea697',
                [AirbridgeAttribute.PRODUCT_NAME]: 'ConferenceRoom',
            },
        ],
    },
)
```
Tokens:
Raw