Партнерские программы

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

Параметры

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
    • 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)

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

Параметры

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
    • lost_orders
    • coupons
    • basket_tracking
    • tracking_in_mobile_site
    • tracking_in_mobile_app
    • vendor_bonus

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

Пример запроса с использованием утилиты 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": [
{
"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": [
{
"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,
"cr": 84.38,
"cr_trend": 3.41,
"activation_date": "2010-03-31 19:05:39",
"modified_date": "2010-04-12 18:05:32"
"moderation": false,
"gotolink": "http://ad.admitad.com/goto/some_link/",
"ecpc": 23.74,
"epc": 2374.34,
"ecpc_trend": 2.41,
"epc_trend": 241.45,
"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",
"advertiser_legal_info": "{ООО "Ромашка"}, ИНН: {1112223334}",
"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,
"actions_limit": 10000,
"actions_limit_24": 1000
}
],
"_meta": {
"count": 4,
"limit": 1,
"offset": 0
}
}

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

Name Description
id Идентификатор партнерской программы
name Название партнерской программы
image Логотип партнерской программы
status Статус партнерской программы
connection_status Статус сотрудничества с площадкой ('active', 'pending', 'declined')
rating Рейтинг партнерской программы
description Описание партнерской программы
raw_description Описание партнерской программы, содержащее html теги
site_url Сайт партнерской программы
currency Системные валюты
regions Регионы площадок
categories Категории партнерских программ
actions Список тарифов по оплачиваемым действиям
actions_detail Детальная информация по актуальным оплачиваемым действиям (действия - тарифы - ставки)
сr Показатель средней конверсии
cr_trend Изменение показателя средней конверсии
ecpc Показатель среднего eCPC
ecpc_trend Изменение показателя средней конверсии
epc Показатель EPC
epc_trend Изменение показателя EPC
geotargeting Разделение оплаты в зависимости от страны веб-мастера
coupon_iframe_denied  Запрет купонного трафика через iframe
activation_date Дата запуска программы
modified_date Дата последнего изменения программы
avg_hold_time Фактическое среднее время холда
avg_money_transfer_time  Среднее время оплаты
gotolink Дефолтная партнёрская ссылка программы для выбранной площадки
goto_cookie_lifetime Время жизни postclick cookie
traffics Виды трафика
moderation Необходимость модерации
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
action_countries Страны, из которых оплачиваются действия (["GE", "RU", ...]/null)
allow_actions_all_counties Возможность работать с данной программой во всех странах (true/false)
action_testing_limit

После генерации заданного количества действий веб-мастер должен остановить трафик до получения обратной связи от рекламодателя.

For mobile programs and online games only (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)

actions_limit

После регистрации указанного количества действий за время активности программы, партнёрская ссылка отключается.

Актуально только для мобильных программ и онлайн-игр (int/null)

actions_limit_24

После регистрации указанного количества действий за сутки (отсчёт по UTC+3), партнёрская ссылка отключается.

Актуально только для мобильных программ и онлайн-игр (int/null)

advertiser_legal_info

Наименование юрлица первоначального рекламодателя и его ИНН
{advertiser_legal_name}, ИНН: {advertiser_INN}

Поле в ответе может быть пустым, если рекламодатель  сейчас не поддерживает маркировку.

 

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

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

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

Название Описание
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 Дата последнего обновления рекламодателем

Подключение площадки к программе

Параметры

HTTP метод Права доступа URL Примечание
POST manage_advcampaigns https://api.admitad.com/
advcampaigns/{c_id}/attach/{w_id}/
  • Возвращает результат операции, где w_id — это идентификатор площадки и с_id — это идентификатор партнерской программы.
  • Подключаясь к партнёрской программе данным методом, вы автоматически подтверждаете, что ознакомились с её правилами и обязуетесь их выполнять.
  • * Возвращает результат в формате JSON.

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

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

curl -L -H 'Authorization: Bearer access_token' -X POST
https://api.admitad.com/advcampaigns/2/attach/3/

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

{
"message": "Request for adding the campaign CampaignName was successfully created.",
"success": "OK"
}

Отключение площадки от программы

Parameters

HTTP метод Права доступа URL Примечание
POST manage_advcampaigns https://api.admitad.com/
advcampaigns/{c_id}/detach/{w_id}/
Возвращает результат операции в формате JSON где w_id — это идентификатор площадки и с_id — это идентификатор партнерской программы.
  • * Возвращает результат в формате JSON.

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

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

curl -L -H 'Authorization: Bearer access_token' -X POST
https://api.admitad.com/advcampaigns/2/detach/3/

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

{
"message": "Program CampaignName has been removed from your list. You can later add it again.",
"success": "Deleted"
}