Interface Airbridge

interface Airbridge {
    init(options: InitializeOptions): void;
    init(
        options: InitializeOptions,
        callback: (error?: unknown, airbridge?: Airbridge) => void,
    ): void;
    startTracking(): void;
    stopTracking(): void;
    fetchResource(callback: (resource: FetchResourceResponse) => void): void;
    setUserID(userID: string): void;
    clearUserID(): void;
    setUserEmail(userEmail: string): void;
    clearUserEmail(): void;
    setUserPhone(userPhone: string): void;
    clearUserPhone(): void;
    setUserAttribute(key: string, value: unknown): void;
    removeUserAttribute(key: string): void;
    clearUserAttributes(): void;
    setUserAlias(key: string, value: string): void;
    removeUserAlias(key: string): void;
    clearUserAlias(): void;
    clearUser(): void;
    setDeviceAlias(key: string, value: string): void;
    removeDeviceAlias(key: string): void;
    clearDeviceAlias(): void;
    createTouchpoint(
        options: CreateTouchpointOptions,
        callback: (error?: unknown, touchpoint?: CreateTouchpointResponse) => void,
    ): void;
    sendWeb(url: string): void;
    sendWeb(
        url: string,
        callback: (error?: unknown, response?: SendWebResponse) => void,
    ): void;
    setDownloads(options: SetDownloadsOptions): void;
    setDeeplinks(options: SetDeeplinksOptions): void;
    openDeeplink(options: OpenDeeplinkOptions): void;
    setBanner(options: SetBannerOptions): void;
    openBanner(options: OpenBannerOptions): void;
    createTrackingLink(
        channel: string,
        options: CreateTrackingLinkOptions,
        onSuccess: (trackingLink: CreateTrackingLinkResponse) => void,
    ): void;
    createTrackingLink(
        channel: string,
        options: CreateTrackingLinkOptions,
        onSuccess: (trackingLink: CreateTrackingLinkResponse) => void,
        onError: (error: Error) => void,
    ): void;
    events: WebEvent;
}

Properties

events

events: WebEvent

Methods

init

init(options: InitializeOptions): void
Initializes the Airbridge Web SDK with the given options.
Parameters
- options: InitializeOptions
  The options to initialize the SDK.
  - app: string
    The name of your application.
  - webToken: string
    The web token for your application.
  - OptionalautoStartTrackingEnabled?: boolean
    Whether to automatically start event tracking when the SDK is initialized.
    If set to true, the SDK will automatically start event tracking when the SDK is initialized.
    If set to false, you need to call the airbridge.startTracking method manually to start event tracking.
    
    Default
    true
  - OptionalcollectMolocoCookieID?: boolean
    Whether to collect the Moloco cookie ID.
    If set to true, the SDK will collect the Moloco cookie ID.
    If set to false, the SDK will not collect the Moloco cookie ID.
    
    Default
    false
  - OptionalcookieWindow?: number
    The window time in days for the cookie expiration.
    
    Default
    3
  - OptionalcookieWindowInMinutes?: number
    The window time in minutes for the cookie expiration.
    If set, this will override the InitializeOptions.cookieWindow option.
  - OptionaldefaultChannel?: string
    The default channel name for the attribution.
  - OptionaldefaultParams?: AttributionParameters
    The default attribution parameters.
  - OptionalforceFirstPartyCookieID?: boolean
    Whether to use the first-party cookie ID instead of the third-party cookie ID for the attribution.
    If set to true, the SDK will use the first-party cookie ID for the attribution.
    If set to false, the SDK will use the third-party cookie ID for the attribution.
    
    Default
    false
  - Optional ExperimentaloverwriteInstance?: boolean
    Whether to overwrite the existing instance of the SDK.
    If set to true, the SDK will re-initialize the global instance by replacing the existing instance with the new instance.
    
    Default
    false
  - OptionalprotectedAttributionWindowInMinutes?: number
    The window time in minutes for the protected attribution window.
    This option will be ignored if InitializeOptions.useProtectedAttributionWindow is false.
    
    Default
    30
  - OptionalsessionTimeout?: number
    The session timeout in milliseconds.
    
    Default
    1800000 (30 minutes)
  - OptionalshareCookieSubdomain?: boolean
    Whether to save the cookie in the subdomain.
    If set to true, the SDK will save the cookie in the subdomain.
    If set to false, the SDK will save the cookie in the root domain if localStorage is not available.
    
    Default
    true
  - OptionalurlQueryMapping?: URLQueryMapping
    Sets the mapping for the URL query parameters.
    This option will be ignored if InitializeOptions.utmParsing is false.
    
    Example
    airbridge.init({ urlQueryMapping: { channel: 'utm_source', campaign: 'utm_campaign', }, })
  - OptionaluseProtectedAttributionWindow?: boolean
    Whether to use the protected attribution window.
    If set to true, the SDK will parse the UTM parameters from the URL.
    
    Default
    true
  - Optionaluser?: User
    Sets the user object for the attribution.
  - OptionaluserHash?: boolean
    Whether to hash the user email and phone number.
    If set to true, the SDK will hash the user email and phone number when sending the event.
    
    Default
    true
  - OptionaluseStoragePerApp?: boolean
    Deprecated
    No longer has any effect. This option is always treated as true.
    Whether to split the storage per application name.
    If set to true, the SDK will split the storage per application name.
    
    Default
    true
  - OptionalutmParameterValueReplaceMap?: UTMParameterValueReplaceMap
    Sets the mapping for the UTM parameters.
    
    Example
    airbridge.init({ utmParameterValueReplaceMap: { utm_source: { 'test.1': 'test', 'test.2': 'test', }, }, })
  - OptionalutmParsing?: boolean
    Whether to parse the UTM parameters from the URL.
    If set to true, the SDK will parse the UTM parameters from the URL.
    
    Default
    false
