Web (JS/TS)

Version 1.3.15

Basic integration (recommended)

Add Taddy script to <head>...</head> section after telegram sdk script

<script src="https://sdk.taddy.pro/web/taddy.min.js?1317" data-pub-id="XXX"></script>

Replace XXX with your Public ID

After the script is loaded, the init() method will be called automatically and the ready event will be emitted. Taddy object can be accessed via window.Taddy

Advanced integration

Add Taddy script to <head>...</head> section after telegram sdk script

<script src="https://sdk.taddy.pro/web/taddy.min.js?1317"></script>

Install TypeScript declarations (optional). This package includes only types declarations without implementation. Adding the Taddy script to the head section is required (see Step 1).

npm i taddy-sdk-web@1.3.17

Initialize Taddy

const taddy = window.Taddy;

taddy.init('xxxxxxxxxxx-pub-id-xxxxxxxxxxx');

Send "ready" event when app is loaded

taddy.ready()

Exchange

Get exchange service

const exchange = taddy.exchange();

Fetch exchange feed

exchange.feed({
    limit: 8,              // default: 4
    imageFormat: 'png',    // default: webp
    autoImpressions: true, // impressions event will be called
    showCompleted: true    // default: false
}).then((items) => {
    // render(items)
    // exchange.impressions(items) -- if autoImpressions: false
});

Send impressions (manual)

exchange.impressions(items);

Open item via Telegram (item click handler)

// open task with auto check
exchange.open(item).then(() => {
    // exchange completed! 
    // reward user, remove task from list, etc...
}).catch(() => {
    // exchange is not completed! 
});

// or open task with manual check
exchange.open(item, false);
// manual check
exchange.check(item).then(success => {
    // if success=true - exchange completed! 
    // reward user, remove task from list, etc...
});

Send custom event ...

Получаем рекламный сервис Taddy

const ads = taddy.ads();

// или можем обращаться напрямую без создания переменной
taddy.ads()

Выполняем загрузку и показ рекламного объявления interstitial

ads.interstitial({
    // можем добавить полезную нагрузку для получения ее через вебхук (view-through)
    payload: { my: "data" },
    // можем добавить обработчик закрытия объявления или полного просмотра
    onClosed: () => console.log('Объявление закрыто'),
    onViewThrough: (id: string) => console.log('Объявление просмотрено', id);
}).then((success: boolean) => {
    // success содержит признак того, что объявление было показано
});

// Минимальный код
ads.interstitial();
// или
taddy.ads().interstitial();

PreviousDocumentation for LLMs NextPHP

Last updated 3 days ago

Basic integration (recommended)

Advanced integration

Exchange

Ads