Smart script fonksiyonları

Yapılandırma, pazarlamacının gereksinimlerine uygun şekilde yapıldığı sürece Smart script'ler web’den uygulamaya doğru attribution yapar. Ancak, geliştiricinin ek değişiklikler yapması gerekirse bu script özelleştirilebilir. Aşağıdaki bölümde, script'teki farklı property ve fonksiyonlara dair bilgi ve örnekler bulabilirsiniz.

Smart script fonksiyonları

Log seviyesi

Gerekiyorsa setLogLevel fonksiyonunu kullanarak tarayıcı konsolundaki logging seviyesini belirleyebilirsiniz. Bu fonksiyonu createLink fonksiyonundan önce çağırın. Argümanlar debug, warn, error veya none olabilir. Varsayılan log seviyesi değeri debug'dır.

AdjustSmartScript.setLogLevel('warn')

Link oluştur

Belirtilen mapping objesi property'leriyle bir Adjust link'i oluşturmak için createLink fonksiyonunu kullanın.

const mapping = { /* mapping object properties */ }
AdjustSmartScript.createLink(mapping)

Script versiyonunu almak

Smart script versiyonunu kontrol etmek için getVersion fonksiyonunu kullanın.

AdjustSmartScript.getVersion()

Mapping objesi property'leri

createLink metoduyla bir mapping objesi kullanmanız gerekir. mapping objesinde bu property'leri tanımladığınızdan emin olun.

defaultLinkToken (string)

Hiçbir ağ link token'ı kullanılabilir olmadığında veya ağ yapılandırması sağlanmadığında kullanılacak ağ token'ı.

campaign (object)

Kampanya bilgilerini içeren bir obje.

adgroup (object)

Adgroup bilgilerini içeren bir obje.

creative (object)

Kreatif bilgilerini içeren bir obje.

campaign, adgroup ve creative kodları bu property'i içermelidir:

in (string | string[])

Kampanya, adgroup veya kreatif adı olarak kullanılacak URL query string'lerinin key'leri olan bir string veya string array'i.: Bir array kullanılırsa script, GET parametrelerindeki adları bulur ve mevcutsa bunların tümünü transform fonksiyonuna iletir. Diğer durumlarda script, ilk boş olmayan değeri kampanya, adgroup veya kreatif adı olarak yazar.

Ayrıca bu property'leri de sağlayabilirsiniz:

transform (function)

in değeri ile çağrılan bir fonksiyon. Kampanya, adgroup ya da kreatifin son adını belirten bir string değeri döndürür. transform bir string döndürmezse ya da bir hata verirse, script ilk boş olmayan değeri kampanya, adgroup ya da kreatif adı olarak yazar.

defaultValue (string)

transform fonksiyonu in değerini bulamadığında kullanılır.

Deeplink kullanıyorsanız, bu parametreleri mutlaka mapping objesinde tanımlayın:

domain (string)

Markalı domain.

Deeplink kullanmıyorsanız markalı domain'i tanımlayabilirsiniz. Hiçbir domain belirtilmezse app.adjust.com link'i oluşturulur.

iosAppSchema (string)

iOS uygulama şeması.

androidAppSchema (string)

Android uygulama şeması.

Deeplink kullanıyorsanız, aşağıdaki parametreleri tanımlayabilirsiniz:

iosDeeplinkPath (string)

iOS deeplink path.

androidDeeplinkPath (string)

Android deeplink path.

Bu parametreleri mapping objesinde tanımlayabilirsiniz:

inputUrl (string)

Mobil web sitesi açılış sayfası URL'i. Bir değer sağlanmadığında script window.location.href değerini mevcut sayfanın URL'i olarak kullanır.

label (object) Bu parametre ile özel veriler gönderebilirsiniz. Daha fazla bilgi için Yardım merkezi dokümantasyonuna göz atabilirsiniz.

networks (object)

Ağ bilgilerini içeren bir key-value objesi.

networks objesi ağ adını temsil eden en az bir key içermelidir. Desteklenen key'ler:

• Meta
• google_ads

Değerin bu property'i içeren bir obje olması gerekir:

linkToken (string)

Key'de tanımlı ağın link token'ı.

customParameters (object)

Özel parametre bilgilerini içeren bir obje.

customParameters objesi bu property'i içermelidir:

in (string | string[])

Bir özel ad olarak kullanılacak URL arama query string'lerinin anahtarları olan bir string veya string array'i.: Bir array kullanılırsa script, GET parametrelerindeki adları bulur ve mevcutsa bunların tümünü transform fonksiyonuna iletir. Diğer durumlarda script, ilk boş olmayan değeri özel ad olarak yazar.

out (string)

Adjust link'inde yazılacak özel parametre adını belirten bir string.

Ayrıca bu property'leri de sağlayabilirsiniz:

transform (function)

in değeri ile çağrılan bir fonksiyon. Son özel adı içeren bir string döndürür. transform bir string döndürmezse ya da bir hata verirse, ilk boş olmayan değer özel ad olarak yazılır.

defaultValue (string)

transform fonksiyonu in değerini bulamadığında kullanılır.

Örnekler

const mapping = {
  inputUrl: "https://www.landing.com?campaign_name=Summer2024&ad_group=SomeGroup",
  defaultLinkToken: "abcd123",
  campaign: { in: "campaign_name" },
  adgroup: { in: "ad_group" },
  creative: { in: "element" }
}
const link = AdjustSmartScript.createLink(mapping);
console.log(link)
// expected output: https://app.adjust.com/abcd123?campaign=Summer2024&adgroup=SomeGroup

const mapping = {
  defaultLinkToken: "abcd1234",
  networks: {
    meta: { linkToken: 'efgh5678'},
    google_ads: { linkToken: 'ijkl9012' }
  },
  campaign: { in: "c" },
  adgroup: { in: "a" },
  creative: { in: "cr" }
}
const link1 = AdjustSmartScript.createLink({
  ...mapping,
  inputUrl: "https://www.landing.com?c=Summer2024&a=SomeGroup&cr=banner&gclid=CLICK_ID"
});
console.log(link1)
// expected output: https://app.adjust.com/ijkl9012?gclid=CLICK_ID&campaign=Summer2024&adgroup=SomeGroup&creative=banner
const link2 = AdjustSmartScript.createLink({
  ...mapping,
  inputUrl: "https://www.landing.com?c=Winter2025&a=AnotherGroup&cr=image&fbclid=FB_CLICK_ID"
});
console.log(link2)
// expected output: https://app.adjust.com/efgh5678?fbclid=FB_CLICK_ID&campaign=Winter2025&adgroup=AnotherGroup&creative=image

const mapping = {
  inputUrl: "https://www.landing.com?utm_content=logo_image&utm_medium=social&utm_source=some-source&utm_campaign=new_campaign",
  defaultLinkToken: "example123",
  domain: "branded.go.link",
  campaign: {
    in: "utm_campaign",
    defaultValue: "dummy-name"
  },
  adgroup: {
    in: ["utm_source", "utm_medium"],
    transform: function(values) { return (values[0] && values[1]) ? `${values[0]}: ${values[1]}` : undefined; }
  },
  creative: {
    in: "utm_content",
    transform: function(values) { return values[0] ? `ad_${values[0]}` : 'ad_default' }
  }
}
const link = AdjustSmartScript.createLink(mapping);
console.log(link)
// expected output: https://branded.go.link?adj_token=example123&adj_campaign=new_campaign&adj_adgroup=some-source%3A%20social&adj_creative=ad_logo_image

const mapping = {
  inputUrl: "https://www.landing.com?user_id=id&cr=logo_image&ad=some_adset&c=new_campaign&product=my_product",
  domain: "example.go.link",
  defaultLinkToken: "abcd1234",
  campaign: { in: "c" },
  adgroup: { in: "ad" },
  creative: { in: "cr" },
  customParameters: [{
    in: ['product', 'user_id'],
    out: 'ref_code',
    transform: function (values) {
      const product = values[0]
      const userId = values[1]
      if (product && userId) {
        return `${userId}+${product}`
      }
      return ''
    }
  }]
}
const link = AdjustSmartScript.createLink(mapping);
console.log(link)
// expected output: https://example.go.link?adj_token=abcd1234&adj_campaign=new_campaign&adj_adgroup=some_adset&adj_creative=logo_image&ref_code=id%2Bmy_product