Returns void
Example
```
airbridge.init({
    app: 'YOUR_APPLICATION_NAME',
    webToken: 'YOUR_WEB_TOKEN',
})
```
init(
options: InitializeOptions,
callback: (error?: unknown, airbridge?: Airbridge) => void,
): void
Initializes the Airbridge Web SDK with the given options and calls the provided callback function.
Parameters
- options: InitializeOptions
  The options to initialize the SDK.
  - app: string
    The name of your application.
  - webToken: string
    The web token for your application.
  - OptionalautoStartTrackingEnabled?: boolean
    Whether to automatically start event tracking when the SDK is initialized.
    If set to true, the SDK will automatically start event tracking when the SDK is initialized.
    If set to false, you need to call the airbridge.startTracking method manually to start event tracking.
    
    Default
    true
  - OptionalcollectMolocoCookieID?: boolean
    Whether to collect the Moloco cookie ID.
    If set to true, the SDK will collect the Moloco cookie ID.
    If set to false, the SDK will not collect the Moloco cookie ID.
    
    Default
    false
  - OptionalcookieWindow?: number
    The window time in days for the cookie expiration.
    
    Default
    3
  - OptionalcookieWindowInMinutes?: number
    The window time in minutes for the cookie expiration.
    If set, this will override the InitializeOptions.cookieWindow option.
  - OptionaldefaultChannel?: string
    The default channel name for the attribution.
  - OptionaldefaultParams?: AttributionParameters
    The default attribution parameters.
  - OptionalforceFirstPartyCookieID?: boolean
    Whether to use the first-party cookie ID instead of the third-party cookie ID for the attribution.
    If set to true, the SDK will use the first-party cookie ID for the attribution.
    If set to false, the SDK will use the third-party cookie ID for the attribution.
    
    Default
    false
  - Optional ExperimentaloverwriteInstance?: boolean
    Whether to overwrite the existing instance of the SDK.
    If set to true, the SDK will re-initialize the global instance by replacing the existing instance with the new instance.
    
    Default
    false
  - OptionalprotectedAttributionWindowInMinutes?: number
    The window time in minutes for the protected attribution window.
    This option will be ignored if InitializeOptions.useProtectedAttributionWindow is false.
    
    Default
    30
  - OptionalsessionTimeout?: number
    The session timeout in milliseconds.
    
    Default
    1800000 (30 minutes)
  - OptionalshareCookieSubdomain?: boolean
    Whether to save the cookie in the subdomain.
    If set to true, the SDK will save the cookie in the subdomain.
    If set to false, the SDK will save the cookie in the root domain if localStorage is not available.
    
    Default
    true
  - OptionalurlQueryMapping?: URLQueryMapping
    Sets the mapping for the URL query parameters.
    This option will be ignored if InitializeOptions.utmParsing is false.
    
    Example
    airbridge.init({ urlQueryMapping: { channel: 'utm_source', campaign: 'utm_campaign', }, })
  - OptionaluseProtectedAttributionWindow?: boolean
    Whether to use the protected attribution window.
    If set to true, the SDK will parse the UTM parameters from the URL.
    
    Default
    true
  - Optionaluser?: User
    Sets the user object for the attribution.
  - OptionaluserHash?: boolean
    Whether to hash the user email and phone number.
    If set to true, the SDK will hash the user email and phone number when sending the event.
    
    Default
    true
  - OptionaluseStoragePerApp?: boolean
    Deprecated
    No longer has any effect. This option is always treated as true.
    Whether to split the storage per application name.
    If set to true, the SDK will split the storage per application name.
    
    Default
    true
  - OptionalutmParameterValueReplaceMap?: UTMParameterValueReplaceMap
    Sets the mapping for the UTM parameters.
    
    Example
    airbridge.init({ utmParameterValueReplaceMap: { utm_source: { 'test.1': 'test', 'test.2': 'test', }, }, })
  - OptionalutmParsing?: boolean
    Whether to parse the UTM parameters from the URL.
    If set to true, the SDK will parse the UTM parameters from the URL.
    
    Default
    false
