Cordova PhoneGap Ionic

npmnpm

🚧

Inconsistent Universal links behavior on iOS 11.2

After updating a device to iOS 11.2, we found that the app's AASA file is no longer downloaded reliably onto your user’s device after an app install. As a result, clicking on Universal links will no longer open the app consistenly. You can set forced uri redirect mode on your Branch links to open the app with URI schemes. View details of the issue on the Apple Bug report.

Configure Branch

imageimage
imageimage

Configure App

  • Cordova and Ionic
<!-- sample config.xml -->
    <widget id="com.eneff.branch.cordovatestbed" version="0.0.1" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
      <!-- Branch -->
      <plugin name="branch-cordova-sdk" spec="^4.0.0" />
      <branch-config>
        <branch-key value="key_live_ndqptlgXNE4LHqIahH1WIpbiyFlb62J3" />
        <uri-scheme value="branchcordova" />
        <link-domain value="cordova.app.link" />  <!-- Required app.link domain -->
        <link-domain value="cordova-alternate.app.link" />  <!-- Required alternate.app.link domain -->
        <ios-team-release value="PW4Q8885U7" />
      </branch-config>
<!-- sample config.xml -->
    <widget id="com.eneff.branch.cordovatestbed" version="1.0.0" xmlns="http://www.w3.org/ns/widgets" xmlns:gap="http://phonegap.com/ns/1.0">
      <!-- Branch -->
      <plugin name="branch-cordova-sdk" spec="^4.0.0" />
      <branch-config>
        <branch-key value="key_live_ndqptlgXNE4LHqIahH1WIpbiyFlb62J3" />
        <uri-scheme value="branchcordova" />
        <link-domain value="cordova.app.link" />  <!-- Required app.link domain -->
        <link-domain value="cordova-alternate.app.link" />  <!-- Required alternate.app.link domain -->
        <ios-team-release value="PW4Q8885U7" />
      </branch-config>
  • Change the following values to match your Branch Dashboard

  • com.eneff.branch.cordovatestbed

  • key_live_ndqptlgXNE4LHqIahH1WIpbiyFlb62J3

  • branchcordova

  • cordova.app.link

  • PW4Q8885U7

Initialize Branch

  • Cordova and PhoneGap
// sample index.js
    var app = {
      initialize: function() {
        this.bindEvents();
      },
      bindEvents: function() {
        document.addEventListener('deviceready', this.onDeviceReady, false);
        document.addEventListener('resume', this.onDeviceResume, false);
      },
      onDeviceReady: function() {
        app.handleBranch();
      },
      onDeviceResume: function() {
        app.handleBranch();
      },
      handleBranch: function() {
        // Branch initialization
        Branch.initSession().then(function(data) {
          if (data['+clicked_branch_link']) {
            // read deep link data on click
            alert('Deep Link Data: ' + JSON.stringify(data));
          }
        });
      }
    };

    app.initialize();
// sample app.js
    angular.module('starter', ['ionic', 'starter.controllers', 'starter.services'])

    .run(function($ionicPlatform) {
      $ionicPlatform.ready(function() {
        if (window.cordova && window.cordova.plugins && window.cordova.plugins.Keyboard) {
          cordova.plugins.Keyboard.hideKeyboardAccessoryBar(true);
          cordova.plugins.Keyboard.disableScroll(true);
        }
        if (window.StatusBar) {
          StatusBar.styleDefault();
        }

        // Branch
        $ionicPlatform.on('deviceready', function() {
          handleBranch();
        });

        $ionicPlatform.on('resume', function() {
          handleBranch();
        });

        function handleBranch() {
          // Branch initialization
          Branch.initSession().then(function(data) {
            if (data['+clicked_branch_link']) {
              // read deep link data on click
              alert('Deep Link Data: ' + JSON.stringify(data));
            }
          });
        }
      });
    })
    // ...
// sample app.component.js
      import { Component } from '@angular/core';
      import { Platform } from 'ionic-angular';
      import { StatusBar, Splashscreen } from 'ionic-native';

      import { TabsPage } from '../tabs/tabs

      @Component({
        template: `<ion-nav [root]="rootPage"></ion-nav>`
      })
      export class MyApp {
        rootPage = TabsPage;

        constructor(platform: Platform) {
          platform.ready().then(() => {
            StatusBar.styleDefault();
            Splashscreen.hide();
            handleBranch();
          });

          platform.resume.subscribe(() => {
            handleBranch();
          });

          // Branch initialization
          const handleBranch = () => {
            // only on devices
            if (!platform.is('cordova')) { return }
            const Branch = window['Branch'];
            Branch.initSession().then(data => {
              if (data['+clicked_branch_link']) {
                // read deep link data on click
                alert('Deep Link Data: ' + JSON.stringify(data));
              }
            });
          }
        }
      }

Test deep link iOS

  • Create a deep link from the Branch Dashboard

  • Delete your app from the device

  • Compile your app (cordova run ios phonegap run ios ionic run ios)

  • Paste deep link in Apple Notes

  • Long press on the deep link (not 3D Touch)

  • Click Open in "APP_NAME" to open your app (example)

Test deep link Android

  • Create a deep link from the Branch Dashboard

  • Delete your app from the device

  • Compile your app (cordova run android phonegap run android ionic run android)

  • Paste deep link in Google Hangouts

  • Click on the deep link to open your app

Implement Features