const mapping = {
  inputUrl: "https://www.landing.com?&cr=logo_image&ad=some_adset&c=new_campaign",
  domain: "example.go.link",
  defaultLinkToken: "abcd1234",
  campaign: { in: "c" },
  adgroup: { in: "ad" },
  creative: { in: "cr" },
  iosAppSchema: "app",
  iosDeeplinkPath: "path/to/screen",
}
const link = AdjustSmartScript.createLink(mapping);
console.log(link)
// expected output: https://example.go.link/path/to/screen?adjust_t=abcd1234&adj_campaign=new_campaign&adj_adgroup=some_adset&adj_creative=logo_image

const mapping = {
  inputUrl: "https://www.landing.com?&cr=logo_image&ad=some_adset&c=new_campaign",
  domain: "example.go.link",
  defaultLinkToken: "abcd1234",
  campaign: { in: "c" },
  adgroup: { in: "ad" },
  creative: { in: "cr" },
  androidAppSchema: "scheme",
  androidDeeplinkPath: "some/path",
}
const link = AdjustSmartScript.createLink(mapping);
console.log(link)
// expected output: https://example.go.link/some/path?adjust_t=abcd1234&adj_campaign=new_campaign&adj_adgroup=some_adset&adj_creative=logo_image

const mapping = {
  inputUrl: "https://www.landing.com?&cr=logo_image&ad=some_adset&c=new_campaign",
  domain: "example.go.link",
  defaultLinkToken: "abcd1234",
  campaign: { in: "c" },
  adgroup: { in: "ad" },
  creative: { in: "cr" },
  androidAppSchema: "scheme",
  androidDeeplinkPath: "some/path",
  iosAppSchema: "app",
  iosDeeplinkPath: "path/to/screen",
}
const link = AdjustSmartScript.createLink(mapping);
console.log(link)
// expected output: https://hello.go.link/path/to/screen?adjust_t=abcd1234&adjust_deeplink=scheme%3A%2F%2Fsome%2Fpath&adj_campaign=new_campaign&adj_adgroup=some_adset&adj_creative=logo_image

Smart script'leri test etmek

Smart script'ler, log'larını tarayıcının konsolunda görüntüler. Script'in belirtilen eşleştirme ile nasıl çalıştığını test etmenizi ve doğru link'lerin oluşturulduğundan emin olmanızı öneririz.

1. Tarayıcınızdaki Geliştirici Araçları konsoluna gidin.
2. Smart script'i uyguladığınız web sayfasına gidin.
3. [adjust-smart-script] prefix'ine sahip bir log yoksa, sayfayı yenileyin. Hala hiçbir log göremiyorsanız, aşağıdakileri kontrol edin:
   • Kodunuzun AdjustSmartScript.setLogLevel('error') ya da AdjustSmartScript.setLogLevel('none') ile log'lara engel olmadığını kontrol edin.
   • Kodunuzun AdjustSmartScript.createLink(params) fonksiyonunu çağırdığından emin olun.

Farklı kullanım senaryolarını inputUrl property'sinin farklı değerleri ile test edebilirsiniz. Örneğin, bir Meta kampanyası yürütüyorsanız ve organik kullanıcıların da açılış sayfanızı ziyaret etmesini bekliyorsanız, kampanya ve Meta parametrelerine sahip bir URL ve herhangi bir ek parametre içermeyen başka bir URL'iniz olabilir.

Örnek log'lar:

[adjust-smart-script]: No networks configured
[adjust-smart-script]: Use defaultLinkToken to create adjust link
[adjust-smart-script]: Found value for campaign is new_campaign
[adjust-smart-script]: Found value for adgroup is some_adset
[adjust-smart-script]: Found value for creative is logo_image
[adjust-smart-script]: Transformed value for ref_code is id+my_product
[adjust-smart-script]: Misconfigured deep link: no valid androidAppSchema provided