A DirectDeals resource is used to communicate an account's currently active direct deals. Direct deals are configured by publishers through the Direct Deals Marketplace. The API provides a read-only interface for retrieving all direct deals relevant to an account.
For a list of methods for this resource, see the end of this page.
Resource representations
The configuration data for an Ad Exchange direct deal.
{ "kind": "adexchangebuyer#directDeal", "id": long, "name": string, "accountId": integer, "sellerNetwork": string, "advertiser": string, "fixedCpm": long, "privateExchangeMinCpm": long, "currencyCode": string, "startTime": long, "endTime": long, "publisherBlocksOverriden": boolean, "dealTier": string, "allowsAlcohol": boolean, "buyerAccountId": long }
Property name | Value | Description | Notes |
---|---|---|---|
accountId |
integer |
The account ID of the buyer this deal is for. | |
advertiser |
string |
The name of the advertiser this deal is for. | |
allowsAlcohol |
boolean |
Whether the publisher for this deal is eligible for alcohol ads. | |
buyerAccountId |
long |
The account id that this deal was negotiated for. It is either the buyer or the client that this deal was negotiated on behalf of. | |
currencyCode |
string |
The currency code that applies to the fixedCpm value. If not set then assumed to be USD. |
|
dealTier |
string |
The deal type such as programmatic reservation or fixed price and so on.
Acceptable values are:
|
|
endTime |
long |
End time for when this deal stops being active. If not set then this deal is valid until manually disabled by the publisher. In seconds since the epoch. | |
fixedCpm |
long |
The fixed price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price). | |
id |
long |
Deal ID. | |
kind |
string |
Resource type. This is always "adexchangebuyer#directDeal" . |
|
name |
string |
Deal name. | |
privateExchangeMinCpm |
long |
The minimum price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the private exchange tier of buying (below fixed price priority, run as a second price auction). | |
publisherBlocksOverriden |
boolean |
If true, the publisher has opted to have their blocks ignored when a creative is bid with for this deal. | |
sellerNetwork |
string |
The name of the publisher offering this direct deal. | |
startTime |
long |
Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch. |
Methods
- get
- Gets one direct deal by ID.
- list
- Retrieves the authenticated user's list of direct deals. Also retrieves all direct deals for the authenticated user's RTB account buyer seats.