Targeting Rules API endpoints — Banner

Targeting rules for advertisers, campaigns, banners, placements, sites, and zones. 64 banner endpoints, generated from the OpenAPI spec. Authentication, the response envelope, pagination and error codes are shared by all endpoints — see REST API overview. Parameters marked form go in an application/x-www-form-urlencoded request body.

The endpoints shared by every level are on Targeting Rules API endpoints.

GET /rest-api/banner/{bannerId}/targeting/{targetId}.do

Request examples

Get banner targeting rule by ID.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
targetId	path	integer	yes	Unique numeric ID of the targeting rule to retrieve

Responses: 200 — Success · 404 — Banner or targeting rule not found · 500 — Internal server error. Errors follow the shared conventions.

DELETE /rest-api/banner/{bannerId}/targeting/{targetId}/delete.do

Request examples

Remove banner targeting rule.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
targetId	path	integer	yes	Unique numeric ID of the targeting rule to remove

Responses: 200 — Success · 404 — Banner or targeting rule not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/api-json-field/create.do

Request examples

Create banner API JSON field targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
apiUrl	form	string	yes	API URL to match
jsonFieldName	form	string	yes	JSON field path to match
jsonFieldValue	form	string	yes	JSON field value to match

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/app-package/create.do

Request examples

Create banner app package targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
appPackage	form	string	yes	Application package name to target

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/browser-country/create.do

Request examples

Create banner browser country targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
countryCode	form	array<string>	yes	ISO 3166-1 alpha-2 country code(s) to target

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/browser-rank/create.do

Request examples

Create banner browser rank targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
browserRank	form	integer	yes	Browser rank value
relation	form	string	yes	Comparison relation — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL or EQUAL Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL.

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/banner/{bannerId}/targeting/browser/chrome/values.do

Request examples

Get Chrome browser versions for banner targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/browser/create.do

Request examples

Create banner browser targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
browser	form	string	yes	Browser to target Values: CHROME_MOBILE, CHROME, MOBILE_SAFARI, SAFARI, EDGE, FIREFOX, OPERA, SAMSUNG_BROWSER, UC_BROWSER, YANDEX, OPERA_MINI, EDGE_MOBILE, QQ_BROWSER, FIREFOX_MOBILE, MIUI_BROWSER, WHALE, HUAWEI_BROWSER, OPERA_MOBILE, BRAVE, BAIDU_BROWSER, YANDEX_BROWSER_IOS, AMAZON_SILK, DUCKDUCKGO, VIVO_BROWSER, ARC … (+44 more, 69 total).
relation	form	string	no	Relation operator for version comparison Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL.
browserVersion	form	string	no	Browser version to compare against

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/banner/{bannerId}/targeting/browser/firefox/values.do

Request examples

Get Firefox browser versions for banner targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/banner/{bannerId}/targeting/browser/ie/values.do

Request examples

Get IE browser versions for banner targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/banner/{bannerId}/targeting/browser/safari/values.do

Request examples

Get Safari browser versions for banner targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/banner/{bannerId}/targeting/browser/values.do

Request examples

Get browser values for banner targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/channel/create.do

Request examples

Create banner channel targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
channel	form	string	yes	Channel name to target

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/connection-type/create.do

Request examples

Create banner connection type targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
connectionType	form	string	yes	Connection type to target Values: UNKNOWN, DIALUP, CABLE_DSL, CORPORATE, CELLULAR, WI_FI.

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/banner/{bannerId}/targeting/connection-type/values.do

Request examples

Get connection type values.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner

Responses: 200 — Success · 404 — Not found — resource does not exist. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/cookie-value/create.do

Request examples

Create banner cookie value targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
cookieName	form	string	yes	Cookie name to match
cookieValue	form	string	yes	Cookie value to match

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/country/create.do

Request examples

Create banner country targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
countryCode	form	array<string>	yes	ISO 3166-1 alpha-2 country code(s) to target

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/banner/{bannerId}/targeting/country/region/city/values.do

Request examples

Get region cities for banner targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
countryCode	query	string	yes	ISO 3166-1 alpha-2 country code
regionName	query	string	yes	Region or state name

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/banner/{bannerId}/targeting/country/region/values.do

Request examples

Get country regions for banner targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
countryCode	query	string	yes	ISO 3166-1 alpha-2 country code

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/custom/create.do

Request examples

