Targeting Rules API endpoints — Advertiser
Endpoint reference for the Targeting Rules tag on the advertiser level (64 advertiser endpoints): Targeting rules for advertisers, campaigns, banners, placements, sites, and zones
Targeting rules for advertisers, campaigns, banners, placements, sites, and zones. 64 advertiser 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/advertiser/{advertiserId}/targeting/{targetId}.do
Get advertiser targeting rule by ID.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
targetId | path | integer | yes | Unique numeric ID of the targeting rule to retrieve |
Responses: 200 — Success · 404 — Advertiser or targeting rule not found · 500 — Internal server error. Errors follow the shared conventions.
DELETE /rest-api/advertiser/{advertiserId}/targeting/{targetId}/delete.do
Delete advertiser targeting rule.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
targetId | path | integer | yes | Unique numeric ID of the targeting rule to delete |
Responses: 200 — Success · 404 — Advertiser or targeting rule not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/api-json-field/create.do
Create advertiser API JSON field targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
rule | form | string | yes | Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
apiUrl | form | string | yes | External API URL to call for targeting evaluation |
jsonField | form | string | yes | JSON field name in the API response to match against |
jsonFieldValue | form | string | yes | Expected value of the JSON field |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/app-package/create.do
Create advertiser app package targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
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 (e.g., com.example.app) |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/browser-country/create.do
Create advertiser browser country targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
rule | form | string | yes | Targeting rule type: INCLUDE or EXCLUDE Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
countryCode | form | array<string> | yes | Array of ISO 3166-1 alpha-2 country codes to target (e.g., US, GB, DE) |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/browser-rank/create.do
Create advertiser browser rank targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
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 popularity rank threshold value |
relation | form | string | no | Comparison relation — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL or EQUAL; omitted, it is LOWER_EQUAL Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL. |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/advertiser/{advertiserId}/targeting/browser/chrome/values.do
Get Chrome browser version values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/browser/create.do
Create advertiser browser targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
browser | form | string | yes | Browser to target (e.g., FIREFOX, CHROME, SAFARI, EDGE) 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). |
rule | form | string | no | Targeting rule type: INCLUDE or EXCLUDE Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
relation | form | string | no | Optional version comparison relation: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL. |
browserVersion | form | string | no | Optional browser major version number (e.g., ‘30’). Old-style versions like ‘30.0’ are supported but only the major version is applied |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/advertiser/{advertiserId}/targeting/browser/firefox/values.do
Get Firefox browser version values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/advertiser/{advertiserId}/targeting/browser/ie/values.do
Get IE browser version values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/advertiser/{advertiserId}/targeting/browser/safari/values.do
Get Safari browser version values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/advertiser/{advertiserId}/targeting/browser/values.do
Get browser targeting values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/channel/create.do
Create advertiser channel targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
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 identifier to target |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/connection-type/create.do
Create advertiser connection type targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
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 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/advertiser/{advertiserId}/targeting/connection-type/values.do
Get connection type values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
Responses: 200 — Success · 404 — Not found — resource does not exist. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/cookie-value/create.do
Create advertiser cookie value targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
rule | form | string | yes | Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
cookieName | form | string | yes | Name of the cookie to match against |
cookieValue | form | string | yes | Expected cookie value to match |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/country/create.do
Create advertiser country targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
rule | form | string | yes | Targeting rule type: INCLUDE or EXCLUDE Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
countryCode | form | array<string> | yes | Array of ISO 3166-1 alpha-2 country codes to target (e.g., US, GB, DE) |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/advertiser/{advertiserId}/targeting/country/region/city/values.do
Get region city values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
countryCode | query | string | yes | ISO 3166-1 alpha-2 country code (e.g., US, GB, DE) |
regionName | query | string | yes | Region name within the specified country, as returned by the country regions endpoint |
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/advertiser/{advertiserId}/targeting/country/region/values.do
Get country region values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
countryCode | query | string | yes | ISO 3166-1 alpha-2 country code (e.g., US, GB, DE) |
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/custom/create.do
Create advertiser custom parameter targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
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 — an expression, value, or substring depending on customType |
customType | form | string | no | Optional custom target type — EXPRESSION, VALUE, or SUBSTRING Values: EXPRESSION, VALUE, ONE_OF, SUBSTRING. |
operation | form | string | no | Optional comparison operation — EQUALS, NOT_EQUALS, CONTAINS, or NOT_CONTAINS Values: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, GREATER, GREATER_OR_EQUALS, LESS, LESS_OR_EQUALS, IN, NOT_IN. |
parameter | form | string | no | Optional parameter name for the operation value |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/date-time/create.do
Create advertiser date/time targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
rule | form | string | yes | Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
timeFrom | form | string | yes | Time range start in HH:mm format |
timeTo | form | string | yes | Time range end in 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 | When true, use client’s local time zone for time range evaluation |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/day-of-week/create.do
Create advertiser day of week targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
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 the week — MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, or SUNDAY Values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY. |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/device-format/create.do
Create advertiser device format targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
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 enum value (e.g., DESKTOP, MOBILE, TABLET) Values: DESKTOP, TABLET, MOBILE, SMART_TV. |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/advertiser/{advertiserId}/targeting/device-format/values.do
Get device format targeting values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/device-ram/create.do
Create advertiser device RAM targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
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 threshold value in megabytes (e.g., 2048) |
relation | form | string | no | Comparison relation — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL or EQUAL; omitted, it is GREATER_EQUAL Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL. |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/device-release-year/create.do
Create advertiser device release year targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
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 to target (e.g., 2020) |
relation | form | string | no | Comparison relation — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL or EQUAL; omitted, it is GREATER_EQUAL Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL. |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/device-vendor/create.do
Create advertiser device vendor targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
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/manufacturer enum value (e.g., APPLE, SAMSUNG, HUAWEI) 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 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/advertiser/{advertiserId}/targeting/device-vendor/values.do
Get device vendor targeting values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/disable.do
Disable advertiser targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/dmp/create.do
Create advertiser DMP targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
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 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/domain/create.do
Create advertiser domain targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
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 (e.g., example.com) |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/enable.do
Enable advertiser targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/hardware-rank/create.do
Create advertiser hardware rank targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
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 quality rank threshold value |
relation | form | string | no | Comparison relation — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL or EQUAL; omitted, it is LOWER_EQUAL Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL. |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/incognito-mode/create.do
Create advertiser incognito mode targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
rule | form | string | yes | Targeting rule type — INCLUDE to target incognito traffic or EXCLUDE to avoid it Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/ip-range/create.do
Create advertiser IP range targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
rule | form | string | yes | Targeting rule type: INCLUDE or EXCLUDE Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
ipFrom | form | string | yes | Start of the IP range (e.g., ‘194.222.012.001’ for IPv4 or ‘2001:0db8:85a3:0000:0000:8a2e:0370:7334’ for IPv6) |
ipTo | form | string | yes | End of the IP range (must be greater than or equal to ipFrom) |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/is-web-app/create.do
Create advertiser web app targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
rule | form | string | yes | Targeting rule type — INCLUDE to target web app traffic or EXCLUDE to avoid it Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/language/create.do
Create advertiser language targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
rule | form | string | yes | Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
languageCode | form | string | yes | ISO 639-1 language code to target (e.g., en, de, fr) |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/advertiser/{advertiserId}/targeting/language/values.do
Get language targeting values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/location/create.do
Create advertiser location targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
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 (e.g., US, GB, DE) |
regionName | form | string | no | Optional region/state name within the specified country |
cityName | form | string | no | Optional city name within the specified country and region |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/mobile-carrier/create.do
Create advertiser mobile carrier targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
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 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/advertiser/{advertiserId}/targeting/mobile-carrier/values.do
Get mobile carrier targeting values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/advertiser/{advertiserId}/targeting/operating-system/{osName}/versions.do
Get OS version values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
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 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/operating-system/create.do
Create advertiser OS targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
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 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/advertiser/{advertiserId}/targeting/operating-system/values.do
Get operating system targeting values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/operation-between-rule-types.do
Set how advertiser targeting rule types combine.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
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 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/placement/create.do
Create advertiser blocked placement targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
placementId | form | string | yes | Comma-separated list of placement IDs to block (e.g., ‘101,102,103’) |
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 — Advertiser or placement not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/platform-rank/create.do
Create advertiser platform rank targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
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 popularity rank threshold value |
relation | form | string | no | Comparison relation — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL or EQUAL; omitted, it is LOWER_EQUAL Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL. |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/preset-app-package/create.do
Create advertiser preset app package targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
rule | form | string | yes | Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
appPackageGroupId | form | integer | yes | Unique numeric ID of the preset application package group to apply |
Responses: 200 — Success · 404 — Advertiser or application package group not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/preset-domain/create.do
Create advertiser preset domain targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
rule | form | string | yes | Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
domainGroupId | form | integer | yes | Unique numeric ID of the preset domain group to apply |
Responses: 200 — Success · 404 — Advertiser or domain group not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/preset-ip-ranges/create.do
Create advertiser preset IP ranges targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
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 — Advertiser or IP ranges group not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/price-band/create.do
Create advertiser price band targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
rule | form | string | yes | Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
priceBand | form | number | yes | Device price band threshold value |
relation | form | string | no | Comparison relation — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL or EQUAL; omitted, it is LOWER_EQUAL Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL. |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/protocol/create.do
Create advertiser protocol targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
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 — HTTP or HTTPS Values: HTTP, HTTPS. |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/proxy/create.do
Create advertiser proxy targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
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 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/screen-resolution/create.do
Create advertiser screen resolution targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
rule | form | string | yes | Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
relation | form | string | yes | Comparison relation — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, or EQUAL Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL. |
screenWidth | form | integer | yes | Target screen width in pixels (e.g., 1920) |
screenHeight | form | integer | yes | Target screen height in pixels (e.g., 1080) |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/advertiser/{advertiserId}/targeting/screen-resolution/values.do
Get screen resolution targeting values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/site/create.do
Create advertiser blocked site targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
siteId | form | string | yes | Comma-separated list of site IDs to block (e.g., ‘201,202,203’) |
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 — Advertiser or site not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/time-range/create.do
Create advertiser time range targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
rule | form | string | yes | Targeting rule type: INCLUDE or EXCLUDE Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
timeFrom | form | string | yes | Start time in 24-hour format hh:MM (e.g., ‘09:00’) |
timeTo | form | string | yes | End time in 24-hour format hh:MM (e.g., ‘18:00’) |
clientLocalTime | form | boolean | no | If true, the time range is evaluated in the client’s local timezone; if false, UTC is used |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/traffic-risk-score/create.do
Create advertiser traffic risk score targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
rule | form | string | yes | Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
riskLevel | form | string | yes | Traffic fraud risk level threshold. Accepts enum name or integer ID for backward compatibility Values: NOT_SCORED, LOW, LIKELY, HIGH, VERY_HIGH, CERTAIN. |
relation | form | string | no | Comparison relation — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL or EQUAL; omitted, it is GREATER_EQUAL Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL. |
riskCategory | form | array<string> | no | Array of risk categories for brand safety targeting. Accepts enum names (e.g. HIGH_RISK_IP), camelCase names (e.g. highRiskIP), or integer IDs 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 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/traffic-source/create.do
Create advertiser traffic source targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
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 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/advertiser/{advertiserId}/targeting/traffic-source/values.do
Get traffic source values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
Responses: 200 — Success · 404 — Not found — resource does not exist. Errors follow the shared conventions.
GET /rest-api/advertiser/{advertiserId}/targeting/types.do
Get available advertiser targeting types.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/advertiser/{advertiserId}/targeting/wifi-traffic/create.do
Create advertiser WiFi traffic targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
rule | form | string | yes | Targeting rule type — INCLUDE to target WiFi traffic or EXCLUDE to target cellular traffic Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/advertiser/{advertiserId}/targetings.do
Get advertiser targeting rules.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
targetType | query | string | no | Optional targeting type filter — when specified, only rules of this type are returned 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 or EXCLUDE) — when specified, only rules with this rule type are returned Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
Responses: 200 — Success · 404 — Advertiser not found · 500 — Internal server error. Errors follow the shared conventions.
DELETE /rest-api/advertiser/{advertiserId}/targetings.do
Delete all advertiser targeting rules.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser |
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 — Advertiser 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
