Advertiser API

Advertiser Management API
Campaign Management API
Banner Management API

Advertiser Management

Delete Advertiser

Deletes advertiser by given id.

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

Error codes:

401 Unauthorized – authentication error

Response sample:
200 OK
{“success”:true} – success
{“permission_denied”:,”success”:false} – failure due to insufficient privileges

Parameters:

hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp
timestamp – UNIX timestamp used in hash generation
username – the given username

Get Advertiser Permissions For User

Get all advertiser shares for user with Access Level info: Can Edit/Can View/Is Owner.

URL: /advertiserShares.do
Method: GET
Response format: application/json

Error codes:

401 Unauthorized – authentication error

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

Parameters:

hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp
timestamp – UNIX timestamp used in hash generation
username – the given username

Get Campaigns For Advertiser

Get the list of all campaigns for a given advertiser.

URL: /advertiser/{advertiserId}/campaigns.do
Method: GET
Response format: application/json

Error codes:

401 Unauthorized – authentication error

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

Parameters:

hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp
timestamp – UNIX timestamp used in hash generation
username – the given username

Update Advertiser

Creates or updates advertiser info based on whether or not id was provided.

URL: /rest-api/advertisers/update.do
Method: PUT
Response format: application/json

Error codes:

401 Unauthorized – authentication error

Response sample:
200 OK
{“success”:true, id:} – success, returns id of affected advertiser record
{“success”:false} – error {“success”:false, “error”:”permission_denied”} – error due to insufficient privileges

Parameters:

hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp
timestamp – UNIX timestamp used in hash generation
username – the given username
id – advertiser identifier (mandatory)
name – advertiser name (optional)
contactName – advertiser contact name (optional)
contactEmail – advertiser contact e-mail (optional)
description – advertiser description (optional)
categoryId – advertiser category (optional)

Campaign Management

Create Campaign

Creates campaign.

URL: /rest-api/campaign/create.do
Method: POST
Response format: application/json

Error codes:

400 Bad Request – wrong request format. No campaign or campaign pricing is not enabled for the given campaign.
401 Unauthorized – authentication error
403 Forbidden – not enough permissions
404 Not Found – advertiser with given id not found

Request Parameters:

name – name of campaign as a String
advertiserId – id of the advertiser
description – description of campaign as a String
active – active status of campaign as a boolean
ctrOptimization – switch for CTR optimization setting of campaign as a boolean
weight – weight of campaign as a integer
allowNewPlacementsAutolinking – permission for campaign to allow link it’s banners to new placements automatically as boolean.
autolinkCategories – ID’s of publishing categories for autolinking.

Response sample:
200 OK
{“success”:true} – success
{“error”:”permission_denied”,”success”:false} – failure due to insufficient privileges

Parameters:

hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp
timestamp – UNIX timestamp used in hash generation
username – the given username

Copy|Move the campaign

URL: /rest-api/campaign/{campaignId}/{operation}/{advertiserId}.do.
Method: POST.
Response format: application/json.
Error codes:

400 Bad Request – wrong request format. E.g. wrong types for parameters or no campaign|advertiser with such id exists.
401 Unauthorized – authentication error.
403 Forbidden – not enough permissions.

Response sample:
200 OK.
Parameters:

hash – a MD5 digest of concatenated username’s md5 password and the given timestamp;
timestamp – UNIX timestamp used in hash generation;
username – the given username;
advertiserId – the given banner id;
campaignId id – of campaign where to move/copy banner to;
operation – operation to perform (literal, either COPY or MOVE);
copyCount – numbers of copies, not required, defaults to 1;
keepBannersLinked – boolean, whether or not preserve banners linkage, defaults to false.

Delete Campaign

Deletes campaign by given id.

URL: /rest-api/campaign/{campaignId}/delete.do
Method: POST
Response format: application/json

Error codes:

401 Unauthorized – authentication error

Response sample:
200 OK
{“success”:true} – success
{“error”:”permission_denied”,”success”:false} – failure due to insufficient privileges

Parameters:

hash – an MD5 digest of a concatenated username’s md5 password and a given timestamp
timestamp – UNIX timestamp used in hash generation
username – the given username
campaignId – the given campaign id

Get Banners For Campaign

Get the list of all banners for given campaign.

URL: /campaign/{campaignId}/banners.do
Method: GET
Response format: application/json

Error codes:

401 Unauthorized – authentication error

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

Parameters:

hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp
timestamp – UNIX timestamp used in hash generation
username – the given username

Get Campaign

Get the campaign by id.

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

Error codes:

401 Unauthorized – authentication error
403 Forbidden – not enough permissions
404 Not Found – no campaign for 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 used in hash generation
username – the given username
campaignId – the given campaign id

Get Campaigns

Get the list of all campaigns for the given user.

URL: /rest-api/campaigns.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 used in hash generation
username – the given username

Update Campaign

Updates campaign with given id.

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

Error codes:

401 Unauthorized – authentication error
403 Forbidden – not enough permissions
404 Not Found – campaign with given id not found

Request Parameters:

name – name of campaign as a String
description – description of campaign as a String
active – active status of campaign as a boolean
ctrOptimization – switch for CTR optimization setting of campaign as a boolean
weight – weight of campaign as a integer
allowNewPlacementsAutolinking – permission for campaign to allow link it’s banners to new placements automatically as boolean.
autolinkCategories – ID’s of publishing categories for autolinking.

Response sample:
200 OK
{“success”:true} – success
{“error”:”permission_denied”,”success”:false} – failure due to insufficient privileges

Parameters:

Campaign Capping API

Get Action Capping

Get the campaign action capping information by campaign id.

URL: /rest-api/campaign/{campaignId}/actionCapping.do
Method: GET
Response format: application/json

Error codes:

401 Unauthorized – authentication error
403 Forbidden – not enough permissions
404 Not Found – campaign with given id 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 used in hash generation.
username – the given username.
campaignId – the given campaign id.

Get Click Capping

Get the campaign click capping information by campaign id.

URL: /rest-api/campaign/{campaignId}/clickCapping.do
Method: GET
Response format: application/json

Error codes:

401 Unauthorized – authentication error
403 Forbidden – not enough permissions
404 Not Found – campaign with given id not found

