OneLinkUrlGenerator v1

Обзор

OneLinkUrlGenerator автоматически генерирует и встраивает ссылки для кнопки или баннера на сайте бренда.

Открытые конструкторы

OneLinkUrlGenerator

Входные аргументы

Тип	Параметр	Описание
Строка	oneLinkURL [обязательно]	- Служит основой для всех ссылок, генерируемых скриптом. - Это домен шаблона OneLink + идентификатор шаблона.
Список строк	pidKeysList	- Содержит список параметров медиа-источника из входящей ссылки, которые будут указаны как параметр pid в исходящей ссылке. - Если во входящей ссылке несколько параметров медиа-источника (например, af_pid и utm_source), pidKeysList сканирует параметры с первого до последнего и использует первое найденное совпадение.
dictionary {string: string, …}	pidOverrideList	Содержит список значений медиа-источника из входящей ссылки, а также значения, на которые их требуется заменить.
Строка	pidStaticValue	Если ключ pid не найден в pidKeysList, в качестве значения pid используется pidStaticValue.
Список строк	campaignKeysList	Содержит список параметров кампании из входящей ссылки, которые будут указаны как параметр c в исходящей ссылке.
Строка	campaignStaticValue	Если в параметре campaignKeysList не найден ключ кампании, в качестве значения параметра c используется campaignStaticValue.
Строка	gclIdParam	- Определяет, какой параметр исходящей ссылки содержит GCLID. - Можно выбрать любой параметр. Внимание! Для отображения в отчетах AppsFlyer с сырыми данными этот параметр должен быть одним из af_sub[1-5].
Строка	skipList	Если какие-либо строки из списка пропуска появляются в реферере HTTP, Smart Script не запускается и возвращает `null`.

Пример использования

const onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
        {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
         pidKeysList: ['incoming_media_source'],
         pidStaticValue: 'my_static_pid',
         campaignKeysList: ['incoming_campaign'],
         campaignStaticValue: 'my_static_cmpn',
      });

Открытые методы

generateUrl

Обзор

Эта функция генерирует URL-адрес на основе вышеупомянутых открытых конструкторов и функций-сеттеров, описанных ниже.

Входные аргументы

Ничего

Возвращаемое значение

Тип	Описание
Строка	URL-адрес, сгенерированный `OneLinkUrlGenerator`

Пример использования

const url = onelinkGenerator.generateUrl();

setDeepLinkValue

Входные аргументы

Тип	Параметр	Описание	Требуется
Строка	deepLinkValueParam	Ключ во входящей ссылке, из которого скрипт берет значение диплинка для параметра исходящей ссылки `deep_link_value`.	true
Строка	deepLinkValue	Резервное значение, которое указывается в параметре `deep_link_value` исходящей ссылки, если параметр `deepLinkValueParam` во входящей ссылке не найден.	false

Возвращаемое значение

void

Пример использования

const onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
        {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
         pidKeysList: ['incoming_media_source'],
         campaignKeysList: ['incoming_campaign']
      });
onelinkGenerator.setDeepLinkValue("original_url_deeplinkvalue", "yessss");
const url = onelinkGenerator.generateUrl();

setChannel

Входные аргументы

Тип	Параметр	Описание	Требуется
Строка	channelParam	Ключ во входящей ссылке, из которого скрипт берет значение диплинка для параметра исходящей ссылки `af_channel`.	true
Строка	channelValue	Резервное значение, которое указывается в параметре `af_channel` исходящей ссылки, если параметр `channelParam` во входящей ссылке не найден.	false

Возвращаемое значение

void

Пример использования

const onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
        {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
         pidKeysList: ['incoming_media_source'],
         campaignKeysList: ['incoming_campaign']
      });
onelinkGenerator.setChannel("original_url_channel", "new_channel");
const url = onelinkGenerator.generateUrl();

setAdset

Входные аргументы

Тип	Параметр	Описание	Требуется
Строка	adsetParam	Ключ во входящей ссылке, из которого скрипт берет значение диплинка для параметра исходящей ссылки `af_adset`.	true
Строка	adsetValue	Резервное значение, которое указывается в параметре `af_adset` исходящей ссылки, если параметр `adsetParam` во входящей ссылке не найден.	false

Возвращаемое значение

void

Пример использования

const onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
        {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
         pidKeysList: ['incoming_media_source'],
         campaignKeysList: ['incoming_campaign']
      });

onelinkGenerator.setAdset("no_adset", "adset");
const url = onelinkGenerator.generateUrl();

setAd

Входные аргументы

Тип	Параметр	Описание	Требуется
Строка	adParam	Ключ во входящей ссылке, из которого скрипт берет значение диплинка для параметра исходящей ссылки `af_ad`.	true
Строка	adValue	Резервное значение, которое указывается в параметре `af_ad` исходящей ссылки, если параметр `adParam` во входящей ссылке не найден.	false