Create banner custom parameter targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
customValue	form	string	yes	Custom targeting value
customType	form	string	no	Custom target type Values: EXPRESSION, VALUE, ONE_OF, SUBSTRING.
operation	form	string	no	Matching operation — EQUALS, NOT_EQUALS, CONTAINS, or NOT_CONTAINS (optional) Values: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, GREATER, GREATER_OR_EQUALS, LESS, LESS_OR_EQUALS, IN, NOT_IN.
parameter	form	string	no	Custom parameter name

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/date-time/create.do

Request examples

Create banner date/time targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
timeFrom	form	string	yes	Start time (HH:mm format)
timeTo	form	string	yes	End time (HH:mm format)
dayOfWeek	form	array<string>	no	Days of week to target; omitted, the rule applies on every day Values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.
clientLocalTime	form	boolean	no	Whether to use client local time

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/day-of-week/create.do

Request examples

Create banner day of week targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
dayOfWeek	form	string	yes	Day of week to target Values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/device-format/create.do

Request examples

Create banner device format targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
deviceFormat	form	string	yes	Device format to target — DESKTOP, TABLET, MOBILE or SMART_TV Values: DESKTOP, TABLET, MOBILE, SMART_TV.

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/banner/{bannerId}/targeting/device-format/values.do

Request examples

Get device format values for banner targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/device-ram/create.do

Request examples

Create banner device RAM targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
deviceRam	form	integer	yes	Device RAM in MB
relation	form	string	yes	Comparison relation — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL or EQUAL Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL.

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/device-release-year/create.do

Request examples

Create banner device release year targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
deviceReleaseYear	form	integer	yes	Device release year
relation	form	string	yes	Comparison relation — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL or EQUAL Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL.

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/device-vendor/create.do

Request examples

Create banner device vendor targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
deviceVendor	form	string	yes	Device vendor to target Values: SAMSUNG, APPLE, XIAOMI, VIVO, OPPO, HONOR, TECNO, INFINIX, HUAWEI, REALME, MOTOROLA, ONEPLUS, ITEL, NOKIA, ZTE, AMAZON, PHILIPS, WIKO, LENOVO, NUBIA, HISENSE, CHANGHONG, KIVI, MEIZU, TCL … (+14 more, 39 total).

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/banner/{bannerId}/targeting/device-vendor/values.do

Request examples

Get device vendor values for banner targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/disable.do

Request examples

Disable banner targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/dmp/create.do

Request examples

Create banner DMP targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
dmp	form	string	yes	DMP — enum name or numeric ID Values: FIRST_PARTY, DTSCOUT, AIDATA, LOTAME, SITEMATH, MEDIAQUARK, JOTTIX.
dmpSegmentId	form	integer	yes	ID of a segment of that DMP

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/domain/create.do

Request examples

Create banner domain targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
domain	form	string	yes	Domain name to target

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/enable.do

Request examples

Enable banner targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/hardware-rank/create.do

Request examples

Create banner hardware rank targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
hardwareRank	form	integer	yes	Hardware rank value
relation	form	string	yes	Comparison relation — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL or EQUAL Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL.

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/incognito-mode/create.do

Request examples

Create banner incognito mode targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/ip-range/create.do

Request examples

Create banner IP range targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
ipFrom	form	string	yes	Start IP address of the range
ipTo	form	string	yes	End IP address of the range

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/is-web-app/create.do

Request examples

Create banner web app targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/language/create.do

Request examples

Create banner language targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
languageCode	form	string	yes	Language code to target (ISO 639-1)

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/banner/{bannerId}/targeting/language/values.do

Request examples

Get language values for banner targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/location/create.do

Request examples

Create banner location targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
countryCode	form	string	yes	ISO 3166-1 alpha-2 country code
regionName	form	string	no	Region or state name
cityName	form	string	no	City name

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/mobile-carrier/create.do

Request examples

Create banner mobile carrier targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
mobileCarriers	form	array<string>	no	Mobile carrier names, spelled exactly as GET /rest-api/targeting/mobile-carrier/bycountry/values.do lists them; an unknown name answers 400

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/banner/{bannerId}/targeting/mobile-carrier/values.do

Request examples

Get mobile carrier values for banner targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/banner/{bannerId}/targeting/operating-system/{osName}/versions.do

Request examples

