--- metadata: - name: generator content: Diplodoc Platform v5.52.0 alternate: - https://yandex.com/support/adfox/en/monetization/script-setup.md - https://yandex.com/support/adfox/ru/monetization/script-setup.md - href: ru/monetization/script-setup.md type: text/markdown title: Markdown version - href: ../llms.txt type: text/markdown title: llms.txt --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.com/support/adfox/ru/llms.txt # Создание и размещение скрипта на сайте ## Создание конфигурационного скрипта {#create} 1. Подготовьте код вставки рекламного места: - Если вы еще не добавляли код вставки на сайт, получите его по [инструкции](https://yandex.com/support/adfox/ru/ad-inventory/codes/get-code.md#site-code). - Если код уже установлен на сайте, возьмите его из верстки. В коде вставки скопируйте значение параметра `containerId` — идентификатор понадобится на этапе создания скрипта. 1. Создайте скрипт с помощью [HB конфигуратора](https://adfox.yandex.ru/hbConfigurator.php): 1. Перейдите на вкладку **Монетизация** → **HB конфигуратор**. {% note info %} Конфигуратор доступен, только если у вас есть кампании с внешним монетизатором. {% endnote %} 1. Нажмите **Добавить контейнер**. Укажите **ID контейнера** — значение параметра `containerId`, которое вы скопировали ранее из кода вставки. 1. Выберите тип рекламного запроса, который вы хотите получать в этом рекламном месте: **Banner**, **Combo**, **InPage** или **InStream**. Об особенностях подключения типа **InStream** читайте в разделе [Подключение InStream video](https://yandex.com/support/adfox/ru/monetization/instream.md). {% note warning %} От монетизаторов, интегрированных с библиотекой Prebid, доступны объявления только с типом **Banner**. {% endnote %} 1. Нажмите кнопку **Добавить монетизатора**. 1. Укажите ширину и высоту баннера в пикселях: например, `[300, 300]`. Этот параметр является обязательным для Prebid-монетизаторов и некоторых монетизаторов Yandex Header Bidding. 1. Выберите монетизаторов и укажите их параметры: - Для монетизаторов Yandex Header Bidding обязательно укажите **Идентификатор площадки монетизатора** (`Placement ID`). Узнать `Placement ID` можно у монетизатора напрямую. {% cut "Таблица с данными монетизаторов Yandex Header Bidding" %} **Монетизатор** | **Ключ монетизатора** | **Поддержка параметра `sizes`** | **InStream video** | **Поддержка [Combo](*combo)**\* **(подробнее см. ниже)** | **Параметр площадки в** `params` ----- | ----- | ----- | ----- | ----- | ----- Adlook | adlook | нет | да | да | `placementId` AdMile | admile | да | да | да | `placementId` AdMixer | AdMixer | нет | нет | да | `placementId` Adspector | adspector | да | да | да | `placementId` Adtelligent | adtelligent | нет | нет | нет | `placementId` Adwile | adwile | нет | нет | нет | `placementId` Alfasense | alfasense | да | нет | нет | `placementId` All in One Media | aio | нет | нет | нет | `placementId` Astralab | astralab | да| да | да | `placementId` A-traffic | atraffic | да | да | да | `placementId` Between Digital | betweenDigital | да | да | да | `placementId` Bidvol | bidvol | да | да | да | `placementId` Buzzoola | buzzoola | да | да | да | `placementId` Criteo | criteo | нет | нет | да | `placementId` DGT SSP | dgt_ssp | нет | нет | нет | `placementId` Digital Caramel | digitalcaramel | да | да | да | `placementId` Dynotech | dynotech | да | нет | нет | `placementId` Fotostrana | fotostrana | нет | нет | нет | `placementId` GetIntent | getintent | нет | нет | нет | `placementId` Gnezdo | Gnezdo | нет | да | нет | `placementId` GPMAds | gpmads | да | да | да | `placementId` Hybrid | hybrid | да | нет | да | `placementId` Hyper AdTech | hyper | да | да | да | `placementId` Kadam | Kadam | нет | нет | нет | `placementId` Link | link | да | да | нет | `placementId` Luxup | luxup | да | да | да | `placementId` Market-place.su | marketplace | да | нет | нет | `placementId` Media Instinct Group | mit | нет | нет | да | `placementId` MediaSniper | mediasniper | да | да | да | `placementId` Mediatoday | mediatoday | нет | нет | нет | `placementId` MTS | mts | нет | да | да | `placementId` MyTarget | myTarget | нет | нет | да | `placementId` Native Rent | nativerent | нет | нет | нет |`placementId` NEMEDIA | nemedia | нет | да | да | `placementId` OHMYBID | ohmybid | да | да | да | `placementId` Otclick HB | otclick | да | да | да | `placementId` OTM | otm | нет | да | нет | `placementId` Punch Media | punchmedia | да | да | да | `placementId` Redllama | redllama | нет | нет | нет | `placementId` Relap | relap | нет | нет | нет | `placementId` Roxot | roxot | да | да | да | `placementId` Sape | sape | да | да | да | `placementId` SberAds | sberads | нет | нет | нет |`placementId` Segmento | segmento | да | да | да | `placementId` SlickJump | slickjump | нет | да | да | `placementId` SMI2 | smi2 | нет | да | да | `placementId` Soloway | adriver | да | да | да | `placementId` Solta | solta | да | да | да | `placementId` Sparrow | sparrow | да | нет | да | `placementId` TechDig | techdig | да | да | да | `placementId` UMG | umg | да | да | да | `placementId` Upravel | upravel | да | да | нет | `placementId` Videohead | videohead | да | да | да | `placementId` Videonow | videonow | нет | нет | да | `placementId` Viqeo | viqeo | да | да | да | `placementId` {% endcut %} - Для монетизаторов, интегрированных с библиотекой Prebid.js, набор обязательных и дополнительных параметров отличается. Список обязательных параметров в зависимости от монетизатора представлен в таблице ниже. {% cut "Таблица с данными Prebid-монетизаторов" %} **Монетизатор** | **Ключ монетизатора** | **Обязательные параметры** | **Опциональные параметры** ----- | ----- | ----- | ----- AdformOpenRTB | pb_adf | `mid` (integer)

