Banner Price Adjustment Rules API endpoints
Endpoint reference for the Banner Price Adjustment Rules tag (10 endpoints): Price adjustment rule management for banners
Price adjustment rule management for banners. 10 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.
POST /rest-api/price-adjustment-rules/banner/{entityId}/create.do
Create a banner price adjustment rule.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
entityId | path | integer | yes | Unique numeric identifier of the banner |
actionType | form | string | no | Action type — MULTIPLY multiplies the gross by actionValue, SET sets the gross to actionValue Values: MULTIPLY, SET. |
actionValue | form | number | no | Action value — the numeric value for the action (e.g. 1.5 for multiply, 2.0 for set) |
conditionOperator | form | string | no | Condition operator — how to compare Values: IS. |
conditionSubject | form | string | no | Condition subject — what the rule checks Values: PLACEMENT. |
conditionValue | form | string | no | Condition value — the ID of the entity to match (e.g. placement ID) |
Responses: 200 — Rule created successfully · 404 — banner not found. Errors follow the shared conventions.
POST /rest-api/price-adjustment-rules/banner/{entityId}/disable.do
Disable banner price adjusting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
entityId | path | integer | yes | Unique numeric identifier of the banner |
Responses: 200 — Price adjusting disabled · 404 — banner not found or deleted. Errors follow the shared conventions.
POST /rest-api/price-adjustment-rules/banner/{entityId}/enable.do
Enable banner price adjusting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
entityId | path | integer | yes | Unique numeric identifier of the banner |
Responses: 200 — Price adjusting enabled · 404 — banner not found or deleted. Errors follow the shared conventions.
GET /rest-api/price-adjustment-rules/banner/{entityId}/list.do
List banner price adjustment rules.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
entityId | path | integer | yes | Unique numeric identifier of the banner |
Responses: 200 — Rules retrieved successfully · 404 — banner not found. Errors follow the shared conventions.
GET /rest-api/price-adjustment-rules/banner/action-types.do
Get action types.
No parameters beyond authentication.
Responses: 200 — Action types retrieved successfully. Errors follow the shared conventions.
GET /rest-api/price-adjustment-rules/banner/condition-operators.do
Get condition operators.
No parameters beyond authentication.
Responses: 200 — Condition operators retrieved successfully. Errors follow the shared conventions.
GET /rest-api/price-adjustment-rules/banner/condition-subjects.do
Get condition subjects.
No parameters beyond authentication.
Responses: 200 — Condition subjects retrieved successfully. Errors follow the shared conventions.
GET /rest-api/price-adjustment-rules/banner/rule/{ruleId}.do
Get banner price adjustment rule by ID.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ruleId | path | integer | yes | Unique numeric identifier of the price adjustment rule |
Responses: 200 — Rule retrieved successfully · 404 — Rule not found. Errors follow the shared conventions.
DELETE /rest-api/price-adjustment-rules/banner/rule/{ruleId}/delete.do
Delete a banner price adjustment rule.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ruleId | path | integer | yes | Unique numeric identifier of the price adjustment rule to delete |
Responses: 200 — Rule deleted successfully · 404 — Rule not found. Errors follow the shared conventions.
POST /rest-api/price-adjustment-rules/banner/rule/{ruleId}/update.do
Update a banner price adjustment rule.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ruleId | path | integer | yes | Unique numeric identifier of the price adjustment rule |
actionType | form | string | no | Action type — MULTIPLY multiplies the gross by actionValue, SET sets the gross to actionValue Values: MULTIPLY, SET. |
actionValue | form | number | no | Action value — the numeric value for the action (e.g. 1.5 for multiply, 2.0 for set) |
conditionOperator | form | string | no | Condition operator — how to compare Values: IS. |
conditionSubject | form | string | no | Condition subject — what the rule checks Values: PLACEMENT. |
conditionValue | form | string | no | Condition value — the ID of the entity to match (e.g. placement ID) |
Responses: 200 — Rule updated successfully · 404 — Rule not found. Errors follow the shared conventions.
Related
- REST API overview — authentication and conventions
- API endpoint reference by tag
- Targeting, capping and limits via API