Initialize Branch features

  • Loads Branch into your app

  • Must be called on deviceready and resume

// for development and debugging only
    Branch.setDebug(true)

    // for GDPR compliance (can be called at anytime)
    Branch.disableTracking(true);

    // Branch initialization
    Branch.initSession().then(function(data) {
      if (data['+clicked_branch_link']) {
        // read deep link data on click
        alert('Deep Link Data: ' + JSON.stringify(data))
      }
    })

Create content reference

// only canonicalIdentifier is required
    var properties = {
      canonicalIdentifier: 'content/123',
      canonicalUrl: 'https://example.com/content/123',
      title: 'Content 123 Title',
      contentDescription: 'Content 123 Description ' + Date.now(),
      contentImageUrl: 'http://lorempixel.com/400/400/',
      price: 12.12,
      currency: 'GBD',
      contentIndexingMode: 'private',
      contentMetadata: {
        custom: 'data',
        testing: 123,
        this_is: true
      }
    }

    // create a branchUniversalObj variable to reference with other Branch methods
    var branchUniversalObj = null
    Branch.createBranchUniversalObject(properties).then(function (res) {
      branchUniversalObj = res
      alert('Response: ' + JSON.stringify(res))
    }).catch(function (err) {
      alert('Error: ' + JSON.stringify(err))
    })

Create deep link

// optional fields
    var analytics = {
      channel: 'facebook',
      feature: 'onboarding',
      campaign: 'content 123 launch',
      stage: 'new user',
      tags: ['one', 'two', 'three']
    }

    // optional fields
    var properties = {
      $desktop_url: 'http://www.example.com/desktop',
      $android_url: 'http://www.example.com/android',
      $ios_url: 'http://www.example.com/ios',
      $ipad_url: 'http://www.example.com/ipad',
      $match_duration: 2000,
      custom_string: 'data',
      custom_integer: Date.now(),
      custom_boolean: true
    }

    branchUniversalObj.generateShortUrl(analytics, properties).then(function (res) {
      alert('Response: ' + JSON.stringify(res.url))
    }).catch(function (err) {
      alert('Error: ' + JSON.stringify(err))
    })

Share deep link

// optional fields
    var analytics = {
      channel: 'facebook',
      feature: 'onboarding',
      campaign: 'content 123 launch',
      stage: 'new user',
      tags: ['one', 'two', 'three']
    }

    // optional fields
    var properties = {
      $desktop_url: 'http://www.example.com/desktop',
      custom_string: 'data',
      custom_integer: Date.now(),
      custom_boolean: true
    }

    var message = 'Check out this link'

    // optional listeners (must be called before showShareSheet)
    branchUniversalObj.onShareSheetLaunched(function (res) {
      // android only
      console.log(res)
    })
    branchUniversalObj.onShareSheetDismissed(function (res) {
      console.log(res)
    })
    branchUniversalObj.onLinkShareResponse(function (res) {
      console.log(res)
    })
    branchUniversalObj.onChannelSelected(function (res) {
      // android only
      console.log(res)
    })

    // share sheet
    branchUniversalObj.showShareSheet(analytics, properties, message)

Read deep link

  • Retrieve Branch data from a deep link

  • Best practice to receive data from the listener (to prevent a race condition)

  • Returns deep link properties

  • Listener

// Branch initialization within your deviceready and resume
    Branch.initSession().then(function success(res) {
      if (res["+clicked_branch_link"]) {
        alert("Open app with a Branch deep link: " + JSON.stringify(res));
        // Branch quick link: https://cordova.app.link/uJcOH1IFpM
        // Branch web link: https://cordova-alternate.app.link/uJcOH1IFpM
        // Branch dynamic link: https://cordova.app.link?tags=one&tags=two&tags=three&channel=Copy&feature=onboarding&stage=new+user&campaign=content+123+launch&type=0&duration=0&source=android&data
        // Branch uri scheme: branchcordova://open?link_click_id=link-500015444967786346
        // Branch android intent: intent://open?link_click_id=518106399270344237#Intent;scheme=looprocks;package=com.eneff.branch.cordovatestbed;S.browser_fallback_url=https%3A%2F%2Fcordova.app.link%2FuJcOH1IFpM%3F__branch_flow_type%3Dchrome_deepview%26__branch_flow_id%3D518106399312287278;S.market_referrer=link_click_id-518106399270344237%26utm_source%3DCopy%26utm_campaign%3Dcontent%20123%20launch%26utm_feature%3Donboarding;S.branch_data=%7B%22~feature%22%3A%22onboarding%22%2C%22this_is%22%3A%22true%22%2C%22custom_string%22%3A%22data%22%2C%22testing%22%3A%22123%22%2C%22%24publicly_indexable%22%3A%22false%22%2C%22%24desktop_url%22%3A%22http%3A%2F%2Fwww.example.com%2Fdesktop%22%2C%22%24one_time_use%22%3Afalse%2C%22custom_object%22%3A%22%7B%5C%5C%5C%22random%5C%5C%5C%22%3A%5C%5C%5C%22dictionary%5C%5C%5C%22%7D%22%2C%22~id%22%3A%22517795540654792902%22%2C%22~campaign%22%3A%22content%20123%20launch%22%2C%22%2Bclick_timestamp%22%3A1524764418%2C%22%2Burl%22%3A%22https%3A%2F%2Fcordova.app.link%2FuJcOH1IFpM%22%2C%22custom_boolean%22%3A%22true%22%2C%22custom%22%3A%22data%22%2C%22source%22%3A%22android%22%2C%22%24og_image_url%22%3A%22http%3A%2F%2Florempixel.com%2F400%2F400%2F%22%2C%22%2Bdomain%22%3A%22cordova.app.link%22%2C%22custom_integer%22%3A%221524690301794%22%2C%22~tags%22%3A%5B%22one%22%2C%22two%22%2C%22three%22%5D%2C%22custom_array%22%3A%22%5B1%2C2%2C3%2C4%2C5%5D%22%2C%22~channel%22%3A%22Copy%22%2C%22~creation_source%22%3A2%2C%22%24canonical_identifier%22%3A%22content%2F123%22%2C%22%24og_title%22%3A%22Content%20123%20Title%22%2C%22%24og_description%22%3A%22Content%20123%20Description%201524690296449%22%2C%22%24identity_id%22%3A%22453670943617990547%22%2C%22~stage%22%3A%22new%20user%22%2C%22%2Bclicked_branch_link%22%3Atrue%2C%22%2Bmatch_guaranteed%22%3Atrue%2C%22%2Bis_first_session%22%3Afalse%7D;B.branch_intent=true;end
        // Branch android app link (device controlled): https://cordova.app.link/uJcOH1IFpM
        // Branch ios universal link (device controlled): https://cordova.app.link/uJcOH1IFpM
      } else if (res["+non_branch_link"]) {
        alert("Open app with a non Branch deep link: " + JSON.stringify(res));
        // Competitor uri scheme: anotherurischeme://hello=world
      } else {
        alert("Open app organically");
        // Clicking on app icon or push notification
      }
    })
    .catch(function error(err) {
      logger(err, true);
    });
  • Latest data
