OneLink Smart Script V2

Краткий обзор. Настраивайте ссылки OneLink, которые автоматически создаются и встраиваются в кнопку или баннер на сайте бренда.

Описание OneLink Smart Script

OneLink Smart Script использует входящие ссылки, ведущие на веб-страницу, для автоматического создания уникальных исходящих ссылок OneLink, ведущих в магазин приложений.

Исходящие URL-адреса генерируются на основе аргументов, которые вы, получив от маркетолога, указали в скрипте. Примечание. Аргумент afParameters состоит из нескольких аргументов (параметров), каждый из которых содержит объект конфигурации с ключами, значениями переопределения и значением по умолчанию.

Шаги реализации

Настроить Smart Script можно следующими способами:

Embed the script in your website

Инициализация и вызов кода Smart Script могут быть либо получены из генератора Smart Script на дэшборде AppsFlyer (рекомендуется), либо импортированы и вызваны разработчиком вручную.

Используйте код, сгенерированный Smart Script

  1. Получите от маркетолога файл, содержащий скрипт, код инициализации и аргументы.
  2. Test the script on the Smart Script test page. Ensure the correct outgoing URL is generated.
  3. Следуйте инструкциям по тестированию и использованию результатов Smart Script.

Смотрите пример интеграции на Github

Вручную настройте скрипт

  1. Скачайте скрипт.
  2. Получите аргументы для вызова скрипта, которые сопоставляют входящие параметры с исходящими, от маркетолога.
  3. Инициализируйте аргументы и объекты конфигурации Smart Script.
  4. Сгенерируйте ссылки, вызвав скрипт в коде HTML веб-страницы / лендинга с помощью следующего метода:
var result = window.AF_SMART_SCRIPT.generateOneLinkURL({
  oneLinkURL,
  afParameters,
  referrerSkipList, // optional
  urlSkipList // optional
})
  1. Следуйте инструкциям по тестированию и использованию результатов Smart Script.

Проверьте и используйте результат Smart Script

  1. Проверьте возвращаемое значение в result. Возможные возвращаемые значения:
    • An outgoing Onelink URL. Use the result value as needed. For example, to place it as a link under a CTA on your website.
    • null. Если скрипт возвращает null, реализуйте желаемый поток для ошибки. Например: текущий URL-адрес веб-страницы/лендинга не изменяется.
      var result_url = "No output from script"
      if (result) {
            result_url = result.clickURL;            
            // Put the generated OneLink URL behind CTA buttons
            document.getElementById('andrd_link').setAttribute('href', result_url);
            document.getElementById('ios_link').setAttribute('href', result_url);
            // Optionally - Create QR code from the generated OneLink URL
            window.AF_SMART_SCRIPT.displayQrCode("my_qr_code_div_id");
            //The size of the QR code is defined in the CSS file under #my_qr_code_div_id
            // #my_qr_code_div_id canvas { 
            //  height: 200px;
            //  width: 200px;
            //}
            // Optionally - fire an impression.
            // The impression will fire to https://impressions.onelink.me//.... 
            window.AF_SMART_SCRIPT.fireImpressionsLink();
      }

Use Google Tag Manager

Чтобы настроить Smart Script в Google Tag Manager:

  1. Confirm that the marketer followed their instructions and placed the Smart Script code into GTM.
  2. Проверьте возвращаемое значение в AF_SMART_SCRIPT_RESULT. Возможные возвращаемые значения:
    • Исходящий URL Onelink. Используйте полученное значение по мере необходимости. Например, чтобы разместить его в виде ссылки в кнопке CTA на вашем сайте.
    • null. Если скрипт возвращает null, реализуйте желаемый поток для ошибки. Например: текущий URL-адрес веб-страницы/лендинга не изменяется.
      var result_url = AF_SMART_SCRIPT_RESULT.clickURL;
      if (result_url) {
            document.getElementById('andrd_link').setAttribute('href', result_url);
            document.getElementById('ios_link').setAttribute('href', result_url);
            // Optionally - Create QR code from the generated OneLink URL
            window.AF_SMART_SCRIPT.displayQrCode("my_qr_code_div_id");
            //The size of the QR code is defined in the CSS file under #my_qr_code_div_id
            // #my_qr_code_div_id canvas { 
            //  height: 200px;
            //  width: 200px;
            //}
            // Optionally - fire an impression.
            // The impression will fire to https://impressions.onelink.me//.... 
            window.AF_SMART_SCRIPT.fireImpressionsLink();            
      }
  1. Test the script on the Smart Script test page. Ensure the correct outgoing URL is generated.

