Targeting, capping and limits via API
Where to find the targeting dimensions and their create parameters, the six entity levels, capping types and subjects, the daily/weekly/monthly/total limit grid, per-action limits, price adjustment rules and bid floors.
Delivery control — targeting rules, capping, limits, bid floors and CPM floor rates, and price
adjustment rules — is the largest part of the REST API, more than half of its operations, and it
is almost entirely regular: once you know the pattern for one entity
level you know it for all six. The examples on the pages below append
$AUTH, the hash-authentication parameters (an X-Api-Key
header works the same) — see the API overview for authentication. Each page links
its calls to the generated reference, which lists every field with a description and an example
request.
Who this is for
Developers who script delivery control for a network — network managers, and publisher or advertiser users whose role holds the permissions named below. The calls behave the same for every role; what differs is which entities and dimensions your role may change.
Pages in this reference
| Page | What it covers | Permission to manage it |
|---|---|---|
| Targeting rules via API | The endpoint pattern shared by the six entity levels, the 41 dimensions and their create parameters, rules, permissions, value lookups, examples, preset groups, category rules | Manage Demand Targeting (advertiser, campaign, banner) or Manage Supply Pre-targeting (site, zone, placement) |
| Frequency capping via API | The capping types, typed and generic endpoint families, subjects | Manage Capping & Limitations; Manage Inventory Capping for placements |
| Delivery limits via API | The limit grid, reading back, resetting counters, bulk reads, site and placement limits, per-action limits | Manage Capping & Limitations; Manage Site and Placement Limits on the supply side |
| Price rules, bid floors and pricing via API | Price adjustment rules, bid floors, CPM floor rates and entity-pricing corner cases | Manage Price Adjusting; Bid Floor Management |
Every page needs, on top of the permission, UPDATE access to the entity you change — through campaign sharing on the demand side and inventory sharing on the supply side. Each page lists the finer per-dimension and per-cap permissions.
Related
- API overview
- Entities CRUD
- Targeting rules via API
- Frequency capping via API
- Delivery limits via API
- Price rules, bid floors and pricing via API
- Generated reference: targeting rules, capping, limits, pricing
- Targeting dimensions reference
- Capping matrix
- Add targeting (UI guide)
- Frequency capping (UI guide)
- Limits (UI guide)
- Price adjustment rules (UI guide)
