Header Bidding API endpoints
Endpoint reference for the Header Bidding tag (9 endpoints): Header-bidding page tags: slots, refresh and Google Ad Manager settings, and the code a page carries
Header-bidding page tags: slots, refresh and Google Ad Manager settings, and the code a page carries. 9 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/hb-tags.do
List header-bidding tags.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
siteId | query | integer | no | Only the tags of this site |
limit | query | integer | no | How many tags to return, 1-500 |
Responses: 200 — {data: [tag], total, more}. Errors follow the shared conventions.
POST /rest-api/hb-tags.do
Create a header-bidding tag.
Request body (application/json, required): JSON object with fields active, adServerWithoutConsent, allowZeroCpmBids, bidTimeoutMs, bidderCode, collapseEmpty, domain, id, integration, loadInViewOnly, name, ourDemandFirst, prebidGlobal, refreshForegroundOnly, refreshIdleMinutes, refreshInViewOnly, refreshSeconds, setDocumentLanguage, siteId, slots — The tag.
Responses: 200 — {data: tag, code, ignoredFields, ignoredFieldReasons}. Errors follow the shared conventions.
GET /rest-api/hb-tags/{tagId}.do
Get a header-bidding tag by id.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
tagId | path | integer | yes | Unique numeric ID of the tag |
Responses: 200 — {data: tag, code: {script, containers, gamKeys}} · 404 — Tag not found or deleted. Errors follow the shared conventions.
POST /rest-api/hb-tags/{tagId}.do
Update a header-bidding tag.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
tagId | path | integer | yes | Unique numeric ID of the tag |
Request body (application/json, required): JSON object with fields active, adServerWithoutConsent, allowZeroCpmBids, bidTimeoutMs, bidderCode, collapseEmpty, domain, id, integration, loadInViewOnly, name, ourDemandFirst, prebidGlobal, refreshForegroundOnly, refreshIdleMinutes, refreshInViewOnly, refreshSeconds, setDocumentLanguage, siteId, slots — Only the fields to change.
Responses: 200 — {data: tag, code, ignoredFields, ignoredFieldReasons} · 404 — Tag not found or deleted. Errors follow the shared conventions.
DELETE /rest-api/hb-tags/{tagId}.do
Delete a header-bidding tag.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
tagId | path | integer | yes | Unique numeric ID of the tag |
Responses: 200 — Deleted · 404 — Tag not found or deleted. Errors follow the shared conventions.
GET /rest-api/hb-tags/ad-units.do
List ad units (sizes) for header-bidding slots.
No parameters beyond authentication.
Responses: 200 — {data: [adUnit], total}. Errors follow the shared conventions.
GET /rest-api/hb-tags/bidders.do
List Prebid bidders a header-bidding slot can carry.
No parameters beyond authentication.
Responses: 200 — {data: [bidder], total}. Errors follow the shared conventions.
GET /rest-api/hb-tags/domains.do
List serving domains for header-bidding tags.
No parameters beyond authentication.
Responses: 200 — {data: [{domain, cdnDomain, isDefault}], total}. Errors follow the shared conventions.
GET /rest-api/hb-tags/placements.do
List placements a header-bidding slot can use.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
siteId | query | integer | yes | Unique numeric ID of the site |
Responses: 200 — {data: [placement], total}. Errors follow the shared conventions.
Related
- REST API overview — authentication and conventions
- API endpoint reference by tag