`inv` (integer)

`mname` (string) | [adf_prebid.org](https://docs.prebid.org/dev-docs/bidders/adf.html) AdKernel | pb_adkernel | `host` (string)

`zoneId` (integer) | [adkernel_prebid.org](https://docs.prebid.org/dev-docs/bidders/adkernel.html) AdRiver | pb_adriver | `siteid` (integer)

`placementId` (string) | [adriver_prebid.org](https://docs.prebid.org/dev-docs/bidders/adriver.html) AlgoriX | pb_algorix | `sid` (string)

`token` (string) | [algorix_prebid.org](https://docs.prebid.org/dev-docs/bidders/algorix.html) AppNexus | pb_appnexus | `placementId` (integer) | [appnexus_prebid.org](https://docs.prebid.org/dev-docs/bidders/appnexus.html) Between Digital | pb_between | `s` (string) | [between_prebid.org](https://docs.prebid.org/dev-docs/bidders/between.html) CPMStar | pb_cpmstar | `placementId` (integer) | [cpmstar_prebid.org](https://docs.prebid.org/dev-docs/bidders/cpmstar.html) Criteo | pb_criteo | `networkId` (integer)

`pubid` (string) | [criteo_prebid.org](https://docs.prebid.org/dev-docs/bidders/criteo.html) Digitalcaramel | pb_digitalcaramel | `siteId` (string)

`placementId` (string) | [digitalcaramel_prebid.org](https://docs.prebid.org/dev-docs/bidders/digitalcaramel.html) Dvgroup | pb_dvgroup | `sspId` (string) | [docs_prebid.org](https://docs.prebid.org/dev-docs/bidders/dvgroup.html) fluct | pb_fluct | `tagId` (string)

`groupId` (string) | [fluct_prebid.org](https://docs.prebid.org/dev-docs/bidders/fluct.html) Getintent | pb_getintent | `pid` (integer) | [getintent_prebid.org](https://docs.prebid.org/dev-docs/bidders/getintent.html) Hybrid | pb_hybrid | `placeId` (string)

`placement` (string) | [hybrid_prebid.org](https://docs.prebid.org/dev-docs/bidders/hybrid.html) Index Exchange | pb_ix | `siteId` (string) | [ix_prebid.org](https://docs.prebid.org/dev-docs/bidders/ix.html) Mediasniper | pb_mediasniper | `placementId` (string) | [mediasniper_prebid.org](https://docs.prebid.org/dev-docs/bidders/mediasniper.html) myTarget | pb_mytarget | `placementId` (string) | [mytarget_prebid.org](https://docs.prebid.org/dev-docs/bidders/mytarget.html) OneTag | pb_onetag | `pubId` (string) | [onetag_prebid.org](https://docs.prebid.org/dev-docs/bidders/onetag.html) OpenX | pb_openx | `delDomain` (string)

`unit` (string) | [openx_prebid.org](https://docs.prebid.org/dev-docs/bidders/openx.html) OperaAds | pb_operaads | `placementId` (string)

`endpointId` (string)

`publisherId` (string) | [operaads_prebid.org](https://docs.prebid.org/dev-docs/bidders/operaads.html) Programmatica | pb_programmatica | `siteId` (string)

`placementId` (string) | [programmatica_prebid.org](https://docs.prebid.org/dev-docs/bidders/programmatica.html) PubMatic | pb_pubmatic | `publisherId` (string) | [pubmatic_prebid.org](https://docs.prebid.org/dev-docs/bidders/pubmatic.html) Rich Audience | pb_richaudience | `pid` (string)

`supplyType` (string) | [richaudience_prebid.org](https://docs.prebid.org/dev-docs/bidders/richaudience.html) RTBHouse | pb_rtbhouse | `publisherId` (string)

`region` (string) | [rtbhouse_prebid.org](https://docs.prebid.org/dev-docs/bidders/rtbhouse.html) Rubicon Project | pb_rubicon | `accountId` (integer)

`siteId` (integer)

`zoneId` (integer) | [rubicon_prebid.org](https://docs.prebid.org/dev-docs/bidders/rubicon.html) Sape | pb_sape | `placeId` (integer) | [rtbsape_prebid.org](https://docs.prebid.org/dev-docs/bidders/rtbsape.html) Silverpush | pb_silverpush | `publisherId` (string) | [silverpush_prebid.org](https://docs.prebid.org/dev-docs/bidders/silverpush.html) Smaato | pb_smaato | `publisherId` (string)

`adspaceId` (string)

`adbreakId` (string) | [smaato_prebid.org](https://docs.prebid.org/dev-docs/bidders/smaato.html) Smart AdServer (Equativ) | pb_smartadserver | `siteId` (integer)

`pageId` (integer)

`formatId` (integer) | [smartadserver_prebid.org](https://docs.prebid.org/dev-docs/bidders/smartadserver.html) Smile Wanted | pb_smilewanted | `zoneId` (string) | [smilewanted_prebid.org](https://docs.prebid.org/dev-docs/bidders/smilewanted.html) Sovrn | pb_sovrn | `tagid` (string) | [sovrn_prebid.org](https://docs.prebid.org/dev-docs/bidders/sovrn.html) Teads | pb_teads | `pageId` (integer)

`placementId` (integer) | [teads_prebid.org](https://docs.prebid.org/dev-docs/bidders/teads.html) VOX | pb_vox | `placementId` (string)

`placement` (string) | [vox_prebid.org](https://docs.prebid.org/dev-docs/bidders/vox.html) {% endcut %} Все необходимые параметры можно получить у монетизатора напрямую. - Для монетизаторов, работающих через Adfox HB, укажите код вставки Adfox. Код нужно запросить у подключаемого монетизатора. {% cut "Таблица с данными монетизаторов Adfox HB" %} **Монетизатор** | **Ключ монетизатора** | **Поддержка параметра `sizes` в `adUnits`** | **Поддержка InStream video** | **Поддержка [Combo](*combo)**\* **(подробнее см. ниже)** | **Параметр площадки в `params`** ----- | ----- | ----- | ----- | ----- | ----- Digital Alliance | adfox_imho-banners | нет | да | да | переменные из объекта `params` кода вставки монетизатора Другие монетизаторы, работающие через Adfox HB | adfox_{owner_name}, где {owner_name} — название аккаунта-монетизатора | нет | нет | да | переменные из объекта `params` кода вставки монетизатора {% endcut %} {% note alert %} На одном рекламном месте нельзя сочетать монетизаторов, которые поддерживают combo и которые его не поддерживают. Если на вашем рекламном месте предполагается смешанный combo-аукцион, подключайте к нему только монетизаторов с поддержкой combo. Ставки от монетизаторов, не поддерживающих combo, будут игнорироваться. {% endnote %} 1. Если на странице несколько рекламных мест, нажмите **Добавить контейнер**, укажите `containerId` другого рекламного места и добавьте монетизаторов аналогичным образом. 1. В поле **User Timeout** укажите время ожидания ответа от сервера монетизатора в миллисекундах. 1. Поле **Trusted Owners** — необязательный параметр. Если вы планируете передавать ставки в запросы других аккаунтов Adfox через шаблон **Проброс кода Adfox [context]**, укажите через запятую идентификаторы аккаунтов, из которых будут пробрасываться коды. 1. Нажмите **Сгенерировать**. Когда скрипт появится в поле справа, нажмите **Скопировать**. 1. Если в скрипте есть Prebid-монетизаторы, не забудьте установить [библиотеку Prebid.js](https://docs.prebid.org/download.html) и добавить скрипт с вызовом библиотеки. 1. Разместите полученный скрипт на сайте. {% note warning %} - На сайт можно устанавливать только один конфиг Header Bidding. - [Код загрузчика](https://yandex.com/support/adfox/ru/ad-inventory/codes/code-loader.md#js-code) должен быть установлен на странице один раз и находиться ниже скрипта с настройками Header Bidding. Так загрузчик обнаружит, что на этой странице есть Header Bidding, и определит, какие объявления должны дождаться ставок. Если вы уже устанавливали код загрузчика ранее, удалите лишний. {% endnote %} 1. Разместите код вставки рекламного блока в том месте, где вы хотите показывать рекламу. Если код вставки уже добавлен на сайт, менять его не нужно. ## Пример единого скрипта для Yandex Header Bidding и Prebid.js {#prebid-example} {% note info %} Подробное описание параметров скрипта смотрите ниже под примером. {% endnote %} ```html ``` {% cut "Описание параметров скрипта" %} #| ||**Параметр** | **Описание**|| || `pbjs` | API библиотеки Prebid.js. Обязательный элемент, если вы подключаете монетизаторов, интегрированных с Prebid.js. В параметр необходимо установить значение `pbjs`. {% cut "Пример" %} ```javascript var pbjs = pbjs || {}; pbjs.que = pbjs.que || []; ``` {% endcut %} || || `biddersMap` | Объект с парами `ключ`: `значение`, где: - `ключ` — ключ монетизатора в одинарных кавычках. Ключи монетизаторов можно узнать в таблицах с данными монетизаторов (см. п. 2.6 инструкции выше). - `значение` — идентификатор рекламной кампании для выбранного монетизатора, созданной на 11 уровне Динамической монетизации, в одинарных кавычках. {% cut "Пример" %} ```javascript 'betweenDigital': '787336' ``` {% endcut %} || || `biddersCpmAdjustmentMap` | Необязательный параметр. Объект с парами `ключ`: `значение`, где: - `ключ` — ключ монетизатора в одинарных кавычках. Ключи монетизаторов можно узнать в таблицах с данными монетизаторов (см. п. 2.6 инструкции выше). - `значение` — коэффициент, на который перемножаются ставки монетизатора. С помощью коэффициента вы можете приоритизировать монетизаторов, например, если один присылает gross CPM, а другой — net CPM. Формат значения — целое или дробное число от 0 до 5 включительно (поддерживается три знака после точки). || || `adUnits` | Массив объектов с информацией о том, среди каких монетизаторов разыгрывать объявления. Содержит: - **code** — идентификатор контейнера для баннера (равен `containerId` в коде вставки Adfox); - **codeType** — тип рекламного запроса, который вы хотите получать в этом рекламном месте. Принимает значения: - `combo` — для получения и InPage, и баннерной рекламы; - `inpage` — для получения только InPage рекламы; - `instream` — для получения только InStream рекламы. Если в ответе приходит `json/html` или параметр `codeType` не задан, будет показана баннерная реклама. - **sizes** — размеры баннера. Обязательный параметр для монетизаторов, интегрированных с Prebid.js, и некоторых других монетизаторов (см. таблицу с данными монетизаторов в п. 2.6 выше). Массив массивов, в котором первое значение — ширина, а второе — высота. {% cut "Пример" %} ```javascript sizes: [[ 728, 90 ]]; ``` {% endcut %} - **bids** — данные о монетизаторах, подключенных к торгам для этой площадки. Представляет собой массив объектов: - `bidder` — ключ монетизатора; - `params` — объект с парами `параметр площадки`: `значение`, где: - `параметр площадки` — настройка для конкретного монетизатора; - `значение` — набор параметров, которые нужно получить от монетизатора. Содержимое объекта `params` зависит от монетизатора: - Для монетизаторов Yandex Header Bidding  — `Placement ID :значение`. {% cut "Пример bids для монетизатора Between Digital" %} ```javascript { bidder: 'betweenDigital', params: { placementId: 8 }, } ``` {% endcut %} - Для монетизаторов, интегрированных с Prebid.js, смотрите список параметров в п. 2.6. в инструкции выше. {% cut "Пример bids для монетизатора AdRiver (Prebid)" %} ```javascript { bidder: 'pb_adriver', params: { 'siteid': 216200 'placementId': '55:test_placement' }, } ``` {% endcut %} - Для монетизаторов, работающих через Adfox HB, заполните — пары `'параметр': 'значение'` из объекта `params` в коде вставки монетизатора. {% cut "Пример" %} ```javascript { bidder: 'adfox_example', params: { 'p1': 'bxzlm', 'p2': 'ekwz' }, } ``` {% endcut %} Объект `params` может содержать необязательный элемент — объект `additional` с дополнительными параметрами запроса, которые определяются по договоренности с монетизатором. {% cut "Пример с необязательными параметрами объекта params" %} ```javascript { bidder: 'betweenDigital', params: { placementId: '8', additional: { // Дополнительные параметры запроса pos: 123, ref: 'my-site/page' }, }, } ``` {% endcut %} {% cut "Массив adUnit с необязательными элементами params" %} ```javascript AdUnit [ { code: string; sizes: Sizes; bids: [ { bidder: 'mytarget', params: { placementId: '320552', additional: { // Дополнительные параметры запроса pos: 123, ref: 'my-site/page' }, }, } ]; } ] ``` {% endcut %} || || `timeout` | Время ожидания ответа от сервера монетизатора. Рекомендуемое время — 500 мс. Максимально возможное время — 3000 мс, но с таким временем основной контент сайта будет загружаться с задержкой. || || `trustedOwners` | Необязательный параметр. Если вы планируете передавать ставки в запросы других аккаунтов Adfox через шаблон **Проброс кода Adfox [context]**, укажите идентификаторы аккаунтов, коды из которых будут пробрасываться. || |# {% endcut %} ## Другие примеры скриптов с header-bidding.js {#other-examples} {% cut "Пример подключения скриптов и размещения рекламных мест" %} ```html
``` {% endcut %} {% cut "Пример подключения рекламы формата InPage" %} ```html
``` {% endcut %} {% cut "Пример подключения рекламы формата Combo" %} ```html ``` {% endcut %} ## Демо-страницы {#demo-page} По ссылкам ниже можно посмотреть, как выглядят примеры баннеров с использованием Header Bidding. [InPage video](https://yandex.ru/project/yan/adfox-specs/header-bidding-examples/adfox-inpage-header-bidding) ## Обратиться в службу поддержки Написать в чат Написать письмо [*combo]: Одновременная передача баннеров и InPage-видео.