Branch.getLatestReferringParams().then(function(res) {
  alert('Response: ' + JSON.stringify(res))
}).catch(function(err) {
  alert('Error: ' + JSON.stringify(err))
})
  • First data
Branch.getFirstReferringParams().then(function(res) {
  alert('Response: ' + JSON.stringify(res))
}).catch(function(err) {
  alert('Error: ' + JSON.stringify(err))
})

NativeLink™ Deferred Deep Linking (iOS Only)

  • Use iOS pasteboard to enable deferred deep linking via Branch NativeLink™

🚧

Prerequisites

Make sure the underlying iOS SDK Version is v1.39.4+

To use this feature you must:

Implement one of the pasteboard opt-in options in the native iOS SDK code.

Navigate to content

  • Handled within Branch.initSession()

  • Branch allows you to pass any custom key-value from URLs to your app. Use this data to navigate to content, display a personalized welcome screen, login a user, offer a promotion, etc.

Branch.initSession().then(function(data) {
      if (data['+clicked_branch_link']) {
        // option 1: save to model to be used later
        window.localStorage['branchData'] = data;

        // option 2: navigate to page
        window.location.href = '#/content/123'

        // option 3: display data
        alert(JSON.stringify(data));
      }
    });

Display content

branchUniversalObj.listOnSpotlight().then(function (res) {
  alert('Response: ' + JSON.stringify(res))
}).catch(function (err) {
  alert('Error: ' + JSON.stringify(err))
})

Track content

branchUniversalObj.registerView().then(function (res) {
  alert('Response: ' + JSON.stringify(res))
}).catch(function (err) {
  alert('Error: ' + JSON.stringify(err))
})

Track users

  • Sets the identity of a user (email, ID, UUID, etc) for events, deep links, and referrals

  • Validate with the Branch Dashboard

var userId = '123456'
    Branch.setIdentity(userId).then(function (res) {
      alert('Response: ' + JSON.stringify(res))
    }).catch(function (err) {
      alert('Error: ' + JSON.stringify(err.message))
    })
  • Removes the identity of a user
Branch.logout().then(function (res) {
      alert('Response: ' + JSON.stringify(res))
    }).catch(function (err) {
      alert('Error: ' + JSON.stringify(err.message))
    })

Track events

  • Registers a custom event

  • Events named open, close, install, and referred session are Branch restricted

  • Best to Track users before Track events to associate a custom event to a user

  • Validate with the Branch Dashboard

var eventName = 'clicked_on_this';
var metadata = { 'custom_dictionary': 123, 'anything': 'everything' };
Branch.sendBranchEvent(eventName, metadata);

var eventName = 'clicked_on_this';
Branch.sendBranchEvent(eventName);

Track commerce

Branch.getStandardEvents().then(function success(res) {
  var event = res.STANDARD_EVENT_ADD_TO_CART;
  var metadata = {
    customerEventAlias: 'alias name for event',
    transactionID: '1234455',
    currency: 'USD',
    revenue: 1.5,
    shipping: 10.2,
    tax: 12.3,
    coupon: 'test_coupon',
    affiliation: 'test_affiliation',
    description: 'Test add to cart event',
    searchQuery: 'test keyword',
    customData: {
      "Custom_Event_Property_Key1": "Custom_Event_Property_val1",
      "Custom_Event_Property_Key2": "Custom_Event_Property_val2"
    }
  };
  Branch.sendBranchEvent(event, metadata);
}).catch(function error(err) {
  alert("Get Standard Event " + err);
});

Handle Referrals

