К основному содержимому

Native SDK

Автор: Olga

Native SDK отличается от прочих форматов тем, что владелец сайта сам занимается размещением и отображением рекламного блока на странице.
​

Установка

Для использования Native SDK необходимо подключить библиотеку на сайт, разместив код вызова библиотеки в блоке <head> Вашего сайта, а также установить переменную с рекламным доменом.
​


  <div>
<div>
  <div><pre><span><script></span>
<span>    <span>var</span> kdmDomain = <span><span>'</span><span>hdbcode.com</span><span>'</span></span>;</span>
  <span></script></span></pre></div>
</div>
</div>
  <div>
<div>
  <div><pre><span><script</span> <span>src</span>=<span><span>"</span><span>https://hdbcode.com/abcdef.js</span><span>"</span></span><span>></span><span></script></span></pre></div>
</div>
</div>
 

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

После подключения SDK станет доступен вызов функции для получения списка рекламных объявлений window.getKdm(options)

Описание объекта options

Название параметра

Тип данных

Описание

Примечания

Необходимость

blockId

integer

ID рекламного блока

Можно получить в интерфейсе рекламного кабинета

Обязательно

imgWidth

integer

Высота картинки

Обязательно

imgHeight

integer

Ширина картинки

Обязательно

amount

integer

Сколько надо вернуть рекламных предложений

По умолчанию равен 1

Необязательно

showAdDescription

boolean

Присылать или нет описание рекламы

По умолчанию false

Необязательно

subDomains

integer

Сколько поддоменов (без учёта домена верхнего уровня) оставлять в location.host и location.href при отправке на сервер параметров domain и page

По умолчанию равен 0. Доменное имя sub2.sub1.test.com при subDomains=1 превратится в test.com; при subDomains=2 — в sub1.test.com

Необязательно

callback

Function([Object])

Функция, которая будет вызвана после получения ответа с сервера

В аргумент функции передаётся массив с объектами, содержащими рекламные материалы (см. описание ниже)

Обязательно


​

Пример получения рекламных материалов

window.getKdm({
  blockId: 311785, 
  amount: 1, 
  imgWidth: 200, 
  imgHeight: 250,
  showAdDescription: true,
  callback: function(data) {
    console.log(data);
  }
 });

Описание параметров объекта рекламного материала

После отправки запроса ответ будет передан в функцию callback, в качестве аргумента передается массив рекламных материалов.
​

Название параметра

Тип данных

Описание

Примечания

Необходимость

description

string

Описание рекламы

Необязательно

title

string

Заголовок

Обязательно

image

URL

URL картинки

Обязательно

url

url

URL клика

Обязательно

calcCpm

float

Расчетный CPM

Расчетная стоимость 1000 показов этого материала

Обязательно

cpcCost

float

Стоимость клика

Обязательно

payMode

integer

0 — CPC; 2 — CPM; 4 — CPATarget

Обязательно

cur

string

Валюты оплаты

USD

Обязательно

campaignID

integer

Обязательно

adID

integer

Обязательно

notificationFunction

Function(void)

Функция, которую надо вызвать на показе рекламы (или на попадании рекламы в видимую область)

Стоит использовать только если не подходит функция notify

Обязательно

nofity

Function(Object)

Функция, которая автоматически отстучится о показе рекламы после попадания её в область видимости в течении указанного времени

Если условия отстука сложнее, можно самостоятельно реализовать их и отстучаться о показе с помощью notificationFunction

Обязательно

target

HTMLElement

Ссылка на DOM-элемент с креативом

Обязательно

delay

integer

Сколько миллисекунд рекламный материал должен находиться в видимой области

По умолчанию равен 1000

Необязательно

visibilityPercent

integer

Какой процент рекламного материала должен находиться в видимой области

По умолчанию равен 50

Необязательно


​

См. также

Нашли ответ на свой вопрос?