Get OS version values for banner targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
osName	path	string	yes	Operating system. Accepts enum name or integer ID for backward compatibility Values: UNSPECIFIED, WINDOWS, LINUX, MAC_OS_X, IOS, IPADOS, ANDROID, SYMBIAN, J2ME, BLACKBERRY, XMB, BADA, PALM_OS, SOLARIS, MEEGO, CHROME_OS, FREE_BSD, WINDOWS_PHONE, SAMSUNG_TIZEN, HISENSE_VIDAA, LG_WEB_OS, ROKU_TV_OS, AMAZON_FIRE_TV, APPLE_TV, ANDROID_TV.

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/operating-system/create.do

Request examples

Create banner OS targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
operatingSystem	form	string	yes	Operating system to target (e.g., WINDOWS, MACOS, LINUX, ANDROID, IOS) Values: UNSPECIFIED, WINDOWS, LINUX, MAC_OS_X, IOS, IPADOS, ANDROID, SYMBIAN, J2ME, BLACKBERRY, XMB, BADA, PALM_OS, SOLARIS, MEEGO, CHROME_OS, FREE_BSD, WINDOWS_PHONE, SAMSUNG_TIZEN, HISENSE_VIDAA, LG_WEB_OS, ROKU_TV_OS, AMAZON_FIRE_TV, APPLE_TV, ANDROID_TV.
version	form	string	no	Optional OS version: a version value from the OS versions endpoint (for example 16.-1 for iOS 16.x.x) or its title. An unknown version, or a version on an OS without versions, answers 400 with the valid versions
relation	form	string	no	Version comparison relation — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL or EQUAL. Required when version is sent (a version without it answers 400); ignored without version Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL.

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/banner/{bannerId}/targeting/operating-system/values.do

Request examples

Get OS values for banner targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/operation-between-rule-types.do

Request examples

Set how banner targeting rule types combine.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
operator	form	string	yes	AND — every rule type must match; OR — any one rule type is enough Values: AND, OR.

Responses: 200 — Success — the response carries the saved operationBetweenRuleTypes · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/placement/create.do

Request examples

Create banner blocked placement targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
placementId	form	string	yes	Comma-separated list of placement IDs to target (e.g., ‘123,456,789’)
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.

Responses: 200 — {success, created, alreadyTargeted} · 404 — Banner or placement not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/platform-rank/create.do

Request examples

Create banner platform rank targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
platformRank	form	integer	yes	Platform rank value
relation	form	string	yes	Comparison relation — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL or EQUAL Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL.

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/preset-app-package/create.do

Request examples

Create banner preset app package targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
presetApplicationPackageGroupId	form	integer	yes	Preset application package group ID

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/preset-domain/create.do

Request examples

Create banner preset domain targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
domainGroupId	form	integer	yes	Preset domain group ID

Responses: 200 — Success · 404 — Banner or domain group not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/preset-ip-ranges/create.do

Request examples

Create banner preset IP ranges targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
presetIpRangesGroupId	form	integer	no	ID of the preset IP ranges group; also accepted as ipRangesGroupId. One of the two is required
ipRangesGroupId	form	integer	no	The same preset IP ranges group ID under its other name; presetIpRangesGroupId wins when both are sent

Responses: 200 — Success · 404 — Banner or IP ranges group not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/price-band/create.do

Request examples

Create banner price band targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
priceBand	form	number	yes	Price band value
relation	form	string	yes	Comparison relation — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL or EQUAL Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL.

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/protocol/create.do

Request examples

Create banner protocol targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
protocol	form	string	yes	Protocol to target Values: HTTP, HTTPS.

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/proxy/create.do

Request examples

Create banner proxy targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
proxy	form	string	yes	Proxy type to target: VPN, TOR, DCH (data center / hosting), PUB (public proxy), WEB (web proxy) or SES (search engine robot) Values: VPN, TOR, DCH, PUB, WEB, SES.

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/screen-resolution/create.do

Request examples

Create banner screen resolution targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
relation	form	string	yes	Relation operator for resolution comparison Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL.
screenWidth	form	integer	yes	Screen width in pixels
screenHeight	form	integer	yes	Screen height in pixels

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/banner/{bannerId}/targeting/screen-resolution/values.do

Request examples

Get screen resolution values for banner targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/site/create.do

Request examples

Create banner blocked site targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
siteId	form	string	yes	Comma-separated list of site IDs to target (e.g., ‘123,456,789’)
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.

Responses: 200 — {success, created, alreadyTargeted} · 404 — Banner or site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/time-range/create.do

Request examples

