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

Обзор

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.

Аргументы

Аргумент Примечания Пример

afParameters

(обязательно)

 

 

 

mediaSource

(обязательно)

Объект конфигурации для медиа-источника
  • Ключи: ['incoming_mediasource’' 'utm_source']
  • Значения переопределения: {twitter: 'twitter_int', orig_src: 'new_src'}
  • Значение по умолчанию: ['any_source']

campaign

Объект конфигурации для кампании
  • Ключи: ['incoming_campaign', 'utm_campaign']
  • Значения переопределения: {campaign_name: 'new_campaign_name'}
  • Значение по умолчанию: ['any_campaign_name']

channel

Объект конфигурации для канала
  • Ключи: ['incoming_channel', 'utm_channel']
  • Значения переопределения: {video: 'new_video'}
  • Значение по умолчанию: ['any_video']

ad

Объект конфигурации для объявления
  • Ключи: ['incoming_ad', 'utm_ad']
  • Значения переопределения: {ad_name: 'new_ad_name'}
  • Значение по умолчанию: ['any_ad_name']
adSet

Объект конфигурации для группы объявлений
  • Ключи: ['incoming_adset', 'utm_adset']
  • Значения переопределения: {'adset_name': 'new_adset_name'}
  • Значение по умолчанию: ['any_adset_name']
Другие (настраиваемые) параметры запроса
  • Перечислите любые другие параметры, которые требуется включить в исходящую ссылку OneLink для атрибуции или диплинкинга, а также объекты конфигурации.
  • Имя настраиваемого параметра указывается разработчиком как paramKey в объекте конфигурации.
  • paramKey: 'deep_link_sub1'
  • Ключи: ['page_id']
  • Значения переопределения: {page12: 'new_page12'}
  • Значение по умолчанию: '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 Идентификатор приложения "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.

    Изменения сохранены 22 дня назад