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

Tổng quan

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.

Đối số

Đối số Nhận xét Ví dụ:

afParameters

(bắt buộc)

 

 

 


mediaSource

(bắt buộc)

Đối tượng cấu hình cho nguồn truyền thông

  • Mã khóa: ['incoming_mediasource’' 'utm_source']
  • Giá trị ghi đè: {twitter: 'twitter_int', orig_src: 'new_src'}
  • Giá trị mặc định: ['any_source']

campaign

Đối tượng cấu hình cho chiến dịch

  • Mã khóa: ['incoming_campaign', 'utm_campaign']
  • Giá trị ghi đè: {campaign_name: 'new_campaign_name'}
  • Giá trị mặc định: ['any_campaign_name']

channel

Đối tượng cấu hình cho kênh

  • Mã khóa: ['incoming_channel', 'utm_channel']
  • Giá trị ghi đè: {video: 'new_video'}
  • Giá trị mặc định: ['any_video']

ad

Đối tượng cấu hình cho quảng cáo

  • Mã khóa: ['incoming_ad', 'utm_ad']
  • Giá trị ghi đè: {ad_name: 'new_ad_name'}
  • Giá trị mặc định: ['any_ad_name']
adSet

Đối tượng cấu hình cho bộ quảng cáo

  • Mã khóa: ['incoming_adset', 'utm_adset']
  • Giá trị ghi đè: {'adset_name': 'new_adset_name'}
  • Giá trị mặc định: ['any_adset_name']
Các thông số truy vấn (tùy chỉnh) khác
  • Danh sách bất kỳ thông số nào khác mà bạn muốn được đưa vào URL OneLink gửi đi để phân bổ hoặc liên kết sâu, cùng với các đối tượng cấu hình của chúng.
  • Tên của thông số tùy chỉnh được nhà phát triển liệt kê là paramKey trong đối tượng cấu hình.
  • paramKey: 'deep_link_sub1'
  • Mã khóa: ['page_id']
  • Giá trị ghi đè: {page12: 'new_page12'}
  • Giá trị mặc định: 'page1'
platform A string describes the platform. MUST be from this list:
  • smartcast
  • tizen
  • Roku
  • webos
  • Vidaa
  • PlayStation
  • Android
  • ios
  • Steam
  • quest
  • battlenet
  • nativepc
  • "steam"
    app_id ID Ứng dụng "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.