- callback: (error?: unknown, airbridge?: Airbridge) => void
  Callback function to be called after initialization.
Returns void
Example
```
airbridge.init({
    app: 'YOUR_APPLICATION_NAME',
    webToken: 'YOUR_WEB_TOKEN',
}, (error) => {
    if (error) {
        // Handle the error
        console.error('Error initializing Airbridge:', error)
        return
    }
    // Airbridge is initialized successfully
})
```

startTracking

startTracking(): void
Starts the event tracking.

Returns void
Example
```
airbridge.startTracking()
```

stopTracking

stopTracking(): void
Stops the event tracking.

Returns void
Example
```
airbridge.stopTracking()
```

fetchResource

fetchResource(callback: (resource: FetchResourceResponse) => void): void
Fetches the resource and calls the provided callback function with the response.
Parameters
- callback: (resource: FetchResourceResponse) => void
  Callback function to be called with the fetched resource.
Returns void
Example
```
airbridge.fetchResource((resource) => {
    // Handle the fetched resource
    console.log('Fetched resource:', resource)
})
```

setUserID

setUserID(userID: string): void
Sets the user ID who is logged in to the current website, in order to integrate user identity.
Parameters
- userID: string
  The user ID to set.
Returns void
Example
```
airbridge.setUserID('user-id')
```

clearUserID

clearUserID(): void
Clears the user ID.

Returns void
Example
```
airbridge.clearUserID()
```

setUserEmail

setUserEmail(userEmail: string): void
Sets the user email who is logged in to the current website, in order to integrate user identity.
Parameters
- userEmail: string
  The user email to set.
Returns void
Example
```
airbridge.setUserEmail('user-email')
```

clearUserEmail

clearUserEmail(): void
Clears the user email.

Returns void
Example
```
airbridge.clearUserEmail()
```

setUserPhone

setUserPhone(userPhone: string): void
Sets the user phone who is logged in to the current website, in order to integrate user identity.
Parameters
- userPhone: string
  The user phone to set.
Returns void
Example
```
airbridge.setUserPhone('user-phone')
```

clearUserPhone

clearUserPhone(): void
Clears the user phone.

Returns void
Example
```
airbridge.clearUserPhone()
```

setUserAttribute

setUserAttribute(key: string, value: unknown): void
Sets a user attribute with the given key and value.
Parameters
- key: string
  The key of the attribute.
- value: unknown
  The value of the attribute.
Returns void
Example
```
airbridge.setUserAttribute('key', 'value')
```

removeUserAttribute

removeUserAttribute(key: string): void
Removes a user attribute with the given key.
Parameters
- key: string
  The key of the attribute to remove.
Returns void
Example
```
airbridge.removeUserAttribute('key')
```

clearUserAttributes

clearUserAttributes(): void
Clears all user attributes.

Returns void
Example
```
airbridge.clearUserAttributes()
```

setUserAlias

setUserAlias(key: string, value: string): void
Sets a user alias with the given key and value.
Parameters
- key: string
  The key of the alias.
- value: string
  The value of the alias.
Returns void
Example
```
airbridge.setUserAlias('key', 'value')
```

removeUserAlias

