Overview
This article contains the specification for Publisher API services available.
Introduction
Publisher API Services contain four API endpoints: Clients, Inventory, Operations and Settings. The Reporting services documentation is available here.
Specification
Client Services
For managing advertisers, agencies and sub-publishers.
Services
| URL | POST (create) | GET (read) | PUT (update) | DELETE |
|---|---|---|---|---|
| /publisher/v2/publishers/[PUBLISHER_ID]/agencies | create a new agency (pass JSON object and logo image optionally as a multipart file) Returns: HTTP 201 + JSON Errors: HTTP 400,403,500 + description |
list all agencies Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
FORBIDDEN
|
FORBIDDEN
|
| /publisher/v2/publishers/[PUBLISHER_ID]/agencies/[AGENCY_ID] |
FORBIDDEN
|
returns one agency Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update one agency Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
FORBIDDEN
|
| /publisher/v2/publishers/[PUBLISHER_ID]/agencies/[AGENCY_ID]/contacts |
create a new contact for a given agency (pass JSON object) Returns: HTTP 201 + JSON Errors: HTTP 400,403,500 + description |
list all contacts for a given agency Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
FORBIDDEN
|
FORBIDDEN
|
| /publisher/v2/publishers/[PUBLISHER_ID]/agencies/[AGENCY_ID]/contacts/[CONTACT_ID] |
FORBIDDEN
|
returns one contact Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update one contact Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
FORBIDDEN
|
| /publisher/v2/publishers/[PUBLISHER_ID]/agencies/[AGENCY_ID]/logo |
FORBIDDEN
|
returns one logo (only metadata) Returns: HTTP 200 + JSON Errors: HTTP 400, 403,404 + description |
update one logo as multipart file (pass JSON object and logo image mandatory) Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
FORBIDDEN
|
| /publisher/v2/publishers/[PUBLISHER_ID]/agencies/[AGENCY_ID]/logo/image |
FORBIDDEN
|
returns one logo as image or error message Returns: HTTP 200 + JSON Errors: HTTP 403,404, + description |
FORBIDDEN
|
FORBIDDEN
|
| /publisher/v2/publishers/[PUBLISHER_ID]/agencies/[AGENCY_ID]/advertisers |
FORBIDDEN
|
returns one agency's advertisers Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update one agency's advertisers Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
FORBIDDEN
|
| /publisher/v2/publishers/[PUBLISHER_ID]/advertisers | create a new advertiser (pass JSON object) Returns: HTTP 201 + JSON Errors: HTTP 400,403,500 + description |
list all advertisers Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
FORBIDDEN
|
FORBIDDEN
|
| /publisher/v2/publishers/[PUBLISHER_ID]/advertisers/[ADVERTISER_ID] |
FORBIDDEN
|
returns one advertiser Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update one advertiser Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
FORBIDDEN
|
| /publisher/v2/publishers/[PUBLISHER_ID]/advertisers/[ADVERTISER_ID]/contacts | create a new contact for a given advertiser (pass JSON object) Returns: HTTP 201 + JSON Errors: HTTP 400,403,500 + description |
list all contacts for a given advertiser Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
FORBIDDEN
|
FORBIDDEN
|
| /publisher/v2/publishers/[PUBLISHER_ID]/advertisers/[ADVERTISER_ID]/contacts/[CONTACT_ID] |
FORBIDDEN
|
returns one contact Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update one contact Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
FORBIDDEN
|
| /publisher/v2/publishers/[PUBLISHER_ID]/advertisers/[ADVERTISER_ID]/logo |
FORBIDDEN
|
returns one logo Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update one logo as multipart file (pass JSON object and logo image mandatory) Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
delete one logo Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
| /publisher/v2/publishers/[PUBLISHER_ID]/advertisers/[ADVERTISER_ID]/logo/image | FORBIDDEN Returns: HTTP 403 |
returns one logo as image or error message Returns: HTTP 200 + JSON Errors: HTTP 403,404, + description |
FORBIDDEN
|
FORBIDDEN
|
| /publisher/v2/publishers/[PUBLISHER_ID]/advertisers/[ADVERTISER_ID]/agencies |
FORBIDDEN
|
returns advertiser agencies Returns: HTTP 200 + JSON Errors: HTTP 403,404, + description |
update advertiser agencies Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
FORBIDDEN
|
| /publisher/v2/publishers/[PUBLISHER_ID]/subpublishers |
create a new subpublisher (pass JSON object) Returns: HTTP 201 + JSON Errors: HTTP 400,403,500 + description |
list all subpublishers Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
FORBIDDEN
|
FORBIDDEN
|
| /publisher/v2/publishers/[PUBLISHER_ID]/subpublishers/[SUBPUBLISHER_ID] |
FORBIDDEN
|
returns one subpublisher Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update one subpublisher Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
FORBIDDEN
|
| /publisher/v2/publishers/[PUBLISHER_ID]/subpublishers/[SUBPUBLISHER_ID]/logo |
FORBIDDEN
|
returns one logo Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update one logo as multipart file (pass JSON object and logo image mandatory) Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
delete one logo Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
| /publisher/v2/publishers/[PUBLISHER_ID]/subpublishers/[SUBPUBLISHER_ID]/logo/image |
FORBIDDEN
|
returns one logo content Accept header must provide image/{image_format} Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
FORBIDDEN
|
FORBIDDEN
|
| /publisher/v2/publishers/[PUBLISHER_ID]/subpublishers/[SUBPUBLISHER_ID]/sites |
links additional sites for a given subpublisher (pass JSON object) Returns: HTTP 201 + JSON/XMLErrors: HTTP 400,403,500 + description |
list all sites for a given subpublisher Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
FORBIDDEN
|
FORBIDDEN
|
| /publisher/v2/publishers/[PUBLISHER_ID]/subpublishers/[SUBPUBLISHER_ID]/sites/[SITE_ID] |
FORBIDDEN
|
Returns one site Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update one site Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
removes link between site and subpublisher Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
| /publisher/v2/publishers/[PUBLISHER_ID]/subpublishers/[SUBPUBLISHER_ID]/contacts |
create a new contact for a given subpublisher (pass JSON object) Returns: HTTP 201 + JSON Errors: HTTP 400,403,500 + description |
list all contacts for a given subpublisher Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
FORBIDDEN
|
FORBIDDEN
|
| /publisher/v2/publishers/[PUBLISHER_ID]/subpublishers/[SUBPUBLISHER_ID]/contacts/[CONTACT_ID] |
FORBIDDEN
|
returns one contact Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update one contact Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
FORBIDDEN |
Schema
| url |
|---|
| /schema/publisher/v2/agencies |
| /schema/publisher/v2/agencies/agency |
| /schema/publisher/v2/agencies/contacts |
| /schema/publisher/v2/agencies/contacts/contact |
| /schema/publisher/v2/agencies/logo |
| /schema/publisher/v2/agency/advertisers |
| /schema/publisher/v2/advertisers |
| /schema/publisher/v2/advertisers/advertiser |
| /schema/publisher/v2/advertisers/contacts |
| /schema/publisher/v2/advertisers/contacts/contact |
| /schema/publisher/v2/advertisers/logo |
| /schema/publisher/v2/advertiser/agencies |
| /schema/publisher/v2/subpublishers |
| /schema/publisher/v2/subpublishers/subpublisher |
| /schema/publisher/v2/subpublishers/subpublisher/logo |
| /schema/publisher/v2/subpublishers/sites |
| /schema/publisher/v2/subpublishers/sites/site |
| /schema/publisher/v2/subpublishers/contacts |
| /schema/publisher/v2/subpublishers/contacts/contact |
Inventory Services
For managing publisher inventory: channels, sites, zones and placements. Other features such as floor price control and advertiser blocklisting is available in Settings Services.
Services
| url | POST (create) | GET (read) | PUT (update) | DELETE |
|---|---|---|---|---|
| /publisher/v1/publishers/[PUBLISHER_ID]/channels | create a new channel (pass JSON object) Returns: HTTP 201 + JSON Errors: HTTP 400,403,500 + description |
list all channels Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
FORBIDDEN Returns: HTTP 403 |
FORBIDDEN Returns: HTTP 403 |
| /publisher/v1/publishers/[PUBLISHER_ID]/channels/[CHANNEL_ID] | FORBIDDEN Returns: HTTP 403 |
return one channel Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update one channel Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
delete one channel Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
| /publisher/v2/publishers/[PUBLISHER_ID]/channels/[CHANNEL_ID]/placements | FORBIDDEN Returns: HTTP 403 |
list all placements Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
update all placements Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
FORBIDDEN Returns: HTTP 403 |
| /publisher/v1/publishers/[PUBLISHER_ID]/inventories | create a new invenotry (pass JSON object) Returns: HTTP 201 + JSON Errors: HTTP 400,403,500 + description |
get all inventories Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
FORBIDDEN Returns: HTTP 403 |
FORBIDDEN Returns: HTTP 403 |
| /publisher/v1/publishers/[PUBLISHER_ID]/inventories/[INVENTORY_ID] | FORBIDDEN Returns: HTTP 403 |
get one inventory Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
update one inventory Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
delete one inventory Returns: HTTP 200 + JSON Errors: HTTP 400,403,404 + description |
| /publisher/v1/publishers/[PUBLISHER_ID]/inventories/[INVENTORY_ID]/tag | FORBIDDEN Returns: HTTP 403 |
return tag Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
FORBIDDEN Returns: HTTP 403 |
FORBIDDEN Returns: HTTP 403 |
| /publisher/v1/publishers/[PUBLISHER_ID]/inventories/[INVENTORY_ID]/zones/[ZONE_ID]/tag | FORBIDDEN Returns: HTTP 403 |
return tag Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
FORBIDDEN Returns: HTTP 403 |
FORBIDDEN Returns: HTTP 403 |
| /publisher/v1/publishers/[PUBLISHER_ID]/inventories/[INVENTORY_ID]/zones/[ZONE_ID]/placements/[PLACEMENT_ID]/tag | FORBIDDEN Returns: HTTP 403 |
return tag Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
FORBIDDEN Returns: HTTP 403 |
FORBIDDEN Returns: HTTP 403 |
| /publisher/v1/publishers/[PUBLISHER_ID]/inventories/[INVENTORY_ID]/zones | create a new zone (pass JSON object) Returns: HTTP 201 + JSON Errors: HTTP 400,403,500 + description |
get all zones Returns: HTTP 200 + JSON Errors: HTTP 400,403,500 + description |
FORBIDDEN Returns: HTTP 403 |
FORBIDDEN Returns: HTTP 403 |
| /publisher/v1/publishers/[PUBLISHER_ID]/inventories/[INVENTORY_ID]/zones/[ZONE_ID] | FORBIDDEN Returns: HTTP 403 |
get one zone Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
update one zone Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
delete one zone Returns: HTTP 200 + JSON Errors: HTTP 400,403,404 + description |
| /publisher/v1/publishers/[PUBLISHER_ID]/inventories/[INVENTORY_ID]/zones/[ZONE_ID]/placements | create a new placement (pass JSON object) Returns: HTTP 201 + JSON Errors: HTTP 400,403,500 + description |
get all placements Returns: HTTP 200 + JSON Errors: HTTP 400,403,500 + description |
FORBIDDEN Returns: HTTP 403 |
FORBIDDEN Returns: HTTP 403 |
| /publisher/v1/publishers/[PUBLISHER_ID]/inventories/[INVENTORY_ID]/zones/[ZONE_ID]/placements/[PLACEMENT_ID] | FORBIDDEN Returns: HTTP 403 |
get one placement Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
update one placement Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
delete one placement Returns: HTTP 200 + JSON Errors: HTTP 400,403,404 + description |
| /publisher/v1/publishers/[PUBLISHER_ID]/inventory-tag-setup | FORBIDDEN Returns: HTTP 403 |
return tag setup Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update tag setup Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
FORBIDDEN Returns: HTTP 403 |
| /publisher/v1/publishers/[PUBLISHER_ID]/placements | FORBIDDEN Returns: HTTP 403 |
return placements Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
FORBIDDEN Returns: HTTP 403 |
FORBIDDEN Returns: HTTP 403 |
Schema
| url |
|---|
| /schema/publisher/v1/inventories |
| /schema/publisher/v1/inventories/inventory |
| /schema/publisher/v1/publishers/inventories/inventory/zones |
| /schema/publisher/v1/publishers/inventories/inventory/zones/zone |
| /schema/publisher/v1/publishers/inventories/inventory/zones/zone/placements |
| /schema/publisher/v1/publishers/inventories/inventory/zones/zone/placements/placement |
| /schema/publisher/v1/channels |
| /schema/publisher/v1/channels/channel |
| /schema/publisher/v1/publishers/channels/channel/placements |
| /schema/publisher/v1/publishers/inventory-tag-setup |
| /schema/publisher/v1/publishers/inventories/inventory/zones/zone/placements/placement/tag |
| /schema/publisher/v1/publishers/placements |
| /schema/publisher/v2/sites |
Operations Services
Manage campaigns, line items and creatives which run on publisher inventory.
Services
| URL | POST (create) | GET (read) | PUT (update) | DELETE |
|---|---|---|---|---|
| /publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/creatives |
create a campaign creative Returns: HTTP 201 + JSON Errors: HTTP 401,403,404 + description |
get all campaign creatives Returns: HTTP 200 + JSON Errors: HTTP 401,403,404 + description |
FORBIDDEN Returns: HTTP 403 |
FORBIDDEN Returns: HTTP 403 |
| /publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/creatives/[CREATIVE_ID] | FORBIDDEN Returns: HTTP 403 |
get creative Returns: HTTP 200 + JSON Errors: HTTP 401,403,404 + description |
update creative Returns: HTTP 200 + JSON Errors: HTTP 401,403,404 + description |
delete creative Returns: HTTP 200 + JSON Errors: HTTP 401,403,404 + description |
| /publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/creatives/[CREATIVE_ID]/display | FORBIDDEN Returns: HTTP 403 |
get creative accept header: image/jpeg, image/png, image/gif for IMAGE. accept header: application/octet-stream for FLASH file Returns: HTTP 200 Errors: HTTP 401,403,404 + description |
FORBIDDEN Returns: HTTP 403 |
FORBIDDEN Returns: HTTP 403 |
| /publisher/v2/publishers/[PUBLISHER_ID]/campaigns | create campaign Returns: HTTP 201 + JSON Errors: HTTP 401,403,404 + description |
get campaigns Returns: HTTP 200 + JSON Errors: HTTP 401,403,404 + description |
FORBIDDEN Returns: HTTP 403 |
FORBIDDEN Returns: HTTP 403 |
| /publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID] | FORBIDDEN Returns: HTTP 403 |
get specific campaign Returns: HTTP 200 + JSON Errors: HTTP 401,403,404 + description |
update campaign Returns: HTTP 200 + JSON Errors: HTTP 401,403,404 + description |
delete campaign Returns: HTTP 200 + JSON Errors: HTTP 401,403,404 + description |
| /publisher/v2/publishers/[PUBLISHER_ID]/creative-types/[CREATIVE_TYPE_NAME]/sizes | FORBIDDEN Returns: HTTP 403 |
get creative sizes by creative type name (localized) Returns: HTTP 200 + JSON Errors: HTTP 401,403,404 + description |
FORBIDDEN Returns: HTTP 403 |
FORBIDDEN Returns: HTTP 403 |
| /publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/creatives/[CREATIVE_ID]/video-file-limelight-urls | FORBIDDEN Returns: HTTP 403 |
get video file limelight urls Returns: HTTP 200 + JSON Errors: HTTP 401,403,404 + description |
FORBIDDEN Returns: HTTP 403 |
FORBIDDEN Returns: HTTP 403 |
| /publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/tracking-pixels | FORBIDDEN Returns: HTTP 403 |
get tracking pixels Returns: HTTP 200 + JSON Errors: HTTP 401,403,404 + description |
FORBIDDEN Returns: HTTP 403 |
FORBIDDEN Returns: HTTP 403 |
| /publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/robot-fields/[ROBOT_ID] | FORBIDDEN Returns: HTTP 403 |
get allowed fields in robot FQN for a given robot Returns: HTTP 200 + JSON Errors: HTTP 401,403,404 + description |
FORBIDDEN Returns: HTTP 403 |
FORBIDDEN Returns: HTTP 403 |
| /publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/comments | create a comment Return: HTTP 201 + JSON Errors: 401, 403, 404 |
get comments of a campaign Returns: HTTP 200 + JSON Errors: HTTP 401,403,404 + description |
FORBIDDEN Returns: HTTP 403 |
FORBIDDEN Returns: HTTP 403 |
|
/publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/comments/ [COMMENT_ID] |
FORBIDDEN Error: HTTP 403 |
get identified comment Returns: HTTP 200 + JSON Errors: HTTP 401, 403, 404 + desc |
update given comment Returns: HTTP 200 + JSON Errors: HTTP 401, 403, 404 + desc |
delete campaign comment Returns: HTTP 200 + JSON Errors: HTTP 401,403,404 + description |
| /publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/line-items/[LINE_ITEM_ID] | FORBIDDEN Error: HTTP 403 |
get line item with the given id Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update line item with the given id Returns: HTTP 200 + JSON Errors: HTTP 403,404+ description |
set line item status to 'deleted' Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
| /publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/line-items | create line item Returns: HTTP 201 + JSON Errors: HTTP 403,404 + description |
get list of line items Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
FORBIDDEN Returns: HTTP 403 |
FORBIDDEN Returns: HTTP 403 |
| /publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/line-items/[LINEITEM_ID]/comments | create a comment Return: HTTP 201 + JSON Errors: 401, 403, 404 |
get comments of a campaign Returns: HTTP 200 + JSON Errors: HTTP 401,403,404 + desc |
FORBIDDEN Error: HTTP 403 |
FORBIDDEN Error: HTTP 403 |
| /publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/line-items/[LINEITEM_ID]/comments/[COMMENT_ID] | FORBIDDEN Error: HTTP 403 |
get identified comment Returns: HTTP 200 + JSON Errors: HTTP 401, 403, 404 + desc |
Update given comment Returns: HTTP 200 + JSON Errors: HTTP 401, 403, 404 + desc |
delete comment Returns: HTTP 200 + JSON Errors: HTTP 401, 403, 404 + desc |
| /publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/line-items/[LINE_ITEM_ID]/placements | FORBIDDEN Returns: HTTP 403 |
returns placements for line item with the given id Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update placements for line item with the given id Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
FORBIDDEN Returns: HTTP 403 |
|
/publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/line-items/ [LINE_ITEM_ID]/channels |
FORBIDDEN Returns: HTTP 403 |
returns channels for line item with the given id Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update channels for line item with the given id Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
FORBIDDEN Returns: HTTP 403 |
|
/publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/line-items/ [LINE_ITEM_ID]/available-channels |
FORBIDDEN Returns: HTTP 403 |
returns available channels for line item with the given id Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
FORBIDDEN Returns: HTTP 403 |
FORBIDDEN Returns: HTTP 403 |
|
/publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/line-item-buying-type/ [LINE_ITEM_BUYING_TYPE_NAME]/available-pixels |
FORBIDDEN Returns: HTTP 403 |
returns available pixels for line item with the given id Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
FORBIDDEN Returns: HTTP 403 |
FORBIDDEN Returns: HTTP 403 |
|
/publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/line-items/ [LINEITEM_ID]/browser-targeting |
FORBIDDEN Returns: HTTP 403 |
get line-item browser-targeting Returns: HTTP 200 + JSON Errors: HTTP 401,403,404 + description |
update line-item browser-targeting Returns: HTTP 200 + JSON Errors: HTTP 400,401,403,404 + description |
FORBIDDEN Returns: HTTP 403 |
|
/publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/line-items/ [LINEITEM_ID]/device-targeting |
FORBIDDEN Returns: HTTP 403 |
get line-item device-targeting Returns: HTTP 200 + JSON Errors: HTTP 401,403,404 + description |
update line-item device-targeting Returns: HTTP 200 + JSON Errors: HTTP 400,401,403,404 + description |
FORBIDDEN Returns: HTTP 403 |
|
/publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/line-items/ [LINEITEM_ID]/geo-targeting |
FORBIDDEN Returns: HTTP 404 |
get line-item geo-targeting Returns: HTTP 200 + JSON Errors: HTTP 401,403,404 + description |
update line-item geo-targeting Returns: HTTP 200 + JSON Errors: HTTP 400,401,403,404 + description |
FORBIDDEN Returns: HTTP 403 |
|
/publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/line-items/ LINEITEM_ID]/keyvalue-targeting |
FORBIDDEN Returns: HTTP 404 |
get keyvalue-targeting Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
update line-item keyvalue-targeting Returns: HTTP 200 + JSON Errors: HTTP 400,401,403,404 + description |
FORBIDDEN Returns: HTTP 403 |
|
/publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/line-items/ [LINEITEM_ID]/time-targeting |
FORBIDDEN Returns: HTTP 403 |
get line-item time-targeting Returns: HTTP 200 + JSON Errors: HTTP 401,403,404 + description |
update line-item time-targeting Returns: HTTP 200 + JSON Errors: HTTP 400,401,403,404 + description |
FORBIDDEN Returns: HTTP 403 |
|
/publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/line-items/ [LINEITEM_ID]/isp-targeting |
FORBIDDEN Returns: HTTP 403 |
get line-item isp-targeting Returns: HTTP 200 + JSON Errors: HTTP 401,403,404 + description |
update line-item isp-targeting Returns: HTTP 200 + JSON Errors: HTTP 400,401,403,404 + description |
FORBIDDEN Returns: HTTP 403 |
|
/publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/line-items/ [LINEITEM_ID]/reporting |
FORBIDDEN Returns: HTTP 403 |
get line-item reporting Returns: HTTP 200 + JSON Errors: HTTP 400,401,403,404 + description |
update line-item reporting Returns: HTTP 200 + JSON Errors: HTTP 400,401,403,404 + description |
FORBIDDEN Returns: HTTP 403 |
|
/publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/line-items/ [LINEITEM_ID]/creatives |
FORBIDDEN Returns: HTTP 403 |
get only assigned line-item creatives Returns: HTTP 200 + JSON Errors: HTTP 400,401,403,404 + description |
update line-item creatives Returns: HTTP 200 + JSON Errors: HTTP 400,401,403,404 + description |
FORBIDDEN Returns: HTTP 403 |
|
/publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/line-items/ [LINEITEM_ID]/line-item-bids |
create line-item bid Returns: HTTP 201 + JSON Errors: HTTP 401,403,404 + description |
get line-item bids Returns: HTTP 200 + JSON Errors: HTTP 401,403,404 + description |
FORBIDDEN Returns: HTTP 403 |
FORBIDDEN Returns: HTTP 403 |
| /publisher/v2/campaign-types | FORBIDDEN Returns: HTTP 403 |
get campaign types Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
FORBIDDEN Returns: HTTP 403 |
FORBIDDEN Returns: HTTP 403 |
|
/publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/sizes/[SIZE_ID]/ text-template |
FORBIDDEN Returns: HTTP 403 |
get text template for campaign Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
FORBIDDEN Returns: HTTP 403 |
FORBIDDEN Returns: HTTP 403 |
| /publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/robot-fields/[ROBOT_ID] | FORBIDDEN Returns: HTTP 403 |
get robot fields Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
FORBIDDEN Returns: HTTP 403 |
FORBIDDEN Returns: HTTP 403 |
|
/publisher/v2/publishers/[PUBLISHER_ID]/campaigns/[CAMPAIGN_ID]/line-items/ [LINEITEM_ID]/auction-ecpm |
FORBIDDEN Returns: HTTP 403 |
get acutionEcpm Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
FORBIDDEN Returns: HTTP 403 |
FORBIDDEN Returns: HTTP 403 |
Schema
| URL |
|---|
| /schema/publisher/v2/publishers/campaigns/creatives/creative |
| /schema/publisher/v2/publishers/campaigns/creatives |
| /schema/publisher/v2/publishers/campaigns/campaign |
| /schema/publisher/v2/publishers/campaigns |
| /schema/publisher/v2/publishers/creative-types/sizes |
| /schema/publisher/v2/publishers/campaigns/creatives/creative/video-file-limelight-urls |
| /schema/publisher/v2/publishers/campaigns/tracking-pixels |
| /schema/publisher/v2/publishers/campaigns/robot-fields |
| /schema/publisher/v2/publishers/campaigns/comments |
| /schema/publisher/v2/publishers/campaigns/comments/comment |
| /schema/publisher/v2/publishers/campaigns/line-items/line-item |
| /schema/publisher/v2/publishers/campaigns/line-items/comments |
| /schema/publisher/v2/publishers/campaigns/line-items/comments/comment |
| /schema/publisher/v2/publishers/campaigns/line-items/channels |
| /schema/publisher/v2/publishers/campaigns/line-items/available-channels |
| /schema/publisher/v2/publishers/campaigns/line-items/pixels |
| /schema/publisher/v2/publishers/campaigns/line-items/browser-targeting |
| /schema/publisher/v2/publishers/campaigns/line-items/device-targeting |
| /schema/publisher/v2/publishers/campaigns/line-items/geo-targeting |
| /schema/publisher/v2/publishers/campaigns/line-items/keyvalue-targeting |
| /schema/publisher/v2/publishers/campaigns/line-items/time-targeting |
| /schema/publisher/v2/publishers/campaigns/line-items/creatives |
| /schema/publisher/v2/publishers/campaigns/line-items/reporting |
| /schema/publisher/v2/publishers/campaigns/line-items/line-item-bids |
| /schema/publisher/v2/publishers/campaigns/sizes/template |
| /schema/publisher/v2/publishers/campaigns/robot-fields |
| /schema/publisher/v2/publishers/campaigns/line-items/line-item-bids/line-item-bid |
| /schema/publisher/v2/publishers/campaigns/line-items/auction-ecpm |
Settings Services
Managing pricing control rules, auction rules, transparency rules, keyvalues, biases, products and subproducts and blocklists.
Services
Settings services contain set of API endpoints for managing:
- Pricing control rules
- Auction rules
- Transparency rules
- Keyvalues
- Biases
- Products and Subproducts
- Blocklist
| URL | POST (create) | GET (read) | PUT (update) | DELETE |
|---|---|---|---|---|
| /publisher/v2/publishers/[PUBLISHER_ID]/pricing-control-rules | create a new pricing control rule(pass JSON object) Returns: HTTP 201 + JSON Errors: HTTP 400,403,500 + description Returns: HTTP 403 |
list all pricing control rules Returns: HTTP 200 + JSON list all pricing control rules Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
NOT ALLOWED Returns: HTTP 405 |
NOT ALLOWED Returns: HTTP 405 |
| /publisher/v2/publishers/[PUBLISHER_ID]/pricing-control-rules/[RULE_ID] | NOT ALLOWED Returns: HTTP 405 |
returns one pricing control rule Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update one pricing control rule Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
delete one pricing control rule Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
| /publisher/v2/publishers/[PUBLISHER_ID]/pixels | create a new pixel (pass JSON object) Returns: HTTP 201 + JSON Errors: HTTP 400,403,500 + description |
list of pixels Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
NOT ALLOWED Returns: HTTP 405 |
NOT ALLOWED Returns: HTTP 405 |
| /publisher/v2/publishers/[PUBLISHER_ID]/pixels/[PIXEL_ID] | NOT ALLOWED Returns: HTTP 405 |
return one pixel Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update one pixel Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
delete one pixel Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
| /publisher/v2/publishers/[PUBLISHER_ID]/biases | create a new bias(pass JSON object) Returns: HTTP 201 + JSON Errors: HTTP 400,403,500 + description |
list all biases Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
NOT ALLOWED Returns: HTTP 403 |
NOT ALLOWED Returns: HTTP 403 |
| /publisher/v2/publishers/[PUBLISHER_ID]/biases/[BIAS_ID] | NOT ALLOWED Returns: HTTP 403 |
returns one bias Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update one bias Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
delete one bias Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
| /publisher/v2/publishers/[PUBLISHER_ID]/biases/tp/[TECHNICAL_PROVIDER_ID]/available-tp-buyers | NOT ALLOWED Returns: HTTP 403 |
list all available technical provider buyers for bias for given tecnical provider id Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
NOT ALLOWED Returns: HTTP 403 |
NOT ALLOWED Returns: HTTP 403 |
| /publisher/v2/publishers/[PUBLISHER_ID]/keyvalues | create a new keyvalue (pass JSON object) Returns: HTTP 201 + JSON Errors: HTTP 400,403,500 + description |
list all keyvalues Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
NOT ALLOWED Returns: HTTP 405 |
NOT ALLOWED Returns: HTTP 405 |
| /publisher/v2/publishers/[PUBLISHER_ID]/keyvalues/[KEYVALUE_ID] | NOT ALLOWED Returns: HTTP 405 |
returns one keyvalue Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update one keyvalue Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
delete one keyvalue Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
| /publisher/v2/publishers/[PUBLISHER_ID]/auction-rules | create a new auction rule (pass JSON object) Returns: HTTP 201 + JSON Errors: HTTP 400,403,500 + description |
list of auction rules Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
NOT ALLOWED Returns: HTTP 405 |
NOT ALLOWED Returns: HTTP 405 |
| /publisher/v2/publishers/[PUBLISHER_ID]/auction-rules/[AUCTION_RULE_ID] | NOT ALLOWED Returns: HTTP 405 |
return one auction rule Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update one auction rule Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
delete one auction rule Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
| /publisher/v2/publishers/[PUBLISHER_ID]/auction-rule-buying-entities | NOT ALLOWED Returns: HTTP 405 |
list of buying entities available for Auction Rules Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
NOT ALLOWED Returns: HTTP 405 |
NOT ALLOWED Returns: HTTP 405 |
|
/publisher/v2/publishers/[PUBLISHER_ID]/auction-rule-buying-entities/[BUYING_ENTITY_ID]/ auction-rule-buying-entity-offices |
NOT ALLOWED Returns: HTTP 403 |
list of buying entity offices available for Auction Rules for given BuyingEntity Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
NOT ALLOWED Returns: HTTP 403 |
NOT ALLOWED Returns: HTTP 403 |
| /publisher/v2/publishers/[PUBLISHER_ID]/transparency-rules | create a new transparency rule (pass JSON object) Returns: HTTP 201 + JSON Errors: HTTP 400,403,500 + description |
list of transparency rules Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
NOT ALLOWED Returns: HTTP 405 |
NOT ALLOWED Returns: HTTP 405 |
| /publisher/v2/publishers/[PUBLISHER_ID]/transparency-rules/[TRANSPARENCY_RULE_ID] | NOT ALLOWED Returns: HTTP 405 |
return one transparency rule Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update one transparency rule Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
delete one transparency rule Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
| /publisher/v2/publishers/[PUBLISHER_ID]/transparency-buying-entities | NOT ALLOWED Returns: HTTP 405 |
list of buying entities for publisher Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
NOT ALLOWED Returns: HTTP 405 |
NOT ALLOWED Returns: HTTP 405 |
| /publisher/v2/publishers/[PUBLISHER_ID]/transparency-buying-entities/[BUYING_ENTITY_ID]/transparency-buying-entity-offices | NOT ALLOWED Returns: HTTP 405 |
list of buying entity offices Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
NOT ALLOWED Returns: HTTP 405 |
NOT ALLOWED Returns: HTTP 405 |
| /publisher/v2/publishers/[PUBLISHER_ID]/transparency-rule/buying-entity-office/[BUYING_ENTITY_OFFICE_ID]/available-placements | NOT ALLOWED Returns: HTTP 405 |
list of available placements for chosen transparency rule and buying entity office Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
NOT ALLOWED Returns: HTTP 405 |
NOT ALLOWED Returns: HTTP 405 |
| /publisher/v2/publishers/[PUBLISHER_ID]/transparency-rule-site-placements | NOT ALLOWED Returns: HTTP 405 |
list of site-placements for transparency rules Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
NOT ALLOWED Returns: HTTP 405 |
NOT ALLOWED Returns: HTTP 405 |
| /publisher/v2/publishers/[PUBLISHER_ID]/products | create a new product (pass JSON object) of a publisher Returns: HTTP 201 + JSON Errors: HTTP 400,403,500 + description |
list all of products a publisher Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
NOT ALLOWED Returns: HTTP 404 |
NOT ALLOWED Returns: HTTP 404 |
| /publisher/v2/publishers/[PUBLISHER_ID]/products/[PRODUCT_ID] | NOT ALLOWED Returns: HTTP 404 |
return one product of a publisher Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update one product of a publisher Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
delete one product of a publisher Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
| /publisher/v2/publishers/[PUBLISHER_ID]/products/[PRODUCT_ID]/subproducts | create a new subproduct (pass JSON object) of a publisher's product Returns: HTTP 201 + JSON Errors: HTTP 400,403,500 + description |
list all of subproducts of a publisher's product Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
NOT ALLOWED Returns: HTTP 404 |
NOT ALLOWED Returns: HTTP 404 |
| /publisher/v2/publishers/[PUBLISHER_ID]/products/[PRODUCT_ID]/subproducts/[SUBPRODUCT_ID] | NOT ALLOWED Returns: HTTP 404 |
return one subproduct of a publisher's product Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update one subproduct of a publisher's product Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
delete one subproduct of a publisher's product Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
| /publisher/v2/publishers/[PUBLISHER_ID]/technical-provider-buyer-rtb-advertisers | NOT ALLOWED Returns: HTTP 403 |
list of all technical provider buyer RTB Advertiser Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
NOT ALLOWED Returns: HTTP 403 |
NOT ALLOWED Returns: HTTP 403 |
| /publisher/v2/publishers/[PUBLISHER_ID]/technical-providers | NOT ALLOWED Returns: HTTP 403 |
list all of all technical providers Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
NOT ALLOWED Returns: HTTP 403 |
NOT ALLOWED Returns: HTTP 403 |
| /publisher/v2/publishers/[PUBLISHER_ID]/blocklists | create a new blocklists(pass JSON object) Returns: HTTP 201 + JSON Errors: HTTP 400,403,500 + description |
list all blocklists Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
NOT ALLOWED Returns: HTTP 405 |
NOT ALLOWED Returns: HTTP 405 |
| /publisher/v2/publishers/[PUBLISHER_ID]/blocklists/[BLOCKLIST_ID] | NOT ALLOWED Returns: HTTP 405 |
returns one blocklists Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update one blocklists Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
delete one blocklists Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
| /publisher/v2/publishers/[PUBLISHER_ID]/blocklists/[BLOCKLIST_ID]/sites | Invoke when you want to ADD new blocklist sites to existing list of blocklist sites. Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
returns sites for blocklist with the given id (in case blocklist is "all_sites" returns all publisher sites). Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update sites for blocklist with the given id Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
Invoke when you want to DELETE supplied blocklist sites from existing list of blocklist sites. Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
| /publisher/v2/publishers/[PUBLISHER_ID]/blocklists/[BLOCKLIST_ID]/ad-types | Invoke when you want to ADD new blocklist ad-types to existing list of blocklist ad-types. Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
returns ad types for blocklist with the given id Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update ad types for blocklist with the given id Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
Invoke when you want to DELETE supplied blocklist ad-types from existing list of blocklist ad-types. Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
| /publisher/v2/publishers/[PUBLISHER_ID]/blocklists/[BLOCKLIST_ID]/categories | Invoke when you want to ADD new blocklist categories to existing list of blocklist categories. Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
returns categories for blocklist with the given id Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update categories for blocklist with the given id Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
Invoke when you want to DELETE supplied blocklist categories from existing list of blocklist categories. Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
| /publisher/v2/publishers/[PUBLISHER_ID]/blocklists/[BLOCKLIST_ID]/advertisers | Invoke when you want to ADD new blocklist advertisers to existing list of blocklist advertisers. Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
returns advertisers for blocklist with the given id Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update advertisers for blocklist with the given id Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
Invoke when you want to DELETE supplied blocklist advertisers from existing list of blocklist advertisers. Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
| /publisher/v2/publishers/[PUBLISHER_ID]/blocklists/[BLOCKLIST_ID]/selected-urls | Invoke when you want to ADD new blocklist selected-urls to existing list of blocklist selected-urls. Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
returns selected urls for blocklist with the given id Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update selected urls for blocklist with the given id Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
Invoke when you want to DELETE supplied blocklist selected-urls from existing list of blocklist selected-urls. Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
| /publisher/v2/publishers/[PUBLISHER_ID]/blocklists/[BLOCKLIST_ID]/available-advertisers | NOT ALLOWED Returns: HTTP 403 |
retrieve list of advertisers that are available to be selected for given [PUBLISHER_ID] and [BLOCKLIST_ID]: Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
NOT ALLOWED Returns: HTTP 403 |
NOT ALLOWED Returns: HTTP 403 |
| /publisher/v2/publishers/[PUBLISHER_ID]/blocklists/[BLOCKLIST_ID]/available-advertiser-urls | NOT ALLOWED Returns: HTTP 403 |
retrieve list of advertiser URLs that are available to be selected for given [PUBLISHER_ID] and [BLOCKLIST_ID]: Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
NOT ALLOWED Returns: HTTP 403 |
NOT ALLOWED Returns: HTTP 403 |
| /publisher/v1/publishers/[PUBLISHER_ID]/technical-provider-brand-urls | NOT ALLOWED Returns: HTTP 403 |
returns list of technical provider brand urls Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
NOT ALLOWED Returns: HTTP 403 |
NOT ALLOWED Returns: HTTP 403 |
| /publisher/v2/publishers/[PUBLISHER_ID]/blocklists/[BLOCKLIST_ID]/urls | create a new url for given blocklist(pass JSON object) Returns: HTTP 201 + JSON Errors: HTTP 400,403,500 + description |
list all urls for given blocklist Returns: HTTP 200 + JSON Errors: HTTP 403,500 + description |
NOT ALLOWED Returns: HTTP 405 |
NOT ALLOWED Returns: HTTP 405 |
| /publisher/v2/publishers/[PUBLISHER_ID]/blocklists/[BLOCKLIST_ID]/urls/[BLOCKLISTURL_ID] | NOT ALLOWED Returns: HTTP 405 |
returns one blocklist url Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
update one blocklist url Returns: HTTP 200 + JSON Errors: HTTP 400,403,404,500 + description |
delete one blocklist url Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
| /publisher/v2/publishers/[PUBLISHER_ID]/blocklists/available-sites | NOT ALLOWED Returns: HTTP 405 |
returns available sites (if there is "all_sites" blocklist for publisher this will return an empty list) Returns: HTTP 200 + JSON Errors: HTTP 403,404 + description |
NOT ALLOWED Returns: HTTP 405 |
NOT ALLOWED Returns: HTTP 405 |
Schema
| url |
|---|
| /schema/publisher/v2/pricing-control-rules |
| /schema/publisher/v2/pricing-control-rules/pricing-control-rule |
| /schema/publisher/v2/pixels |
| /schema/publisher/v2/pixels/pixel |
| /schema/publisher/v2/biases |
| /schema/publisher/v2/biases/bias |
| /schema/publisher/v2/biases/available-tp-buyers |
| /schema/publisher/v2/keyvalues |
| /schema/publisher/v2/keyvalues/keyvalue |
| /schema/publisher/v2/auction-rules |
| /schema/publisher/v2/auction-rules/auction-rule |
| /schema/publisher/v2/auction-rule-buying-entities |
| /schema/publisher/v2/auction-rule-buying-entity-offices |
| /schema/publisher/v2/transparency-rules |
| /schema/publisher/v2/transparency-rules/transparency-rule |
| /schema/publisher/v2/transparency-buying-entities |
| /schema/publisher/v2/transparency-buying-entity-offices |
| /schema/publisher/v1/transparency-rule/available-placements |
| /schema/publisher/v2/transparency-rule-site-placements |
| /schema/publisher/v2/products |
| /schema/publisher/v2/product |
| /schema/publisher/v2/subproducts |
| /schema/publisher/v2/subproduct |
| /schema/publisher/v2/technical-provider-buyer-rtb-advertisers |
| /schema/publisher/v2/technical-providers |
| /schema/publisher/v2/buyers |
| /schema/publisher/v2/blocklists |
| /schema/publisher/v2/blocklists/blocklist |
| /schema/publisher/v2/blocklists/sites |
| /schema/publisher/v2/blocklists/ad-types |
| /schema/publisher/v2/blocklists/categories |
| /schema/publisher/v2/blocklists/advertisers |
| /schema/publisher/v2/blocklists/selected-urls |
| /schema/publisher/v2/blocklists/available-advertisers |
| /schema/publisher/v2/blocklists/available-advertiser-urls |
| /schema/publisher/v1/technical-provider-brand-urls |
| /schema/publisher/v2/blocklists/urls |
| /schema/publisher/v2/blocklists/urls/url |
| /schema/publisher/v2/blocklists/available-sites |