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.initializeConversion('YOUR-CLICK-ID-PARAMETER');

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

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

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

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

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

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

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

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

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

затем

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

Offer18WebSDK.trackConversion(options);

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

Поток SDK

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

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

Offer18WebSDK.trackImpression(options)

затем

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

Offer18WebSDK.trackClick(options);

затем

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

Offer18WebSDK.trackConversion(options);

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

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

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

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

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

trackClick(options)

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

  • Параметры:

    • 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)

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

  • Параметры:

    • 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)

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

  • Параметры:

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

Параметр
Тип
Описание

domain

строка

Обязательно: Домен для постбэка пользователя.

accountId

строка

Обязательно: Идентификатор аккаунта Offer18 пользователя.

offerId

строка

Обязательно: Идентификатор кампании.

coupon

строка

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

postbackType

строка

Это может быть либо 'iframe', либо 'pixel', значение по умолчанию — 'iframe'.

isGlobalPixel

булево

Пользователь может настроить глобальный пиксель, установив это значение в true, значение по умолчанию — false.

allowMultiConversion

булево

Пользователь может разрешить мульти-конверсию, установив это значение в true, значение по умолчанию — false.

conversionData

объекте

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

conversionData Объект

Параметр
Тип
Описание

event

строка

Название события (пожалуйста, укажите событие)

выплата

строка

Сумма выплаты (пожалуйста, укажите сумму выплаты)

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

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

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

ПредыдущаяAndroid SDKСледующаяОтслеживать путь пользователя

Последнее обновление

Это было полезно?