airbridge-react-native-sdk/source/constant/AirbridgeTrackingLinkOption.ts

Airbridge SDK for React Native

/**
 * Contains key of tracking-link option.
 */
export class AirbridgeTrackingLinkOption {
    /// A campaign parameter. (String)
    static get CAMPAIGN() {
        return 'campaign'
    }

    /// A campaign parameter. (String)
    static get AD_GROUP() {
        return 'ad_group'
    }

    /// A campaign parameter. (String)
    static get AD_CREATIVE() {
        return 'ad_creative'
    }

    /// A campaign parameter. (String)
    static get CONTENT() {
        return 'content'
    }

    /// A campaign parameter. (String)
    static get TERM() {
        return 'term'
    }

    /// A campaign parameter. (String)
    static get SUB_ID() {
        return 'sub_id'
    }

    /// A campaign parameter. (String)
    static get SUB_ID_1() {
        return 'sub_id_1'
    }

    /// A campaign parameter. (String)
    static get SUB_ID_2() {
        return 'sub_id_2'
    }

    /// A campaign parameter. (String)
    static get SUB_ID_3() {
        return 'sub_id_3'
    }

    /// A url of deeplink open the app. (Custom Scheme URL String)
    static get DEEPLINK_URL() {
        return 'deeplink_url'
    }

    /// A option enable stop-over-feature of deeplink. (Boolean)
    static get DEEPLINK_STOPOVER() {
        return 'deeplink_stopover'
    }

    /// A url of fallback for ios if app is not installed. ("store" | Web URL String)
    static get FALLBACK_IOS() {
        return 'fallback_ios'
    }

    /// A url of fallback for android if app is not installed. ("store" | Web URL String)
    static get FALLBACK_ANDROID() {
        return 'fallback_android'
    }

    /// A url of fallback for desktop if app is not installed. (Web URL String)
    static get FALLBACK_DESKTOP() {
        return 'fallback_desktop'
    }

    /// A custom id of store for ios used when user move to store. (String)
    static get FALLBACK_IOS_STORE_PPID() {
        return 'fallback_ios_store_ppid'
    }

    /// A custom id of store for android used when user move to store. (String)
    static get FALLBACK_ANDROID_STORE_LISTING() {
        return 'fallback_android_store_listing'
    }

    /// A title of link-preview. (String)
    static get OGTAG_TITLE() {
        return 'ogtag_title'
    }

    /// A description of link-preview. (String)
    static get OGTAG_DESCRIPTION() {
        return 'ogtag_description'
    }

    /// A image-url of link-preview. (Web URL String)
    static get OGTAG_IMAGE_URL() {
        return 'ogtag_image_url'
    }

    /// A customization of link-preview. ("desktop")
    /// - Note: Airbridge crawl og-tag from response of FALLBACK_DESKTOP.
    static get OGTAG_WEBSITE_CRAWL() {
        return 'ogtag_website_crawl'
    }

    /// A custom-short-id of tracking-link. (String)
    /// - Warning: Must be used with CUSTOM_DOMAIN option.
    /// - Note: Refer example. <https://app.example.com/invite>
    static get CUSTOM_SHORT_ID() {
        return 'custom_short_id'
    }

    /// A option enable re-engagement-feature of attribution. ("off" | "on_true" | "on_false")
    /// - Note: "off" uses touchpoint from install and deeplink event.
    /// - Note: "on_true" uses touchpoint from deeplink event only.
    /// Can be used by re-engagement campaign.
    /// - Note: "on_false" uses touchpoint from install event only.
    /// Can be used by UA(user-acquisition) campaign.
    static get IS_REENGAGEMENT() {
        return 'is_reengagement'
    }
}