var amount = 10;
var bucket = "this_bucket";
Branch.redeemRewards(amount, bucket).then(function success(res) {
  alert("Response: " + JSON.stringify(res));
}).catch(function error(err) {
  alert("Error: " + JSON.stringify(err));
});

var amount = 10;
Branch.redeemRewards(amount).then(function success(res) {
  alert("Response: " + JSON.stringify(res));
}).catch(function error(err) {
  alert("Error: " + JSON.stringify(err));
});
  • Load credits
var bucket = "this_bucket";
Branch.loadRewards(bucket).then(function success(res) {
  alert("Response: " + JSON.stringify(res));
}).catch(function error(err) {
  alert("Error: " + JSON.stringify(err));
});

Branch.loadRewards().then(function success(res) {
  alert("Response: " + JSON.stringify(res));
}).catch(function error(err) {
  alert("Error: " + JSON.stringify(err));
});
  • Load history
Branch.creditHistory().then(function success(res) {
  alert("Response: " + JSON.stringify(res));
}).catch(function error(err) {
  alert("Error: " + JSON.stringify(err));
});

Troubleshoot Issues

Testing: Key Points

  • Need to select "app uses IDFA or GAID" when publishing your app

  • Best to enable Deepviews (Testing: Supported Platforms)

  • Mobile browser capability: Android 4.4.4+, Safari 8+, Chrome 32+, Firefox 29+

Testing: Optional App Config

  • Additional configuration for custom link domains, simulating installs, unique bundle identifiers, etc
<!-- sample config.xml -->
    <widget id="com.eneff.branch.cordovatestbed" version="1.0.0" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
      <!-- Branch -->
      <plugin name="branch-cordova-sdk" spec="^4.0.0" /> <!-- optional spec -->
      <branch-config>
        <branch-key value="key_live_ndqptlgXNE4LHqIahH1WIpbiyFlb62J3" />
        <uri-scheme value="branchcordova" />
        <link-domain value="yourcustomdomain.com" />
        <link-domain value="cordova.app.link" />  <!-- optional previous link domain -->
        <link-domain value="bnc.lt" />  <!-- optional previous link domain -->
        <ios-team-release value="PW4Q8885U7" /> <!-- required if iOS app -->
        <ios-team-debug value="FG35JLLMXX" /> <!-- optional -->
        <android-prefix value="/WSuf" /> <!-- optional (for bnc.lt) -->
        <android-testmode value="true" /> <!-- optional (simulate installs) -->
      </branch-config>
      
      
 <widget ios-CFBundleIdentifier="com.eneff.branch.cordovatestbedios" android-packageName="com.eneff.branch.cordovatestbedandroid" version="1.0.0" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">

Testing: Branch Analytics

  • Whenever a user clicks on a deep link and opens the app, and will trigger either an install or an open

  • installs represent Branch recognizing the app_id and device_id for the first time

  • installs represent new app users and the success rate of your Branch deep links

  • installs do not represent App Store downloads

  • non-Branch installs are installs outside of Branch deep link clicks

  • opens are non-installs

  • If a user uninstalls and reinstalls the app, this will be an open because Branch recognizes the device

  • If a user has the app and clicks a Branch deep link, this will be an open because the user is not new

Testing: Simulating an Install

  • Delete your app

  • [iOS] iPhone Device -> Settings -> Privacy -> Advertising -> Reset Advertising Identifier -> Reset Identifier

  • [Android] Add <android-testmode value="true" /> to your config.xml (Testing: Optional App Config)

  • Add Branch.setDebug(true); before Branch.initSession(); (Initialize Branch Features)

  • Click on a deep link to navigate to your $fallback_url because your app is not installed

  • Install your app

  • Open your app

  • Read from Branch.initSession().then(data) for +is_first_session = true

Testing: Supported Platforms

  • Apps which support Branch deep links
iOSDetailsAndroidDetails
Facebook NewsFeedWorks when DeepViews are enabled
Facebook MessangerWorks when DeepViews are enabled
Twitter
PinterestWorks when DeepViews are enabled
Slack
Chrome address bar🅾🅾
Chrome web page
FireFox address bar🅾🅾
FireFox web page
Safari address bar🅾
Safari web page
WeChatWorks when DeepViews are enabled
WhatsAppapp.link requires https/http to be clickableapp.link requires https/http to be clickable
Hangouts
iMessage
Apple Mail
Gmail

Link Data: Universal Object properties

KeyDefaultUsageLink Property
canonicalIdentifier(Required) This is the unique identifier for content that will help Branch dedupe across many instances of the same thing. Suitable options: a website with pathing, or a database with identifiers for entities$canonical_identifier
canonicalUrlThe canonical URL, used for SEO purposes$canonical_url
titleThe name for the piece of content$og_title
contentDescriptionA description for the content$og_description
contentImageUrlThe image URL for the content. Must be an absolute path$og_image_url
priceThe price of the item$amount
currencyThe currency representing the price in ISO 4217 currency code$currency
contentIndexingMode"public"Can be set to either "public" or "private". Public indicates that you’d like this content to be discovered by other apps.$publicly_indexable
contentMetadataAny custom key-value data e.g. { "custom": "data" }

Link Data: Deep Link Properties

