Список партнёрских программ

Параметры

HTTP метод Права доступа URL Параметры Примечание
GET advcampaigns https://api.admitad.com/advcampaigns/
  • offset**
  • limit**
  • language***
  • website****
  • has_tool*****
  • traffic_id******
Возвращает список рекламных программ.*
GET advcampaigns https://api.admitad.com/advcampaigns/{id}/
  • language***
Возвращает рекламную программу, где id - это идентификатор рекламной программы.*
  • * Возвращает результат в формате JSON.
  • ** Задаёт пропуск и количество возвращаемых записей. Например limit=5&offset=2.
  • *** Интернационализация категорий (по умолчанию ru). Например language=ru.

  • **** Идентификатор площадки. Например website=12342, позволяет определить необходимость модерации при подключении программы.
  • ***** Фильтр по наличию у кампании инструмента. Возможные значения:
    • deeplink
    • products
    • retag
    • postview
    • lost_orders
    • broker_traffic
  • ****** Фильтр по наличию у кампании разрешённого вида трафика. Например 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": null,
            "ecpc": null,
            "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
        }
    ],
    "_meta": {
        "count": 4,
        "limit": 1,
        "offset": 0
    }
}

Описание полей ответа API-сервера

Название Описание
id Идентификатор рекламной программы
name Название рекламной программы
image Логотип рекламной программы
status Статус рекламной программы
rating Рейтинг рекламной программы
description Описание рекламной программы
raw_description Описание рекламной программы содержащее html теги
site_url Сайт рекламной программы
exclusive Экслюзивная рекламная программа
currency Системные валюты
regions Регионы площадок
categories Категории рекламных программ
actions Список тарифов по оплачиваемым действиям
сr Показатель средней конверсии
cr_trend Изменение показателя средней конверсии
ecpc Показатель среднего eCPC
ecpc_trend Изменение показателя среднего eCPC
rate_of_approve Процент подтверждения
more_rules Дополнительные правила
geotargeting Разделение оплаты в зависимости от страны клиента
coupon_iframe_denied Запрет купонного трафика через iframe
activation_date Дата запуска программы
modified_date Дата последнего изменения программы
connected Программа подключена к одной или нескольким площадкам вебмастера
avg_hold_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”