Node SDK

Этот SDK для Node.js предназначен для отслеживания взаимодействий пользователей, таких как клики, показы, конверсии и другие события, в ваших веб-приложениях.

Начать

Чтобы начать отслеживание с помощью Node SDK Offer18, вам нужно интегрировать SDK в ваше веб-приложение как node-модуль.

Узнать последнюю стабильную версию пакета Node

https://www.npmjs.com/package/offer18-sdkwww.npmjs.com

---

Установка

Вы можете установить пакет с помощью npm:

npm install offer18-sdk

или

npm i offer18-sdk

---

Использование

Импорт

import Offer18SDK from 'offer18-sdk';

Инициализация

const Offer18WebSDK = new Offer18SDK();

Доступные методы

// Инициализировать конверсию
Offer18WebSDK.initializeUrlParam('YOUR-CLICK-ID-PARAMETER');

// Зарегистрировать клик
Offer18WebSDK.trackClick(options);

// Зарегистрировать показ
Offer18WebSDK.trackImpression(options);

// Зарегистрировать конверсию
Offer18WebSDK.trackConversion(options);

// Сбросить cookie
Offer18WebSDK.clearCookies();

// Включить логгер
Offer18WebSDK.activateDebugMode();

---

Поток конверсии

Поток конверсии — это последовательность, в которой Node SDK будет отслеживать только конверсии. Чтобы реализовать поток конверсии, после инициализации SDK вам нужно добавить методы в следующем порядке::

Размещение: при загрузке страницы или после монтирования компонента

Offer18WebSDK.initializeUrlParam('YOUR-CLICK-ID-PARAMETER');

затем

Размещение: страница благодарности/страница успешного заказа

Offer18WebSDK.trackConversion(options);

Узнать больше о YOUR-CLICK-ID-PARAMETER & опции в Обзор методов

---

Поток SDK

Поток SDK — это последовательность, которая позволяет отслеживать весь процесс конверсии в Node SDK, включая отслеживание показов, кликов и конверсий. После инициализации SDK вам нужно добавить методы в следующем порядке:

Размещение: при загрузке страницы или после монтирования компонента

Offer18WebSDK.trackImpression(options)

затем

Размещение: можно размещать на всех страницах (при загрузке страницы или после монтирования компонента)

Offer18WebSDK.trackClick(options);

затем

Размещение: страница благодарности/страница успешного заказа

Offer18WebSDK.trackConversion(options);

Узнать больше о опции в Обзор методов

---

Обзор методов

initializeConversion('YOUR-CLICK-ID-PARAMETER')

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

Замените YOUR-CLICK-ID-PARAMETER на ключ параметра, который используется для принятия значения из {tid} токена в URL предложения.

trackClick(options)

Этот метод используется для отслеживания кликов.

• Параметры:

  • опции (object): параметры конфигурации.

Параметр	Тип	Описание
trackingURL	строка	Обязательно: URL для отслеживания, который можно извлечь из панели управления Offer18
keymapping	массив	Массив параметров Offer18 и собственных параметров в формате <OFFER18-PARAMETER>:<YOUR-PARAMETER>. Пользователь может заменить <OFFER18-PARAMETER> параметрами Offer18, такими как aff_sub1, aff_sub2 и <YOUR-PARAMETER> с их параметрами, из которых пользователь получает значения от своей сети.

Пример кода

Offer18WebSDK.trackClick({
    trackingURL: 'https://example.o18.click/c?o=0000000&m=0000',
    keymapping: ['a:<YOUR-PARAMETER>']
});

trackImpression(options)

Этот метод используется для отслеживания показов.

• Параметры:

  • опции (object): параметры конфигурации.

Параметр	Тип	Описание
impressionURL	строка	Обязательно: URL для отслеживания, который можно извлечь из панели управления Offer18
keymapping	массив	Массив параметров Offer18 и собственных параметров в формате <OFFER18-PARAMETER>:<YOUR-PARAMETER>. Пользователь может заменить <OFFER18-PARAMETER> параметрами Offer18, такими как aff_sub1, aff_sub2 и <YOUR-PARAMETER> с их параметрами, из которых пользователь получает значения от своей сети.

Пример кода

Offer18WebSDK.trackImpression({
    impressionURL: 'https://example.o18.click/i?o=0000000&m=0000',
    keymapping: ['a:<YOUR-PARAMETER>']
});

trackConversion(options)

Этот метод используется для отслеживания конверсий.

• Параметры:

  • опции (object): параметры конфигурации.

Параметр	Тип	Описание
domain	строка	Обязательно: Домен постбэка пользователя.
accountId	строка	Обязательно: Идентификатор аккаунта Offer18 пользователя.
offerId	строка	Обязательно: Идентификатор кампании.
coupon	строка	Здесь можно использовать код купона.
postbackType	строка	Это может быть либо 'iframe', либо 'pixel', значение по умолчанию — 'iframe'.
isGlobalPixel	булево	Пользователь может настроить глобальный пиксель, установив это значение в true, значение по умолчанию — false.
allowMultiConversion	булево	Пользователь может разрешить множественные конверсии, установив это значение в true, значение по умолчанию — false.
conversionData	объект	Этот объект содержит параметры, которые можно использовать для получения значений из сети.

conversionData Объект

Параметр	Тип	Описание
event	строка	Название события (пожалуйста, укажите событие)
payout	строка	Сумма выплаты (пожалуйста, укажите сумму выплаты)
sale	строка	Сумма продажи (пожалуйста, укажите сумму продажи)
currency	строка	Код валюты
adv_sub1	строка	Подпараметр рекламодателя 1
adv_sub2	строка	Подпараметр рекламодателя 2
adv_sub3	строка	Подпараметр рекламодателя 3
adv_sub4	строка	Подпараметр рекламодателя 4
adv_sub5	строка	Подпараметр рекламодателя 5

Пример кода

Offer18WebSDK.trackConversion({
        domain: '',
        accountId: '',
        offerId: '',
        coupon:'',
        postbackType: '', // 'iframe' или 'pixel'
        isGlobalPixel: false, // true или false
        allowMultiConversion: false, // true или false
        conversionData: {
            event: '', // Название события (пожалуйста, укажите событие)
            payout: '', // Сумма выплаты (пожалуйста, укажите сумму выплаты)
            sale: '', // Сумма продажи (пожалуйста, укажите сумму продажи)
            currency: '',
            adv_sub1: '',
            adv_sub2: '',
            adv_sub3: '',
            adv_sub4: '',
            adv_sub5: '',
        }
    });

clearCookies()

Этот метод используется для удаления всех first-party cookie, добавленных этим пакетом.

activateDebugMode()

Этот метод используется для включения логгера. Логи всех действий, выполняемых этим пакетом, будут видны в консоли инструментов разработчика браузера. Вам нужно добавить этот метод сразу после инициализации SDK

Совместимость Node SDK с фронтенд-фреймворками и библиотеками

Следующие фронтенд фреймворки и библиотеки совместимы с Node SDK и могут использоваться с ними напрямую через npm:

Next.js, Nuxt.js, SvelteKit, Gatsby, Remix, RedwoodJS, Blitz.js, Astro, Eleventy (11ty), React Static, Gridsome, VuePress, Quasar Framework, Razzle, Preact CLI, NestLand, Hydrogen, Marko, Inferno, Vite, React, Vue.js, Svelte, Preact, SolidJS, Alpine.js, Lit, Stencil.js, Hyperapp, Riot.js, Mithril.js