KeyDefaultUsage
channelUse channel to tag the route that your link reaches users. For example, tag links with "Facebook" or "LinkedIn" to help track clicks and installs through those paths separately
featureThis is the feature of your app that the link might be associated with. For example, if you had built a referral program, you would label links with the feature ‘referral’
campaignUse this field to organize the links by actual campaign. For example, if you launched a new feature or product and want to run a campaign around that
stageUse this to categorize the progress or category of a user when the link was generated. For example, if you had an invite system accessible on level 1, level 3 and 5, you could differentiate links generated at each level with this parameter
tagsThis is a free form entry with unlimited values ["string"]. Use it to organize your link data with labels that don’t fit within the bounds of the above
aliasSpecify a link alias in place of the standard encoded short URL e.g. yourdomain.com/youralias. Link aliases are unique, immutable objects that cannot be deleted. You cannot change the alias of existing links. Aliases on the legacy bnc.lt domain are incompatible with Universal Links and Spotlight
type0Set to 1 to limit deep linking behavior of the generated link to a single use. Set type to 2 to make the link show up under Marketing Dashboard while adding $marketing_title to data. Must be an int. Does not work with the Cordova SDK (limitation of native SDKs)
  • Properties

    • Custom Data
KeyValueUsage
random123Any key-value pair
hello"world"Any key-value pair
custom_datatrueAny key-value pair
- Redirection
KeyDefaultUsage
$fallback_urlChange the redirect endpoint for all platforms - so you don’t have to enable it by platform. Note that Branch will forward all robots to this URL, which overrides any OG tags entered in the link. System-wide Default URL (set in Link Settings)
$desktop_urlChange the redirect endpoint on desktops Text-Me-The-App page (set in Link Settings)
$ios_urlChange the redirect endpoint for iOS App Store page for your app (set in Link Settings)
$ipad_urlChange the redirect endpoint for iPads $ios_url value
$android_urlChange the redirect endpoint for Android Play Store page for your app (set in Link Settings)
$windows_phone_urlChange the redirect endpoint for Windows OS Windows Phone default URL (set in Link Settings)
$blackberry_urlChange the redirect endpoint for Blackberry OS BlackBerry default URL (set in Link Settings)
$fire_urlChange the redirect endpoint for Amazon Fire OS Fire default URL (set in Link Settings)
$ios_wechat_urlChange the redirect endpoint for WeChat on iOS devices $ios_url value
$android_wechat_urlChange the redirect endpoint for WeChat on Android devices $android_url value
$after_click_urlURL redirect to after the main click redirect has completed
$web_onlyfalseForce to open the $fallback_url instead of the app
- Deep Link
KeyDefaultUsage
$deeplink_pathopen?link_click_id=1234Set the deep link path for all platforms - so you don’t have to enable it by platform. When the Branch SDK receives a link with this parameter set, it will automatically load the custom URI path contained within
$android_deeplink_pathSet the deep link path for Android apps When the Branch SDK receives a link with this parameter set, it will automatically load the custom URI path contained within
$ios_deeplink_pathSet the deep link path for iOS apps. When the Branch SDK receives a link with this parameter set, it will automatically load the custom URI path contained within
$match_duration7200Lets you control the probabilistic modeling timeout (the time that a click will wait for an app open) also known as attribution window. Specified in seconds
$always_deeplinktrueSet to false to make links always fall back to your mobile site. Does not apply to Universal Links or Android App Links.
$ios_redirect_timeout750Control the timeout that the client-side JS waits after trying to open up the app before redirecting to the App Store. Specified in milliseconds
$android_redirect_timeout750Control the timeout that the clientside JS waits after trying to open up the app before redirecting to the Play Store. Specified in milliseconds
$one_time_usefalseSet to true to limit deep linking behavior of the generated link to a single use. Can also be set using type
$custom_sms_textText for SMS link sent for desktop clicks to this link. Must contain {{ link }} Value of Text me the app page in Settings
$marketing_titleThe Marketing Title for the deep link in the Marketing Dashboard
- Content
KeyDefaultUsage
$publicly_indexable1Cannot modify here. Needs to be set by the Branch Universal Object
$keywordsKeywords for which this content should be discovered by. Just assign an array of strings with the keywords you’d like to use
$canonical_identifierThis is the unique identifier for content that will help Branch dedupe across many instances of the same thing. Suitable options: a website with pathing, or a database with identifiers for entities
$exp_date0Cannot modify here. Needs to be set by the Branch Universal Object. Must be epoch timestamp with milliseconds
$content_typeThis is a label for the type of content present. Apple recommends that you use uniform type identifier as described here
- DeepView
KeyDefaultUsage
$ios_deepviewdefault_templateThe name of the deepview template to use for iOS
$android_deepviewdefault_templateThe name of the deepview template to use for Android
$desktop_deepviewdefault_templateThe name of the deepview template to use for the Desktop
- Open Graph
KeyDefaultUsage
$og_titleSet the title of the link as it will be seen in social media displays
$og_descriptionSet the description of the link as it will be seen in social media displays
$og_image_urlSet the image of the link as it will be seen in social media displays
$og_image_widthSet the image’s width in pixels for social media displays
$og_image_heightSet the image’s height in pixels for social media displays
$og_videoSet a video as it will be seen in social media displays
$og_urlSet the base URL of the link as it will be seen in social media displays
$og_typeSet the type of custom card format link as it will be seen in social media displays
$og_redirect(Advanced, not recommended) Set a custom URL that we redirect the social media robots to in order to retrieve all the appropriate tags
$og_app_id(Rarely used) Sets the app id tag
- Twitter
KeyDefaultUsage
$twitter_cardSet the Twitter card type of the link
$twitter_titleSet the title of the Twitter card
$twitter_descriptionSet the description of the Twitter card
$twitter_image_urlSet the image URL for the Twitter card
$twitter_siteSet the site for Twitter
$twitter_app_countrySet the app country for the app card
$twitter_playerSet the video player’s URL. Defaults to the value of $og_video.
$twitter_player_widthSet the player’s width in pixels
$twitter_player_heightSet the player’s height in pixels

