Deeplinking support

Deeplinking support directs users to specific pages inside your app. It is designed to provide a streamlined experience to continue the game and app onboarding experience and unfinished customer journey.

The following requirements apply to Deeplinking support:

  • Respond with resp.seatbid[0].bid[0].ext.deeplinking:1
  • Include the following Deeplinking schema in the custom format in the ClickThrough node:
deeplinker://navigate?primaryUrl=twitter%3A%2F%2Ftimeline&fallbackUrl=https%3A%2F%2Fmobile.twitter.com&primaryTracker=https%3A%2F%2Funity.com%2Ftracker%3Ffeature%3Ddeeplinking%26type%3Dprimary&fallbackTracker=https%3A%2F%2Funity.com%2Ftracker%3Ffeature%3Ddeeplinking%26type%3Dfallback
  • deeplinker://navigate: Unity Ads custom deeplink protocol
  • Four query parameters: primaryURL,fallbackUrl,primaryTracker,fallbackTracker
    • primaryURL(required): deeplink URL fired on click event
      • Must be properly encoded URL
      • Example: twitter%3A%2F%2Ftimeline
    • fallbackUrl(optional: used if primary fails): normal URL link (starts with https) fired if deeplink fails
      • Must be properly URL encoded
      • Will be validated as a regular URL
      • Example: https%3A%2F%2Fmobile.twitter.com
    • primaryTracker(optional): normal url link (starts with https) fired when primaryUrl is fired successfully
      • Must be properly URL encoded
      • Will be validated as a regular URL
      • Example: https%3A%2F%2Funity.com%2Ftracker%3Ffeature%3Ddeeplinking%26type%3Dprimary
    • fallbackTracker(optional): normal URL link (starts with https) fired when fallbackUrl is fired successfully
      • Must be properly URL encoded
      • Will be validated as a regular URL
      • Example: https%3A%2F%2Funity.com%2Ftracker%3Ffeature%3Ddeeplinking%26type%3Dfallback

Note: The primaryUrl, fallbackUrl, primaryTracker, fallbackTracker must be properly URL encoded in the whole deeplink URL to work correctly. URLs that are not properly encoded will not work correctly. For example: format deeplinker://navigate?primaryUrl=unity://game?a=b&c=d should be deeplinker://navigate?primaryUrl=unity%3A%2F%2Fgame%3Fa%3Db%26c%3Dd