Список партнерских программ¶
Параметры¶
| HTTP метод | Права доступа | URL | Параметры | Примечание |
|---|---|---|---|---|
| GET | advcampaigns | https://api.admitad.com/advcampaigns/ |
|
Возвращает список партнерских программ.* |
| GET | advcampaigns | https://api.admitad.com/advcampaigns/{id}/ |
|
Возвращает партнерскую программу, где id — это идентификатор партнерской программы.* |
- * Возвращает результат в формате JSON.
- ** Задаёт пропуск и количество возвращаемых записей. Например limit=5&offset=2.
- *** Язык категорий (по умолчанию ru). Например language=ru.
- **** Идентификатор площадки. Например website=12342, позволяет определить необходимость модерации при подключении программы.
- ***** Фильтр по наличию у программы инструмента. Возможные значения:
- deeplink
- products
- retag
- lost_orders
- coupons
- basket_tracking
- tracking_in_mobile_site
- tracking_in_mobile_app
vendor_bonus
****** Фильтр по наличию у программы разрешённого вида трафика. Например traffic_id=1. Для получения идентификаторов трафика воспользуйтесь этим методом.
С помощью этого метода вы сможете выгрузить список программ из каталога и их стандартную ставку. Если вы хотите видеть эксклюзивные ставки программ для вашей площадки, воспользуйтесь этим методом.
Пример использования¶
Пример запроса с использованием утилиты curl:
curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/advcampaigns/?limit=1&website=1234124
curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/advcampaigns/3/?language=ru
Пример ответа API-сервера в формате JSON:
{
"results": [
{
"status": "active",
"rating": "5.00",
"image": "//cdn.admitad.com/media/campaign/images/2012/06/13/4b9182dae3a6758eb12f76a76a5b3f26.jpg",
"description": "Gmail is a mail service by google",
"traffics": [
{
"enabled": false,
"name": "Type 1",
"type": "lead",
"id": 1
},
{
"enabled": false,
"name": "Type 2",
"type": "sale",
"id": 2
}
],
"actions": [
{
"payment_size": "50.00",
"type": "sale",
"name": "Action name",
"id": 1
},
{
"payment_size": "1.30%",
"type": "sale",
"name": "Paid order",
"id": 892
},
{
"payment_size": "11.00",
"type": "lead",
"name": "Registration",
"id": 11
}
],
"site_url": "http://www.gmail.com/",
"regions": [
{
"region": "BY"
},
{
"region": "CA"
},
{
"region": "DE"
},
{
"region": "KZ"
},
{
"region": "RU"
},
{
"region": "US"
}
],
"currency": "USD",
"geotargeting": true,
"coupon_iframe_denied": false,
"connected": true,
"id": 6,
"cr": 9.83,
"ecpc": 45.32,
"epc": 4532.45,
"cr_trend": 3.3323,
"ecpc_trend": 2.3441,
"epc_trend": 241.8345,
"categories": [
{
"language": "en",
"name": "Shop",
"parent": null,
"id": 1
},
{
"language": "en",
"name": "Online Games",
"parent": null,
"id": 2
},
{
"language": "en",
"name": "Browser",
"parent": {
"language": "en",
"name": "Online Games",
"parent": null,
"id": 2
},
"id": 3
},
{
"language": "en",
"name": "Other",
"parent": null,
"id": 5
},
{
"language": "en",
"name": "Finances",
"parent": {
"language": "en",
"name": "Other",
"parent": null,
"id": 5
},
"id": 6
},
{
"language": "en",
"name": "Subcategory",
"parent": {
"language": "en",
"name": "Other",
"parent": null,
"id": 5
},
"id": 17
}
],
"name": "Campaign1"
"action_type": "sale",
"individual_terms": false,
"allow_deeplink": true,
"action_testing_limit": 500,
"mobile_device_type": "smartphone",
"mobile_os_type": "android",
"mobile_os": "android 9.0",
"action_countries": ["BY", "GE", "RU"],
"allow_actions_all_countries": false,
}
],
"_meta": {
"count": 4,
"limit": 1,
"offset": 0
}
}
Описание полей ответа API-сервера¶
| Название | Описание |
|---|---|
| id | Идентификатор партнерской программы |
| name | Название партнерской программы |
| image | Логотип партнерской программы |
| status | Статус партнерской программы |
| rating | Рейтинг партнерской программы |
| description | Описание партнерской программы |
| raw_description | Описание партнерской программы, содержащее html теги |
| site_url | Сайт партнерской программы |
| exclusive | Эксклюзивная партнерская программа |
| currency | Системные валюты |
| regions | Регионы площадок |
| categories | Категории партнерских программ |
| actions | Список тарифов по оплачиваемым действиям |
| cr | Показатель средней конверсии |
| cr_trend | Изменение показателя средней конверсии |
| ecpc | Показатель среднего eCPC |
| ecpc_trend | Изменение показателя среднего eCPC |
| epc | Показатель EPC |
| epc_trend | Изменение показателя EPC |
| rate_of_approve | Процент подтверждения |
| more_rules | Дополнительные правила |
| geotargeting | Разделение оплаты в зависимости от страны веб-мастера |
| coupon_iframe_denied | Запрет купонного трафика через iframe |
| activation_date | Дата запуска программы |
| modified_date | Дата последнего изменения программы |
| connected | Программа подключена к одной или нескольким площадкам веб-мастера |
| avg_hold_time | Фактическое среднее время холда |
| avg_money_transfer_time | Среднее время оплаты |
| denynewwms | Набор новых веб-мастеров приостановлен |
| goto_cookie_lifetime | Время жизни postclick cookie |
| retag | ReTag |
| show_products_links | Разрершено показывать ссылки для выгрузки товаров (true, false) |
| traffics | Виды трафика |
| landing_code | Код связанного лендинга |
| landing_title | Заголовок связанного лендинга |
| action_type | Тип действия (lead/sale) |
| individual_terms | Индивидуальные условия |
| allow_deeplink | Возможность использовать deeplink |
allow_actions_all_counties |
Возможность работать с данной программой во всех странах (true/false) |
| action_countries | Страны, из которых оплачиваются действия ([“GE”, “RU”, ...]/null) |
| action_testing_limit | После генерации заданного количества действий веб-мастер должен остановить трафик до получения обратной связи от рекламодателя. Актуально только для мобильных программ и онлайн-игр (int/null) |
| mobile_os_type | Тип операционной системы, поддерживаемый приложением. Актуально только для мобильных программ (“android”/”ios”/null) |
| mobile_os | Установка приложения поддерживается, начиная с данной версии. Актуально только для мобильных программ (“android 6.0”/”android all”/”ios 11.0”/”ios all”/null) |
| mobile_device_type | Тип устройства, поддерживаемый приложением. Актуально только для мобильных программ (“smartphone”/”tablet”/”all”/null) |