Link Data: Commerce properties

ValueCategoryValueCategory
0Animals & Pet Supplies11Home & Garden
1Apparel & Accessories12Luggage & Bags
2Arts & Entertainment13Mature
3Baby & Toddler14Media
4Business & Industrial15Office Supplies
5Camera & Optics16Religious & Ceremonial
6Electronics17Software
7Food, Beverage & Tobacco18Sporting Goods
8Furniture19Toys & Games
9Hardware20Vehicles & Parts
10Health & Beauty
  • Currencies
ValueCurrencyValueCurrencyValueCurrency
0AED60HKD120RSD
1AFN61HNL121RUB
2ALL62HRK122RWF
3AMD63HTG123SAR
4ANG64HUF124SBD
5AOA65IDR125SCR
6ARS66ILS126SDG
7AUD67INR127SEK
8AWG68IQD128SGD
9AZN69IRR129SHP
10BAM70ISK130SLL
11BBD71JMD131SOS
12BDT72JOD132SRD
13BGN73JPY133SSP
14BHD74KES134STD
15BIF75KGS135SYP
16BMD76KHR136SZL
17BND77KMF137THB
18BOB78KPW138TJS
19BOV79KRW139TMT
20BRL80KWD140TND
21BSD81KYD141TOP
22BTN82KZT142TRY
23BWP83LAK143TTD
24BYN84LBP144TWD
25BYR85LKR145TZS
26BZD86LRD146UAH
27CAD87LSL147UGX
28CDF88LYD148USD
29CHE89MAD149USN
30CHF90MDL150UYI
31CHW91MGA151UYU
32CLF92MKD152UZS
33CLP93MMK153VEF
34CNY94MNT154VND
35COP95MOP155VUV
36COU96MRO156WST
37CRC97MUR157XAF
38CUC98MVR158XAG
39CUP99MWK159XAU
40CVE100MXN160XBA
41CZK101MXV161XBB
42DJF102MYR162XBC
43DKK103MZN163XBD
44DOP104NAD164XCD
45DZD105NGN165XDR
46EGP106NIO166XFU
47ERN107NOK167XOF
48ETB108NPR168XPD
49EUR109NZD169XPF
50FJD110OMR170XPT
51FKP111PAB171XSU
52GBP112PEN172XTS
53GEL113PGK173XUA
54GHS114PHP174XXX
55GIP115PKR175YER
56GMD116PLN176ZAR
57GNF117PYG177ZMW
58GTQ118QAR
59GYD119RON

Link data: Mixpanel Integration

  • Sync with Mixpanel if plugin is installed
Branch.setRequestMetadata("$mixpanel_distinct_id", "123");

Compiling: Cordova dependencies

  • Node
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)";
brew update;
brew install node;
  • Xcode

    • Install Xcode

    • Open Xcode -> agree to SDK license agreement

    • Open Xcode -> Create new Xcode project -> Run simulator -> Agree to developer mode on mac

  • Android Studio

    • Read instructions

    • Install JVM

    • Install Android Studio

    • Open Android Studio -> configure -> appearance/system settings/android sdk -> android 6.0 -> Okay

    • Open Android Studio -> New project -> ... -> Run -> Create new emulator -> Nexus 6p 23 -> Finish

# add to ~/.bash_profile
export ANDROID_HOME=$HOME/Library/Android/sdk
export PATH=$ANDROID_HOME/tools:$PATH
export PATH=$ANDROID_HOME/platform-tools:$PATH


source ~/.bash_profile;


android update sdk;
  • Install Android SDK build-tools 24.0.1

  • Generate Android Keystore

keytool -genkeypair -dname "cn=Full Name, ou=Business Unit, o=Company, c=US" -alias release -keypass aaa111 -keystore release.keystore -storepass aaa111 -validity 10000
keytool -list -v -keystore release.keystore
  • Genymotion [optional]

    • Install Virtual Box

    • Install Genymotion

    • Genymotion -> Add virtual device -> Google Nexus 6P - 6.0.0 - API 23 -> Next