Create a QR code with the Smart Script result

Необходимое условие: Smart Script V2.1+

Чтобы создать QR-код:

  1. Создайте тег div с определенным идентификатором на HTML-странице вашего сайта для размещения QR-кода.
    Вы можете стилизовать тег div по желанию.
  2. После запуска Smart Script и создания URL-адреса OneLink вызовите следующую функцию и передайте ей идентификатор div:
window.AF_SMART_SCRIPT.displayQrCode("my_qr_code_div_id");
  1. Рекомендация. Получив результат, показывайте QR-код, когда пользователи работают на настольных компьютерах, и кнопку со ссылкой, когда пользователи используют мобильные устройства.

Fire an impression

You can fire an impression when a page loads, a CTA or banner displays, etc. Note: Impressions can only be fired on mobile devices; not on desktop.

Необходимое условие: Smart Script V2.2+

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

  1. Следуйте инструкциям, чтобы запустить Smart Script и сгенерировать URL-адрес клика.
  2. Убедитесь, что результат действителен (а не null).
  3. Запустите следующую функцию показа:
window.AF_SMART_SCRIPT.fireImpressionsLink();

Аргументы

Аргумент Примечания Пример
oneLinkURL (обязательно)
  • Предоставьте домен шаблона OneLink + идентификатор шаблона. Внимание! Не URL-адрес настраиваемой ссылки OneLink.
  • yourbrand.onelink.me/A1b2
  • Пример с фирменным доменом: click.yourbrand.com/A1b2

afParameters

(обязательно)

 

 

 


mediaSource

(обязательно)

Объект конфигурации для медиа-источника

  • Ключи: ['incoming_mediasource’' 'utm_source']
  • Значения переопределения: {twitter: 'twitter_int', orig_src: 'new_src'}
  • Значение по умолчанию: ['any_source']

campaign

Объект конфигурации для кампании

  • Ключи: ['incoming_campaign', 'utm_campaign']
  • Значения переопределения: {campaign_name: 'new_campaign_name'}
  • Значение по умолчанию: ['any_campaign_name']

channel

Объект конфигурации для канала

  • Ключи: ['incoming_channel', 'utm_channel']
  • Значения переопределения: {video: 'new_video'}
  • Значение по умолчанию: ['any_video']

ad

Объект конфигурации для объявления

  • Ключи: ['incoming_ad', 'utm_ad']
  • Значения переопределения: {ad_name: 'new_ad_name'}
  • Значение по умолчанию: ['any_ad_name']
adSet

Объект конфигурации для группы объявлений

  • Ключи: ['incoming_adset', 'utm_adset']
  • Значения переопределения: {'adset_name': 'new_adset_name'}
  • Значение по умолчанию: ['any_adset_name']
deepLinkValue

Объект конфигурации для deep_link_value

  • Ключи: ['product_id', 'page_name']
  • Значения переопределения: {twenty_percent_off: 'thirty_percent_off'}
  • Значение по умолчанию: 'new_offers_page'
afSub1-5

Объект конфигурации для af_sub[1-5]

 
googleClickIdKey

Задайте имя параметра, который содержит GCLID.
Внимание! Для отображения в отчетах AppsFlyer с сырыми данными этот параметр должен быть одним из af_sub[1-5].

 
Другие (настраиваемые) параметры запроса
  • Перечислите любые другие параметры, которые требуется включить в исходящую ссылку OneLink для атрибуции или диплинкинга, а также объекты конфигурации.
  • Имя настраиваемого параметра указывается разработчиком как paramKey в объекте конфигурации.
  • paramKey: 'deep_link_sub1'
  • Ключи: ['page_id']
  • Значения переопределения: {page12: 'new_page12'}
  • Значение по умолчанию: 'page1'
 
