Список программ для площадки

Параметры

HTTP метод Права доступа URL Параметры Примечание
GET advcampaigns_for_website https://api.admitad.com/advcampaigns/website/{w_id}/
  • offset**
  • limit**
  • connection_status***
  • has_tool****
Возвращает список рекламных программ площадки, где w_id - это идентификатор площадки.*
GET advcampaigns_for_website https://api.admitad.com/advcampaigns/{c_id}/website/{w_id}/ Возвращает рекламную программу, где w_id - это идентификатор площадки и с_id - это идентификатор рекламной программы.*
  • * Возвращает результат в формате JSON.
  • ** Задаёт пропуск и количество возвращаемых записей. Например limit=5&offset=2.
  • *** Фильтр по статусу сотрудничества с площадкой. Возможные значения:
    • active
    • pending
    • declined
  • **** Фильтр по наличию у кампании инструмента. Возможные значения:
    • deeplink
    • products
    • retag
    • arecord
    • call_tracking
    • postview
    • lost_orders

Пример использования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/advcampaigns/website/22/?limit=1

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/advcampaigns/6/website/22/

Пример ответа API-сервера в формате JSON:

{
    "results": [
        {
            "status": "active",
            "connection_status": "active",
            "rating": "5.00",
            "image": "//cdn.admitad.com/media/campaign/images/2012/06/13/4b9182dae3a6758eb12f76a76a5b3f26.jpg",
            "show_products_links": false,
            "traffics": [
                {
                    "enabled": false,
                    "name": "Type 1",
                    "id": 1
                },
                {
                    "enabled": false,
                    "name": "Type 2",
                    "id": 2
                }
            ],
            "description": "Gmail is a mail service by google",
            "avg_hold_time": null,
            "actions": [
            {
                "hold_time": 30,
                "payment_size": "5USD",
                "type": "lead",
                "name": "Example action",
                "id": 42
            }
        ],
            "site_url": "http://www.gmail.com/",
            "regions": [
                {
                    "region": "01"
                },
                {
                    "region": "BY"
                },
                {
                    "region": "CA"
                },
                {
                    "region": "DE"
                },
                {
                    "region": "KZ"
                },
                {
                    "region": "RU"
                },
                {
                    "region": "US"
                }
            ],
            "actions_detail": [
                {
                    "hold_size": 30,
                    "tariffs": [
                        {
                            "action_id": 42,
                            "rates": [
                                {
                                    "price_s": "0.00",
                                    "tariff_id": 42,
                                    "country": null,
                                    "date_s": "2014-11-06",
                                    "is_percentage": false,
                                    "id": 78,
                                    "size": "5.00"
                                }
                            ],
                            "id": 42,
                            "name": "Tariff name"
                        }
                    ],
                    "type": "lead",
                    "name": "Example action",
                    "id": 42
                }
            ],
            "currency": "USD",
            "goto_cookie_lifetime": 45,
            "geotargeting": true,
            "coupon_iframe_denied": false,
            "allow_deeplink": true,
            "max_hold_time": 120,
            "cr": 84.38,
        "activation_date": "2010-03-31 19:05:39",
        "modified_date": "2010-04-12 18:05:32"
        "gotolink": "http://ad.admitad.com/goto/some_link/",
            "ecpc": 23.74,
            "id": 6,
            "show_products_links": true,
            "products_csv_link": "http://export.admitad.com/ru/webmaster/websites/xxx/products/export_adv_products/?user=webmaster&code=db403bd6d2&advcampaign_id=xxx&format=csv",
            "products_xml_link": "http://export.admitad.com/ru/webmaster/websites/xxx/products/export_adv_products/?user=webmaster&code=db403bd6d2&advcampaign_id=xxx&format=xml",
            "feeds_info": [
                                {
                                        "name": "Campaign1",
                                        "admitad_last_update": "2015-10-27 15:35:58",
                                        "advertiser_last_update": "2015-10-27 08:38:00",
                                        "csv_link": "http://export.admitad.com/ru/webmaster/websites/22/products/export_adv_products/?user=webmaster1&code=db403bd6d2&feed_id=xxx&format=csv",
                                        "xml_link": "http://export.admitad.com/ru/webmaster/websites/22/products/export_adv_products/?user=webmaster1&code=db403bd6d2&feed_id=xxx&format=xml"
                                }
                        ],
            "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": "Finance",
                    "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"
        }
    ],
    "_meta": {
        "count": 4,
        "limit": 1,
        "offset": 0
    }
}

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

Название Описание
id Идентификатор рекламной программы
name Название рекламной программы
image Логотип рекламной программы
status Статус рекламной программы
connection_status Статус сотрудничества с площадкой (‘active, ‘pending’, ‘declined’)
rating Рейтинг рекламной программы
description Описание рекламной программы
raw_description Описание рекламной программы содержащее html теги
site_url Сайт рекламной программы
currency Системные валюты
regions Регионы площадок
categories Категории рекламных программ
actions Список тарифов по оплачиваемым действиям
actions_detail Детальная информация по актуальным оплачиваемым действиям (действия - тарифы - ставки)
сr Показатель средней конверсии
ecpc Показатель среднего eCPC
geotargeting Разделение оплаты в зависимости от страны клиента
coupon_iframe_denied Запрет купонного трафика через iframe
activation_date Дата запуска программы
modified_date Дата последнего изменения программы
avg_hold_time Фактическое среднее время холда
max_hold_time Максимальное время холда
gotolink Дефолтная ссылка для перехода
goto_cookie_lifetime Время жизни postclick cookie
traffics Разрешенные виды трафика
show_products_links

Разрешено показывать ссылки для выгрузки товаров (true, false)

products_xml_link Cсылкa на выгрузку товаров в формате xml (если show_products_links = true)
products_csv_link Cсылкa на выгрузку товаров в формате csv (если show_products_links = true)
feeds_info Список товарных фидов рекламной программы
allow_deeplink Возможность использовать “Deeplink”

Описание полей оплачиваемых действий

Название Описание
id Идентификатор оплачиваемого действия
name Название действия
type Тип действия lead/sale
hold_size Время холда
tariffs Список тарифов оплачиваемого действия

Описание полей тарифов оплачиваемых действий

Название Описание
id Идентификатор тарифа
name Название тарифа
action_id Идентификатор оплачиваемого действия
rates Список ставок тарифов оплачиваемого действия

Описание полей ставок тарифов

Название Описание
id Идентификатор ставки тарифа
size

Размер ставки (процент или сумма в валюте кампании)

tariff_id Идентификатор тарифа
country Страна для которой действует ставка, null - все страны
price_s Нижняя граница платежа с которой действует ставка
date_s Дата с которой действует ставка
is_percentage Тип ставки (True если процентная)

Описание полей товарных фидов рекламной программы

Название Описание
name Название фида
xml_link Cсылкa на выгрузку товаров в формате xml
csv_link Cсылкa на выгрузку товаров в формате csv
admitad_last_update Дата последнего обновления
advertiser_last_update Дата последнего обновления рекламодателем