Enable Targeting

Enables Targeting for the given Placement.

URL: /rest-api/placement/{placementId}/targeting/enable.do

Method: POST

Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types of parameters or Placement with such ID doesn't exist.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Targeting with given ID not found for the given Placement.

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.
  • placementId – the given Placement ID.

Disable Targeting

Disables Targeting for the given Placement.

URL: /rest-api/placement/{placementId}/targeting/disable.do

Method: POST

Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types of parameters or Placement with such ID doesn't exist.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Targeting with given ID not found for the given Placement.

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.
  • placementId – the given Placement ID.

Remove Targeting

Removes Targeting by its ID for the given Placement.

URL: /rest-api/placement/{placementId}/targeting/{targetId}/delete.do

Method: DELETE

Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types of parameters or Placement with such ID doesn't exist.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Targeting with given ID not found for the given Placement.

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.
  • placementId – the given Placement ID.
  • targetId – the given Targeting ID.

Get Targeting

Get the Targeting by its ID for the given Placement.

URL: /rest-api/placement/{placementId}/targeting/{targetId}.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 Placement.

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.
  • placementId – the given Placement ID.
  • targetId - the given Targeting ID.

Get all Targetings

Get all Targetings by Placement ID.

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

Method: GET

Response format: application/json

Error codes:

  • 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 for hash generation.
  • username – a given username.
  • placementId – the given Placement ID.

Get Targeting Types

Get the Targeting types for the given Placement.

URL: /rest-api/placement/{placementId}/targeting/types.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 Placement.

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.
  • placementId – the given Placement ID.

Get Browsers

Get available Browser values for Browser Targeting type.

URL: /rest-api/placement/{placementId}/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 given Placement.

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.
  • placementId – the given Placement ID.

Get Mobile Carriers

Get available Mobile Carrier names for Mobile Carrier Targeting type.

URL: /rest-api/placement/{placementId}/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 Placement.

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.
  • placementId – the given Placement ID.

Get Firefox versions

Get available Firefox browser version values for Browser Targeting type.

URL: /rest-api/placement/{placementId}/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 – Placement with such ID doesn't exist.

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.
  • placementId – the given Placement ID.

Get Chrome versions

Get available Chrome browser version values for Browser Targeting type.

URL: /rest-api/placement/{placementId}/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 – Placement with such ID doesn't exist.

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.
  • placementId – the given Placement ID.

Get Safari versions

Get available Safari browser version values for Browser Targeting type.

URL: /rest-api/placement/{placementId}/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 – Placement with such ID doesn't exist.

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.
  • placementId – the given Placement ID.

Get IE versions

Get available Internet Explorer browser version values for Browser Targeting type.

URL: /rest-api/placement/{placementId}/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 – Placement with such ID doesn't exist.

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.
  • placementId – the given Placement ID.

Get OS values

Get available operating systems values for OS Targeting type.

URL: /rest-api/placement/{placementId}/targeting/os/values.do

Method: GET

Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Placement with such ID doesn't exist.

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.
  • placementId – the given Placement ID.

Get OS versions

Get available operating systems versions' values for OS Targeting type.

URL: /rest-api/placement/{placementId}/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 – Placement with such ID doesn't exist.

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.
  • osName – operation system name from list of available OS values.
  • placementId – the given Placement ID.

Get Device Formats

Get available device formats values for Device Format Targeting type.

URL: /rest-api/placement/{placementId}/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 – Placement with such ID doesn't exist.

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.
  • placementId – the given Placement ID.

Get Device Vendors

Get available device vendor values for Device Vendor Targeting type.

URL: /rest-api/placement/{placementId}/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 – Placement with such ID doesn't exist.

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.
  • placementId – the given Placement ID.

Get Resolutions

Get available screen resolution values for Screen Resolution Targeting type.

URL: /rest-api/placement/{placementId}/targeting/resolution/values.do

Method: GET

Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Placement with such ID doesn't exist.

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.
  • placementId – the given Placement ID.

Get Regions

Get available regions for the given country.

URL: /rest-api/placement/{placementId}/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 – Placement with such ID doesn't exist.

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.
  • placementId – the given Placement ID.
  • countryCode – ISO country code.

Get Cities

Get available City names for given Country and Region.

URL: /rest-api/placement/{placementId}/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 – Placement with such ID doesn't exist.

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.
  • placementId – the given Placement ID.
  • countryCode – ISO country code.
  • regionName – State or region name.