referrerSkipList
Список строк в реферере HTTP для определенного клика (например, Twitter или Facebook), при обнаружении которых Smart Script возвращает null. Это может быть полезно для SRN, таких как Twitter и Facebook, клики по которым уже регистрируются.  
urlSkipList Список строк в URL-адресе определенного клика (например, af_r), при обнаружении которых Smart Script возвращает null. Может быть полезен, если вы используете ссылку атрибуции AppsFlyer с параметром af_r для перенаправления пользователей на свой мобильный сайт и не хотите потерять данные исходного клика.  

Объект конфигурации

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

Аргумент Описание Пример
keys
  • Список строк
  • Список возможных параметров входящей ссылки, которые ищет скрипт для передачи значений в соответствующие параметры исходящей ссылки.
  • Скрипт выполняет поиск слева направо и останавливается при первом совпадении.
  • Пример: ['in_channel', 'utm_channel']
  • Для своего параметра channel скрипт ищет во входящей ссылке значение параметра in_channel.

overrideValues

  • Dictionary {string: string}
  • Для значений, которые требуется изменить в исходящей ссылке, укажите значения из входящей ссылки и то, на что их нужно заменить.
  • Скрипт заменяет значения параметров из входящей ссылки на значения, определенные вами. 

Пример: {'video': 'video_new'}

Найдя во входящей ссылке значение "video" для своего параметра channel, в исходящей ссылке скрипт изменяет его на "video_new".

defaultValue
  • Строка
  • Задайте «резервное» значение.
  • Если параметр из списка ключей не найден, в исходящей ссылке используется значение по умолчанию (defaultValue).
  • Чтобы значение по умолчанию использовалось принудительно, передайте пустой список ключей.

Пример: ['web_video']

Если параметр in_channel не найден, для параметра channel в скрипте будет использоваться значение "web_video".

Примеры

Basic attribution

В следующем примере показано базовое преобразование входящей ссылки в исходящую ссылку OneLink с использованием одного ключа для медиа-источника (media_source) и кампании (campaign).

Multiple keys

В следующем примере показано преобразование входящей ссылки в исходящую ссылку OneLink с использованием нескольких ключей для медиа-источника (media_source) и кампании (campaign).

UTM parameters

В следующем примере показано преобразование входящей ссылки в исходящую ссылку OneLink с использованием параметров UTM для медиа-источника (media_source) и кампании (campaign).

Override values

В следующем примере показано преобразование входящей ссылки в исходящую ссылку OneLink с заменой входящего значения медиа-источника (media_source).

Default values

В следующем примере показано преобразование входящей ссылки в исходящую ссылку OneLink с использованием значения по умолчанию, когда не найдено входящее значение медиа-источника (media_source).

Forced default values

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

Google click ID passthrough to af_sub

В следующем примере показано преобразование входящей ссылки в исходящую ссылку OneLink, при котором идентификатор клика Google передается в af_sub4. Примечание. Когда GCLID найден, скрипт ищет входящий параметр keyword и помещает его значение в исходящую ссылку как значение параметра af_keywords.

Facebook click ID passthrough to af_sub

В следующем примере показано преобразование входящей ссылки в исходящую ссылку OneLink, при котором идентификатор клика Facebook передается в af_sub2.

Set attribution and OneLink parameters

В следующем примере показано преобразование входящей ссылки в исходящую ссылку OneLink c параметрами атрибуции AppsFlyer и параметрами OneLink.

Set additional custom parameters

В следующем примере показано преобразование входящей ссылки в исходящую ссылку OneLink с дополнительными настраиваемыми параметрами (включая параметр af_prt для агентств).

Referrer skip list

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

URL skip list

Смотрите пример, в котором показано, как отключить срабатывание Smart Script для URL-адресов с определенной строкой (например, af_r), создав список пропуска. Если в URL-адресе клика есть какие-либо строки из этого списка, Smart Script возвращает значение null.

Smart Script set up with Google Tag Manager

В следующем примере показано преобразование входящей ссылки в исходящую ссылку OneLink с использованием OneLink Smart Script, настроенного с помощью Google Tag Manager.

QR code

Смотрите пример, в котором показано, как Smart Script генерирует QR-код.

Impression

См. пример показа.