Advertisers API endpoints
Endpoint reference for the Advertisers tag (8 endpoints): Advertiser CRUD operations and configuration
Reference network manager admin
Advertiser CRUD operations and configuration. 8 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.
GET /rest-api/advertiser/{advertiserId}/campaigns.do
List campaigns for advertiser.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser whose campaigns to list |
Responses: 200 — Array of campaign objects · 404 — Advertiser not found or deleted. Errors follow the shared conventions.
GET /rest-api/advertisers-tree.do
List advertisers with campaigns and banners tree.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertisingCategories | query | array<integer> | no | Optional array of advertising category IDs to filter the results. Only advertisers belonging to at least one of the specified categories will be returned. Pass multiple values as repeated query parameters, e.g. advertisingCategories=1&advertisingCategories=5. |
start | query | integer | no | Paging: skip this many advertisers (ordered by id). Default 0 |
limit | query | integer | no | Paging: at most this many advertisers, each with all its campaigns and banners. Omitted — every advertiser. A page shorter than limit is the last one |
Responses: 200 — Array of advertiser objects with nested campaigns and banners. Errors follow the shared conventions.
GET /rest-api/advertisers.do
List all advertisers.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertisingCategories | query | array<integer> | no | Optional array of advertising category IDs to filter the results. Only advertisers belonging to at least one of the specified categories will be returned. Pass multiple values as repeated query parameters, e.g. advertisingCategories=1&advertisingCategories=5. |
offset | query | integer | no | Pagination offset over advertisers ordered by id (zero-based) |
limit | query | integer | no | Maximum number of advertisers to return; omit for all |
fields | query | array<string> | no | Return only these fields of each entity, comma-separated; id is always kept. A requested field no returned row carries is named in the X-Ignored-Fields response header |
filter | query | object | no | Keep only entities matching every key, e.g. filter[cpaOptimization]=true&filter[hasLimit]=true. Keys are the entity’s on/off settings (active, enableTargeting, cpaOptimization, alwaysRedirect, …) and a has<Relation> flag for each setting kept in rows of its own (hasLimit, hasPricing, hasFrequencyCapping, hasTrackingCode, hasPriceAdjustmentRules, hasLabels, hasBanners, …), true when the relation holds a row; hasCapping, hasLimits and hasTargetingRules group the relations of their kind. An unknown key is a 400 that lists every valid key for the list. |
Responses: 200 — Array of advertiser objects. Errors follow the shared conventions.
GET /rest-api/advertisers/{advertiserId}.do
Get advertiser by ID.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser to retrieve |
Responses: 200 — Advertiser details · 404 — Advertiser not found or deleted. Errors follow the shared conventions.
DELETE /rest-api/advertisers/{advertiserId}/delete.do
Delete advertiser.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
advertiserId | path | integer | yes | Unique numeric ID of the advertiser to delete |
Responses: 200 — Advertiser deleted · 404 — Advertiser not found or already deleted. Errors follow the shared conventions.
POST /rest-api/advertisers/status.do
Switch advertisers on or off.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ids | form | array<integer> | yes | Advertiser IDs to switch, 1 to 500 |
active | form | boolean | yes | true to switch the advertisers on, false to switch them off |
Responses: 200 — Batch applied · 404 — None of the ids names an existing advertiser. Errors follow the shared conventions.
POST /rest-api/advertisers/update.do
Create or update advertiser.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | form | integer | no | ID of the advertiser to update — omit to create a new advertiser |
categoryId | form | array<integer> | no | Advertising category IDs, comma-separated or repeated — replace the advertiser’s categories. At least one is required when the ADVERTISER_CATEGORIES_REQUIRED permission is on |
actionLimitsEnabled | form | boolean | no | Enable per-action conversion limits |
active | form | boolean | no | Set to true to activate or false to deactivate the advertiser. |
adomain | form | string | no | Advertiser’s own brand domain, published to buyers as the OpenRTB adomain for block-list matching. Not a tracking or redirect domain. |
adsHost | form | string | no | Custom ad serving domain for this advertiser |
confirmationDelay | form | string | no | How recent revenue is treated before the advertiser confirms it: DEFAULT — the network’s default confirmation status; NONE — always confirmed; LAST_N_DAYS — the last preliminaryConfirmationDays days stay unconfirmed; LAST_CONFIRMED_DATE — everything after the advertiser’s last confirmed date stays unconfirmed Values: DEFAULT, NONE, LAST_N_DAYS, LAST_CONFIRMED_DATE. |
contactEmail | form | string | no | Contact email address |
contactName | form | string | no | Contact person name |
description | form | string | no | Advertiser description |
enablePriceAdjusting | form | boolean | no | Whether price adjustment rules are enabled for this advertiser |
enableRules | form | boolean | no | Enable advanced rules engine for this advertiser |
enableTargeting | form | boolean | no | Enable targeting rules for this advertiser |
lastConfirmedDate | form | string | no | Date up to which the advertiser’s revenue counts as confirmed under the LAST_CONFIRMED_DATE policy, yyyy-MM-dd; empty clears it. Needs MANAGE_COMPLETENESS_DELAY_INVENTORY |
name | form | string | no | Advertiser name |
operationBetweenRuleTypes | form | string | no | Logical operator between different targeting rule types (AND, OR) Values: AND, OR. |
preliminaryConfirmationDays | form | integer | no | Number of days for preliminary conversion confirmation, 0 to 365 |
privateField | form | boolean | no | Mark as private — hidden from marketplace discovery |
selfServeCpmFloorAdjustment | form | integer | no | Self-serve CPM floor adjustment percentage (0-10000, where 100 = no adjustment) |
enableLimits | form | boolean | no | Set to true to automatically create an AdvertiserLimit record for this advertiser if one does not already exist. Requires MANAGE_CAPPING_AND_LIMITATIONS permission. |
Responses: 200 — Advertiser created/updated. Response contains ‘id’ field · 404 — Advertiser not found or deleted (update only). Errors follow the shared conventions.
PUT /rest-api/advertisers/update.do
Create or update advertiser.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | form | integer | no | ID of the advertiser to update — omit to create a new advertiser |
categoryId | form | array<integer> | no | Advertising category IDs, comma-separated or repeated — replace the advertiser’s categories. At least one is required when the ADVERTISER_CATEGORIES_REQUIRED permission is on |
actionLimitsEnabled | form | boolean | no | Enable per-action conversion limits |
active | form | boolean | no | Set to true to activate or false to deactivate the advertiser. |
adomain | form | string | no | Advertiser’s own brand domain, published to buyers as the OpenRTB adomain for block-list matching. Not a tracking or redirect domain. |
adsHost | form | string | no | Custom ad serving domain for this advertiser |
confirmationDelay | form | string | no | How recent revenue is treated before the advertiser confirms it: DEFAULT — the network’s default confirmation status; NONE — always confirmed; LAST_N_DAYS — the last preliminaryConfirmationDays days stay unconfirmed; LAST_CONFIRMED_DATE — everything after the advertiser’s last confirmed date stays unconfirmed Values: DEFAULT, NONE, LAST_N_DAYS, LAST_CONFIRMED_DATE. |
contactEmail | form | string | no | Contact email address |
contactName | form | string | no | Contact person name |
description | form | string | no | Advertiser description |
enablePriceAdjusting | form | boolean | no | Whether price adjustment rules are enabled for this advertiser |
enableRules | form | boolean | no | Enable advanced rules engine for this advertiser |
enableTargeting | form | boolean | no | Enable targeting rules for this advertiser |
lastConfirmedDate | form | string | no | Date up to which the advertiser’s revenue counts as confirmed under the LAST_CONFIRMED_DATE policy, yyyy-MM-dd; empty clears it. Needs MANAGE_COMPLETENESS_DELAY_INVENTORY |
name | form | string | no | Advertiser name |
operationBetweenRuleTypes | form | string | no | Logical operator between different targeting rule types (AND, OR) Values: AND, OR. |
preliminaryConfirmationDays | form | integer | no | Number of days for preliminary conversion confirmation, 0 to 365 |
privateField | form | boolean | no | Mark as private — hidden from marketplace discovery |
selfServeCpmFloorAdjustment | form | integer | no | Self-serve CPM floor adjustment percentage (0-10000, where 100 = no adjustment) |
enableLimits | form | boolean | no | Set to true to automatically create an AdvertiserLimit record for this advertiser if one does not already exist. Requires MANAGE_CAPPING_AND_LIMITATIONS permission. |
Responses: 200 — Advertiser created/updated. Response contains ‘id’ field · 404 — Advertiser not found or deleted (update only). Errors follow the shared conventions.
Related
- REST API overview — authentication and conventions
- API endpoint reference by tag
- Entities — create, read, update, delete via API
