Targeting Rules API endpoints — Campaign
Endpoint reference for the Targeting Rules tag on the campaign level (64 campaign endpoints): Targeting rules for advertisers, campaigns, banners, placements, sites, and zones
Targeting rules for advertisers, campaigns, banners, placements, sites, and zones. 64 campaign 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/campaign/{campaignId}/targeting/{targetId}.do
Get campaign targeting rule by ID.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
targetId | path | integer | yes | Unique numeric ID of the targeting rule to retrieve |
Responses: 200 — Success · 404 — Campaign or targeting rule not found · 500 — Internal server error. Errors follow the shared conventions.
DELETE /rest-api/campaign/{campaignId}/targeting/{targetId}/delete.do
Delete campaign targeting rule.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
targetId | path | integer | yes | Unique numeric ID of the targeting rule to delete |
Responses: 200 — Success · 404 — Campaign or targeting rule not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/api-json-field/create.do
Create campaign API JSON field targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
apiUrl | form | string | yes | URL of the API endpoint to query |
jsonField | form | string | yes | JSON field path to evaluate |
jsonFieldValue | form | string | yes | Expected JSON field value |
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/app-package/create.do
Create campaign app package targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
appPackage | form | string | yes | Application package name |
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/browser-country/create.do
Create campaign browser country targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
countryCode | form | array<string> | yes | Array of ISO 3166-1 alpha-2 country codes to target |
rule | form | string | yes | Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/browser-rank/create.do
Create campaign browser rank targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
browserRank | form | integer | yes | Browser rank threshold |
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
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 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/campaign/{campaignId}/targeting/browser/chrome/values.do
Get Chrome browser version values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/browser/create.do
Create campaign browser targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
browser | form | string | yes | Browser enum value 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). |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
rule | form | string | no | Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
relation | form | string | no | Optional comparison relation for version targeting — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, or EQUAL Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL. |
browserVersion | form | string | no | Optional browser version string (e.g., ‘80’ or ‘80.0’) |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/campaign/{campaignId}/targeting/browser/firefox/values.do
Get Firefox browser version values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/campaign/{campaignId}/targeting/browser/ie/values.do
Get IE browser version values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/campaign/{campaignId}/targeting/browser/safari/values.do
Get Safari browser version values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/campaign/{campaignId}/targeting/browser/values.do
Get browser targeting values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/channel/create.do
Create campaign channel targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
channel | form | string | yes | Channel identifier |
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/connection-type/create.do
Create campaign connection type targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
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 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/campaign/{campaignId}/targeting/connection-type/values.do
Get connection type values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Not found — resource does not exist. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/cookie-value/create.do
Create campaign cookie value targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
cookieName | form | string | yes | Cookie name to match |
cookieValue | form | string | yes | Cookie value to match |
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/country/create.do
Create campaign country targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
countryCode | form | array<string> | yes | Array of ISO 3166-1 alpha-2 country codes to target |
rule | form | string | yes | Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/campaign/{campaignId}/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 |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/campaign/{campaignId}/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) |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/custom/create.do
Create campaign custom parameter targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
customValue | form | string | yes | Custom targeting value |
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
customType | form | string | no | Custom target type Values: EXPRESSION, VALUE, ONE_OF, SUBSTRING. |
operation | form | string | no | Comparison operation Values: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, GREATER, GREATER_OR_EQUALS, LESS, LESS_OR_EQUALS, IN, NOT_IN. |
parameter | form | string | no | Parameter name |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/date-time/create.do
Create campaign date/time targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
timeFrom | form | string | yes | Start time in HH:mm format |
timeTo | form | string | yes | End time in HH:mm format |
rule | form | string | yes | Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
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’s local time |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/day-of-week/create.do
Create campaign day of week targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
dayOfWeek | form | string | yes | Day of the week Values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY. |
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/device-format/create.do
Create campaign device format targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
deviceFormat | form | string | yes | Device format (DESKTOP, MOBILE, TABLET) Values: DESKTOP, TABLET, MOBILE, SMART_TV. |
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/campaign/{campaignId}/targeting/device-format/values.do
Get device format targeting values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/device-ram/create.do
Create campaign device RAM targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
deviceRam | form | integer | yes | Device RAM in MB |
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
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 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/device-release-year/create.do
Create campaign device release year targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
deviceReleaseYear | form | integer | yes | Device release year |
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
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 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/device-vendor/create.do
Create campaign device vendor targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
deviceVendor | form | string | yes | Device vendor enum value 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). |
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/campaign/{campaignId}/targeting/device-vendor/values.do
Get device vendor targeting values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/disable.do
Disable campaign targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/dmp/create.do
Create campaign DMP targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
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 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/domain/create.do
Create campaign domain targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
domain | form | string | yes | Domain name to target |
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/enable.do
Enable campaign targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/hardware-rank/create.do
Create campaign hardware rank targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
hardwareRank | form | integer | yes | Hardware rank threshold |
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
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 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/incognito-mode/create.do
Create campaign incognito mode targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/ip-range/create.do
Create campaign IP range targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ipFrom | form | string | yes | Start of IP range |
ipTo | form | string | yes | End of IP range |
rule | form | string | yes | Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/is-web-app/create.do
Create campaign web app targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/language/create.do
Create campaign language targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
languageCode | form | string | yes | ISO 639-1 language code |
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/campaign/{campaignId}/targeting/language/values.do
Get language targeting values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/location/create.do
Create campaign location targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
countryCode | form | string | yes | ISO 3166-1 alpha-2 country code |
rule | form | string | yes | Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
regionName | form | string | no | Optional region name |
cityName | form | string | no | Optional city name |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/mobile-carrier/create.do
Create campaign mobile carrier targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
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 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/campaign/{campaignId}/targeting/mobile-carrier/values.do
Get mobile carrier targeting values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/campaign/{campaignId}/targeting/operating-system/{osName}/versions.do
Get OS version values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
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 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/operating-system/create.do
Create campaign OS targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
operatingSystem | form | string | yes | Operating system enum value 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. |
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
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 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/campaign/{campaignId}/targeting/operating-system/values.do
Get operating system targeting values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/operation-between-rule-types.do
Set how campaign targeting rule types combine.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
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 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/placement/create.do
Create campaign blocked placement targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
placementId | form | string | yes | Comma-separated placement IDs to block |
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
Responses: 200 — {success, created, alreadyTargeted} · 404 — Campaign or placement not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/platform-rank/create.do
Create campaign platform rank targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
platformRank | form | integer | yes | Platform rank threshold |
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
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 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/preset-app-package/create.do
Create campaign preset app package targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
appPackageGroupId | form | integer | yes | Unique numeric ID of the preset app package group |
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign or application package group not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/preset-domain/create.do
Create campaign preset domain targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
domainGroupId | form | integer | yes | Unique numeric ID of the preset domain group |
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign or domain group not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/preset-ip-ranges/create.do
Create campaign preset IP ranges targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
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 — Campaign or IP ranges group not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/price-band/create.do
Create campaign price band targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
priceBand | form | number | yes | Price band value |
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
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 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/protocol/create.do
Create campaign protocol targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
protocol | form | string | yes | Protocol — HTTP or HTTPS Values: HTTP, HTTPS. |
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/proxy/create.do
Create campaign proxy targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
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. |
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/screen-resolution/create.do
Create campaign screen resolution targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
relation | form | string | yes | Comparison relation Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL. |
screenWidth | form | integer | yes | Screen width in pixels |
screenHeight | form | integer | yes | Screen height in pixels |
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/campaign/{campaignId}/targeting/screen-resolution/values.do
Get screen resolution targeting values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/site/create.do
Create campaign blocked site targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
siteId | form | string | yes | Comma-separated site IDs to block |
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
Responses: 200 — {success, created, alreadyTargeted} · 404 — Campaign or site not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/time-range/create.do
Create campaign time range targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
timeFrom | form | string | yes | Start time in HH:mm format |
timeTo | form | string | yes | End time in HH:mm format |
rule | form | string | yes | Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
clientLocalTime | form | boolean | no | Whether to use client’s local time instead of server time |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/traffic-risk-score/create.do
Create campaign traffic risk score targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
riskLevel | form | string | yes | Traffic fraud risk level Values: NOT_SCORED, LOW, LIKELY, HIGH, VERY_HIGH, CERTAIN. |
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
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 | Optional risk categories 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 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/traffic-source/create.do
Create campaign traffic source targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
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 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/campaign/{campaignId}/targeting/traffic-source/values.do
Get traffic source values.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Not found — resource does not exist. Errors follow the shared conventions.
GET /rest-api/campaign/{campaignId}/targeting/types.do
Get available campaign targeting types.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/targeting/wifi-traffic/create.do
Create campaign WiFi traffic targeting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
rule | form | string | yes | Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH. |
campaignId | path | integer | yes | Unique numeric ID of the campaign |
Responses: 200 — Success · 404 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
GET /rest-api/campaign/{campaignId}/targetings.do
Get campaign targeting rules.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
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 — Campaign not found · 500 — Internal server error. Errors follow the shared conventions.
DELETE /rest-api/campaign/{campaignId}/targetings.do
Delete all campaign targeting rules.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Unique numeric ID of the campaign |
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 — Campaign 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