Response sample:
200 OK
{id: 1, paymentModel: “CPM”, price: 0.03, countries: [{country: "US", price: 0.02}, {country: "UK", price: 0.025}, ... }

Parameters:

Get Frequency Capping

Get the campaign frequency capping information by campaign id.

URL: /rest-api/campaign/{campaignId}/frequencyCapping.do
Method: GET
Response format: application/json

Error codes:

401 Unauthorized - authentication error
403 Forbidden - not enough permissions
404 Not Found - campaign with given id not found

Response sample:
200 OK
{id: 1, paymentModel: "CPM", price: 0.03, countries: [{country: "US", price: 0.02}, {country: "UK", price: 0.025}, ... }

Parameters:

Remove Action Capping

Removes the campaign action capping by campaign id.

URL: rest-api/campaign/{campaignId}/actionCapping.do
Method: DELETE
Response format: application/json

Error codes:

400 Bad Request - wrong request format. No campaign or campaign pricing is not enabled for the given campaign.
401 Unauthorized - authentication error
403 Forbidden - not enough permissions

Response sample:
200 OK

Parameters:

Remove Click Capping

Removes the campaign click capping by campaign id.

URL: /rest-api/campaign/{campaignId}/clickCapping.do
Method: DELETE
Response format: application/json

Error codes:

400 Bad Request - wrong request format. No campaign or campaign pricing is not enabled for the given campaign.
401 Unauthorized - authentication error
403 Forbidden - not enough permissions

Response sample:
200 OK

Parameters:

Remove Frequency Capping

Removes the campaign frequency capping by campaign id.

URL: /rest-api/campaign/{campaignId}/frequencyCapping.do
Method: DELETE
Response format: application/json

Error codes:

400 Bad Request - wrong request format. No campaign or campaign pricing is not enabled for the given campaign.
401 Unauthorized - authentication error
403 Forbidden - not enough permissions

Response sample:
200 OK

Parameters:

Set Action Capping

Sets (and enables if was disabled) the campaign action capping values by campaign id.

URL: /rest-api/campaign/{campaignId}/actionCapping/set.do
Method: POST
Response format: application/json

Error codes:

400 Bad Request - wrong request format. No campaign or campaign pricing is not enabled for the given campaign.
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 used in hash generation
username - the given username
campaignId - the given campaign id
amount - amount of capping
period - period for capping
periodType - period type, available values: HOUR, DAY, WEEK, MONTH, YEAR
evenDistribution - - value for even distribution (true/false)

Set Click Capping

Sets (and enables if was disabled) the campaign click capping values by campaign id.

URL: /rest-api/campaign/{campaignId}/clickCapping/set.do
Method: POST
Response format: application/json

Error codes:

Response sample:
200 OK

Parameters:

Sets (and enables if was disabled) the campaign click capping values by campaign id

URL: /rest-api/campaign/{campaignId}/clickCapping/update.do.
Method: POST.
Response format: application/json.
Error codes:

400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists.
401 Unauthorized - authentication error.
403 Forbidden - not enough permissions.
404 Not Found - no click capping enabled or campaign not found.

Response sample:
200 OK.
Parameters:

hash - a MD5 digest of concatenated username's md5 password and the given timestamp;
timestamp - UNIX timestamp used in hash generation;
username - the given username;
id - id of capping record to update;
campaignId - the given campaign id;
amount - amount of capping;
period - period for capping;
periodType - period type, available values: HOUR, DAY, WEEK, MONTH, YEAR;
evenDistribution - value for even distribution (true/false).

Set Frequency Capping

Sets (and enables if was disabled) the campaign frequency capping values by campaign id.

URL: /rest-api/campaign/{campaignId}/frequencyCapping/set.do
Method: POST
Response format: application/json

Error codes:

Response sample:
200 OK

Parameters:

Update Action Capping

Sets (and enables if was disabled) the campaign action capping values by campaign id.

URL: /rest-api/campaign/{campaignId}/actionCapping/update.do
Method: POST
Response format: application/json

Error codes:

Response sample:
200 OK

Parameters:

Update Click Capping

Sets (and enables if was disabled) the campaign click capping values by campaign id.

URL: //rest-api/campaign/{campaignId}/clickCapping/update.do
Method: POST
Response format: application/json

Error codes:

Response sample:
200 OK

Parameters:

Update Frequency Capping

Sets (and enables if was disabled) the campaign frequency capping values by campaign id.

URL: /rest-api/campaign/{campaignId}/frequencyCapping/update.do
Method: POST
Response format: application/json

Error codes:

Response sample:
200 OK

Parameters:

Campaign Limits API

Disable Limits

Disables campaign limits.

URL: /rest-api/campaign/{campaignId}/limits.do
Method: DELETE
Response format: application/json

Error codes:

400 Bad Request - wrong request format. No campaign or campaign pricing is not enabled for the given campaign.
401 Unauthorized - authentication error
403 Forbidden - not enough permissions

Response sample:
200 OK

Parameters:

Get Limits

Get the campaign limits information by campaign id.

URL: /rest-api/campaign/{campaignId}/limits.do
Method: GET
Response format: application/json

Error codes:

401 Unauthorized - authentication error
403 Forbidden - not enough permissions
404 Not Found - no limits set for such campaign.

Response sample:
200 OK

Parameters:

Reset Limits

Resets the campaign limits counter values by campaign id and counter type.

URL: /rest-api/campaign/{campaignId}/limits/reset.do
Method: DELETE
Response format: application/json

Error codes:

Response sample:
200 OK

Parameters:

hash - an MD5 digest of a concatenated username's md5 password and a given timestamp
timestamp - UNIX timestamp used in hash generation
username - the given username
campaignId - the given campaign id
limitCounters - list of counters to reset, available values: TOTAL_IMPRESSIONS, TOTAL_CLICKS, TOTAL_REVENUE, DAILY_IMPRESSIONS, DAILY_CLICKS, DAILY_REVENUE

Set Limits

Set the campaign limits information by campaign id.

URL: /rest-api/campaign/{campaignId}/limits/set.do
Method: POST
Response format: application/json

Error codes:

400 Bad Request - wrong request format. No campaign or campaign pricing is not enabled for the given campaign.
401 Unauthorized - authentication error
403 Forbidden - not enough permissions

Request Parameters:

Long totalImpressionsLimit; Long totalClicksLimit; Double totalBudgetLimit; Long dailyImpressionsLimit; Long dailyClicksLimit; Double dailyBudgetLimit; Long totalImpressions; Long totalClicks; Double totalBudget; Long dailyImpressions; Long dailyClicks; Double dailyBudget;
startDate - limit start, "yyyy-MM-dd-HH-mm"
endDate - limit end, "yyyy-MM-dd-HH-mm"
totalImpressionsLimit - limit for impressions
totalClicksLimit - limit for clicks
totalBudgetLimit - limit for budget
dailyImpressionsLimit - daily limit for impressions
dailyClicksLimit - daily limit for clicks
dailyBudgetLimit - daily limit for budget
totalImpressions - current value for impressions
totalClicks - current value for clicks
totalBudget - current value for budget
dailyImpressions - value for impressions for current day
dailyClicks - value for clicks for current day
dailyBudget - value for budget for current day

Response sample:
200 OK

Parameters:

Update Limits

Updates the campaign limits information by campaign id.

URL: /rest-api/campaign/{campaignId}/limits/update.do
Method: POST
Response format: application/json

Error codes:

Request Parameters:

Long totalImpressionsLimit; Long totalClicksLimit; Double totalBudgetLimit; Long dailyImpressionsLimit; Long dailyClicksLimit; Double dailyBudgetLimit; Long totalImpressions; Long totalClicks; Double totalBudget; Long dailyImpressions; Long dailyClicks; Double dailyBudget;
startDate - limit start, milliseconds
endDate - limit end, milliseconds
totalImpressionsLimit - limit for impressions
totalClicksLimit - limit for clicks
totalBudgetLimit - limit for budget
dailyImpressionsLimit - daily limit for impressions
dailyClicksLimit - daily limit for clicks
dailyBudgetLimit - daily limit for budget
totalImpressions - current value for impressions
totalClicks - current value for clicks
totalBudget - current value for budget
dailyImpressions - value for impressions for current day
dailyClicks - value for clicks for current day
dailyBudget - value for budget for current day

Response sample:
200 OK

Parameters:

Campaign Targeting API

Get Targeting

Get the campaign targeting by id and by campaign id.

URL: /rest-api/campaign/{campaignId}/targeting/{targetId}.do
Method: GET
Response format: application/json

Error codes:
401 Unauthorized - authentication error
403 Forbidden - not enough permissions
404 Not Found - no targeting with given id found for given campaign
Response sample:
200 OK

Get Targetings

Get the campaign targetings by campaign id.

URL: /rest-api/campaign/{campaignId}/targetings.do
Method: GET
Response format: application/json

Error codes:
401 Unauthorized - authentication error
403 Forbidden - not enough permissions
Response sample:
200 OK

Get Targeting Types

Get the campaign targeting types by campaign id.

URL: /rest-api/campaign/{campaignId}/targeting/types.do
Method: GET
Response format: application/json

Error codes:
401 Unauthorized - authentication error
403 Forbidden - not enough permissions
404 Not Found - no targeting with given id found for given campaign
Response sample:
200 OK

Remove Targeting

Removes targeting by targeting id and campaign id.

URL: /rest-api/campaign/{campaignId}/targeting/{targetId}/delete.do
Method: DELETE
Response format: application/json

Error codes:
400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists
401 Unauthorized - authentication error
403 Forbidden - not enough permissions
404 Not Found - no targeting with given id found for given campaign
Response sample:
200 OK

Get available operating systems values for operating system targeting type

URL: /rest-api/targeting/os/values.do.

Method: GET.

Response format: application/json.

Error codes:

401 Unauthorized - authentication error.
403 Forbidden - not enough permissions.
404 Not Found - no banner found.

Response sample:
200 OK.

Parameters:

hash — an MD5 digest of a concatenated username's md5 password and a given timestamp;
timestamp — UNIX timestamp used for hash generation;
username — a given username.

Get available values of version of operating systems for operating system targeting type

URL: /rest-api/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 - no banner found.

Response sample:
200 OK.

Parameters:

hash — an MD5 digest of a concatenated username's md5 password and a given timestamp;
timestamp — UNIX timestamp used for hash generation;
username — a given username;
osName - the name of Operation System from list of available OS values.

Create Browser Target

Sets (and enables if was disabled) the browser targeting by campaign id.

URL: /rest-api/campaign/{campaignId}/targeting/browser/create.do
Method: POST
Response format: application/json

Parameters:
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp
timestamp - UNIX timestamp used in hash generation
username - the given username
campaignId - the given campaign id
rule - EXCLUDE or INCLUDE
browser -
relation - - values are LOWER,GREATER,LOWER_EQUAL,GREATER_EQUAL,EQUAL
browserVersion -

Create Channel Target

Sets the campaign channel targeting by campaign id.

URL: /rest-api/campaign/{campaignId}/targeting/channel/create.do
Method: POST
Response format: application/json

Create Coookie Value Target

Sets (and enables if was disabled) the campaign cookie value targeting by campaign id.

URL: /rest-api/campaign/{campaignId}/targeting/cookie/create.do
Method: POST
Response format: application/json

Create Country Target

Sets (and enables if was disabled) the campaign country targeting by campaign id.

URL: /rest-api/campaign/{campaignId}/targeting/country/create.do
Method: POST
Response format: application/json

Create Custom Parameter Target

Sets custom parameter targeting by campaign id.

URL: /rest-api/campaign/{campaignId}/targeting/custom/create.do
Method: POST
Response format: application/json

Parameters:
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp
timestamp - UNIX timestamp used in hash generation
username - the given username
campaignId - the given campaign id
rule - EXCLUDE or INCLUDE
expression - - valid expression (Sample: ($p1==1 || $p1=='a') && ($p2>=12 && $p2<=22) )

Create Day Of Week Target

Sets day of week targeting by campaign id.

URL: /rest-api/campaign/{campaignId}/targeting/dayofweek/create.do
Method: POST
Response format: application/json

Parameters:
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp
timestamp - UNIX timestamp used in hash generation
username - the given username
campaignId - the given campaign id
rule - EXCLUDE or INCLUDE
dayOfWeek - available values are MONDAY,TUESDAY,WEDNESDAY,THURSDAY,FRIDAY,SATURDAY,SUNDAY

Create Device Format Target

Sets (and enables if was disabled) the campaign device targeting by campaign id.

URL: /rest-api/campaign/{campaignId}/targeting/deviceformat/create.do
Method: POST
Response format: application/json

Create Device Target

Sets (and enables if was disabled) the campaign device targeting by campaign id.

URL: /rest-api/campaign/{campaignId}/targeting/device/create.do
Method: POST
Response format: application/json

Create Device Vendor Target

Sets (and enables if was disabled) the campaign device vendor targeting by campaign id.

URL: /rest-api/campaign/{campaignId}/targeting/devicevendor/create.do
Method: POST
Response format: application/json

Create Domain Target

Sets (and enables if was disabled) the campaign referrer domain targeting by campaign id.

URL: /rest-api/campaign/{campaignId}/targeting/domain/create.do
Method: POST
Response format: application/json

Create Ip Range Target

Sets ip range targeting by campaign id.
Params - Valid IP range (Sample: from 194.222.012.001 to 194.223.07.01)

URL: /rest-api/campaign/{campaignId}/targeting/iprange/create.do
Method: POST
Response format: application/json

Parameters:
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp
timestamp - UNIX timestamp used in hash generation
username - the given username
campaignId - the given campaign id
ipFrom - valid ip from for range
ipTo - valid ip to for range
rule - EXCLUDE or INCLUDE

Create Language Target

Sets (and enables if was disabled) the campaign language targeting by campaign id.

URL: /rest-api/campaign/{campaignId}/targeting/language/create.do
Method: POST
Response format: application/json

Create Location Target

Sets location targeting by campaign id.

URL: /rest-api/campaign/{campaignId}/targeting/location/create.do
Method: POST
Response format: application/json

Create Mobile Carrier Target

Sets the campaign mobile carrier targeting by campaign id.

URL: /rest-api/campaign/{campaignId}/targeting/mobilecarrier/create.do
Method: POST
Response format: application/json

Create OS Target

Sets operating system targeting by campaign id.

URL: /rest-api/campaign/{campaignId}/targeting/os/create.do
Method: POST
Response format: application/json

Create Screen Resolution Target

Sets the campaign screen resolution targeting by campaign id.

URL: /rest-api/campaign/{campaignId}/targeting/resolution/create.do
Method: POST
Response format: application/json

Parameters:
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp
timestamp - UNIX timestamp used in hash generation
username - the given username
campaignId - the given campaign id
relation - - available values LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL
screenWidth -
screenHeight -
rule - EXCLUDE or INCLUDE

Create Time Range Target

Sets time range targeting by campaign id.

URL: /rest-api/campaign/{campaignId}/targeting/timerange/create.do
Method: POST
Response format: application/json

Parameters:
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp
timestamp - UNIX timestamp used in hash generation
username - the given username
campaignId - the given campaign id
timeFrom - String in format 24h format hh:MM , where hh - hours, MM - minutes
timeTo - String in format 24h format hh:MM , where hh - hours, MM - minutes
rule - EXCLUDE or INCLUDE

Create Wifi Traffic Target

Sets the campaign wifi traffic targeting by campaign id.

URL: /rest-api/campaign/{campaignId}/targeting/wifi/create.do
Method: POST
Response format: application/json

Disable Targeting

Disables targeting for given campaign.

URL: /rest-api/campaign/{campaignId}/targeting/disable.do
Method: POST
Response format: application/json

Enable Targeting

Enables targeting for given campaign.

URL: /rest-api/campaign/{campaignId}/targeting/enable.do
Method: POST
Response format: application/json

Campaign Adjusted CPM API

Add Fixed Cpm Country Pricing

Create or update Adjusted CPM value.

URL: /rest-api/campaign/{campaignId}/adjustedCpm/value.do
Method: PUT
Response format: application/json

Error codes:
400 Bad Request - no campaign with such id exists
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 used in hash generation
username - the given username
campaignId - the given campaign id
value - the value of adjustment
countryCode - the 2 symbol country code corresponding to ISO 3166
date - the date of adjustment application

Adjusted Cpm Country Trigger

Enabe or disable Adjusted CPM value.

URL: /rest-api/campaign/{campaignId}/adjustedCpm.do
Method: POST
Response format: application/json

Error codes:
400 Bad Request - no campaign with such id exists
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 used in hash generation
username - the given username
campaignId - the given campaign id
enable - true if CPM Adjustment should be enabled and false otherwise

Adjusted Cpm List

List of Adjusted CPM values.

URL: /rest-api/campaign/{campaignId}/adjustedCpm/values.do
Method: GET
Response format: application/json

Error codes:
400 Bad Request - no campaign with such id exists
401 Unauthorized - authentication error
403 Forbidden - not enough permissions
Response sample:
200 OK

Campaign Pricing API

Get Campaign Pricing

Get the campaign pricing information by campaign id.

URL: /rest-api/campaign/{campaignId}/pricing.do
Method: GET
Response format: application/json

Error codes:

401 Unauthorized - authentication error
403 Forbidden - not enough permissions
404 Not Found - no campaign pricing for such campaign

Response sample:
200 OK

Parameters:

Update Campaign Country Pricing

Update the country campaign pricing information by campaign id.

URL: /rest-api/campaign/{campaignId}/pricing/{countryCode}.do
Method: POST
Response format: application/json

Error codes:

400 Bad Request - wrong request format. E.g. wrong types for parameters, no campaign or country with such code exists, or campaign pric
401 Unauthorized - authentication error
403 Forbidden - not enough permissions

Request Parameters:

price - campaign price as a double

Response sample:
200 OK

Parameters:

Update the campaign pricing information by campaign id

URL: /rest-api/campaign/{campaignId}/campaignPricing/actionPricing.do.

Method: POST.

Response format: application/json.

Error codes:

400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists.
401 Unauthorized - authentication error.
403 Forbidden - not enough permissions.

Response sample:
200 OK.

Request parameters:

price - campaign price as a double;
actionName - actionName is a string corresponding to name of existing action in specified campaign;
actionKey - actionKey is a string corresponding to key of existing action in specified campaign.

Parameters:

hash - a MD5 digest of concatenated username's md5 password and the given timestamp;
timestamp - UNIX timestamp used in hash generation;
username - the given username;
campaignId - the given campaign id.

Disable Campaign Pricing

Disables campaign pricing.

URL: /rest-api/campaigns/{campaignId}/pricing.do
Method: DELETE
Response format: application/json

Error codes:

400 Bad Request - no campaign with such id exists
401 Unauthorized - authentication error
403 Forbidden - not enough permissions

Response sample:
200 OK

Parameters:

Update Campaign Country Pricing Batch

Update the country campaign pricing information by campaign id from csv pricing file.

URL: /rest-api/campaign/{campaignId}/pricing/batch.do
Method: POST
Response format: application/json

Error codes:

400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign exists, or campaign pricing disabled for the given cam
Unauthorized - authentication error
403 Forbidden - not enough permissions

Request Parameters:

countryPricing - csv formatted file with country prices

Response sample:
200 OK

Parameters:

Update Campaign Pricing

Update the campaign pricing information by campaign id.

URL: /rest-api/campaign/{campaignId}/pricing.do
Method: POST
Response format: application/json

Error codes:

400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists
401 Unauthorized - authentication error
403 Forbidden - not enough permissions

Request Parameters:

price - campaign price as a double
paymentModel - FIXED_PRICE
pricingType - CPM, CPC or CPA

Response sample:
200 OK

Parameters:

Banner Management

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 no banner with such id exists.
401 Unauthorized - authentication error.
403 Forbidden - not enough permissions.

Response sample:
200 OK.

Request parameters:

placementType - required, values are SITE_PLACEMENT,VIDEO_PLACEMENT, APPLICATION_PLACEMENT or MOBILE_SITE_PLACEMENT
campaignId - required, the given campaign id
active - active status of banner as a boolean
name
allowNewPlacementsAutoLinking - permission for banner to be linked to new placements automatically as boolean
autolinkCategories - ID's of publishing categories for autolinking.
weight - integer value
adUnitId - available values - see /rest-api/banner/adunit/values.do
adUnitHeight - height, required for Custom ad unit. ignored for not a Custom ad unit. (long value)
adUnitWidth - width, required for Custom ad unit. ignored for not a Custom ad unit. (long value)
bannerType - available values are EXTERNAL_FILE, CODE, MOBILE_ADVERTISING_NETWORK, LOCAL_FILE, EXTERNAL_FILE, EXTERNAL_VIDEO, LOCAL_VIDEO, APPLICATION_ADVERTISING_NETWORK, TEMPLATE
flashBannerLink
imageBannerLink
videoFileLink
flashFile
imageFile
videoFile
templateId - id of template being used if banner type is TEMPLATE. Required by template properties are to be passed along.
thirdTrackingCode
code - for CODE banner type
url - for EXTERNAL_FILE banner type
inStreamVideoType - for video banners, values are LINEAR_VIDEO_AD, NON_LINEAR_VIDEO_AD
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
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.

Response sample:

200 OK

Parameters:

hash — an MD5 digest of a concatenated username’s md5 password and a given timestamp;
timestamp — UNIX timestamp used for hash generation;
username — a given username.

Copy|Move the banner

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 no banner|campaign with such id exists.
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 used for hash generation;
username — a given username;
bannerId – the given banner id;
campaignId – id of campaign where to move/copy banner to;
operation – operation to perform (literal, either COPY or MOVE);
copyCount – numbers of copies, not required, defaults to 1;
keepBannersLinked – boolean, whether or not preserve banners linkage, defaults to false.

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 for 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 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 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 used in hash generation
username – the given username
advertisingCategories – IDs of advertising categories to filter down result to (optional)
bannerIds – IDs of banners to filter down result to (optional)

Update Banner

Update the banner active state, autolinking facility and autolinking 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 no banner with such id exists
401 Unauthorized – authentication error
403 Forbidden – not enough permissions

Request Parameters:

active – active status of banner as a boolean
allowNewPlacementsAutoLinking – permission for banner to be linked to new placements automatically as boolean
autolinkCategories – ID’s of publishing categories for autolinking.

Response sample:
200 OK

Parameters:

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 no banner with such id exists
401 Unauthorized – authentication error
403 Forbidden – not enough permissions
Response sample:
200 OK

Get Ad Unit Values By Banner Type

Get the available banner adunit values.

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 for 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 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 banner adunit values.

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 for such id found
Response sample:
200 OK

Get Mobile Networks

Get the available mobile advertising networks.

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 for 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 used in hash generation
username – the given username

Get Placements For Banner

Get the banner by 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 for such id found
Response sample:
200 OK
{id: 1, name: “bannerName1″}

Update Banners Urls Batch

Update landing urls for specified 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 no banner exists.
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 used in hash generation
username – the given username

Banner Capping API

Get Action Capping

Get the banner action capping information by banner id.

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

Error codes:
401 Unauthorized – authentication error
403 Forbidden – not enough permissions
404 Not Found – no action capping set for such banner
Response sample:
200 OK

Get Click Capping

Get the banner click capping information by banner id.

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

Error codes:
401 Unauthorized – authentication error
403 Forbidden – not enough permissions
404 Not Found – no click capping set for such banner
Response sample:
200 OK
{id: 1, paymentModel: “CPM”, price: 0.03, countries: [{country: "US", price: 0.02}, {country: "UK", price: 0.025}, ... }

Get Frequency Capping

Get the banner frequency capping information by banner id.

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

Error codes:
401 Unauthorized - authentication error
403 Forbidden - not enough permissions
404 Not Found - no frequency capping set for such banner
Response sample:
200 OK
{id: 1, paymentModel: "CPM", price: 0.03, countries: [{country: "US", price: 0.02}, {country: "UK", price: 0.025}, ... }

Remove Action Capping

Removes the banner action capping by banner id.

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

Remove Click Capping

Removes the banner click capping by banner id.

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

Remove Frequency Capping

Removes the banner frequency capping by banner id.

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

Set Action Capping

Sets (and enables if was disabled) the banner action capping values by banner id.

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

Parameters:
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp
timestamp - UNIX timestamp used in hash generation
username - the given username
bannerId - the given banner id
amount - amount of capping
period - period for capping
periodType - period type, available values: HOUR, DAY, WEEK, MONTH, YEAR
evenDistribution - - value for even distribution (true/false)

Set Click Capping

Sets (and enables if was disabled) the banner click capping values by banner id.

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

Parameters:
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp
timestamp - UNIX timestamp used in hash generation
username - the given username
bannerId - the given banner id
amount - amount of capping
period - period for capping
periodType - period type, available values: HOUR, DAY, WEEK, MONTH, YEAR
evenDistribution - - value for even distribution (true/false)

Set Frequency Capping

Sets (and enables if was disabled) the banner frequency capping values by banner id.

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

Parameters:
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp
timestamp - UNIX timestamp used in hash generation
username - the given username
bannerId - the given banner id
amount - amount of capping
period - period for capping
periodType - period type, available values: HOUR, DAY, WEEK, MONTH, YEAR
evenDistribution - - value for even distribution (true/false)

Update Action Capping

Sets (and enables if was disabled) the banner action capping values by banner id.

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

Parameters:
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp
timestamp - UNIX timestamp used in hash generation
username - the given username
bannerId - the given banner id
amount - amount of capping
period - period for capping
periodType - period type, available values: HOUR, DAY, WEEK, MONTH, YEAR
evenDistribution - - value for even distribution (true/false)

Update Click Capping

Sets (and enables if was disabled) the banner click capping values by banner id.

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

Parameters:
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp
timestamp - UNIX timestamp used in hash generation
username - the given username
bannerId - the given banner id
amount - amount of capping
period - period for capping
periodType - period type, available values: HOUR, DAY, WEEK, MONTH, YEAR
evenDistribution - - value for even distribution (true/false)

Update Frequency Capping

Sets (and enables if was disabled) the banner frequency capping values by banner id.

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

Parameters:
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp
timestamp - UNIX timestamp used in hash generation
username - the given username
bannerId - the given banner id
amount - amount of capping
period - period for capping
periodType - period type, available values: HOUR, DAY, WEEK, MONTH, YEAR
evenDistribution - - value for even distribution (true/false)

Banner Limits API

Disable Limits

Disables banner limits.

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

Error codes:
400 Bad Request - no banner with such id exists
401 Unauthorized - authentication error
403 Forbidden - not enough permissions
Response sample:
200 OK

Get Limits

Get the banner limits information by banner id.

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

Error codes:
401 Unauthorized - authentication error
403 Forbidden - not enough permissions
404 Not Found - no limits set for such banner
Response sample:
200 OK

Reset Limits

Resets the banner limits counter values by banner id and counter type.

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

Parameters:
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp
timestamp - UNIX timestamp used in hash generation
username - the given username
bannerId - the given banner id
limitCounters - list of counters to reset, available values: TOTAL_IMPRESSIONS, TOTAL_CLICKS, TOTAL_REVENUE, DAILY_IMPRESSIONS, DAILY_CLICKS, DAILY_REVENUE

Set Limits

Set the banner limits information by banner id.

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

Error codes:
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists
401 Unauthorized - authentication error
403 Forbidden - not enough permissions
Request Parameters:
Long totalImpressionsLimit; Long totalClicksLimit; Double totalBudgetLimit; Long dailyImpressionsLimit; Long dailyClicksLimit; Double dailyBudgetLimit; Long totalImpressions; Long totalClicks; Double totalBudget; Long dailyImpressions; Long dailyClicks; Double dailyBudget;
startDate - limit start, "yyyy-MM-dd-HH-mm"
endDate - limit end, "yyyy-MM-dd-HH-mm"
totalImpressionsLimit - limit for impressions
totalClicksLimit - limit for clicks
totalBudgetLimit - limit for budget
dailyImpressionsLimit - daily limit for impressions
dailyClicksLimit - daily limit for clicks
dailyBudgetLimit - daily limit for budget
totalImpressions - current value for impressions
totalClicks - current value for clicks
totalBudget - current value for budget
dailyImpressions - value for impressions for current day
dailyClicks - value for clicks for current day
dailyBudget - value for budget for current day
Response sample:
200 OK

Update Limits

Updates the banner limits information by banner id.

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

Error codes:
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists
401 Unauthorized - authentication error
403 Forbidden - not enough permissions
404 Not Found - no limits enabled or banner not found
Request Parameters:
Long totalImpressionsLimit; Long totalClicksLimit; Double totalBudgetLimit; Long dailyImpressionsLimit; Long dailyClicksLimit; Double dailyBudgetLimit; Long totalImpressions; Long totalClicks; Double totalBudget; Long dailyImpressions; Long dailyClicks; Double dailyBudget;
startDate - limit start, milliseconds
endDate - limit end, milliseconds
totalImpressionsLimit - limit for impressions
totalClicksLimit - limit for clicks
totalBudgetLimit - limit for budget
dailyImpressionsLimit - daily limit for impressions
dailyClicksLimit - daily limit for clicks
dailyBudgetLimit - daily limit for budget
totalImpressions - current value for impressions
totalClicks - current value for clicks
totalBudget - current value for budget
dailyImpressions - value for impressions for current day
dailyClicks - value for clicks for current day
dailyBudget - value for budget for current day
Response sample:
200 OK

Banner Targeting API

Create Browser Target

Sets (and enables if was disabled) the browser targeting by banner id.

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

Create Channel Target

Sets the banner channel targeting by banner id.

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

Create Coookie Value Target

Sets (and enables if was disabled) the banner cookie value targeting by banner id.

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

Create Country Target

Sets (and enables if was disabled) the banner country targeting by banner id.

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

Create Custom Parameter Target

Sets custom parameter targeting by banner id.

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

Parameters:
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp
timestamp - UNIX timestamp used in hash generation
username - the given username
bannerId - the given banner id
rule - EXCLUDE or INCLUDE
expression - - valid expression (Sample: ($p1==1 || $p1=='a') && ($p2>=12 && $p2<=22) )

Create Day Of Week Target

Sets day of week targeting by banner id.

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

Parameters:
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp
timestamp - UNIX timestamp used in hash generation
username - the given username
bannerId - the given banner id
rule - EXCLUDE or INCLUDE
dayOfWeek - - available values are MONDAY,TUESDAY,WEDNESDAY,THURSDAY,FRIDAY,SATURDAY,SUNDAY

Create Device Format Target

Sets (and enables if was disabled) the banner device targeting by banner id.

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

Create Device Target

Sets (and enables if was disabled) the banner mobile carrier targeting by banner id.

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

Create Device Vendor Target

Sets (and enables if was disabled) the banner device vendor targeting by banner id.

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

Create Domain Target

Sets (and enables if was disabled) the banner referrer domain targeting by banner id.

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

Create Ip Range Target

Sets ip range targeting by banner id.
Params - Valid IP range (Sample: from 194.222.012.001 to 194.223.07.01)

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

Parameters:
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp
timestamp - UNIX timestamp used in hash generation
username - the given username
bannerId - the given banner id
ipFrom - valid ip from for range
ipTo - valid ip to for range
rule - EXCLUDE or INCLUDE

Create Language Target

Sets (and enables if was disabled) the banner language targeting by banner id.

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

Create Location Target

Sets location targeting by banner id.

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

Create Mobile Carrier Target

Sets the banner mobile carrier targeting by banner id.

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

Parameters:
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp
timestamp - UNIX timestamp used in hash generation
username - the given username
bannerId - the given banner id
rule - EXCLUDE or INCLUDE
mobileCarriers - - array of mobile carrier names

Create OS Target

Sets operating system targeting by banner id.

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

Create Screen Resolution Target

Sets the banner screen resolution targeting by banner id.

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

Parameters:
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp
timestamp - UNIX timestamp used in hash generation
username - the given username
bannerId - the given banner id
relation - - available values LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL
screenWidth -
screenHeight -
rule - EXCLUDE or INCLUDE

Create Time Range Target

Sets time range targeting by banner id.

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

Parameters:
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp
timestamp - UNIX timestamp used in hash generation
username - the given username
bannerId - the given banner id
timeFrom - String in format 24h format hh:MM , where hh - hours, MM - minutes
timeTo - String in format 24h format hh:MM , where hh - hours, MM - minutes
rule - EXCLUDE or INCLUDE

Create Wifi Traffic Target

Sets the banner wifi traffic targeting by banner id.

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

Get Targeting

Get the banner targeting by id and by banner id.

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

Error codes:
401 Unauthorized - authentication error
403 Forbidden - not enough permissions
404 Not Found - no targeting with given id found for given banner
Response sample:
200 OK

Get Targetings

Get the banner targetings by banner id.

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

Error codes:
401 Unauthorized - authentication error
403 Forbidden - not enough permissions
Response sample:
200 OK

Get Targeting Types

Get the banner targeting types by banner id.

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

Error codes:
401 Unauthorized - authentication error
403 Forbidden - not enough permissions
404 Not Found - no targeting with given id found for given banner
Response sample:
200 OK

Remove Targeting

Removes targeting by targeting id and banner id.

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

Disable Targeting

Disables targeting for given banner.

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

Enable Targeting

Enables targeting for given banner.

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

Banner Placement Linking API

Create or Update Banner Placements

Overwrites banner to placement links.

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

Error codes:

401 Unauthorized - authentication error
Response sample:
200 OK
{"success":true, id:} - success, returns id of affected zone record
{"success":false} - error {"success":false, "error":"permission_denied"} - error due to insufficient privileges

Delete Banner Placements

Removes banner to placement links.

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

Error codes:

Get Banner Placements List

Get the list of all linked placements for given banner. Returns only banners of types SITE_PLACEMENT, MOBILE_SITE_PLACEMENT and NON_STANDARD_SITE_PLACEMENT

URL: /rest-api/banners/{bannerId}/placements.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 used in hash generation
username – the given username

Banner Pricing API

Get Banner Pricing

Get the banner pricing information by banner id.

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

Error codes:
401 Unauthorized – authentication error
403 Forbidden – not enough permissions
404 Not Found – no banner pricing for such banner
Response sample:
200 OK
{id: 1, paymentModel: “CPM”, price: 0.03, countries: [{country: "US", price: 0.02}, {country: "UK", price: 0.025}, ... }

Disable Banner Country Pricing

Remove country banner pricing by banner id.

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

Error codes:

400 Bad Request - wrong request format. No banner or banner pricing is not enabled for the given banner
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 used in hash generation
username - the given username
bannerId - the given banner id
countryCode - 2 symbol country code corresponding to ISO 3166

Disable Banner Pricing

Disables banner pricing.

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

Error codes:

400 Bad Request - no banner with such id exists
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 used in hash generation
username - the given username
bannerId - the given banner id

Get Banner Pricing

Get the banner pricing information by banner id.

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

Error codes:

401 Unauthorized - authentication error
403 Forbidden - not enough permissions
404 Not Found - no banner pricing for such banner

Response sample:
200 OK

Parameters:

hash - an MD5 digest of a concatenated username's md5 password and a given timestamp
timestamp - UNIX timestamp used in hash generation
username - the given username
bannerId - the given banner id

Update Banner Pricing

Update the banner pricing information by banner id.

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

Error codes:

400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists
401 Unauthorized - authentication error
403 Forbidden - not enough permissions

Request Parameters:

price - banner price as a double
paymentModel - payment model as a string. Should be one of following: CPM, CPC, CPA

Response sample:
200 OK

Parameters:

hash - an MD5 digest of a concatenated username's md5 password and a given timestamp
timestamp - UNIX timestamp used in hash generation
username - the given username
bannerId - the given banner id

Update Banner Country Pricing

Update the country banner pricing information by banner id.

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

Error codes:

400 Bad Request - wrong request format. E.g. wrong types for parameters, no banner or country with such code exists, or banner pricing dis
401 Unauthorized - authentication error
403 Forbidden - not enough permissions

Request Parameters:

price - banner price as a double

Response sample:
200 OK

Parameters:

Update Banner Country Pricing Batch

Update the country banner pricing information by banner id from csv file.

URL: /rest-api/banner/{bannerId}/pricing/batch
Method: POST
Response format: application/json

Error codes:

400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner exists, or banner pricing disabled for the given banne
401 Unauthorized - authentication error
403 Forbidden - not enough permissions

Request Parameters:

countryPrices - csv formatted file with prices by countries

Response sample:
200 OK

Parameters:

hash - an MD5 digest of a concatenated username's md5 password and a given timestamp
timestamp - UNIX timestamp used in hash generation
username - the given username
bannerId - the given banner id
countryPrices - csv formatted file with prices by countries

Disable Banner Frequency Capping

Disables banner frequency capping.

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

Error codes:

400 Bad Request - no banner with such id exists
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 used in hash generation
username - the given username
bannerId - the given banner id

Get Advertising Categories

Get the list of all configured advertising categories.

URL: /rest-api/categories/advertising.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 used in hash generation
username - the given username

Get Publishing Categories

Get the list of all configured publishing categories.

URL: /rest-api/categories/publishing.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 used in hash generation
username - the given username

Update Banner Frequency Capping

Update the banner frequency capping information by banner id.

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

Error codes:

400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists
401 Unauthorized - authentication error
403 Forbidden - not enough permissions

Request Parameters:

amount - number of events as a double
periodType - period type as a string. Should be one of following: HOUR,DAY,WEEK,MONTH,YEAR
flat - enforce uniform distribution of events within time frame (boolean).
period - number of periods as long.

Response sample:
200 OK

Parameters:

hash - an MD5 digest of a concatenated username's md5 password and a given timestamp
timestamp - UNIX timestamp used in hash generation
username - the given username
bannerId - the given banner id

Get linked banners for placement

URL: /rest-api/banner/placement/{placementId}/banners.do

Method: GET.

Response format: application/json.

Error codes:

401 Unauthorized - authentication error.
403 Forbidden - not enough permissions.
404 Not Found - no placement for such id found.

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

Parameters:

hash - a MD5 digest of concatenated username's md5 password and the given timestamp;
timestamp - UNIX timestamp used in hash generation;
username - the given username;
placementId - the given placement id.

Get the available 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 for 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 used for hash generation;
username — a given username.

Get the list of all advertisers of given user account with campaigns and banners

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 used for hash generation;
username — a given username;
advertisingCategories - IDs of advertising categories to filter down result to (optional).

Get the list of all mobile advertising networks

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 used for hash generation;
username — a given username.

Get the AdUnit list

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 used for hash generation;
username — a given username.

Action Management API

Get all actions shared to user

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

401 Unauthorized - authentication error.
403 Forbidden - not enough permissions.

Parameters:

hash — an MD5 digest of a concatenated username's md5 password and a given timestamp;
timestamp — UNIX timestamp used for hash generation;
username — a given username.

Get the action by action key

URL: /rest-api/action/{actionKey}.do.

Method: GET.

Response format: application/json.

Error codes:

401 Unauthorized - authentication error.
403 Forbidden - not enough permissions.
404 Not Found - no action with given actionKey found for given campaign.

Parameters:

hash — an MD5 digest of a concatenated username's md5 password and a given timestamp;
timestamp — UNIX timestamp used for hash generation;
username — a given username.

Updates action

URL: /rest-api/action/{actionKey}/update.do.

Method: POST.

Response format: application/json.

Error codes:

400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists.
401 Unauthorized - authentication error.
403 Forbidden - not enough permissions.

Parameters:

hash — an MD5 digest of a concatenated username's md5 password and a given timestamp;
timestamp — UNIX timestamp used for hash generation;
username — a given username;
key - action key;
name - action name;
clickToConversionTimeFrame - period for click to conversion;
clickToConversionTimeFramePeriodType — period type, available values: HOUR, DAY, WEEK, MONTH, YEAR;
viewToConversionTimeFrame — period for view to conversion;

Creates new action

URL: /rest-api//action/create.do.
Method: POST.
Response format: application/json.
Error codes:

400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists.
401 Unauthorized - authentication error.
403 Forbidden - not enough permissions.

Parameters:

hash — an MD5 digest of a concatenated username's md5 password and a given timestamp;
timestamp — UNIX timestamp used for hash generation;
username — a given username;
name — action name;
clickToConversionTimeFrame - period for click to conversion;
clickToConversionTimeFramePeriodType — period type, available values: HOUR, DAY, WEEK, MONTH, YEAR;
viewToConversionTimeFrame — period for view to conversion;
viewToConversionTimeFramePeriodType — period type, available values: HOUR, DAY, WEEK, MONTH, YEAR.

Removes action by action key

URL: /rest-api//action/{actionKey}/delete.do.
Method: DELETE.
Response format: application/json.
Error codes:

400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists.
401 Unauthorized - authentication error.
403 Forbidden - not enough permissions.
404 Not Found - no action with given actionKey found for given campaign.

Response sample:
200 OK.
Parameters:

hash — an MD5 digest of a concatenated username's md5 password and a given timestamp;
timestamp — UNIX timestamp used for hash generation;
username — a given username.

Templates Management API

Get the list of all template properties required|supported by given template

URL: /rest-api/template/{templateId}/properties.do.

Method: GET.

Response format: application/json.

Error codes:

401 Unauthorized - authentication error.
403 Forbidden - not enough permissions.
404 Not Found - no template for such id found.

Response sample:
200 OK.
[{"allowedContentTypes":"image/png","required":true,"key":"$$BANNER_SMALL$$"}, {"allowedContentTypes":"image/png","required":true,"key":"$$IMG_1$$"}, {"maxLength":255,"required":true,"url":false,"key":"$$LANDING_URL$$"}]

Parameters:

hash — an MD5 digest of a concatenated username's md5 password and a given timestamp;
timestamp — UNIX timestamp used for hash generation;
username — a given username;
templateId the given template id.

Get the list of all templates available to a user

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

401 Unauthorized - authentication error.

Response sample:
200 OK.
[{"id":1,"title":"Foo","propertiesCount":10,"placementType":"NON_STANDARD_SITE_PLACEMENT"}, {"id":2,"title":"Bar","propertiesCount":2,"placementType":"SITE_PLACEMENT"}]

Parameters:

hash — an MD5 digest of a concatenated username's md5 password and a given timestamp;
timestamp — UNIX timestamp used for hash generation;
username — a given username.

Get Browsers

Get available major 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 - no targeting with given id found for given banner
Response sample:
200 OK

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 - no banner found
Response sample:
200 OK

Get Country Regions

Get available regions for 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 - no banner found
Response sample:
200 OK

Get Device Format Values

Get available device formats 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 - no banner found
Response sample:
200 OK

Get Device Values

Get available devices 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 - no banner found
Response sample:
200 OK

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 - no banner found
Response sample:
200 OK

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 - no banner found
Response sample:
200 OK

Get IE Browsers

Get available Safari 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 - no banner found
Response sample:
200 OK

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 - no banner found
Response sample:
200 OK

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 - no targeting with given id found for given banner
Response sample:
200 OK

Get OS Values

Get available operating systems values for operating system 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 - no banner found
Response sample:
200 OK

Get OS Versions by OS Name

Gets available versions of an OS for operating system 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 - no campaign found
Response sample:
200 OK

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 - no banner found
Response sample:
200 OK

Parameters:
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp
timestamp - UNIX timestamp used in hash generation
username - the given username
bannerId - the given banner id
countryCode - the given country code
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 - no banner found
Response sample:
200 OK

Get Screen Resolution Values

Get available screen resolutions 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 - no banner found
Response sample:
200 OK

Advertiser API

Table of Contents

Advertiser Management

Delete Advertiser

Get Advertiser Permissions For User

Get Campaigns For Advertiser

Update Advertiser

Campaign Management

Create Campaign

Copy|Move the campaign

Delete Campaign

Get Banners For Campaign

Get Campaign

Get Campaigns

Update Campaign

Campaign Capping API

Get Action Capping

Get Click Capping

Get Frequency Capping

Remove Action Capping

Remove Click Capping

Remove Frequency Capping

Set Action Capping

Set Click Capping

Sets (and enables if was disabled) the campaign click capping values by campaign id

Set Frequency Capping

Update Action Capping

Update Click Capping

Update Frequency Capping

Campaign Limits API

Disable Limits

Get Limits

Reset Limits

Set Limits

Update Limits

Campaign Targeting API

Get Targeting

Get Targetings

Get Targeting Types

Remove Targeting

Get available operating systems values for operating system targeting type

Get available values of version of operating systems for operating system targeting type

Create Browser Target

Create Channel Target

Create Coookie Value Target

Create Country Target

Create Custom Parameter Target

Create Day Of Week Target

Create Device Format Target

Create Device Target

Create Device Vendor Target

Create Domain Target

Create Ip Range Target

Create Language Target

Create Location Target

Create Mobile Carrier Target

Create OS Target

Create Screen Resolution Target

Create Time Range Target

Create Wifi Traffic Target

Disable Targeting

Enable Targeting

Campaign Adjusted CPM API

Add Fixed Cpm Country Pricing

Adjusted Cpm Country Trigger

Adjusted Cpm List

Campaign Pricing API

Get Campaign Pricing

Update Campaign Country Pricing

Update the campaign pricing information by campaign id

Disable Campaign Pricing

Update Campaign Country Pricing Batch

Update Campaign Pricing

Banner Management

Creates banner for given campaign id

Copy|Move the banner

Get Banner

Get Banners

Get Banners URLs

Update Banner