Get Languages

Get available languages.

URL: /rest-api/placement/{placementId}/targeting/language/values.do

Method: GET

Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Placement with such ID doesn't exist.

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.
  • placementId – the given Placement ID.

Create Browser Targeting

Sets Browser Targeting for the Placement (and enable if it was disabled).

URL: /rest-api/placement/{placementId}/targeting/create.do

Method: POST

Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types of parameters or Placement 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 for hash generation.
  • username – a given username.
  • placementId – the given Placement ID.
  • rule – EXCLUDE or INCLUDE.
  • browser – Browser name.
  • relation – available values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL.
  • browserVersion – version of the user's Browser.

Create Country Targeting

Sets Country Targeting for the Placement (and enable if it was disabled).

URL: /rest-api/placement/{placementId}/targeting/country/create.do

Method: POST

Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types of parameters or Placement 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 for hash generation.
  • username – a given username.
  • placementId – the given Placement ID.
  • countryCode – ISO country code.
  • rule – EXCLUDE or INCLUDE.

Create IP Range Targeting

Sets the IP Range Targeting by Placement ID.
Params – Valid IP range (Sample: from 194.222.012.001 to 194.223.07.01)

URL: /rest-api/placement/{placementId}/targeting/iprange/create.do

Method: POST

Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types of parameters or Placement 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 for hash generation.
  • username – a given username.
  • placementId – the given Placement ID.
  • ipFrom – first valid IP from the range.
  • ipTo – last valid IP of the range.
  • rule – EXCLUDE or INCLUDE.

Create Time Range Targeting

Set Time Range Targeting for the Placement.

URL: /rest-api/placement/{placementId}/targeting/timerange/create.do

Method: POST

Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types of parameters or Placement 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 for hash generation.
  • username – a given username.
  • placementId – the given Placement 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 Location Targeting

Set Location Targeting for the Placement.

URL: /rest-api/placement/{placementId}/targeting/location/create.do

Method: POST

Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types of parameters or Placement 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 for hash generation.
  • username – a given username.
  • placementId – the given Placement ID.
  • countryCode – ISO Country code.
  • regionName – State or region name (optional).
  • cityName – City name.
  • rule – EXCLUDE or INCLUDE.

Create Cookie Targeting

Set Cookie value Targeting for the Placement (and enable if it was disabled).

URL: /rest-api/placement/{placementId}/targeting/cookie/create.do

Method: POST

Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types of parameters or Placement 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 for hash generation.
  • username – a given username.
  • placementId – the given Placement ID.
  • cookieName – Cookie name.
  • cookieValue – Cookie value.
  • rule – EXCLUDE or INCLUDE.

Create Domain Targeting

Set the Referrer Domain Targeting for the Placement (and enable if it was disabled).

URL: /rest-api/placement/{placementId}/targeting/domain/create.do

Method: POST

Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types of parameters or Placement 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 for hash generation.
  • username – a given username.
  • placementId – the given Placement ID.
  • domain – Domain name.
  • rule – EXCLUDE or INCLUDE.

Create Preset Domain Group Targeting

Set the Preset Domain Group Targeting for the Placement (and enable if it was disabled).

URL: /rest-api/placement/{placementId}/targeting/preset-domain/create.do

Method: POST

Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types of parameters or Placement 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 for hash generation.
  • username – a given username.
  • placementId – the given Placement ID.
  • domainGroupId – ID of the Domain Group.
  • rule – EXCLUDE or INCLUDE.

Create Channel Targeting

Set Channel Targeting for the Placement (and enable if it was disabled).

URL: /rest-api/placement/{placementId}/targeting/channel/create.do

Method: POST

Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types of parameters or Placement 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 for hash generation.
  • username – a given username.
  • placementId – the given Placement ID.
  • channel – Epom Channel.
  • rule – EXCLUDE or INCLUDE.

Create Screen Resolution Targeting

Set Screen Resolution Targeting for the Placement.

URL: /rest-api/placement/{placementId}/targeting/resolution/create.do

Method: POST

Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types of parameters or Placement 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 for hash generation.
  • username – a given username.
  • placementId – the given Placement ID.
  • relation – available values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL.
  • screenWidth
  • screenHeight
  • rule – EXCLUDE or INCLUDE.

