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

POST https://api.offer18.com/api/m/offers

🔗 Нажмите, чтобы протестировать API создания оффера

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

Query	Тип	Описание
mid	Integer	ID сетевого аккаунта
api-key	String	Ключ API сети
secret-key	String	Секретный ключ сети

Действие

Query	Тип	Описание
action	String	Допустимые значения: create / update / delete
offer_id	Integer	Требуется при обновлении и удалении оффера

---

Поля

Тело	Тип	Описание
offer_name	String	Название кампании
advertiser_id	Integer	ID рекламодателя
offer_url	URL	URL кампании
external_offer_id	String	Внешний ID кампании (если есть)
app_id	String	ID приложения (если есть)
logo	URL	URL логотипа кампании
category	String	Категория кампании
preview_url	URL	URL предпросмотра кампании
currency	String	Валюта оффера 🔗 Просмотреть валюты
price_advertiser	Decimal	Цена, заданная рекламодателем для кампании
price_affiliate	Decimal	Цена, выплачиваемая партнёру за кампанию
model_advertiser	String	Модель рекламодателя кампании 🔗 Просмотреть модели
model_affiliate	String	Модель рекламодателя кампании 🔗 Просмотреть модели
hide_affiliate_payout	Integer	Допустимые значения 1: Чтобы скрыть выплату партнёру
start_datetime	Timestamp UTC	Дата / время начала (YYYY-MM-DD HH:MM:SS)
end_datetime	Timestamp UTC	Дата / время окончания (YYYY-MM-DD HH:MM:SS )
visibility	String	Допустимые значения: public, permission, private
status	String	Допустимые значения: approve, pending
deep_links	Integer	Допустимые значения 1: Чтобы включить deeplinks в офферах
offer_terms	String	Условия кампании
offer_kpi	String	KPI-условия кампании
private_note	String	Личные заметки в кампании
imps_url	URL	URL показа
landing_page_id_1	Integer	Если пользователь хочет обновить существующую целевую страницу
landing_page_name_1	String	Название первой целевой страницы
landing_page_url_1	URL	URL первой целевой страницы кампании
landing_page_id_2	Integer	Если пользователь хочет обновить существующую целевую страницу
landing_page_name_2	String	Название второй целевой страницы
landing_page_url_2	URL	URL второй целевой страницы кампании
creatives	URL	URL креативов кампании
fallback	boolean	Допустимые значения: 1: Чтобы включить fallback
fallback_offer_id	Integer	ID оффера fallback'а
fallback_url	URL	URL fallback'а
fraud_conv_speed	Integer	Время в секундах
proxy_block	Integer	Допустимые значения: 1: Чтобы блокировать прокси
blank_ref_block	Integer	Допустимые значения: 1: Чтобы блокировать пустой реферер
hide_referral	Integer	Допустимые значения: 1: Чтобы скрыть реферальную ссылку
assign_affiliates	Integer	Назначить партнёров этой кампании (значения, разделённые запятыми)
capping_rule_id	Integer	Если пользователь хочет обновить существующее правило лимита
capping[0][capping_rule_name]	String	Название правила лимита
capping[0][capping_rule_type]	String	Тип правила лимита 1. advertiser_capping 2. affiliate_capping
capping[0][capping_timezone]	Отметка времени	Часовой пояс лимита
capping[0][capping_events]	String	События лимита
capping[0][capping_type]	String	Тип лимита 1. gross_conversions 2. approved_conversions 3. gross_revenue 4. approved_revenue 5. gross_payout 6. approved_payout 7. gross_clicks 8. approved_clicks
capping[0][capping_period]	String	Период лимита 1. daily 2. weekly 3. monthly 4. hourly
capping[0][capping_value]	Integer	Значение лимита
capping[0][overcap_action]	String	Действие при превышении лимита 1. stop 2. fallback 3. fallback_conversion_accept 4. conversion_accept 5. conversion_reject 6. conversion_pending
capping[0][capping_notification_email]	Строка	Email уведомления о лимите
capping[0][capping_affiliate_visibility]	Integer	1: Чтобы показать правило лимита партнёру
capping[0][capping_affiliate_id]	Строка	ID партнёров (через запятую)
targeting_rule_id	Integer	Если пользователь хочет обновить существующее правило таргетинга
target_country	String	Разрешить определённую страну 🔗 Просмотреть страны
block_country	String	Блокировать определённую страну 🔗 Просмотреть страны
target_os	String	Разрешить определённую операционную систему 🔗 Просмотреть ОС
block_os	String	Блокировать определённую операционную систему 🔗 Просмотреть ОС
target_device	String	Разрешить определённые устройства 🔗 Просмотреть устройства
block_device	String	Блокировать определённые устройства 🔗 Просмотреть устройства
target_browser	String	Разрешить определённый браузер 🔗 Просмотреть браузеры
block_browser	String	Блокировать определённый браузер 🔗 Просмотреть браузеры
target_isp	String	Разрешить определённый ISP
block_isp	String	Блокировать определённый ISP
events[0][event_name]	String	Название события
events[0][event_token]	String	Токен события
capping_conversion_period	String	Устаревшее
capping_budget	Integer	Устаревшее
capping_conversion	Integer	Устаревшее
capping_budget_period	String	Устаревшее

Правила лимита (инструкции)

1. Если вы хотите задать несколько правил лимита, вы можете сделать это, присвоив правила разным номерам Пример 1: capping[1][capping_rule_name] \n capping[1][capping_rule_type] Пример 2: capping[2][capping_rule_name] \n capping[2][capping_rule_type]

2. Если вы хотите обновить существующее правило лимита, вы должны отправить capping_rule_id в API-запрос вместе с новыми данными в 0номер (ноль) Пример: capping[0][capping_rule_name] \n capping[0][capping_rule_type]

События (инструкции)

1. Если вы хотите создать несколько событий, вы можете сделать это, присвоив события разным номерам Пример 1: events[1][event_name] \n events[1][event_token] Пример 2: events[2][event_name] \n events[2][event_token]

---

Пример API-запроса

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

Ответ API

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

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

Ответ API

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

---

Для безопасного взаимодействия всегда вызывайте API на стороне сервера.