Banners

List of banners

Parameters

HTTP method	Access rights	URL	Parameters	Note
GET	banners	`https://api.admitad.com/banners/{c_id}/`	Parameter request list	Returns a list of banners, where с_id is the affiliate program ID*.

* Returns the result in the JSON format.

Parameter request list

Name	Type	Allowed values
landing	integer	Landing pages
mobile_content	string	true false
uri_scheme	string	http https no
offset	integer	limit, offset parameters
limit	integer	limit, offset parameters

Example of use

Example of a request with utility ``curl``:

curl -L -H 'Authorization: Bearer access_token' -X GET

https://api.admitad.com/banners/340/?limit=2

Example of the response from the API server in the JSON format:

{

        "results": [

            {

                "name": "Gmail Banner",

                "size_width": 240,

                "creation_date": "2015-03-31T19:44:00",

                "size_height": 400,

                "mobile_content": true,

                "banner_image_url": "https://cdn.admitad.com/bs/2015/03/31/2c8c9dc5173456544c82a12465aadb74.png",

                "is_flash": false,

                "type": "flash",

                "id": 703

            },

            {

                "banner_flashobj_url": "https://cdn.admitad.com/bs/2015/03/23/aaab3ffd6137de8ee93149a1da0fc131.swf",

                "name": "Gmail Banner2",

                "size_width": 728,

                "creation_date": "2015-03-31T19:44:00",

                "size_height": 90,

                "mobile_content": false,

                "banner_image_url": "https://cdn.admitad.com/bs/2015/03/31/2088d0e3e765a438d6229bc62fc56c14.png",

                "is_flash": true,

                "type": "png",

                "id": 704

            }

        ],

        "_meta": {

            "count": 5,

            "limit": 2,

            "offset": 704

        }

    }

Description of API server response fields

Name	Description
id	Banner ID
name	Name of banner
size_width	Banner width
size_height	Banner height
creation_date	Banner added time
is_flash	Flash banner
type	Type of banner (PNG, JPEG, GIF, link, flash)
banner_image_url	Link to the image banner
banner_flashobj_url	Link to the flash banner
mobile_content	Mobile content

List of banners for the ad space

Parameters

HTTP method	Access rights	URL	Parameters	Note
GET	banners_for_website	`https://api.admitad.com/banners/{c_id}/website/{w_id}/`	Parameter request list	Returns a list of banners, where c_id is the affiliate program ID and w_id is the ad space identifier*.

* Returns the result in the JSON format.

Parameter request list

Name	Type	Allowed values
landing	integer	Landing pages
mobile_content	string	true false
uri_scheme	string	http https no
offset	integer	limit, offset parameters
limit	integer	limit, offset parameters

Example of use

Example of a request with utility ``curl``:

curl -L -H 'Authorization: Bearer access_token' -X GET

https://api.admitad.com/banners/340/website/30220/?limit=2

Example of the response from the API server in the JSON format:

{

        "results": [

            {

                "name": "Gmail Banner1",

                "size_width": 240,

                "creation_date": "2015-03-31T19:44:00",

                "direct_link": "https://ad.admitad.com/g/sltaobsmtn8ad74db9a54e2e5e494f/",

                "size_height": 400,

                "banner_image_url": "https://cdn.admitad.com/bs/2015/03/31/2c8cdc5173456544c82
a12465aadb94.png",

                "html_code": "<!-- admitad.banner: sltaobsmtn8ad74db9a53e2e5e494f Heroes -->\
n<a target=\"_blank\" rel=\"nofollow\" href=\"https://ad.admitad.com/g/sltaobsmtn8ad74db9a53e2
e5e494f/?i=4\">\n    <img width=\"240\" height=\"400\" border=\"0\" src=\"https://ad.admitad.co
m/b/sltaobsmtn8ad74db9a53e2e5e494f/\" alt=\"Heroes\"/>\n</a>\n<!-- /admitad.banner -->",

                "is_flash": false,

                "mobile_content": true,

                "type": "png",

                "id": 700

            },

            {

                "banner_flashobj_url": "https://cdn.admitad.com/bs/2015/03/23/aabb3ffd6137de8
ee93149a1de0fc131.swf",

                "name": "Gmail Banner2",

                "size_width": 728,

                "creation_date": "2015-03-31T19:44:00",

                "direct_link": "https://ad.admitad.com/g/4z38td62p88ad74db9a53e2e5e494f/",

                "size_height": 90,

                "banner_image_url": "https://cdn.admitad.com/bs/2015/03/31/2088d0e3e765a438d6
229bc62fc56c34.png",

                "html_code": "<!-- admitad.banner: 4z38td62p88ad74db9a53e2e5e494f Heroes -->\n
<a target=\"_blank\" rel=\"nofollow\" href=\"https://ad.admitad.com/g/4z38td62p88ad74db9a53e2e
5e494f/?i=4\">\n    <img width=\"728\" height=\"90\" border=\"0\" src=\"https://ad.admitad.com
/b/4z38td62p88ad74db9a53e2e5e494f/\" alt=\"Heroes\"/>\n</a>\n<!-- /admitad.banner -->",

                "is_flash": true,

                "mobile_content": false,

                "type": "png",

                "id": 701

            }

        ],

        "_meta": {

            "count": 5,

            "limit": 2,

            "offset": 0

        }

    }

Description of API server response fields

Name	Description
id	Banner ID
name	Name of banner
size_width	Banner width
size_height	Banner height
creation_date	Banner added time
direct_link	Direct link
is_flash	Flash banner
type	Type of banner (PNG, JPEG, GIF, link, flash)
banner_image_url	Link to the image banner
banner_flashobj_url	Link to the flash banner
html_code	Banner code to paste into the publisher’s website
mobile_content	Mobile content