Create Banner

Creates Banner for given Campaign ID.

URL: /rest-api/banner/create.do

Method: POST

Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g.: wrong types for parameters or Banner with such ID doesn't exist.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.

Response sample:
200 OK

Request parameters:

  • placementType – type of Placement. Available values are: SITE_PLACEMENT, NON_STANDARD_SITE_PLACEMENT, MOBILE_SITE_PLACEMENT, VIDEO_PLACEMENT, APPLICATION_PLACEMENT, EMAIL_PLACEMENT.
  • campaignId – ID of the Campaign.
  • active – Banner status as a boolean.
  • name – Banner name as a String.
  • labels – label name (optional).
  • target - available values are _BLANK, _PARENT, _SELF, _TOP (optional).
  • allowNewPlacementsAutoLinking – permission for Banner to be linked to new Placements automatically as a boolean.
  • autolinkCategories – ID's of publishing categories for autolinking.
  • weight – Banner Weight (integer value).
  • adUnitId – available values: /rest-api/banner/adunit/values.do
  • adUnitHeight – Banner Height, required for Custom ad units. Ignored for non–Custom ad units. (long value)
  • adUnitWidth – Banner Width, required for Custom ad units. Ignored for not a Custom ad units. (long value)
  • bannerType – available values: EXTERNAL_FILE, CODE, MOBILE_ADVERTISING_NETWORK, LOCAL_FILE, EXTERNAL_FILE, EXTERNAL_VIDEO, LOCAL_VIDEO, APPLICATION_ADVERTISING_NETWORK, TEMPLATE, VAST_2_0_TAG_URL (for 3rd party VAST/VPAID tags).
  • flashBannerLink
  • imageBannerLink
  • videoFileLink
  • flashFile
  • imageFile
  • videoFile
  • templateId – ID of the Template being used if Banner type is TEMPLATE. Properties required by the Template should be passed along.
  • thirdTrackingCode['Country Abbreviation'] – Country–specific 3rd–party tracking code.
  • thirdTrackingCode['*'] – Global 3rd–party tracking code.
  • code – for CODE Banner type.
  • url – for EXTERNAL_FILE and VAST_2_0_TAG_URL Banner type.
  • inStreamVideoType – required for Video Banners, values are LINEAR_VIDEO_AD, NON_LINEAR_VIDEO_AD
  • mobileAdvertisingNetwork – required for MOBILE_ADVERTISING_NETWORK Banner type.
  • mobileAdvertisingNetworkParameters – map of parameters for MOBILE_ADVERTISING_NETWORK Banner type. For example: mobileAdvertisingNetworkParameters[PUBLISHER_ALIAS]=somepub. List of available params for each network can be found using: /rest-api/banner/mobilenetworks.do
  • applicationOperatingSystem – required for APPLICATION_ADVERTISING_NETWORK Banner type, values are: ANDROID, IOS.
  • applicationAdCategory – required for APPLICATION_ADVERTISING_NETWORK Banner type, values are: INTERSTITIAL, BANNER.
  • applicationAdvertisingNetwork – for APPLICATION_ADVERTISING_NETWORK Banner type.
  • applicationAdvertisingNetworkParameters – map of parameters for APPLICATION_ADVERTISING_NETWORK Banner type.
  • additionalParameters['flashVars'] – additional parameters for flash creative (if present). Format: key=value, URL–encoded.
  • enablePassbackFunctionality – Passback active status as a boolean. Returns bannerPassbackURL and bannerPassbackHtmlCode values if parameter is true.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used for hash generation.
  • username – a given username.

Update Banner

Update the Banner active state, Auto–linking and Auto–linking Categories.

URL: /rest-api/banner/{bannerId}/update.do
Method: POST
Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types for parameters or Banner with such ID doesn't exist.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.