removeUserAlias(key: string): void
Removes a user alias with the given key.
Parameters
- key: string
  The key of the alias to remove.
Returns void
Example
```
airbridge.removeUserAlias('key')
```

clearUserAlias

clearUserAlias(): void
Clears all user aliases.

Returns void
Example
```
airbridge.clearUserAlias()
```

clearUser

clearUser(): void
Clears all user data.

Returns void
Example
```
airbridge.clearUser()
```

setDeviceAlias

setDeviceAlias(key: string, value: string): void
Sets a device alias with the given key and value.
Parameters
- key: string
  The key of the alias.
- value: string
  The value of the alias.
Returns void
Example
```
airbridge.setDeviceAlias('key', 'value')
```

removeDeviceAlias

removeDeviceAlias(key: string): void
Removes a device alias with the given key.
Parameters
- key: string
  The key of the alias to remove.
Returns void
Example
```
airbridge.removeDeviceAlias('key')
```

clearDeviceAlias

clearDeviceAlias(): void
Clears all device aliases.

Returns void
Example
```
airbridge.clearDeviceAlias()
```

createTouchpoint

createTouchpoint(
options: CreateTouchpointOptions,
callback: (error?: unknown, touchpoint?: CreateTouchpointResponse) => void,
): void

Creates a touchpoint with the given options and calls the provided callback function.

Parameters

options: CreateTouchpointOptions
The options to create the touchpoint.
- OptionaldefaultParams?: PlacementParameters["defaultParams"]
- OptionalctaParams?: PlacementParameters["ctaParams"]
callback: (error?: unknown, touchpoint?: CreateTouchpointResponse) => void
Callback function to be called after creating the touchpoint.

Returns void

Example

airbridge.createTouchpoint({
    defaultParams: {
        campaign: 'campaign',
        medium: 'medium',
        content: 'content',
        term: 'term',
    },
    ctaParams: {
        cta_param_1: 'cta_param_1',
        cta_param_2: 'cta_param_2',
        cta_param_3: 'cta_param_3',
    },
}, (error, touchpoint) => {
    if (error) {
        // Handle the error
        console.error('Error creating touchpoint:', error)
        return
    }
    // Handle the created touchpoint
    console.log('Created touchpoint:', touchpoint.referrer)
})

sendWeb

sendWeb(url: string): void
Opens the website with the URL.
Parameters
- url: string
  The URL to open the website.
Returns void
Example
```
airbridge.sendWeb('https://www.example.com')
```

sendWeb(
url: string,
callback: (error?: unknown, response?: SendWebResponse) => void,
): void

Opens the website with the URL.

Parameters

url: string
The URL to open the website.
callback: (error?: unknown, response?: SendWebResponse) => void
The callback function to be called with the website URL to open.

Returns void

Example

airbridge.sendWeb('https://www.example.com', (error, response) => {
    if (error) {
        // Handle the error
        console.error('Error opening website:', error)
        return
    }
    // Open the website with the response.targetUrl
    console.log('Opening website:', response.targetUrl)
    location.href = response.targetUrl
})

setDownloads

setDownloads(options: SetDownloadsOptions): void
Sets the click event to the button element with button ID to open the store deeplink.
Parameters
- options: SetDownloadsOptions
  The options to set the store deeplink button.
  - buttonID: string | string[]
    The button ID(s) to add the click event.
  - OptionaldefaultParams?: PlacementParameters["defaultParams"]
    The attribution parameters.
  - OptionalctaParams?: PlacementParameters["ctaParams"]
    The CTA parameters.
Returns void
Example
```
airbridge.setDownloads({
    buttonID: 'open-store',
    defaultParams: {
        campaign: 'campaign',
        medium: 'medium',
        content: 'content',
        term: 'term',
    },
    ctaParams: {
        cta_param_1: 'cta_param_1',
        cta_param_2: 'cta_param_2',
        cta_param_3: 'cta_param_3',
    },
})
```

setDeeplinks

setDeeplinks(options: SetDeeplinksOptions): void

Sets the click event to the button element with button ID to open the deeplink. If options.fallbacks.ios is set to itunes-appstore, opens the store when the application is not installed. If options.fallbacks.android is set to google-play, opens the store when the application is not installed.

Parameters

options: SetDeeplinksOptions
The options to set the deeplink button.
- buttonID: string | string[]
  The button ID(s) to add the click event.
