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

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

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

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

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

Действие

Запрос	Тип	Описание
type	Строка	Допустимые значения: create / update
oid	Целое	Требуется при обновлении оффера

---

Поля

Тело	Тип	Описание
offer_name	Строка	Название кампании
advertiser_id	Целое	ID рекламодателя
offer_url	URL	URL кампании
external_offer_id	Строка	Внешний ID кампании (если есть)
app_id	Строка	ID приложения (если есть)
logo	URL	URL логотипа кампании
category	Строка	Категория кампании
preview_url	URL	URL предпросмотра кампании
currency	Строка	Валюта оффера 🔗 Просмотреть валюты
price_advertiser	Десятичное	Цена, предлагаемая рекламодателем за кампанию
price_affiliate	Десятичное	Цена, выплачиваемая партнёру за кампанию
model_advertiser	Строка	Модель рекламодателя кампании 🔗 Просмотреть модели
model_affiliate	Строка	Модель рекламодателя кампании 🔗 Просмотреть модели
hide_affiliate_payout	Целое	Допустимые значения 1: Скрыть выплату партнёру (Affiliate Payout)
start_datetime	Метка времени UTC	Дата/время начала (ГГГГ-ММ-ДД ЧЧ:ММ:СС)
end_datetime	Метка времени UTC	Дата/время окончания (ГГГГ-ММ-ДД ЧЧ:ММ:СС )
visibility	Строка	Допустимые значения: public, permission, private
status	Строка	Допустимые значения: approve, pending
deep_links	Целое	Допустимые значения 1: Включить deeplinks в оферах
offer_terms	Строка	Условия кампании
offer_kpi	Строка	KPI условия кампании
private_note	Строка	Приватные заметки в кампании
imps_url	URL	URL показов (Impression)
landing_page_name_1	Строка	Название первой лендинговой страницы
landing_page_url_1	URL	URL первой лендинговой страницы для кампании
landing_page_name_2	Строка	Название второй лендинговой страницы
landing_page_url_2	URL	URL второй лендинговой страницы для кампании
creatives	URL	URL креативов для кампании
fallback	булево	Допустимые значения: 1: Включить резервный вариант
fallback_offer_id	Целое	ID оффера резервного варианта
fallback_url	URL	URL резервного варианта (Fallback)
fraud_conv_speed	Целое	Время в секундах
proxy_block	Целое	Допустимые значения: 1: Блокировать прокси
blank_ref_block	Целое	Допустимые значения: 1: Блокировать пустую ссылку-реферер
hide_referral	Целое	Допустимые значения: 1: Скрыть реферал
assign_affiliates	Целое	Назначить партнёров (affiliates) этой кампании (Значения через запятую)
capping_rule_id	Строка	В случае, если пользователь хочет обновить существующее правило ограничения
capping[0][capping_rule_name]	Строка	Название правила ограничения (Capping Rule)
capping[0][capping_rule_type]	Строка	Тип правила ограничения 1. advertiser_capping 2. affiliate_capping
capping[0][capping_timezone]	Метка времени	Часовой пояс ограничения
capping[0][capping_events]	Строка	События ограничения
capping[0][capping_type]	Строка	Тип ограничения 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]	Строка	Период ограничения 1. daily 2. weekly 3. monthly 4. hourly
capping[0][capping_value]	Целое	Значение ограничения
capping[0][overcap_action]	Строка	Действие при превышении 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]	Целое	1: Показать правило ограничения партнёру
capping[0][capping_affiliate_id]	Строка	ID партнёров (через запятую)
target_country	Строка	Разрешить конкретную страну 🔗 Просмотреть страны
block_country	Строка	Блокировать конкретную страну 🔗 Просмотреть страны
target_os	Строка	Разрешить конкретную операционную систему 🔗 Просмотреть ОС
block_os	Строка	Блокировать конкретную операционную систему 🔗 Просмотреть ОС
target_device	Строка	Разрешить конкретные устройства 🔗 Просмотреть устройства
block_device	Строка	Блокировать конкретные устройства 🔗 Просмотреть устройства
target_browser	Строка	Разрешить конкретный браузер 🔗 Просмотреть браузеры
block_browser	Строка	Блокировать конкретный браузер 🔗 Просмотреть браузеры
target_isp	Строка	Разрешить конкретного провайдера (ISP)
block_isp	Строка	Блокировать конкретного провайдера (ISP)
events[0][event_name]	Строка	Название события
events[0][event_token]	Строка	Токен события
capping_conversion_period	Строка	Устаревшее
capping_budget	Целое	Устаревшее
capping_conversion	Целое	Устаревшее
capping_budget_period	Строка	Устаревшее

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

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

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

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

1. Если вы хотите создать несколько событий, вы можете сделать это, присвоив события разным номерам Пример 1: events[1][event_name] events[1][event_token] Пример 2: events[2][event_name] 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 с сервера.