> For the complete documentation index, see [llms.txt](https://knowledgebase.offer18.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledgebase.offer18.com/ru/set/api-seti/api-sozdaniya-offera-1.md).

# API создания оффера

```
POST https://api.offer18.com/api/m/offer_create
```

:link: [<mark style="color:синий;">**Нажмите, чтобы протестировать API создания оффера**</mark>](https://offer18.readme.io/reference/offers-api)

### Общие параметры

| **Запрос** | **Тип** | **Описание**        |
| ---------- | ------- | ------------------- |
| mid        | Целое   | ID аккаунта сети    |
| api-key    | Строка  | API-ключ сети       |
| secret-key | Строка  | Секретный ключ сети |

**Действие**

<table data-header-hidden><thead><tr><th width="207.16379474883627"></th><th width="194.99924751175493"></th><th></th></tr></thead><tbody><tr><td><strong>Запрос</strong></td><td><strong>Тип</strong></td><td><strong>Описание</strong></td></tr><tr><td>type</td><td>Строка</td><td><strong>Допустимые значения:</strong><br>create / update</td></tr><tr><td>oid</td><td>Целое</td><td>Требуется при обновлении оффера</td></tr></tbody></table>

***

### **Поля**&#x20;

<table data-header-hidden data-full-width="false"><thead><tr><th width="329.1820791993198"> </th><th width="124"> </th><th width="293.1921073532865"> </th></tr></thead><tbody><tr><td><strong>Тело</strong></td><td><strong>Тип</strong></td><td><strong>Описание</strong></td></tr><tr><td>offer_name</td><td>Строка</td><td>Название кампании</td></tr><tr><td>advertiser_id</td><td>Целое</td><td>ID рекламодателя </td></tr><tr><td>offer_url</td><td>URL</td><td>URL кампании</td></tr><tr><td>external_offer_id</td><td>Строка</td><td>Внешний ID кампании (если есть)</td></tr><tr><td>app_id</td><td>Строка</td><td>ID приложения (если есть)</td></tr><tr><td>logo</td><td>URL</td><td>URL логотипа кампании</td></tr><tr><td>category</td><td>Строка</td><td>Категория кампании</td></tr><tr><td>preview_url</td><td>URL</td><td>URL предпросмотра кампании</td></tr><tr><td>currency</td><td>Строка</td><td><p>Валюта оффера</p><p><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span> <a href="/pages/c5cd60bf393cfe040df1d311d8c64cb375cfe4b3#currency"><mark style="color:синий;">Просмотреть валюты</mark></a></p></td></tr><tr><td>price_advertiser</td><td>Десятичное</td><td>Цена, предлагаемая рекламодателем за кампанию</td></tr><tr><td>price_affiliate</td><td>Десятичное</td><td>Цена, выплачиваемая партнёру за кампанию</td></tr><tr><td>model_advertiser</td><td>Строка</td><td>Модель рекламодателя кампании<br><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span> <a href="/pages/c5cd60bf393cfe040df1d311d8c64cb375cfe4b3#models"><mark style="color:синий;">Просмотреть модели</mark></a></td></tr><tr><td>model_affiliate</td><td>Строка</td><td>Модель рекламодателя кампании<br><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span> <a href="/pages/c5cd60bf393cfe040df1d311d8c64cb375cfe4b3#models"><mark style="color:синий;">Просмотреть модели</mark> </a></td></tr><tr><td>hide_affiliate_payout</td><td>Целое</td><td>Допустимые значения <br><strong>1:</strong> Скрыть выплату партнёру (Affiliate Payout)</td></tr><tr><td>start_datetime</td><td>Метка времени UTC</td><td>Дата/время начала<br>(ГГГГ-ММ-ДД ЧЧ:ММ:СС) </td></tr><tr><td>end_datetime</td><td>Метка времени UTC</td><td>Дата/время окончания<br>(ГГГГ-ММ-ДД ЧЧ:ММ:СС )</td></tr><tr><td>visibility</td><td>Строка</td><td><strong>Допустимые значения:</strong><br>public, permission, private</td></tr><tr><td>status</td><td>Строка</td><td><strong>Допустимые значения:</strong> approve, pending</td></tr><tr><td>deep_links</td><td>Целое</td><td>Допустимые значения<br><strong>1:</strong> Включить deeplinks в оферах</td></tr><tr><td>offer_terms</td><td>Строка</td><td>Условия кампании</td></tr><tr><td>offer_kpi</td><td>Строка</td><td>KPI условия кампании</td></tr><tr><td>private_note</td><td>Строка</td><td>Приватные заметки в кампании</td></tr><tr><td>imps_url</td><td>URL</td><td>URL показов (Impression)</td></tr><tr><td>landing_page_name_1</td><td>Строка</td><td>Название первой лендинговой страницы </td></tr><tr><td>landing_page_url_1</td><td>URL</td><td>URL первой лендинговой страницы для кампании</td></tr><tr><td>landing_page_name_2</td><td>Строка</td><td>Название второй лендинговой страницы</td></tr><tr><td>landing_page_url_2</td><td>URL</td><td>URL второй лендинговой страницы для кампании</td></tr><tr><td>creatives</td><td>URL</td><td>URL креативов для кампании</td></tr><tr><td>fallback</td><td>булево</td><td>Допустимые значения:<br><strong>1:</strong> Включить резервный вариант</td></tr><tr><td>fallback_offer_id</td><td>Целое</td><td>ID оффера резервного варианта</td></tr><tr><td>fallback_url</td><td>URL</td><td>URL резервного варианта (Fallback)</td></tr><tr><td>fraud_conv_speed</td><td>Целое</td><td>Время в секундах</td></tr><tr><td>proxy_block</td><td>Целое</td><td>Допустимые значения:<br><strong>1:</strong> Блокировать прокси</td></tr><tr><td>blank_ref_block</td><td>Целое</td><td>Допустимые значения:<br><strong>1:</strong> Блокировать пустую ссылку-реферер</td></tr><tr><td>hide_referral</td><td>Целое</td><td>Допустимые значения:<br><strong>1:</strong> Скрыть реферал</td></tr><tr><td>assign_affiliates</td><td>Целое</td><td>Назначить партнёров (affiliates) этой кампании<br>(Значения через запятую)</td></tr><tr><td>capping_rule_id</td><td>Строка</td><td>В случае, если пользователь хочет обновить существующее правило ограничения</td></tr><tr><td>capping[0][capping_rule_name]</td><td>Строка</td><td>Название правила ограничения (Capping Rule) </td></tr><tr><td>capping[0][capping_rule_type]</td><td>Строка</td><td>Тип правила ограничения <br>1. <strong>advertiser_capping</strong><br>2. <strong>affiliate_capping</strong></td></tr><tr><td>capping[0][capping_timezone]</td><td>Метка времени</td><td>Часовой пояс ограничения</td></tr><tr><td>capping[0][capping_events]</td><td>Строка</td><td>События ограничения</td></tr><tr><td>capping[0][capping_type]</td><td>Строка</td><td>Тип ограничения<br>1. <strong>gross_conversions</strong><br>2. <strong>approved_conversions</strong><br>3. <strong>gross_revenue</strong><br>4. <strong>approved_revenue</strong><br>5. <strong>gross_payout</strong><br>6. <strong>approved_payout</strong><br>7. <strong>gross_clicks</strong><br>8. <strong>approved_clicks</strong></td></tr><tr><td>capping[0][capping_period]</td><td>Строка</td><td>Период ограничения<br>1. <strong>daily</strong><br>2. <strong>weekly</strong><br>3. <strong>monthly</strong><br>4. <strong>hourly</strong></td></tr><tr><td>capping[0][capping_value]</td><td>Целое</td><td>Значение ограничения</td></tr><tr><td>capping[0][overcap_action]</td><td>Строка</td><td>Действие при превышении<br>1. <strong>stop</strong><br>2. <strong>fallback</strong><br>3. <strong>fallback_conversion_accept</strong><br>4. <strong>conversion_accept</strong><br>5. <strong>conversion_reject</strong><br>6. <strong>conversion_pending</strong></td></tr><tr><td>capping[0][capping_notification_email]</td><td>Строка</td><td>Email для уведомлений об ограничении</td></tr><tr><td>capping[0][capping_affiliate_visibility]</td><td>Целое</td><td><strong>1:</strong> Показать правило ограничения партнёру</td></tr><tr><td>capping[0][capping_affiliate_id]</td><td>Строка</td><td>ID партнёров (через запятую)</td></tr><tr><td>target_country</td><td>Строка</td><td>Разрешить конкретную страну <br><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span> <a href="/pages/c5cd60bf393cfe040df1d311d8c64cb375cfe4b3#countries"><mark style="color:синий;">Просмотреть страны</mark></a></td></tr><tr><td>block_country</td><td>Строка</td><td>Блокировать конкретную страну <br><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span> <a href="/pages/c5cd60bf393cfe040df1d311d8c64cb375cfe4b3#countries"><mark style="color:синий;">Просмотреть страны</mark></a></td></tr><tr><td>target_os</td><td>Строка</td><td>Разрешить конкретную операционную систему<br><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span> <a href="/pages/c5cd60bf393cfe040df1d311d8c64cb375cfe4b3#operating-systems"><mark style="color:синий;">Просмотреть ОС</mark></a></td></tr><tr><td>block_os</td><td>Строка</td><td>Блокировать конкретную операционную систему<br><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span> <a href="/pages/c5cd60bf393cfe040df1d311d8c64cb375cfe4b3#operating-systems"><mark style="color:синий;">Просмотреть ОС</mark></a></td></tr><tr><td>target_device</td><td>Строка</td><td>Разрешить конкретные устройства<br><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span><a href="/pages/c5cd60bf393cfe040df1d311d8c64cb375cfe4b3#devices"> <mark style="color:синий;">Просмотреть устройства</mark></a></td></tr><tr><td>block_device</td><td>Строка</td><td>Блокировать конкретные устройства<br><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span><a href="/pages/c5cd60bf393cfe040df1d311d8c64cb375cfe4b3#devices"> <mark style="color:синий;">Просмотреть устройства</mark></a></td></tr><tr><td>target_browser</td><td>Строка</td><td>Разрешить конкретный браузер<br><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span> <a href="/pages/c5cd60bf393cfe040df1d311d8c64cb375cfe4b3#browsers"><mark style="color:синий;">Просмотреть браузеры</mark></a></td></tr><tr><td>block_browser</td><td>Строка</td><td>Блокировать конкретный браузер<br><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span> <a href="/pages/c5cd60bf393cfe040df1d311d8c64cb375cfe4b3#browsers"><mark style="color:синий;">Просмотреть браузеры</mark></a></td></tr><tr><td>target_isp</td><td>Строка</td><td>Разрешить конкретного провайдера (ISP)</td></tr><tr><td>block_isp</td><td>Строка</td><td>Блокировать конкретного провайдера (ISP)</td></tr><tr><td>events[0][event_name]</td><td>Строка</td><td>Название события </td></tr><tr><td>events[0][event_token]</td><td>Строка</td><td>Токен события</td></tr><tr><td>capping_conversion_period</td><td>Строка</td><td><mark style="color:оранжевый;"><strong>Устаревшее</strong></mark></td></tr><tr><td>capping_budget</td><td>Целое</td><td><mark style="color:оранжевый;"><strong>Устаревшее</strong></mark></td></tr><tr><td>capping_conversion</td><td>Целое</td><td><mark style="color:оранжевый;"><strong>Устаревшее</strong></mark></td></tr><tr><td>capping_budget_period</td><td>Строка</td><td><mark style="color:оранжевый;"><strong>Устаревшее</strong></mark></td></tr></tbody></table>

**Правила ограничения (Инструкции)**&#x20;

{% hint style="info" %}

1. Если вы хотите установить несколько правил ограничения, вы можете сделать это, присвоив правила разным номерам\
   **Пример 1:** \
   &#x20; capping\[**1**]\[capping\_rule\_name] \
   &#x20; capping\[**1**]\[capping\_rule\_type]\
   **Пример 2:**\
   &#x20; capping\[**2**]\[capping\_rule\_name] \
   &#x20; capping\[**2**]\[capping\_rule\_type]
2. Если вы хотите обновить существующее правило ограничения, вы должны отправить **capping\_rule\_id** в API-запрос вместе с новыми данными в **0**(Нулевой) номер\
   **Пример:**\
   &#x20; capping\[**0**]\[capping\_rule\_name] \
   &#x20; capping\[**0**]\[capping\_rule\_type]
   {% endhint %}

**События (Инструкции)**&#x20;

{% hint style="info" %}

1. Если вы хотите создать несколько событий, вы можете сделать это, присвоив события разным номерам\
   **Пример 1:** \
   &#x20; events\[1]\[event\_name] \
   &#x20; events\[1]\[event\_token]\
   **Пример 2:**\
   &#x20; events\[2]\[event\_name] \
   &#x20; events\[2]\[event\_token]
   {% endhint %}

***

### Пример запроса к API

**Создание оффера**

![](/files/5d0ccfc8160b2ecad8c3528bd13dd64dcdae7eb0)

**Ответ API**

```
{
    "status": "200",
    "response": "offer_created_successfully",
    "offer_id": 000012    
}
```

**Обновление оффера**

![](/files/b7e0b4612b0f85c6b2703440e93a80f7089b0e03)

**Ответ API**

```
{
    "status": "200",
    "response": "offer_updated_successfully",
    "offer_id": "000001"
}
```

***

{% hint style="info" %}
**Для безопасного взаимодействия всегда вызывайте API с сервера.**
{% endhint %}