Request Parameters:

  • active – Banner active status as a boolean.
  • name – Banner name as a String (optional).
  • allowNewPlacementsAutoLinking – permission for Banner to be linked to new Placements automatically as a boolean.
  • autolinkCategories – ID's of Inventory Categories for Auto–linking.
  • autoLinkLabels – names of Labels for Auto–linking.
  • labels – Label(s) name(s).
  • target - available values are _BLANK, _PARENT, _SELF, _TOP (optional).
  • linkToPlacements – link to all matched Placements as a boolean.
  • weight – Weight of the Banner, integer value.
  • adUnitId – available values: /rest-api/banner/adunit/values.do
  • adUnitHeight – Banner Height, required for Custom ad units. Ignored for non–Custom ad units. (long value)
  • adUnitWidth – Banner Width, required for Custom ad units. Ignored for non–Custom ad units. (long value)
  • bannerType – available values are EXTERNAL_FILE, CODE, MOBILE_ADVERTISING_NETWORK, LOCAL_FILE, TEMPLATE, VAST_2_0_TAG_URL (for 3rd party VAST/VPAID tags).
  • flashBannerLink
  • imageBannerLink
  • flashFile
  • imageFile
  • templateId – ID of the Template being used if Banner type is TEMPLATE. Properties required by the Template should be passed along.
  • thirdTrackingCode['Country Abbreviation'] – Country–specific 3rd–party tracking code.
  • thirdTrackingCode['*'] – Global 3rd–party tracking code.
  • code – for CODE Banner type.
  • url – for EXTERNAL_FILE and VAST_2_0_TAG_URL Banner type.
  • mobileAdvertisingNetwork – for MOBILE_ADVERTISING_NETWORK Banner type.
  • mobileAdvertisingNetworkParameters – map of parameters,for MOBILE_ADVERTISING_NETWORK Banner type, for example: mobileAdvertisingNetworkParameters[PUBLISHER_ALIAS]=somepub. List of available params for each network can be found using: /rest-api/banner/mobilenetworks.do
  • directFileDownload – To open a browser for a Banner link, or download a file and open it with an associated app. Behaviour flag as a boolean.
  • additionalParameters['flashVars'] – additional parameters for flash creative (if present). Format: key=value, URL–encoded.
  • enablePassbackFunctionality – Passback active status as a boolean. Returns bannerPassbackURL and bannerPassbackHtmlCode values if parameter is true.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Banner ID.

Copy|Move Banner

Copies or Moves the Banner to another Campaign.

URL: /rest-api/banner/{bannerId}/{operation}/{campaignId}.do
Method: POST
Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types for parameters or Banner/Campaigns with such IDs do not exist.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Banner ID.
  • campaignId - ID of the Campaign where to move or copy the Banner.
  • operation - operation to perform (COPY or MOVE).
  • copyCount - numbers of copies (default value: 1); optional
  • keepBannersLinked - whether or not to preserve Banners linked to the Placements; boolean, default value: false.

Update Banners Urls Batch

Update landing URLs for multiple Banners.

URL: /rest-api/banners/urls.do
Method: POST
Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types for parameters or Banners do not exist.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.

Request body: JSON–formatted string of Banner to URL mappings as follows:
[{"id":1,"url":"http://example.com"}, ...]

Response sample:
200 OK

