[Устарело] OneLink Smart Script V1

Краткий обзор. Настраивайте ссылки OneLink, которые автоматически создаются и встраиваются в кнопку или баннер на сайте бренда. Примечание. Хотя это не обязательно, рассмотрите переход на OneLink Smart Script V2.

Описание OneLink Smart Script

Прежде чем перейти на вашу страницу в магазине приложений, пользователи попадают на ваш мобильный сайт либо органически, либо через рекламные кампании. При этом, так как клика два (первый ведет на веб-страницу, второй — с веб-страницы в магазин приложений), сбор метрик конверсии по кликам и диплинкинг являются проблематичными.

Эти проблемы решает технология OneLink Smart Script. Данный скрипт:

Использует входящие ссылки, ведущие на веб-страницу, для автоматического создания уникальных исходящих ссылок OneLink, ведущих в магазин приложений.
Обеспечивает точный сбор метрик web-to-app по всем медиа-источникам.
Может использоваться для диплинкинга.
Незаметно запускается на любой странице сайта или лэндинге.

Процедура

Чтобы настроить Smart Script, требуется пройти следующий чек-лист.

Чек-лист
1. Импортируйте скрипт на сайт.
2. Инициализируйте объект Smart Script OneLinkUrlGenerator с параметрами и значениями.
3. [Необязательно] Запустите сеттеры с дополнительными параметрами и значениями.
4. Сгенерируйте URL-адреса.

Import the script

Чтобы импортировать скрипт на сайт:

Скачайте скрипт.
Импортируйте его на мобильный сайт / страницы, на которых он должен работать.

Initialize the script

Чтобы инициализировать скрипт:

Получите от маркетолога: параметры/значения, которые должна содержать исходящая ссылка OneLink (на основе содержимого входящей ссылки). Подробная информация приведена в следующей таблице.
Инициализируйте объекты Smart Script OneLinkUrlGenerator , используя аргументы (параметры).

Параметр	Тип	Функциональные возможности	Пример
oneLinkURL [обязательно]	строка	- Служит основой для всех ссылок, генерируемых скриптом. - Это домен шаблона OneLink + идентификатор шаблона.	yourbrand.onelink.me/A1b2 Пример с фирменным доменом: click.yourbrand.com/A1b2
pidKeysList	Список строк	- Содержит список параметров медиа-источника из входящей ссылки, которые будут указаны как параметр pid в исходящей ссылке. - Если во входящей ссылке несколько параметров медиа-источника (например, af_pid и utm_source), pidKeysList сканирует параметры с первого до последнего и использует первое найденное совпадение.	['af_pid', 'utm_source']
pidOverrideList	dictionary {string: string, …}	Содержит список значений медиа-источника из входящей ссылки, а также значения, на которые их требуется заменить.	{ 'twitter': 'twitter_int', 'snapchat': 'snapchat_int', 'some_social_net': 'some_social_net_int' }
pidStaticValue	строка	Если ключ pid не найден в pidKeysList, в качестве значения pid используется pidStaticValue.	- 'website' - 'landing_page'
campaignKeysList	Список строк	Содержит список параметров кампании из входящей ссылки, которые будут указаны как параметр c в исходящей ссылке.	['af_campaign', 'utm_campaign']
campaignStaticValue	строка	Если в параметре campaignKeysList не найден ключ кампании, в качестве значения параметра c используется campaignStaticValue.	- 'website' - 'landing_page'
gclIdParam	строка	- Определяет, какой параметр исходящей ссылки содержит GCLID. - Можно выбрать любой параметр. Внимание! Для отображения в отчетах AppsFlyer с сырыми данными этот параметр должен быть одним из af_sub[1-5].	'af_sub5'
skipList	строка	Если какие-либо строки из списка пропуска появляются в реферере HTTP, Smart Script возвращает `null`.	- '[‘facebook’, ‘twitter’]' - Facebook is in the skipList by default.

Run setters

Чтобы запустить сеттеры:

Получите от маркетолога: любые другие параметры и значения, которые должна содержать исходящая ссылка OneLink (на основе содержимого входящей ссылки).
Запустите сеттеры с помощью следующего шаблона:

onelinkGenerator.set[parameter]("parameter value", "optional static value");

Например:

onelinkGenerator.setAfSub1("original_url_sub1", "ram_afsub1");

Generate URLs

Чтобы создать исходящие ссылки OneLink:

В HTML страницы сайта / лэндинга вызовите метод generateURL, который запускает скрипт.
Возможные возвращаемые значения:
- Исходящая ссылка Onelink
- Null. Если скрипт возвращает null, существующая ссылка веб-страницы/лэндинга не изменяется.

Примеры

Basic attribution

Входящая ссылка:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/basic_url.html?af_c=gogo&af_pid=email

Скрипт:

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

Исходящая ссылка:
https://engmntqa.onelink.me/LtRd/?pid=email&c=gogo&af_js_web=true

UTM parameters

Входящая ссылка:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/utm_params.html?utm_source=email&utm_campaign=summer_sale

Скрипт:

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

Исходящая ссылка:
https://engmntqa.onelink.me/LtRd/?pid=email&c=summer_sale&af_js_web=true