Create banner time range targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
timeFrom	form	string	yes	Start time of the range (HH:mm format)
timeTo	form	string	yes	End time of the range (HH:mm format)
clientLocalTime	form	boolean	no	Whether to use client local time

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/traffic-risk-score/create.do

Request examples

Create banner traffic risk score targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
riskLevel	form	string	yes	Risk level Values: SERVICE_DISABLED, ERROR, NOT_SCORED, LOW, LIKELY, HIGH, VERY_HIGH, CERTAIN.
relation	form	string	yes	Comparison relation — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL or EQUAL Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL.
riskCategory	form	array<string>	no	Risk categories to target Values: HIGH_RISK_IP, HIGH_RISK_APP, APP_SPOOFING, DISPLAY_IMPRESSION_FRAUD, DEVICE_ID_STUFFING, DEFASED_APP, VIDEO_IMPRESSION_FRAUD, HIGH_RISK_DOMAIN, IAB_CRAWLER, DATACENTER, DISPLAY_CLICK_FRAUD, LOCATION_OBFUSCATION, HIJACKED_SESSION, COOKIE_STUFFING, DATACENTER_PROXY, PUBLISHER_FRAUD, IDIO_BOTS, TOR, AUTO_RELOADER, CLICK_FARM, BLANK_USER_AGENT, PHISHING, DOORWAY_SITE, IAB_DUMMY_BOT, FAST_CLICKER.

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/traffic-source/create.do

Request examples

Create banner traffic source targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
trafficSource	form	string	yes	Traffic source to target Values: HEADER_BIDDING.

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/banner/{bannerId}/targeting/traffic-source/values.do

Request examples

Get traffic source values.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner

Responses: 200 — Success · 404 — Not found — resource does not exist. Errors follow the shared conventions.

GET /rest-api/banner/{bannerId}/targeting/types.do

Request examples

Get available banner targeting types.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner whose available targeting types to retrieve

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/banner/{bannerId}/targeting/wifi-traffic/create.do

Request examples

Create banner WiFi traffic targeting.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/banner/{bannerId}/targetings.do

Request examples

Get banner targeting rules.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner whose targeting rules to retrieve
targetType	query	string	no	Optional targeting type filter — when specified, only rules of this type are returned (e.g., COUNTRY, BROWSER, DEVICE_FORMAT) Values: COUNTRY, BROWSER_COUNTRY, LOCATION, LANGUAGE, MOBILE_CARRIER, TIME_RANGE, DAY_OF_WEEK, DATE_TIME, OPERATING_SYSTEM, BROWSER, DEVICE_FORMAT, DEVICE_VENDOR, RESOLUTION, PROTOCOL, WIFI_TRAFFIC, IS_WEB_APP, INCOGNITO_MODE, DEVICE_RELEASE_YEAR, DEVICE_RAM, BROWSER_RANK, HARDWARE_RANK, PLATFORM_RANK, PRICE_BAND, DOMAIN, CHANNEL … (+18 more, 43 total).
rule	query	string	no	Optional rule filter — INCLUDE to return only whitelist rules, EXCLUDE to return only blacklist rules Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.

Responses: 200 — Success · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

DELETE /rest-api/banner/{bannerId}/targetings.do

Request examples

Delete all banner targeting rules.

Parameter	In	Type	Required	Description
bannerId	path	integer	yes	Unique numeric ID of the banner
targetType	form	string	no	Optional targeting type filter — only rules of this type are deleted Values: COUNTRY, BROWSER_COUNTRY, LOCATION, LANGUAGE, MOBILE_CARRIER, TIME_RANGE, DAY_OF_WEEK, DATE_TIME, OPERATING_SYSTEM, BROWSER, DEVICE_FORMAT, DEVICE_VENDOR, RESOLUTION, PROTOCOL, WIFI_TRAFFIC, IS_WEB_APP, INCOGNITO_MODE, DEVICE_RELEASE_YEAR, DEVICE_RAM, BROWSER_RANK, HARDWARE_RANK, PLATFORM_RANK, PRICE_BAND, DOMAIN, CHANNEL … (+18 more, 43 total).
rule	form	string	no	Optional rule filter — only INCLUDE or only EXCLUDE rules are deleted Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.

Responses: 200 — Success — the response carries the deleted count · 404 — Banner not found · 500 — Internal server error. Errors follow the shared conventions.

Related

• REST API overview — authentication and conventions
• API endpoint reference by tag
• Targeting, capping and limits via API