Advertiser Price Adjustment Rules API endpoints
Endpoint reference for the Advertiser Price Adjustment Rules tag (10 endpoints): Price adjustment rule management for advertisers
Price adjustment rule management for advertisers. 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/advertiser/{entityId}/create.do
Create an advertiser price adjustment rule.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
entityId | path | integer | yes | Unique numeric identifier of the advertiser |
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 — Successful operation · 404 — Not found — resource does not exist. Errors follow the shared conventions.
POST /rest-api/price-adjustment-rules/advertiser/{entityId}/disable.do
Disable advertiser price adjusting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
entityId | path | integer | yes | Unique numeric identifier of the advertiser |
Responses: 200 — Successful operation · 404 — Not found — resource does not exist. Errors follow the shared conventions.
POST /rest-api/price-adjustment-rules/advertiser/{entityId}/enable.do
Enable advertiser price adjusting.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
entityId | path | integer | yes | Unique numeric identifier of the advertiser |
Responses: 200 — Successful operation · 404 — Not found — resource does not exist. Errors follow the shared conventions.
GET /rest-api/price-adjustment-rules/advertiser/{entityId}/list.do
List advertiser price adjustment rules.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
entityId | path | integer | yes | Unique numeric identifier of the advertiser |
Responses: 200 — Successful operation · 404 — Not found — resource does not exist. Errors follow the shared conventions.
GET /rest-api/price-adjustment-rules/advertiser/action-types.do
Get action types.
No parameters beyond authentication.
Responses: 200 — Successful operation. Errors follow the shared conventions.
GET /rest-api/price-adjustment-rules/advertiser/condition-operators.do
Get condition operators.
No parameters beyond authentication.
Responses: 200 — Successful operation. Errors follow the shared conventions.
GET /rest-api/price-adjustment-rules/advertiser/condition-subjects.do
Get condition subjects.
No parameters beyond authentication.
Responses: 200 — Successful operation. Errors follow the shared conventions.
GET /rest-api/price-adjustment-rules/advertiser/rule/{ruleId}.do
Get advertiser price adjustment rule by ID.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ruleId | path | integer | yes | Unique numeric identifier of the price adjustment rule |
Responses: 200 — Successful operation · 404 — Not found — resource does not exist. Errors follow the shared conventions.
DELETE /rest-api/price-adjustment-rules/advertiser/rule/{ruleId}/delete.do
Delete an advertiser price adjustment rule.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ruleId | path | integer | yes | Unique numeric identifier of the price adjustment rule to delete |
Responses: 200 — Successful operation · 404 — Not found — resource does not exist. Errors follow the shared conventions.
POST /rest-api/price-adjustment-rules/advertiser/rule/{ruleId}/update.do
Update an advertiser 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 — Successful operation · 404 — Not found — resource does not exist. Errors follow the shared conventions.
Related
- REST API overview — authentication and conventions
- API endpoint reference by tag
- Targeting, capping and limits via API
