Guides

Creating a direct click URL

Suggest Edits

🚧

This method requires v2.4.0 and above

📘

This method is an extension to Smart Script

Make sure you read the Smart Script implementation and arguments

Overview

This method provides support for creating a click URLs, to be used mainly by non mobile platforms (e.g. Steam, CTVs etc). When the click is matched to an installation, an attribution will be noted.

Arguments

Argument Remarks Example

afParameters

(required)

 

 

 

mediaSource

(required)

Configuration object for media source
  • Keys: ['incoming_mediasource’' 'utm_source']
  • Override values: {twitter: 'twitter_int', orig_src: 'new_src'}
  • Default value: ['any_source']

campaign

Configuration object for campaign
  • Keys: ['incoming_campaign', 'utm_campaign']
  • Override values: {campaign_name: 'new_campaign_name'}
  • Default value: ['any_campaign_name']

channel

Configuration object for channel
  • Keys: ['incoming_channel', 'utm_channel']
  • Override values: {video: 'new_video'}
  • Default value: ['any_video']

ad

Configuration object for ad
  • Keys: ['incoming_ad', 'utm_ad']
  • Override values: {ad_name: 'new_ad_name'}
  • Default value: ['any_ad_name']
adSet

Configuration object for adset
  • Keys: ['incoming_adset', 'utm_adset']
  • Override values: {'adset_name': 'new_adset_name'}
  • Default value: ['any_adset_name']
Other (custom) query parameters
  • List of any other parameters you want to be included in the outgoing OneLink URL for attribution or deep linking, along with their configuration objects.
  • The name of the custom parameter is listed by the developer as paramKey in the configuration object.
  • paramKey: 'deep_link_sub1'
  • Keys: ['page_id']
  • Override values: {page12: 'new_page12'}
  • Default value: 'page1'
platform A string describes the platform. MUST be from this list:
  • smartcast
  • tizen
  • roku
  • webos
  • vidaa
  • playstation
  • android
  • ios
  • steam
  • quest
  • battlenet
  • nativepc
  • epic
  • switch
    		•  "steam"
    app_id Application ID "123456"
    redirectURL The URL the user will be redirected "https://store.steampowered.com/app/123456/Team_Fortress_2/"

    Game landing page demo

    You can find here a fully functional demo landing page which demonstrates integrating the generateDirectClickURL Smart Script code.

    Code example for a Steam game

    //Initializing Smart Script arguments
// If a media source key is NOT FOUND on the link and NO default value is found, the script will return a null string 
var mediaSource = {keys: ["my_media_source"], defaultValue: "my_default_media_source"};
var campaign = {keys: ["my_campaign"], defaultValue: "my_default_campaign"};

//Calling the function after embedding the code will be through a global parameter on the window object called window.AF_SMART_SCRIPT
//Onelink URL is generated

var result = window.AF_SMART_SCRIPT.generateDirectClickURL({
  afParameters:{
    mediaSource: mediaSource,
    campaign: campaign
  },
  platform: 'steam',
  app_id: '123456',
  redirectURL:'https://store.steampowered.com/app/123456/Team_Fortress_2/'
})

var result_url = "No output from script"
if (result) {
  result_url = result.clickURL;            
}

    See example of the conversion of an incoming URL to an outgoing direct click URL for a Steam game.

    Updated 2 months ago