Возвращаемое значение

void

Пример использования

const onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
        {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
         pidKeysList: ['incoming_media_source'],
         campaignKeysList: ['incoming_campaign']
      });

onelinkGenerator.setAd("original_url_ad", "new_ad");
const url = onelinkGenerator.generateUrl();

setAfSub1

Входные аргументы

Тип	Параметр	Описание	Требуется
Строка	afSub1Param	Ключ во входящей ссылке, из которого скрипт берет значение диплинка для параметра исходящей ссылки `af_sub1`.	true
Строка	afSub1Value	Резервное значение, которое указывается в параметре `af_sub1` исходящей ссылки, если параметр `afSub1Param` во входящей ссылке не найден.	false

Возвращаемое значение

void

Пример использования

const onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
        {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
         pidKeysList: ['incoming_media_source'],
         campaignKeysList: ['incoming_campaign']
      });

onelinkGenerator.setAfSub1("original_url_sub1", "ram_afsub1");
const url = onelinkGenerator.generateUrl();

setAfSub2

Входные аргументы

Тип	Параметр	Описание	Требуется
Строка	afSub2Param	Ключ во входящей ссылке, из которого скрипт берет значение диплинка для параметра исходящей ссылки `af_sub2`.	true
Строка	afSub2Value	Резервное значение, которое указывается в параметре `af_sub2` исходящей ссылки, если параметр `afSub2Param` во входящей ссылке не найден.	false

Возвращаемое значение

void

Пример использования

const onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
        {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
         pidKeysList: ['incoming_media_source'],
         campaignKeysList: ['incoming_campaign']
      });

onelinkGenerator.setAfSub2("original_url_sub2","fallback_sub2");
const url = onelinkGenerator.generateUrl();

setAfSub3

Входные аргументы

Тип	Параметр	Описание	Требуется
Строка	afSub3Param	Ключ во входящей ссылке, из которого скрипт берет значение диплинка для параметра исходящей ссылки `af_sub3`.	true
Строка	afSub3Value	Резервное значение, которое указывается в параметре `af_sub3` исходящей ссылки, если параметр `afSub3Param` во входящей ссылке не найден.	false

Возвращаемое значение

void

Пример использования

const onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
        {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
         pidKeysList: ['incoming_media_source'],
         campaignKeysList: ['incoming_campaign']
      });

onelinkGenerator.setAfSub3("original_sub3", "new_afsub3");
const url = onelinkGenerator.generateUrl();

setAfSub4

Входные аргументы

Тип	Параметр	Описание	Требуется
Строка	afSub4Param	Ключ во входящей ссылке, из которого скрипт берет значение диплинка для параметра исходящей ссылки `af_sub4`.	true
Строка	afSub4Value	Резервное значение, которое указывается в параметре `af_sub4` исходящей ссылки, если параметр `afSub4Param` во входящей ссылке не найден.	false

Возвращаемое значение

void

Пример использования

const onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
        {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
         pidKeysList: ['incoming_media_source'],
         campaignKeysList: ['incoming_campaign']
      });
onelinkGenerator.setAfSub3("orignial_sub4", "fallback_afsub4");
const url = onelinkGenerator.generateUrl();

setAfSub5

Входные аргументы

Тип	Параметр	Описание	Требуется
Строка	afSub5Param	Ключ во входящей ссылке, из которого скрипт берет значение диплинка для параметра исходящей ссылки `af_sub5`.	true
Строка	afSub5Value	Резервное значение, которое указывается в параметре `af_sub5` исходящей ссылки, если параметр `afSub5Param` во входящей ссылке не найден.	false

Возвращаемое значение

void

Пример использования

const onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
        {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
         pidKeysList: ['incoming_media_source'],
         campaignKeysList: ['incoming_campaign']
      });
onelinkGenerator.setAfSub5("neverfind_sub5", "new_afsub5");
const url = onelinkGenerator.generateUrl();

setCustomParameter

Входные аргументы

Тип	Параметр	Описание	Требуется
Строка	searchKey	Ключ во входящей ссылке, из которого скрипт берет для исходящей ссылки значение `customKey`	true
Строка	customKey	Ключ в исходящей ссылке OneLink, в который передается значение, найденное по `searchKey`	true
Строка	customValue	Резервное значение, которое указывается в параметре `customKey` исходящей ссылки, если параметр `searchKey` во входящей ссылке не найден.	false

Возвращаемое значение

void

Пример использования

const onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
        {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
         pidKeysList: ['incoming_media_source'],
         campaignKeysList: ['incoming_campaign']
      });
onelinkGenerator.setCustomParameter("search_key_on_url", "onelink_custom_param", "fallback_value");
const url = onelinkGenerator.generateUrl();