- Optionaldeeplinks?: DeeplinkOptions["deeplinks"]
- Optionalfallbacks?: DeeplinkOptions["fallbacks"]
- OptionaldefaultParams?: PlacementParameters["defaultParams"]
- OptionalctaParams?: PlacementParameters["ctaParams"]
- Optionalredirect?: boolean
  Whether to open the application directly without the user gesture.
  If set to true, opens the application directly without the user gesture.
  If set to false, opens the application after the user gesture in the click event.
  Default
```
false
```
- OptionaldesktopPopUp?: boolean
  Whether to open the application in new window on desktop environment.
  If set to true, opens the application in new window on desktop environment.
  Default
```
false
```

Returns void

Example

airbridge.setDeeplinks({
    buttonID: 'open-application',
    deeplinks: {
        ios: 'example://main',
        android: 'example://main',
        desktop: 'https://www.example.com',
    },
    fallbacks: {
        ios: 'itunes-appstore',
        android: 'google-play',
    },
    defaultParams: {
        campaign: 'campaign',
        medium: 'medium',
        content: 'content',
        term: 'term',
    },
    ctaParams: {
        cta_param_1: 'cta_param_1',
        cta_param_2: 'cta_param_2',
        cta_param_3: 'cta_param_3',
    },
})

Example

airbridge.setDeeplinks({
    buttonID: 'open-application',
    deeplinks: {
        ios: 'https://www.example.com',
        android: 'https://www.example.com',
        desktop: 'https://www.example.com',
    },
    fallbacks: {
        ios: 'itunes-appstore',
        android: 'google-play',
    },
    defaultParams: {
        campaign: 'campaign',
        medium: 'medium',
        content: 'content',
        term: 'term',
    },
    ctaParams: {
        cta_param_1: 'cta_param_1',
        cta_param_2: 'cta_param_2',
        cta_param_3: 'cta_param_3',
    },
})

openDeeplink

openDeeplink(options: OpenDeeplinkOptions): void
Opens the deeplink
Parameters
- options: OpenDeeplinkOptions
  The options to open the deeplink.
  - type: "redirect" | "click"
    Determines the type of opening the deeplink.
    If set to redirect, opens the application directly without the user gesture.
    If set to click, opens the application after the user gesture in the click event.
  - Optionaldeeplinks?: DeeplinkOptions["deeplinks"]
  - Optionalfallbacks?: DeeplinkOptions["fallbacks"]
  - OptionaldefaultParams?: PlacementParameters["defaultParams"]
  - OptionalctaParams?: PlacementParameters["ctaParams"]
  - OptionaldesktopPopUp?: boolean
    Whether to open the application in new window on desktop environment.
    If set to true, opens the application in new window on desktop environment.
    
    Default
    false
Returns void
Example
```
airbridge.openDeeplink({
    type: 'redirect',
    deeplinks: {
        ios: 'example://main',
        android: 'example://main',
        desktop: 'https://www.example.com',
    },
    fallbacks: {
        ios: 'itunes-appstore',
        android: 'google-play',
    },
    defaultParams: {
        campaign: 'campaign',
        medium: 'medium',
        content: 'content',
        term: 'term',
    },
    ctaParams: {
        cta_param_1: 'cta_param_1',
        cta_param_2: 'cta_param_2',
        cta_param_3: 'cta_param_3',
    },
})
```

setBanner

setBanner(options: SetBannerOptions): void
Opens a banner with the given options.
Parameters
- options: SetBannerOptions
  The options for the banner.
  - Optionaltitle?: string
    The title of the banner.
  - Optionaldescription?: string
    The description of the banner.
  - OptionalkeyColor?: string
    The key color of the banner.
  - Optionalposition?: number
    The position of the banner (1 = top, 0 = bottom).
Returns void
Deprecated
Use airbridge.openBanner() instead.
Example
```
airbridge.setBanner({
    title: 'Move to Store Banner',
    description: 'Click the button to move to the store',
    keyColor: '#0a69ff',
    position: 1, // top
})
```

openBanner

openBanner(options: OpenBannerOptions): void

Opens a banner with the given options.

Parameters

options: OpenBannerOptions
The options for the banner.
- title: string
  The title of the banner.
- description: string
  The description of the banner.
- buttonText: string
  The text for the button in the banner.
