---
metadata:
  - name: generator
    content: Diplodoc Platform v5.34.3
alternate:
  - https://yandex.com/dev/video-sdk/doc/en/sdk-html5/AdConfig-interface.md
  - https://yandex.com/dev/video-sdk/doc/ru/sdk-html5/AdConfig-interface.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/video-sdk/doc/ru/llms.txt

# AdConfig

Интерфейс для работы с параметрами запуска рекламы.

[Свойства](#properties)

## Свойства {#properties}

| Имя                             | Тип                                         | Обязательное | Описание                                                                                                                                                                                         |
|:-------------------------------|:-------------------------------------------|:------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Параметры РСЯ-интеграции**   |                                            |              |                                                                                                                                                                                                  |
| `partnerId`                    | number                                     |      ✅       | Идентификатор партнера в Партнерском интерфейсе.                                                                                                                                                 |
| `category`                     | number                                     |      ✅       | Категория раздела сайта партнера.                                                                                                                                                                |
| `impId`                        | number                                     |      ❌       | Идентификатор рекламного блока (AdBreak). По умолчанию используется блок типа preroll, если параметр не указан.                                                                                   |
| `partnerStatId`                | string                                     |      ❌       | Идентификатор среза статистики (число от 1 до 1 000 000 000).                                                                                                                                     |
| **Параметры Adfox-интеграции** |                                            |              |                                                                                                                                                                                                  |
| `adFoxParameters`              | [AdFoxParameters](AdFoxParameters.md)      |      ✅       | Параметры интеграции через Adfox.                                                                                                                                                                |
| **Общие параметры**            |                                            |              |                                                                                                                                                                                                  |
| `videoContentUrl`              | string                                     |      ✅       | URL видеоконтента с воспроизведением In-Stream рекламы (если видеоплеер встроен на страницу через iframe). В остальных случаях значение может совпадать с `targetRef`.                                                                                                                                        |
| `videoContentDuration`         | number или строка `'infinity'`                      |      ✅       | Длительность видеоконтента в секундах. Для эфиров и трансляций требуется строковое значение `'infinity'`.                        |
| `targetRef`                    | string                                     |      ✅       | URL страницы с воспроизведением In-Stream рекламы.                                                                                                                                              |
| `adBreakType`                  | [AdBreakType](ADType-string.md)            |      ❌       | Тип рекламного блока (если не требуется загрузка параметров рекламы из РСЯ).                                                                                                                    |
| `desiredBitrate`               | number                                     |      ❌       | Рекомендуемый битрейт в килобитах в секунду (kbps).                                                                                    |
| `preferableAdSize`             | [PixelSize](PixelSize.md)                  |      ❌       | Предпочитаемые размеры рекламного блока.                                                                                                                                                        |
| `trackingEvents`               | [TrackingEvents](TrackingEvents-string.md) |      ❌       | Названия событий стандарта VAST для отслеживания.                                                                                                                                                |
| `vast`                         | string                                     |      ❌       | XML-VAST документ в виде строки.                                                                                                                                                                 |
| `vastUrl`                       | string                                     |      ❌       | URL для загрузки VAST-документа.                                                                                                                                                                |
| `vmapLoadTimeout`               | milliseconds                               |      ❌       | Максимальное время ожидания загрузки VMAP.                                                                                                                                                      |