Method returns JSON–formatted string with errors that occurred during execution. Format: {"success":false, : }
Example: {"160″:"no_url_property_found","success":false}

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.

Delete Banner

Deletes the Banner.

URL: /rest-api/banner/{bannerId}/delete.do
Method: DELETE
Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types for parameters or Banner with such ID doesn't exist.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Banner ID.

Delete Banners' Labels

Deletes the Label(s) for Banner(s) in a Campaign.

URL: /rest-api/banner/{bannerId}/update.do
Method: POST
Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types for parameters or Banner with such ID doesn't exist.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.

Response sample:
200 OK

Request Parameters:

  • bannerId – the given Banner ID.

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • labels=[] – parameter for removing the Labels.

Get Banner

Get the Banner by ID.

URL: /rest-api/banner/{bannerId}.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – no Banner with such ID found.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Banner ID.

Get Banners

Get the list of all banners for the given user.

URL: /rest-api/banners.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • advertisingCategories – IDs of categories to filter down result to (optional)
  • campaignId – ID of banners' parent campaign (optional).

Get Banners' URLs

Get the list of configured landing URLs for given Banners.

URL: /rest-api/banners/urls.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • advertisingCategories – IDs of Advertising Categories to filter the results to (optional).
  • bannerIds – IDs of banners to filter the results to (optional).

Get Banners for Labels

Receive the list of Banners which have the given Label(s).

URL: /rest-api/banners.do
Method: GET
Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types for parameters or Banner with such ID doesn't exist.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.

Response sample:
200 OK

Request parameters:

  • labels – names of Label(s).

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used for hash generation.
  • username – a given username.

Get Ad Unit Values By Banner Type

Get the available Ad Unit values for a certain Banner type.

URL: /rest-api/banners/{bannerType}/adunit/values.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – no Banner with such ID found.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerType – type of banner. Available values are: LOCAL_FILE, EXTERNAL_FILE, CODE, MOBILE_ADVERTISING_NETWORK, APPLICATION_ADVERTISING_NETWORK, LOCAL_VIDEO, EXTERNAL_VIDEO, URL, VAST_2_0_TAG_URL, TEMPLATE, OPENRTB_DSP.

Get Banner Ad Unit Values

Get the available Ad Unit values for a certain Banner.

URL: /rest-api/banner/adunit/values.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – no Banner with such ID found.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • placementType – available values are: SITE_PLACEMENT, NON_STANDARD_SITE_PLACEMENT, MOBILE_SITE_PLACEMENT, VIDEO_PLACEMENT, APPLICATION_PLACEMENT, EMAIL_PLACEMENT.

Get all Ad Units

Get all Ad Units available in the given network.

URL: /rest-api/adunit/list.do
Method: GET
Response format: application/json
Error codes:

  • 401 Unauthorized - authentication error.

Response sample:
200 OK
[{"id":1,"height":250,"width":300,"name":"Medium Rectangle (300x250)","custom":false},{"id":2,"height":150,"width":180,"name":"Rectangle (180x150)","custom":false}, ...]

Parameters:

  • hash - an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp - UNIX timestamp in milliseconds used for hash generation.
  • username - a given username.

Get Mobile Networks for Banner

Get the available Mobile Advertising Networks for a given Banner.

URL: /rest-api/banner/mobilenetworks.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – no Banner with such ID found.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.

Get all Mobile Advertising Networks

Get the list of all Mobile Advertising Networks available for the given network.

URL: /rest-api/adnetworks/mobileNetworks.do

Method: GET

Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.

Response sample:
200 OK
[{"id":1, "name":"First Placement"}, ...]

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used for hash generation.
  • username – a given username.

Get Application Advertising Networks

Get the list of all Application Advertising Networks.

URL: /rest-api/banner/applicationnetworks.do

Method: GET

Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – no Banner with such ID found.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used for hash generation.
  • username – a given username.

Get Placements For Banner

Get the Placements linked to the Banner by its ID.

URL: /rest-api/banner/{bannerId}/placements.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – no Banner with such ID found.

Response sample:
200 OK
{id: 1, name: "bannerName1″}

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Banner ID.

Get all Advertisers, Campaigns and Banners

Get the list of all Advertisers, Campaigns and Banners in the network.
Requires ALL or SHARED level on VIEW permission for INVENTORY items.
When SHARED level being used, Share of any type must be present between requester and entity being requested.

URL: /rest-api/advertisers-tree.do

Method: GET

Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.

Response sample:
200 OK
[{"id":1,"name":"First Advertiser", "campaigns":[...,"banners":[...]]},…]

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used for hash generation.
  • username – a given username.
  • advertisingCategories – IDs of Advertising Categories to filter down result to (optional).

Get Browsers

Get available Browsers' values for Browser Targeting type.

URL: /rest-api/banner/{bannerId}/targeting/browsers/values.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Targeting with given ID not found for the Banner.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Banner ID.

Get Chrome Browsers

Get available Chrome Browser version values for Browser Targeting type.

URL: /rest-api/banner/{bannerId}/targeting/browsers/chrome/values.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Banner not found.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Banner ID.

Get Country Regions

Get available Regions for the given Country.

URL: /rest-api/banner/{bannerId}/targeting/country/region/values.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Banner not found.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Banner ID.
  • countryCode – ISO Country code. To pass multiple Country codes use: "UK, US, CA".

Get Device Format Values

Get available Device Format values for Device Format Targeting type.

URL: /rest-api/banner/{bannerId}/targeting/device/format/values.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Banner not found.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Banner ID.

Get Device Values

Get available Device values for Device Targeting type.

URL: /rest-api/banner/{bannerId}/targeting/device/values.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Banner not found.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Banner ID.

Get Device Vendor Values

Get available Device Vendor values for Device Vendor Targeting type.

URL: /rest-api/banner/{bannerId}/targeting/device/vendor/values.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Banner not found.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Banner ID.

Get Firefox Browsers

Get available Firefox Browser version values for Browser Targeting type.

URL: /rest-api/banner/{bannerId}/targeting/browsers/firefox/values.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Banner not found.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Banner ID.

Get IE Browsers

Get available Internet Explorer browser version values for browser targeting type.

URL: /rest-api/banner/{bannerId}/targeting/browsers/ie/values.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Banner not found.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Banner ID.

Get Languages

Get available languages.

URL: /rest-api/banner/{bannerId}/targeting/language/values.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Banner not found.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Banner ID.

Get Mobile Carriers

Get available Mobile Carriers' names for Mobile Carrier Targeting type.

URL: /rest-api/banner/{bannerId}/targeting/mobilecarriers/values.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Targeting with given ID not found for the given Banner.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Banner ID.

Get OS Values

Get available operating systems values for OS Targeting type.

URL: /rest-api/banner/{bannerId}/targeting/os/values.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Banner not found.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Banner ID.

Get OS Versions by OS Name

Gets available versions of the operating system for OS Targeting type.

URL: /rest-api/banner/{bannerId}/targeting/os/{osName}/versions.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Campaign not found.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Campaign ID.

Get Regions Cities

Get available Cities for given Country Region.

URL: /rest-api/banner/{bannerId}/targeting/country/region/city/values.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Banner not found.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Banner ID.
  • countryCode – ISO Country code. To pass multiple Country codes use: "UK, US, CA".
  • regionName – the given region name.

Get Safari Browsers

Get available Safari Browser version values for Browser Targeting type.

URL: /rest-api/banner/{bannerId}/targeting/browsers/safari/values.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Banner not found.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Banner ID.

Get Screen Resolution Values

Get available screen resolution values for Screen Resolution Targeting type.

URL: /rest-api/banner/{bannerId}/targeting/resolution/values.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Banner not found.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Banner ID.

Get Security Settings for Banner

Get security settings for the Banner with given ID.

URL: /rest-api/security-settings/banner.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.

Response sample:

200 OK
[{"id":1,"name":"Kids & Teens"},{"id":2,"name":"News"}, ... ] { "forensiqSettings": {"trafficShare": 5, "trafficQualityFiltering": "ACCEPT_ALL", "dateTo": { "formatted": "16/08/2016", "timestamp": 1471294800000 }, "countries": ["UA", "US"], ..., "mediaScannerSettings": { "mediaScannerEndDate": { "formatted": "16/08/2016", "timestamp": 1471294800000 }, "mediaScannerRate": 24, ... }

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • id – banner ID.

Update Security Settings for Banner

Update Security Settings for the Banner with given ID.

URL: /rest-api/security-settings/banner/save.do
Method: POST
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.

Request example:

{
"mediaScannerOn": true, "mediaScannerStartDate": "2016-07-27", "mediaScannerEndDate": "2016-08-16", "mediaScannerRate": "24",
"forensiqOn": true, "countries": ["UA","US"],"dateFrom": "2016-07-27", "dateTo": "2016-08-16", "trafficQualityFiltering": "ACCEPT_ALL", "trafficShare": "5.0", "trafficQualityMaxRisk": "50"
}

Response sample:
200 OK
{ "success" : true }

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • id – banner ID.
  • mediaScannerOn – (required) enable/disable media scanner settings; boolean.
  • mediaScannerStartDate – (required) start date for media scanner in yyyy-MM-dd format.
  • mediaScannerEndDate – (required) end date for media scanner in yyyy-MM-dd format.
  • mediaScannerRate – (required) media scanner rate.
  • forensiqOn – (required) enable/disable forensiq; boolean.
  • countries – (optional) array of country codes.
  • adEvents – (optional) array of ad events to set. Available values: REQUEST, IMPRESSION, CLICK, ACTION.
  • dateFrom – (required) start date for forensiq in yyyy-MM-dd format.
  • dateTo – (required) end date for forensiq in yyyy-MM-dd format.
  • trafficQualityFiltering – (required) traffic quality filtering. Available values: ACCEPT_ALL, REJECT_HIGH_RISK, REJECT_SUSPICIOUS or REJECT_CUSTOM.
  • trafficShare – (required) traffic share as a double.
  • trafficQualityMaxRisk – (required) traffic share as integer.

Disable Security Settings for Banner

Disables all security settings for the Banner with given ID.

URL: /rest-api/security-settings/banner/disable.do
Method: POST

Error codes:

  • 401 Unauthorized – authentication error.

Response format: application/json

Response sample:
200 OK
{ "success": true }

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • id – banner ID.

Need more help?

Should you require any additional help with our solutions, do not hesitate to contact Epom technical support at support@epom.com. Our support managers are dedicated to resolving any issues and providing you with solutions and support if you face difficulties or have questions.