Описание функций умного скрипта

Если настройка выполнена в соответствии с требованиями маркетолога, умный скрипт должен работать и обеспечивать точную атрибуцию из веб-версии в приложение. Однако если разработчику потребуется внести дополнительные изменения, скрипт можно настраивать. В разделе ниже описываются различные свойства и функции скрипта, а также приводятся примеры.

Функции умного скрипта

Установка уровня лога

При необходимости используйте функцию setLogLevel для указания уровня лога в консоли браузера. Вызовите эту функцию перед вызовом функции createLink. Аргументы: debug, warn, error или none. Значение уровня лога по умолчанию — debug.

AdjustSmartScript.setLogLevel('warn')

Создать ссылку

Используйте функцию createLink для создания ссылки Adjust с заданными свойствами сопоставления объекта.

const mapping = { /* свойства сопоставления объекта */ }
AdjustSmartScript.createLink(mapping)

Получение версии скрипта

Используйте функцию getVersion для проверки версии умного скрипта.

AdjustSmartScript.getVersion()

Свойства сопоставления объекта

Объект mapping должен быть передан в метод createLink. ОБЯЗАТЕЛЬНО задайте в объекте mapping приведенные здесь свойства.

defaultLinkToken (string)

токен ссылки, который будет использоваться, если токен ссылки на сеть неприменим или не указана конфигурация сети.

campaign (object)

объект, содержащий информацию о кампании.

adgroup (object)

объект, содержащий информацию о рекламной группе.

creative (object)

объект, содержащий информацию о креативе.

Объекты campaign, adgroup и creative ДОЛЖНЫ содержать следующее свойство:

in (string | string[])

строка или массив строк — ключи для строк поискового запроса URL, которые будут использоваться в качестве имени кампании, рекламной группы или креатива.

если передается массив, скрипт находит эти имена среди параметров GET и, если они есть, передает их все в функцию transform. В противном случае скрипт записывает в качестве имени кампании, рекламной группы или креатива первое непустое значение.

Вы также МОЖЕТЕ предоставить следующие свойства:

transform (function)

функция, вызывающая значение in. Она возвращает строковое значение, которое является конечным именем кампании, рекламной группы или креатива. Если transform не возвращает строку или выдает ошибку, скрипт записывает в качестве имени кампании, группы объявлений или креатива первое непустое значение.

defaultValue (string)

используется, когда значение in не найдено функцией transform.

Если вы используете диплинки, вы ДОЛЖНЫ определить приведенные здесь параметры в объекте mapping.

domain (string)

брендированный домен.

если вы не используете диплинки, можно указать брендированный домен. Если домен не указан, создается ссылка app.adjust.com.

iosAppSchema (string)

схема приложения iOS.

androidAppSchema (string)

схема приложения Android.

Если вы используете диплинки, МОЖНО определить приведенные далее параметры.

iosDeeplinkPath (string)

путь диплинка iOS.

androidDeeplinkPath (string)

путь диплинка Android.

Вы МОЖЕТЕ определить приведенные далее параметры в объекте mapping.

inputUrl (string)

URL-адрес целевой страницы мобильного веб-сайта. Если значение не указано, в качестве URL-адреса текущей страницы скрипт использует значение window.location.href.

label (object`) Этот параметр позволяет отправлять пользовательские данные. Более подробную информацию см. в документации Справочного центра.

networks (object)

Объект с ключом-значением, содержащий информацию о сети.

Объект networks ДОЛЖЕН содержать как минимум один ключ, представляющий имя сети. Поддерживаются следующие ключи:

• Meta
• google_ads

Это значение ДОЛЖНО быть объектом, содержащим следующее свойство:

linkToken (string)

токен ссылки сети, определенной в ключе.

customParameters (object)

объект, содержащий информацию о настраиваемых параметрах.

Объект customParameters ДОЛЖЕН содержать следующее свойство:

in (string | string[])

строка или массив строк — ключи для строк поискового запроса URL, которые будут использоваться в качестве настраиваемого имени.

если передается массив, скрипт находит эти имена среди параметров GET и, если они есть, передает их все в функцию transform. В противном случае скрипт записывает в качестве настраиваемого имени первое непустое значение.

out (string)

строка, указывающая имя настраиваемого параметра, который будет записан в ссылку Adjust.

Вы также МОЖЕТЕ предоставить следующие свойства:

transform (function)

функция, вызывающая значение in. Она возвращает строковое значение, которое является конечным настраиваемым именем. Если transform не возвращает строку или выдает ошибку, в качестве настраиваемого записывается первое непустое значение.

defaultValue (string)

используется, когда значение in не найдено функцией transform.

Примеры

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)
// ожидаемый результат: 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)
// ожидаемый результат: 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)
// ожидаемый результат: 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)
// ожидаемый результат: 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)
// ожидаемый результат: 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)
// ожидаемый результат: 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)
// ожидаемый результат: 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)
// ожидаемый результат: 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

Тестирование умных скриптов

Умные скрипты выводят свои логи в консоль браузера. Рекомендуется протестировать работу скрипта с указанным сопоставлением и убедиться, что создаются правильные ссылки.

1. В браузере перейдите в консоль инструментов разработчика.
2. Перейдите на веб-страницу, где вы реализовали умные скрипты.
3. Если логи с префиксом [adjust-smart-script] отсутствуют, обновите страницу. Если вы по-прежнему не видите логов, убедитесь, что:
   • ваш код не запрещает ведение логов, вызывая AdjustSmartScript.setLogLevel('error') или AdjustSmartScript.setLogLevel('none');
   • ваш код вызывает функцию AdjustSmartScript.createLink(params).

С помощью различных значений свойства inputUrl можно протестировать различные варианты использования. Например, если проводится кампания Meta и ожидается, что вашу целевую страницу будут посещать органические пользователи, можно указать URL-адрес с параметрами кампании и Meta, а также другой URL-адрес без дополнительных параметров.

Пример лога:

[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