Node SDK

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

Начать

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

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

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');

then

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

Offer18WebSDK.trackConversion(options);

Узнайте больше о YOUR-CLICK-ID-PARAMETER & options in Обзор методов

---

Поток SDK

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

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

Offer18WebSDK.trackImpression(options)

then

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

Offer18WebSDK.trackClick(options);

then

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

Offer18WebSDK.trackConversion(options);

Узнайте больше о options in Обзор методов

---

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

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

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

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

trackClick(options)

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

• Parameters:

  • options (object): Configuration options.

Parameter	Type	Description
trackingURL	string	Mandatory: Tracking URL which can be extracted from Offer18 dashboard
keymapping	array	An array of Offer18 parameters and Native parameters in the format <OFFER18-PARAMETER>:<YOUR-PARAMETER>. User can replace <OFFER18-PARAMETER> with Offer18 Parameters like aff_sub1, aff_sub2 and <YOUR-PARAMETER> with their parameters in which user is getting values from their network.

Example code

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

trackImpression(options)

This method is utilized for tracking impressions.

• Parameters:

  • options (object): Configuration options.

Parameter	Type	Description
impressionURL	string	Mandatory: Tracking URL which can be extracted from Offer18 dashboard
keymapping	array	An array of Offer18 parameters and Native parameters in the format <OFFER18-PARAMETER>:<YOUR-PARAMETER>. User can replace <OFFER18-PARAMETER> with Offer18 Parameters like aff_sub1, aff_sub2 and <YOUR-PARAMETER> with their parameters in which user is getting values from their network.

Example code

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

trackConversion(options)

This method is utilized for tracking conversions.

• Parameters:

  • options (object): Configuration options.

Parameter	Type	Description
domain	string	Mandatory: Postback domain of the user.
accountId	string	Mandatory: Offer18 account id of the user.
offerId	string	Mandatory: Id of the campaign.
coupon	string	Coupon code can be used here.
postbackType	string	It can be either 'iframe' or 'pixel', default value is 'iframe'.
isGlobalPixel	boolean	User can configure global pixel by setting this true, default value is false.
allowMultiConversion	boolean	User can allow MultiConversion by setting this true, default value is false.
conversionData	object	This object contains the parameters which can be used to get values from the network.

conversionData Object

Parameter	Type	Description
event	string	Event Name (Please specify the event)
payout	string	Payout Amount (Please specify the payout amount)
sale	string	Sale Amount (Please specify the sale amount)
currency	string	Currency code
adv_sub1	string	Advertiser sub parameter 1
adv_sub2	string	Advertiser sub parameter 2
adv_sub3	string	Advertiser sub parameter 3
adv_sub4	string	Advertiser sub parameter 4
adv_sub5	string	Advertiser sub parameter 5

Example code

Offer18WebSDK.trackConversion({
        domain: '',
        accountId: '',
        offerId: '',
        coupon:'',
        postbackType: '', // 'iframe' or 'pixel'
        isGlobalPixel: false, // true or false
        allowMultiConversion: false, // true or false
        conversionData: {
            event: '', // Event Name (Please specify the event)
            payout: '', // Payout Amount (Please specify the payout amount)
            sale: '', // Sale Amount (Please specify the sale amount)
            currency: '',
            adv_sub1: '',
            adv_sub2: '',
            adv_sub3: '',
            adv_sub4: '',
            adv_sub5: '',
        }
    });

clearCookies()

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

activateDebugMode()

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

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

Следующие frontend фреймворки и библиотеки совместимы с 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