Create WiFi Targeting

Set WiFi Traffic Targeting for the Placement.

URL: /rest-api/placement/{placementId}/targeting/wifi/create.do

Method: POST

Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types of parameters or Placement 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 for hash generation.
  • username – a given username.
  • placementId – the given Placement ID.
  • rule – EXCLUDE or INCLUDE.

Create Language Targeting

Set Language Targeting for the Placement (and enable if it was disabled).

URL: /rest-api/placement/{placementId}/targeting/language/create.do

Method: POST

Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types of parameters or Placement 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 for hash generation.
  • username – a given username.
  • placementId – the given Placement ID.
  • languageCode – language code.
  • rule – EXCLUDE or INCLUDE.

Create OS Targeting

Set Operating System Targeting for the Placement.

URL: /rest-api/placement/{placementId}/targeting/os/create.do

Method: POST

Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types of parameters or Placement 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 for hash generation.
  • username – a given username.
  • placementId – the given Placement ID.
  • operatingSystem – user's operating system.
  • version – OS version. Full list of available values can be obtained from:
    /rest-api/placement/{placementId}/targeting/os/{osName}/versions.do
  • relation – available values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL.
  • rule – EXCLUDE or INCLUDE.

Create Device Vendor Targeting

Set Device Vendor Targeting for the Placement (and enable if it was disabled).

URL: /rest-api/placement/{placementId}/targeting/devicevendor/create.do

Method: POST

Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types of parameters or Placement 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 for hash generation.
  • username – a given username.
  • placementId – the given Placement ID.
  • deviceVendor – Device Vendor name.
  • rule – EXCLUDE or INCLUDE.

Create Device Targeting

Set Device Targeting for the Placement (and enable if it was disabled).

URL: /rest-api/placement/{placementId}/targeting/deviceformat/create.do

Method: POST

Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types of parameters or Placement 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 for hash generation.
  • username – a given username.
  • placementId – the given Placement ID.
  • deviceFormat – device type (Desktop, Tablet, Mobile, Smart TV).
  • rule – EXCLUDE or INCLUDE.

Create Mobile Carrier Targeting

Set Mobile Carrier Targeting for the Placement.

URL: /rest-api/placement/{placementId}/targeting/mobilecarrier/create.do

Method: POST

Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types of parameters or Placement 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 for hash generation.
  • username – a given username.
  • placementId – the given Placement ID.
  • rule – EXCLUDE or INCLUDE.
  • mobileCarriers – array of Mobile Carrier names.

Create Day of Week Targeting

Set Targeting by day of the week for the Placement.

URL: /rest-api/placement/{placementId}/targeting/dayofweek/create.do

Method: POST

Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types of parameters or Placement 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 for hash generation.
  • username – a given username.
  • placementId – the given Placement ID.
  • rule – EXCLUDE or INCLUDE.
  • dayOfWeek – available values are MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

Create Custom Parameter Targeting

Set Custom Parameter Targeting for the Placement.

URL: /rest-api/placement/{placementId}/targeting/custom/create.do

Method: POST

Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types of parameters or Placement 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 for hash generation.
  • username – a given username.
  • placementId – the given Placement ID.
  • rule – EXCLUDE or INCLUDE.
  • expression – valid expression (Sample: =12 && $p2>=22) ) ]]>.

Create Protocol Targeting by Placement ID

Set Protocol Targeting by Placement ID.

URL: /rest-api/placement/{placementId}/targeting/protocol/create.do

Method: POST

Response format: application/json

Error codes:

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

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.
  • placementId – the given Placement ID.
  • rule – EXCLUDE or INCLUDE.
  • protocol – protocol in upper case. Available values: HTTP or HTTPS.

Get Mobile Carriers by Country

Get Mobile Carrier List sorted by Country.

URL: /rest-api/targeting/mobilecarriers/bycountry/values.do
Method: GET
Response format: application/json

Error codes:

  • 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.
  • country – ISO Country code to get the response for a specific Country.

Block Campaign for the Placement

Block Campaign for the given Placement.

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

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types of parameters, or Banner with such ID doesn't exist.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Targeting with given ID was not found for the 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 in milliseconds used in hash generation.
  • username – the given username.
  • placementId – Placement IDs as a string; comma-delimited ("id1,id2,id3").
  • rule – Targeting rule; INCLUDE or EXCLUDE.


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.