New Publisher Deal
POST {{campaign_url}}/publisherDeals?marketId=1
Create a new publisher deal
You can create a new publisher deal by sending this POST request. To define settings for your deal, open the body tab and edit the JSON object.
For DTO field contacts, see the corresponding DTO table below to customize the data.
Request Body (Definitions)
*Optional element
| JSON Object Key | Description | Type |
|---|---|---|
| dealType | Type of publisher deal. Private auction: For an invite-only auction at pre-negotiated floor price. Unreserved fixed: For unreserved impressions at pre-negotiated fixed price. Guaranteed: For reserved impressions at pre-negotiated fixed price. Allowed values: privateAuction, unreservedFixed, guaranteed | string |
| automaticDeal (Not available if dealType is guaranteed) | Indicates if this deal should automatically be added to new packages/line items for targeting. | boolean |
| preferred | Indicates if the inventory sources in this deal are curated by the Nexxen business development team. | boolean |
| advertiserIds | ID(s) of the advertiser(s) to which this deal should be made available. Set to an empty array to denote all advertisers. | comma-separated array of strings |
| dealId | ID of this deal. User-defined. | string |
| dealName | Name of this deal. | string |
| mediaFormat | Media format supported by this deal. Must match the media format(s) supported by the specified inventorySourceId. Allowed values: display, video, audio | string |
| inventorySourceId | ID of the inventory source for this deal. Allowed values | string |
| publisherName | Name of the publisher with which this deal was negotiated. User-defined. | string |
| hdCreativeRequired (Only available if mediaFormat is video) | Indicates if this deal requires high-definition creatives. | boolean |
| currency | Currency used for this deal. Allowed values | string |
| price | CPM price for this deal. | double |
| *startDate (Only required if dealType is guaranteed) | Start date of the deal's active period. Must be in the format yyyy-mm-ddThh:mm:ss+offset. | string |
| *endDate (Only required if dealType is guaranteed) | End date of the deal's active period. Must be in the format yyyy-mm-ddThh:mm:ss+offset. | string |
| *impressions | Number of impressions negotiated. | double |
| *otherInfo | Additional information for this deal. | string |
| contacts (Only available if dealType is guaranteed) | Contact details for this deal. | comma-separated array containing one or more contact DTOs |
contact DTO
| Key | Description | Type |
|---|---|---|
| Email of the primary/secondary contact. | string | |
| name | Name of the primary/secondary contact. | string |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
marketId | number | Numeric ID associated with the market for which the publisher deal is being created. Required only if you have access to multiple markets. |
Request Body
{"dealType"=>"privateAuction", "automaticDeal"=>false, "preferred"=>false, "advertiserIds"=>["{{advertiserId}}"], "dealId"=>"tester 1", "dealName"=>"doc test", "mediaFormat"=>"display", "inventorySourceId"=>"1", "publisherName"=>"test publisher", "hdCreativeRequired"=>false, "currency"=>"usd", "price"=>1.0, "startDate"=>"2022-08-01T00:00:00Z", "endDate"=>"2022-10-01T00:00:00Z", "impressions"=>3, "otherInfo"=>"additional info here", "contacts"=>[{"email"=>"primary@email.com", "name"=>"primary contact"}]}
RESPONSES
status: Created
{"data":[{"id":"1608775141","marketId":"-1","resourceType":"publisherDeal","workflowStatus":"approved","createdAt":"2022-08-23T03:38:50Z","updatedAt":"2022-08-23T03:38:50Z","dealType":"privateAuction","advertiserIds":[],"dealId":"docID","dealName":"doc team deal","mediaFormat":"display","inventorySourceId":"1","publisherName":"test publisher","currency":"usd","price":1,"startDate":"2022-07-31T04:00:00Z","endDate":"2022-10-01T03:59:59Z","impressions":3,"otherInfo":"additional info here","hdCreativeRequired":false,"preferred":true}],"errors":[]}