PID and campaign static values

Входящая ссылка:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/static_val.html?af_not_c=gogo&af_not_pid=email

Скрипт:

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',
      });
      const url = onelinkGenerator.generateUrl();

Исходящая ссылка:
https://engmntqa.onelink.me/LtRd/?pid=my_static_pid&c=my_static_cmpn&af_js_web=true

Override PIDs

Входящая ссылка:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/override_pid.html?af_pid=twitter&af_c=big_social

Скрипт:

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

Исходящая ссылка:
https://engmntqa.onelink.me/LtRd/?pid=twitter_out&c=big_social&af_js_web=true

Google Click ID passthrough to af_sub

Входящая ссылка:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/gclid.html?af_pid=sms&af_c=candles&gclid=1a2b3c

Скрипт:

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

Исходящая ссылка:
https://engmntqa.onelink.me/LtRd/?pid=google_lp&c=candles&af_js_web=true&af_sub4=1a2b3c

Set OneLink parameters

Чтобы создать длинную ссылку, которая будет использоваться для диплинкинга, можно передавать и настраиваемые, и предопределенные параметры. Функции для передачи параметров приведены в следующем примере скрипта.

Чтобы передать настраиваемый параметр:

Вызовите функцию setCustomParameter.
setCustomParameter принимает три аргумента:
1. [Обязательный] Ключ во входящей ссылке, из которого скрипт берет значение для исходящей ссылки.
2. [Обязательный] Ключ, который требуется указать в исходящей ссылке.
3. [Необязательный] Статическое резервное значение на случай, если ключ из первого аргумента не будет найден в ссылке.

Если ключ из первого аргумента не найден, и статическое резервное значение не задано, параметр пропускается.

Чтобы передать предопределенный параметр

Вызовите функции, указанные в следующем примере скрипта (кроме setCustomParameter).
Каждая функция принимает два аргумента:
1. [Обязательный] Ключ во входящей ссылке, из которого скрипт берет значение для исходящей ссылки.
2. [Необязательный] Статическое резервное значение на случай, если ключ из первого аргумента не будет найден в ссылке.

Если ключ из первого аргумента не найден, и статическое резервное значение не задано, параметр пропускается.

Входящая ссылка:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/setters.html?af_c=gogo&af_pid=email

Скрипт:

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");
      onelinkGenerator.setChannel("original_url_channel", "new_channel");
      onelinkGenerator.setAdset("no_adset", "adset");
      onelinkGenerator.setAd("original_url_ad", "new_ad");
      onelinkGenerator.setAfSub1("original_url_sub1", "ram_afsub1");
      onelinkGenerator.setAfSub2("original_url_sub2");
      onelinkGenerator.setAfSub3("no_sub3", "new_afsub3");
      onelinkGenerator.setAfSub4("original_url_sub4");
      onelinkGenerator.setAfSub5("neverfind_sub5", "new_afsub5");
      onelinkGenerator.setCustomParameter("original_url_fruit_name", "onelink_my_custom_param", "apples");
      const url = onelinkGenerator.generateUrl();

Исходящая ссылка:
https://engmntqa.onelink.me/LtRd/?pid=email&c=gogo&af_js_web=true&deep_link_value=yessss&af_channel=new_channel&af_adset=adset&af_ad=new_ad&af_sub1=ram_afsub1&af_sub3=new_afsub3&af_sub5=new_afsub5&onelink_my_custom_param=apples

Set additional attribution parameters

Вы можете создать длинную ссылку с дополнительными параметрами атрибуции. Функции для передачи параметров приведены в следующем примере скрипта.

Чтобы добавить параметр атрибуции:

Вызовите функцию setCustomParameter.
setCustomParameter принимает три аргумента:
1. [Обязательный] Ключ параметра атрибуции во входящей ссылке, из которого скрипт берет значение для исходящей ссылки.
2. [Обязательный] Ключ параметра атрибуции, который требуется указать в исходящей ссылке.
3. [Необязательный] Статическое резервное значение на случай, если ключ из первого аргумента не будет найден в ссылке.

Если ключ из первого аргумента не найден, и статическое резервное значение не задано, параметр пропускается.

Входящая ссылка:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/set_af_params.html?af_c=gogo&af_pid=email&partner_name=bigagency

Скрипт:

onelinkGenerator.setCustomParameter("incoming_site_id", "af_siteid", "defaultSiteID");

Outgoing URL:
https://engmntqa.onelink.me/LtRd/?pid=email&c=gogo&af_js_web=true&af_siteid=defaultSiteID

Skip clicks from Twitter or Facebook

Вы можете отключить срабатывание Smart Script для определенных кликов (например, из Twitter или Facebook), создав список пропуска. Если какие-либо строки из этого списка появляются в реферере HTTP, Smart Script возвращает значение null.

Скрипт:

const onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
      {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
        pidKeysList: ['original_pid'],
        campaignKeysList: ['original_campaign'],
        skipList: ['twitter', 'facebook']
    });
const url = onelinkGenerator.generateUrl();

Don't skip any clicks

Чтобы OneLink Smart Script гарантированно выполнялся для всех кликов и не пропускал никакие из них, передайте пустой список пропуска.

Скрипт:

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