- destination:
      | BannerWebDestinationOptions
      | BannerDownloadDestinationOptions
      | BannerDeeplinkDestinationOptions
  The destination options for the banner (web, download, or deeplink).
- Optionalcolor?: string
  The color of the banner.
- Optionalposition?: "top" | "bottom"
  The position of the banner (top or bottom).
- Optionalstyles?: Record<string, Partial<CSSStyleDeclaration>>
  The custom styles for the banner.

Returns void

Example

airbridge.openBanner({
    title: 'Move to Website Banner',
    description: 'Click the button to move to the website',
    buttonText: 'Move',
    color: '#0a69ff',
    position: 'top',
    destination: {
        type: 'web',
        url: 'https://www.example.com',
    },
})

Example

airbridge.openBanner({
    title: 'Move to Store Banner',
    description: 'Click the button to move to the store',
    buttonText: 'Move',
    color: '#0a69ff',
    position: 'top',
    destination: {
        type: 'download',
        defaultParams: {
            campaign: 'campaign',
            medium: 'medium',
            content: 'content',
            term: 'term',
        },
        ctaParams: {
            cta_param_1: 'cta_param_1',
            cta_param_2: 'cta_param_2',
            cta_param_3: 'cta_param_3',
        },
    },
})

Example

airbridge.openBanner({
    title: 'Move to Application Banner',
    description: 'Click the button to move to the application',
    buttonText: 'Open',
    color: '#0a69ff',
    position: 'top',
    destination: {
        type: 'deeplink',
        deeplinks: {
            ios: 'example://main',
            android: 'example://main',
            desktop: 'https://www.example.com',
        },
        fallbacks: {
            ios: 'itunes-appstore',
            android: 'google-play',
        },
        defaultParams: {
            campaign: 'campaign',
            medium: 'medium',
            content: 'content',
            term: 'term',
        },
        ctaParams: {
            cta_param_1: 'cta_param_1',
            cta_param_2: 'cta_param_2',
            cta_param_3: 'cta_param_3',
        },
    },
})

createTrackingLink

createTrackingLink(
    channel: string,
    options: CreateTrackingLinkOptions,
    onSuccess: (trackingLink: CreateTrackingLinkResponse) => void,
): void
Creates a tracking link with the given channel and options, and calls the provided success callback.
Parameters
- channel: string
  The channel for the tracking link.
- options: CreateTrackingLinkOptions
  The options for the tracking link.
  - [key: string]: unknown
  - Optionalcampaign?: string
  - Optionalad_group?: string
  - Optionalad_creative?: string
  - Optionalcontent?: string
  - Optionalterm?: string
  - Optionalsub_id?: string
  - Optionalsub_id_1?: string
  - Optionalsub_id_2?: string
  - Optionalsub_id_3?: string
  - Optionaldeeplink_url?: string
  - Optionaldeeplink_stopover?: boolean
  - Optionalfallback_ios?: "store" | string
  - Optionalfallback_android?: "store" | string
  - Optionalfallback_desktop?: string
  - Optionalfallback_ios_store_ppid?: string
  - Optionalfallback_android_store_listing?: string
  - Optionalogtag_title?: string
  - Optionalogtag_description?: string
  - Optionalogtag_image_url?: string
  - Optionalogtag_website_crawl?: "desktop"
  - Optionalcustom_short_id?: string
  - Optionalis_reengagement?: "off" | "on_true" | "on_false"
- onSuccess: (trackingLink: CreateTrackingLinkResponse) => void
  Callback function to be called with the created tracking link.
Returns void
Example
```
airbridge.createTrackingLink('example', {
    campaign: 'campaign',
    ...,
}, (trackingLink) => {
    // Handle the created tracking link
    console.log(trackingLink.shortURL)
    window.open(trackingLink.shortURL, '_blank')
})
```
createTrackingLink(
    channel: string,
    options: CreateTrackingLinkOptions,
    onSuccess: (trackingLink: CreateTrackingLinkResponse) => void,
    onError: (error: Error) => void,
): void
Creates a tracking link with the given channel and options, and calls the provided success and error callbacks.
Parameters
- channel: string
  The channel for the tracking link.
- options: CreateTrackingLinkOptions
  The options for the tracking link.
- onSuccess: (trackingLink: CreateTrackingLinkResponse) => void
  Callback function to be called with the created tracking link.
- onError: (error: Error) => void
  Callback function to be called with an error if one occurs.
