Web SDK

Начать

Чтобы начать отслеживание с веб-SDK Offer18, необходимо добавить тег script на веб-сайт.

Размещение : Заголовок (Все страницы)

<script src="https://web-resources.offer18.net/sdk/web/WebSDK.js"></script>

---

Отслеживать клики

Чтобы отслеживать клики с помощью SDK, добавьте следующий код в ваш скрипт.

Размещение : Заголовок (Все страницы)

<script>
    window.Offer18WebSDK.trackClick({
        trackingURL: '<YOUR-TRACKING-LINK>',
        keymapping: ['<OFFER18-PARAMETER>:<YOUR-PARAMETER>', '<OFFER18-PARAMETER>:<YOUR-PARAMETER>',...]
    });
</script>

Конфигурация объекта - window.Offer18WebSDK.trackclick()

1. trackingURL (Обязательный) : URL отслеживания, который можно получить на панели управления Offer18.

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

Пример кода

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

В приведенном выше примере a является ID партнёра в отображении ключей

---

Отслеживать показы

Чтобы отслеживать показы с помощью SDK, добавьте следующий код в ваш скрипт

Размещение : Заголовок (Все страницы)

<script>
    window.Offer18WebSDK.trackImpression({
        impressionURL: '<YOUR-IMPRESSION-URL>',
        keymapping: ['<OFFER18-PARAMETER>:<YOUR-PARAMETER>', '<OFFER18-PARAMETER>:<YOUR-PARAMETER>',...]
    });
</script>

Конфигурация объекта - window.Offer18WebSDK.trackImpression()

1. impressionURL (Обязательный) : URL показа, который можно получить на панели управления Offer18.

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

Пример кода

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

В приведенном выше примере a является ID партнёра в отображении ключей

---

Отслеживать конверсии

Пользователи должны добавить следующий фрагмент кода на все лендинги, кроме страниц подтверждения заказа / страницы успеха заказа (Thank you).

Размещение : Заголовок (Все страницы)

<script>
    window.Offer18WebSDK.initializeConversion('<YOUR-CLICK-ID-PARAMETER>');
</script>

После добавления скрипта необходимо добавить следующий скрипт на страницу thankyou/order-confirmation

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

<script>
    window.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: '',
        }
    })
</script>

Конфигурация объекта - window.Offer18WebSDK.trackConversion()

1. domain (Обязательный) : Домен постбэка пользователя.

2. accountId (Обязательный) : Идентификатор аккаунта Offer18 пользователя.

3. offerId (Обязательный) : Идентификатор кампании.

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

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

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

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

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

Пример кода

<script>
    window.Offer18WebSDK.trackConversion({
        domain: 'example.o18.link',
        accountId: '0000',
        offerId: '00000000',
    });
</script>

---

Режим отладки

Чтобы включить режим отладки в SDK, можно добавить следующий код в ваш скрипт:

<script>
    window.Offer18WebSDK.activateDebugMode();
</script>

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