Compiling: Display console logs

  • iOS Simulator

    • cordova run ios;

    • Safari -> Preferences -> Advance -> Show Develop menu in menu bar

    • Safari -> Develop -> Simulator -> index.html -> Console

    • May need to unplug and replug device

    • May need to open Xcode and update provisioning profile

  • iOS Xcode

    • cordova plugin add cordova-plugin-console;

    • cordova build ios;

    • Xcode -> APP_LOCATION/platforms/ios/APP_NAME.Xcodeproj

    • Xcode -> App -> General -> Signing -> Team

    • Xcode -> Product -> Run

    • Xcode -> View -> Debug Area -> Activate Console

  • Android Device

    • Plug device in

    • cordova run android;

    • Chrome -> [chrome://inspect/#devices](chrome://inspect/#devices) -> Console

  • Android Genymotion

    • Genymotion -> Start

    • cordova run android;

    • Chrome -> [chrome://inspect/#devices](chrome://inspect/#devices) -> Console

Compiling: Update the Branch SDK

  • To get the latest improvements and capabilities
# terminal
cordova plugin remove io.branch.sdk
cordova plugin remove branch-cordova-sdk
<!-- config.xml -->
<plugin name="branch-cordova-sdk" spec="^4.0.0" />

Compiling: Incompatibilities

  • The following plugins will not work with the Branch SDK

  • PhoneGap Build is also not supported by the Branch SDK because we need plugin hooks to enable Entitlements, Universal Links, App Links, and URI Scheme redirects but PhoneGap Build does not allow plugin hooks.

  • With both the 'branch-cordova-sdk' plugin and the 'cordova-plugin-siri-shortcuts' plugin installed, deep-linking breaks. This seems to most often happen when the siri shortcuts plugin is installed after the branch plugin.

    • Solution
      • Using a modified version of the AppDelegate+SiriShortcuts Category to include Branch. This version only works if both Branch and SiriShortcuts is present.
      • From within the Xcode workspace, locate AppDelegate+BranchSDK.m. Either remove it or ignore it.
      • From within the Xcode workspace, locate AppDelegate+SiriShortcuts.m. This is the file we want to modify.
      • Update AppDelegate+SiriShortcuts.m to call Branch SDK. This version should work when dropped in with the current release of both SDKs.
#import "AppDelegate+SiriShortcuts.h"
    #import <objectivec/runtime.h>

    #import "BranchNPM.h"

    #ifdef BRANCH_NPM
    #import "Branch.h"
    #else
    #import <Branch/Branch.h>
    #endif

    static void * UserActivityPropertyKey = &UserActivityPropertyKey;

    @implementation AppDelegate (siriShortcuts)

    - (NSUserActivity *)userActivity {
        return objectivec_getAssociatedObject(self, UserActivityPropertyKey);
    }

    - (void)setUserActivity:(NSUserActivity *)activity {
        objectivec_setAssociatedObject(self, UserActivityPropertyKey, activity, objectivec_ASSOCIATION_RETAIN_NONATOMIC);
    }

    - (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray *))restorationHandler {

        // SiriShortcuts code
        NSString *bundleIdentifier = [[NSBundle mainBundle] bundleIdentifier];
        if ([userActivity.activityType isEqualToString:[NSString stringWithFormat:@"%@.shortcut", bundleIdentifier]]) {
            self.userActivity = userActivity;
        }

        // Respond to Universal Links
        if (![[Branch getInstance] continueUserActivity:userActivity]) {
            // send unhandled URL to notification
            if ([userActivity.activityType isEqualToString:NSUserActivityTypeBrowsingWeb]) {
                [[NSNotificationCenter defaultCenter] postNotification:[NSNotification notificationWithName:@"BSDKPostUnhandledURL" object:[userActivity.webpageURL absoluteString]]];
            }
        }

        return YES;
    }

    // Respond to URI scheme links
    - (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
        // pass the url to the handle deep link call
        if (![[Branch getInstance] application:app openURL:url options:options]) {
            // do other deep link routing for the Facebook SDK, Pinterest SDK, etc
            [[NSNotificationCenter defaultCenter] postNotification:[NSNotification notificationWithName:CDVPluginHandleOpenURLNotification object:url]];
            // send unhandled URL to notification
            [[NSNotificationCenter defaultCenter] postNotification:[NSNotification notificationWithName:@"BSDKPostUnhandledURL" object:[url absoluteString]]];
        }
        return YES;
    }

    // Respond to Push Notifications
    - (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo {
        @try {
            [[Branch getInstance] handlePushNotification:userInfo];
        }
        @catch (NSException *exception) {
            [[NSNotificationCenter defaultCenter] postNotification:[NSNotification notificationWithName:@"BSDKPostUnhandledURL" object:userInfo]];
        }
    }

    @end

Compiling: Cordova errors

Migrate from SDK 2.5+ to 3.0+

// Branch initialization
- Branch.initSession(function(data) {
+ Branch.initSession().then(function(data) {
if (data["+clicked_branch_link"]) {
// read deep link data on click
alert("Deep Link Data: " + JSON.stringify(data));
}
});

Device only

  • Error

ORIGINAL EXCEPTION: Branch is not defined

ReferenceError: Branch is not defined

  • Solution

    • Branch opens and installs your app, so you cannot simulate Branch in the desktop browser or simulator
// Ionic 2/3 - running on browser instead of device
if (!platform.is('cordova')) { return }
Branch.userCompletedAction('did_this')


// Ionic 2/3 - missing Branch import
const Branch = window['Branch'];

Provisioning Profile missing

  • Error

** ARCHIVE FAILED **

The following build commands failed:
Check dependencies
    (1 failure)
    Error: Error code 65 for command: xcodebuild with args: -xcconfig,cordova/build-debug.xcconfig,-workspace,Branch Testing.xcworkspace,-scheme,Branch Testing,-configuration,Debug,-destination,generic/platform=iOS,-archivePath,Branch Testing.xcarchive,archive,CONFIGURATION_BUILD_DIR=build/device,SHARED_PRECOMPS_DIR=build/sharedpch
No profiles for 'com.eneff.branch.cordova_testbed' were found
  • Solution

    • Fix by opening your app in Xcode and launch from there (to select a Provisioning Profile)

Invalid bundle id

  • Error
An invalid value 'XC com eneff branch cordova_testbed' was provided for the parameter 'appIdName'.


Error: Error code 1 for command: /gradlew with args: cdvBuildDebug,-b,/build.gradle,-Dorg.gradle.daemon=true,-Pandroid.useDeprecatedNdk=true
  • Solution

    • Don't use cordova, hyphens (Android), or underscores (iOS) in your bundle id (widget id)

File not found

  • Error
Branch.h not found
  • Solution

    • If that is the ONLY error you see, this can be fixed by upgrading dependencies. Ensure you are using version 4.0.1 of this plugin or higher and have updated your Xcode, Cordova, and other dependencies (listed below) to the latest versions. This error arose due to an inability in CocoaPods and cordova-ios to resolve dependencies that was later fixed.

    • Sometimes this error occurs when a build error occurs in the Pod project; since Branch is usually the first pod alphabetically, it'll show up as the error when attempting to build the main project (since the Pod didn't get built), even though the real error is elsewhere. Make sure to read your build log to find the original error that prevented building the Pod project.

Build fails with Pods

  • iOS build fails with Pods and CONFIGURATION_BUILD_DIR configured

  • Command-line builds result in the above error. Please see the section below Compiling: Capacitor for the full list of up-to-date dependencies needed for CLI builds to work.

Compiling: Cordova 8

  • Version 4.1.x of this plugin works with Cordova 8, but you need to add some fields to your config.xml file:

  • Cordova 8 does not correctly support CocoaPods, which the 4.x releases of this plugin utilize

  • This plugin can't include both versions of the pod spec, which changed between Cordova 8 and Cordova 9. We have chosen to include the Cordova 9 version.

  • In order to support Cordova 8's handling of CocoaPods, you must install an extra Cordova plugin to correctly incorporate our CocoaPod ("Branch" v.0.31.3 as of 2020.02.10)

  • Install the plugin cordova-plugin-cocoapods-support

  • That plugin does not add any code to your app, it is strictly a Cordova hook to create your Podfile before building your app.

  • Add the following lines to the widget/platform[name="ios"] path in config.xml:

<preference name="pods_ios_min_version" value="<YOUR MINIMUM VALUE>" />
<pod name="Branch" spec="~> 0.31.3" />
  • Replace <YOUR MINIMUM VALUE> with the minimum iOS version your app requires, e.g. "8" or "10.0" or "11.4"

  • Run cordova prepare ios again and ensure you see console output similar to

Searching for new pods
Checking config.xml for pods.
config.xml requires pod: Branch
Installing pods
Sit back and relax this could take a while.
  • Provided that the dependencies listed in the next section are up to date (see Compiling: Capacitor), you should also be able to do cordova build ios without issue.

Compiling: Capacitor

  • Version 4.1.0 of this plugin works with Ionic 4 + Cordova and Ionic 4 + Capacitor, with the following caveats:

  • We strongly recommend Node >= 10.15. Node 8 might work, but it is not tested.

  • For BOTH Cordova and Capacitor, you must use Xcode >= 11.1, CocoaPods >= 1.8.4, Cordova >= 8.0.0, Ionic-CLI >= 5.1, cordova-ios >= 5.1.0

    • Every single one of these dependencies has fixes that allow the command line build, and the pod dependency resolution to work correctly
  • You MUST use @capacitor/ios >= 1.4.0. Versions prior to that version did not federate the OpenURL notifications to other plugins, including Branch.

  • use_frameworks has been removed from this plugin and will now be statically built. If the another podfile uses use_frameworks that is fine but this plugin no longer flags itself as dynamic. Ideally your app should be updated to remove use_frameworks! from your Podfile.

  • When using Capacitor, you must add the following entries yourself to ios/App/App/Info.plist:

<key>CFBundleURLTypes</key>
<array>
  <dict>
    <key>CFBundleURLName</key>
    <string>com.getcapacitor.capacitor</string>
    <key>CFBundleURLSchemes</key>
    <array>
      <string>capacitor</string>
    </array>
  </dict>
  <dict>
    <key>CFBundleURLName</key>
    <string>branch-cordova-sdk</string>
    <key>CFBundleURLSchemes</key>
    <array>
      <string>[YOUR URL SCHEME HERE]</string>
    </array>
  </dict>
</array>
<key>branch_key</key>
<string>[YOUR BRANCH LIVE KEY]</string>
<key>branch_app_domain</key>
<string>[YOUR DOMAIN].app.link</string>
  • This is a limitation of Capacitor where explicit config changes are the developer's responsibility in order to avoid "magic config"

  • When using Capacitor, you must add your Associated Domains entitlements via the Xcode entitlement editor yourself

    • This MUST be done using Xcode - again this is part of Capacitor's core philosophy whereby you are in control of every config file change

    • Open the "Signing & Entitlements" tab in Xcode, add the Associated Domains entitlement, and add the urls found on your Branch dashboard.

AppStore: iOS

  • App rejected because it uses push notification features but does not declare the aps-environment key

  • When branch-cordova-sdk moved to use CocoaPods, a change was introduced in Cordova 9 where the separate entitlement files were no longer flattened together. This issue has been fixed in version 4.1.0 of this plugin by directly adding the Branch config to your existing entitlements rather than creating new entitlement files. This change is backward-compatible with Cordova 8.

Apple Search Ads: iOS

Updated 2 months ago


Cordova PhoneGap Ionic


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.


Filters