Список баннеров для площадки

Параметры

HTTP метод Права доступа URL Параметры Примечание
GET banners_for_website https://api.admitad.com/banners/{c_id}/website/{w_id}/
  • limit **
  • offset **
  • mobile_content ***
  • landing ****
  • uri_scheme *****
Возвращает список баннеров, где c_id - это идентификатор рекламной программы и w_id - это идентификатор площадки. *
  • * Возвращает результат в формате JSON.
  • ** Задаёт пропуск и количество возвращаемых записей. Например limit=5&offset=2.
  • *** Фильтр по мобильному контенту. Возможные значения true или false. Например mobile_content=true.
  • **** Возвращает банеры для конкретного лендинга. Необходимо передавать идентификатор лендинга. Например landing=14.
  • ***** Задает протокол для direct_link. Необязательный параметр, возможные значения http, https, no. По умолчанию используется http. Значение no позволяет получить url без схемы, подробнее: RFC 3986: “Uniform Resource Identifier (URI): Generic Syntax”, Section 4.2 Например uri_scheme=https.

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

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

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

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

{
        "results": [
            {
                "name": "Gmail Banner",
                "size_width": 94,
                "creation_date": "2011-01-18 20:13:27",
                "direct_link": "http://ad.admitad.com/goto/6b6668afad59505879f5234642e5a7/",
                "size_height": 39,
                "image_src_type": "local",
                "banner_image_url": "http://admitad.trezor.by/media/advertising_campaign/banners/2010/04/02/4deef187b9d8387a7b250ea63662f7f2.jpg",
                "flashobj_src_type": "local",
                "banner_flashobj_url": "http://admitad.trezor.by/media/advertising_campaign/banners/2010/04/04/df21f3959c8fca80219b791aaa95b2e7.swf",
                "html_code": {
                    "async": "<script type=\"text/javascript\"> \ntry{(function(d,ad,s,ulp,subID,injectTo){ \n\n  /* Optional settings (these lines can be removed): */ \n  ulp = \"{ulp}\";  // - custom goto link;\n  subID = \"\";  // - local banner key; \n  injectTo = \"\";  // - #id of html element (ex., \"top-banner\").\n\nvar dInject=\"admitad\"+ad+subID+Math.round(Math.random()*100000000);\ninjectTo==\"\" && d.write('<div id=\"'+dInject+'\"></div>');\ns=s.replace(\"$\",ad);s+=\"?inject=\"+(injectTo==\"\"||!injectTo?dInject:injectTo);\nif(subID!=\"\")s+=\"&subid=\"+subID;if(ulp!=\"\")s+=\"&ulp=\"+escape(encodeURI(ulp)); \ns=((\"https:\"==d.location.protocol)?\"https\":\"http\")+\"://\"+s;var j=d.createElement(\"script\");\nj.type=\"text/javascript\";j.src=s;(d.getElementsByTagName(\"head\")[0]).appendChild(j);\n})(window.document,\"6b6668afad59505879f5234642e5a7\",\"ad.admitad.com/j/$/\",\"\",\"\",\"\");}catch(err){}\n</script>",
                    "image": "<a target=\"_blank\" rel=\"nofollow\" href=\"http://%(domain)s/goto/%(code)s/{get-ulp}\">\n<img width=\"%(width)s\" height=\"%(height)s\" border=\"0\" src=\"http://%(domain)s/b/%(code)s/\" alt=\"%(alt)s\" />\n</a>",
                    "flash": "<script type=\"text/javascript\"> \ntry{(function(d,ad,s,ulp,subID,injectTo){ \n\n  /* Optional settings (these lines can be removed): */ \n  ulp = \"{ulp}\";  // - custom goto link;\n  subID = \"\";  // - local banner key; \n  injectTo = \"\";  // - #id of html element (ex., \"top-banner\").\n\nvar dInject=\"admitad\"+ad+subID+Math.round(Math.random()*100000000);\ninjectTo==\"\" && d.write('<div id=\"'+dInject+'\"></div>');\ns=s.replace(\"$\",ad);s+=\"?inject=\"+(injectTo==\"\"||!injectTo?dInject:injectTo);\nif(subID!=\"\")s+=\"&subid=\"+subID;if(ulp!=\"\")s+=\"&ulp=\"+escape(encodeURI(ulp)); \ns=((\"https:\"==d.location.protocol)?\"https\":\"http\")+\"://\"+s;var j=d.createElement(\"script\");\nj.type=\"text/javascript\";j.src=s;(d.getElementsByTagName(\"head\")[0]).appendChild(j);\n})(window.document,\"6b6668afad59505879f5234642e5a7\",\"ad.admitad.com/j/$/\",\"\",\"\",\"\");}catch(err){}\n</script>\n<noscript>\n<embed wmode=\"opaque\" width=\"%(width)s\" height=\"%(height)s\" src=\"http://%(domain)s/f/%(code)s/\" type=\"application/x-shockwave-flash\">\n<noembed>\n<a target=\"_blank\" rel=\"nofollow\" href=\"http://%(domain)s/goto/%(code)s/{get-ulp}\">\n<img width=\"%(width)s\" height=\"%(height)s\" border=\"0\" src=\"http://%(domain)s/b/%(code)s/\" alt=\"%(alt)s\" />\n</a>\n</noembed>\n</noscript>",
                    "sync": "<script src=\"http://ad.admitad.com/b/6b6668afad59505879f5234642e5a7/\"></script>",
                    "full": "<!-- admitad.banner: 6b6668afad59505879f5234642e5a7 AdvCamp 1 -->\n<a target=\"_blank\" rel=\"nofollow\" href=\"http://ad.admitad.com/goto/6b6668afad59505879f5234642e5a7/{get-ulp}\">\n<img width=\"94\" height=\"39\" border=\"0\" src=\"http://ad.admitad.com/b/6b6668afad59505879f5234642e5a7/\" alt=\"AdvCamp 1\" />\n</a>\n<!-- /admitad.banner -->"
                },
                "is_flash": true,
                "mobile_content": true,
                "type": "flash",
                "id": 1
            },
            {
                "name": "Gmail Banner2",
                "size_width": 300,
                "creation_date": "2011-01-18 20:13:27",
                "direct_link": "http://ad.admitad.com/goto/bf8dbd563b59505879f5234642e5a7/",
                "flashobj_url": "",
                "size_height": 300,
                "image_src_type": "local",
                "banner_image_url": "http://admitad.trezor.by/media/advertising_campaign/banners/2010/04/04/df21f3959c8fca80219b791aaa95b2e7.png",
                "flashobj_src_type": "local",
                "banner_flashobj_url": "",
                "html_code": {
                    "async": "<script type=\"text/javascript\"> \ntry{(function(d,ad,s,ulp,subID,injectTo){ \n\n  /* Optional settings (these lines can be removed): */ \n  ulp = \"{ulp}\";  // - custom goto link;\n  subID = \"\";  // - local banner key; \n  injectTo = \"\";  // - #id of html element (ex., \"top-banner\").\n\nvar dInject=\"admitad\"+ad+subID+Math.round(Math.random()*100000000);\ninjectTo==\"\" && d.write('<div id=\"'+dInject+'\"></div>');\ns=s.replace(\"$\",ad);s+=\"?inject=\"+(injectTo==\"\"||!injectTo?dInject:injectTo);\nif(subID!=\"\")s+=\"&subid=\"+subID;if(ulp!=\"\")s+=\"&ulp=\"+escape(encodeURI(ulp)); \ns=((\"https:\"==d.location.protocol)?\"https\":\"http\")+\"://\"+s;var j=d.createElement(\"script\");\nj.type=\"text/javascript\";j.src=s;(d.getElementsByTagName(\"head\")[0]).appendChild(j);\n})(window.document,\"bf8dbd563b59505879f5234642e5a7\",\"ad.admitad.com/j/$/\",\"\",\"\",\"\");}catch(err){}\n</script>",
                    "image": "<a target=\"_blank\" rel=\"nofollow\" href=\"http://%(domain)s/goto/%(code)s/{get-ulp}\">\n<img width=\"%(width)s\" height=\"%(height)s\" border=\"0\" src=\"http://%(domain)s/b/%(code)s/\" alt=\"%(alt)s\" />\n</a>",
                    "flash": "<script type=\"text/javascript\"> \ntry{(function(d,ad,s,ulp,subID,injectTo){ \n\n  /* Optional settings (these lines can be removed): */ \n  ulp = \"{ulp}\";  // - custom goto link;\n  subID = \"\";  // - local banner key; \n  injectTo = \"\";  // - #id of html element (ex., \"top-banner\").\n\nvar dInject=\"admitad\"+ad+subID+Math.round(Math.random()*100000000);\ninjectTo==\"\" && d.write('<div id=\"'+dInject+'\"></div>');\ns=s.replace(\"$\",ad);s+=\"?inject=\"+(injectTo==\"\"||!injectTo?dInject:injectTo);\nif(subID!=\"\")s+=\"&subid=\"+subID;if(ulp!=\"\")s+=\"&ulp=\"+escape(encodeURI(ulp)); \ns=((\"https:\"==d.location.protocol)?\"https\":\"http\")+\"://\"+s;var j=d.createElement(\"script\");\nj.type=\"text/javascript\";j.src=s;(d.getElementsByTagName(\"head\")[0]).appendChild(j);\n})(window.document,\"bf8dbd563b59505879f5234642e5a7\",\"ad.admitad.com/j/$/\",\"\",\"\",\"\");}catch(err){}\n</script>\n<noscript>\n<embed wmode=\"opaque\" width=\"%(width)s\" height=\"%(height)s\" src=\"http://%(domain)s/f/%(code)s/\" type=\"application/x-shockwave-flash\">\n<noembed>\n<a target=\"_blank\" rel=\"nofollow\" href=\"http://%(domain)s/goto/%(code)s/{get-ulp}\">\n<img width=\"%(width)s\" height=\"%(height)s\" border=\"0\" src=\"http://%(domain)s/b/%(code)s/\" alt=\"%(alt)s\" />\n</a>\n</noembed>\n</noscript>",
                    "sync": "<script src=\"http://ad.admitad.com/b/bf8dbd563b59505879f5234642e5a7/\"></script>",
                    "full": "<!-- admitad.banner: bf8dbd563b59505879f5234642e5a7 AdvCamp 1 -->\n<a target=\"_blank\" rel=\"nofollow\" href=\"http://ad.admitad.com/goto/bf8dbd563b59505879f5234642e5a7/{get-ulp}\">\n<img width=\"300\" height=\"300\" border=\"0\" src=\"http://ad.admitad.com/b/bf8dbd563b59505879f5234642e5a7/\" alt=\"AdvCamp 1\" />\n</a>\n<!-- /admitad.banner -->"
                },
                "is_flash": false,
                "mobile_content": false,
                "type": "png",
                "id": 2
            }
        ],
        "_meta": {
            "count": 5,
            "limit": 2,
            "offset": 0
        }
    }

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

Название Описание
id Идентификатор баннера
name Название баннера
size_width Ширина баннера
size_height Высота баннера
creation_date Время добавления баннера
direct_link Прямая ссылка для перехода
is_flash Флэш-баннер
type Тип баннера(png, jpeg, gif, link, flash)
image_src_type Место расположения image-баннера(local - на серверах admitad, remote - на стороннем сервере)
banner_image_url Ссылка на image-баннер
flashobj_src_type Место расположения flash-баннера(local - на серверах admitad, remote - на стороннем сервере)
banner_flashobj_url Ссылка на flash-баннер
html_code Код баннера для вставки на сайт веб-мастера
mobile_content Мобильный контент