Creating a direct click URL

🚧

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

Resumen General

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.

Argumentos

Argumento Observaciones Ejemplo

afParameters

(obligatorio)

 

 

 


mediaSource

(obligatorio)

Objeto de configuración para la fuente de medios

  • Claves: ['incoming_mediasource’' 'utm_source']
  • Valores a sobrescribir: {twitter: 'twitter_int', orig_src: 'new_src'}
  • Valor predeterminado: ['any_source']

campaign

Objeto de configuración para la campaña

  • Claves: ['incoming_campaign', 'utm_campaign']
  • Valores a sobrescribir: {campaign_name: 'new_campaign_name'}
  • Valor predeterminado: ['any_campaign_name']

channel

Objeto de configuración para el canal

  • Claves: ['incoming_channel', 'utm_channel']
  • Valores a sobrescribir: {video: 'new_video'}
  • Valor predeterminado: ['any_video']

ad

Objeto de configuración para el anuncio

  • Claves: ['incoming_ad', 'utm_ad']
  • Valores a sobrescribir: {ad_name: 'new_ad_name'}
  • Valor predeterminado: ['any_ad_name']
adSet

Objeto de configuración para conjunto de anuncios

  • Claves: ['incoming_adset', 'utm_adset']
  • Valores a sobrescribir: {'adset_name': 'new_adset_name'}
  • Valor predeterminado: ['any_adset_name']
Otros parámetros de consulta (personalizados)
  • Lista de cualquier otro parámetro que desees incluir en la URL de OneLink saliente para atribución o enlaces profundos, junto con sus objetos de configuración.
  • El desarrollador enumera el nombre del parámetro personalizado como paramKey en el objeto de configuración.
  • paramKey: 'deep_link_sub1'
  • Claves: ['page_id']
  • Valores a sobrescribir: {page12: 'new_page12'}
  • Valor predeterminado: 'page1'
platform A string describes the platform. MUST be from this list:
  • smartcast
  • tizen
  • roku
  • webos
  • vidaa
  • playstation
  • android
  • ios
  • steam
  • quest
  • battlenet
  • "steam"
    app_id ID de aplicación "123456"
    redirectURL The URL the user will be redirected "https://store.steampowered.com/app/123456/Team_Fortress_2/"

    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.