Returns void
Example
```
airbridge.createTrackingLink('example', {
    campaign: 'campaign',
    ...,
}, (trackingLink) => {
    // Handle the created tracking link
    console.log(trackingLink.shortURL)
   window.open(trackingLink.shortURL, '_blank')
}, (error) => {
    // Handle the error
    console.error('Error creating tracking link:', error)
})
```

Interface Airbridge

Index

Properties

Methods

Properties

events

Methods

init

Parameters

app: string

webToken: string

OptionalautoStartTrackingEnabled?: boolean

Default

OptionalcollectMolocoCookieID?: boolean

Default

OptionalcookieWindow?: number

Default

OptionalcookieWindowInMinutes?: number

OptionaldefaultChannel?: string

OptionaldefaultParams?: AttributionParameters

OptionalforceFirstPartyCookieID?: boolean

Default

Optional ExperimentaloverwriteInstance?: boolean

Default

OptionalprotectedAttributionWindowInMinutes?: number

Default

OptionalsessionTimeout?: number

Default

OptionalshareCookieSubdomain?: boolean

Default

OptionalurlQueryMapping?: URLQueryMapping

Example

OptionaluseProtectedAttributionWindow?: boolean

Default

Optionaluser?: User

OptionaluserHash?: boolean

Default

OptionaluseStoragePerApp?: boolean

Deprecated

Default

OptionalutmParameterValueReplaceMap?: UTMParameterValueReplaceMap

Example

OptionalutmParsing?: boolean

Default

Returns void

Example

Parameters

app: string

webToken: string

OptionalautoStartTrackingEnabled?: boolean

Default

OptionalcollectMolocoCookieID?: boolean

Default

OptionalcookieWindow?: number

Default

OptionalcookieWindowInMinutes?: number

OptionaldefaultChannel?: string

OptionaldefaultParams?: AttributionParameters

OptionalforceFirstPartyCookieID?: boolean

Default

Optional ExperimentaloverwriteInstance?: boolean

Default

OptionalprotectedAttributionWindowInMinutes?: number

Default

OptionalsessionTimeout?: number

Default

OptionalshareCookieSubdomain?: boolean

Default

OptionalurlQueryMapping?: URLQueryMapping

Example

OptionaluseProtectedAttributionWindow?: boolean

Default

Optionaluser?: User

OptionaluserHash?: boolean

Default

OptionaluseStoragePerApp?: boolean

Deprecated

Default

OptionalutmParameterValueReplaceMap?: UTMParameterValueReplaceMap

Example

`Optional`autoStartTrackingEnabled?: boolean

`Optional`collectMolocoCookieID?: boolean

`Optional`cookieWindow?: number

`Optional`cookieWindowInMinutes?: number

`Optional`defaultChannel?: string

`Optional`defaultParams?: AttributionParameters

`Optional`forceFirstPartyCookieID?: boolean

`Optional` `Experimental`overwriteInstance?: boolean

`Optional`protectedAttributionWindowInMinutes?: number

`Optional`sessionTimeout?: number

`Optional`shareCookieSubdomain?: boolean

`Optional`urlQueryMapping?: URLQueryMapping

`Optional`useProtectedAttributionWindow?: boolean

`Optional`user?: User

`Optional`userHash?: boolean

`Optional`useStoragePerApp?: boolean

`Optional`utmParameterValueReplaceMap?: UTMParameterValueReplaceMap

`Optional`utmParsing?: boolean

`Optional`autoStartTrackingEnabled?: boolean

`Optional`collectMolocoCookieID?: boolean

`Optional`cookieWindow?: number

`Optional`cookieWindowInMinutes?: number

`Optional`defaultChannel?: string

`Optional`defaultParams?: AttributionParameters

`Optional`forceFirstPartyCookieID?: boolean

`Optional` `Experimental`overwriteInstance?: boolean

`Optional`protectedAttributionWindowInMinutes?: number

`Optional`sessionTimeout?: number

`Optional`shareCookieSubdomain?: boolean

`Optional`urlQueryMapping?: URLQueryMapping

`Optional`useProtectedAttributionWindow?: boolean

`Optional`user?: User

`Optional`userHash?: boolean

`Optional`useStoragePerApp?: boolean

`Optional`utmParameterValueReplaceMap?: UTMParameterValueReplaceMap

`Optional`utmParsing?: boolean