See the overview for an explanation of format.
Field
Required
Type
Writable
Description
Product Id
No
integer
No
Numeric ID value of the media product.
Plan Id
No
integer
No
Numeric ID value of the media proposal.
Campaign Id
No
integer
No
Name
Yes
string
Yes
The name of the entry.
Type
No
string
No
Type of the media product.
- Open Auction Display
- Open Auction Audio
- Open Auction Video
- Youtube TrueView In-stream
- Youtube TrueView Discovery
- Youtube TrueView Bumper
- Youtube TrueView Reach
- Google Preferred Bumper
- Google Preferred Short
- Google Preferred Long
- Standard Reserve Short
- Standard Reserve Long
- Non-skippable In-stream
- Private (Publisher)
- Private (Inventory source)
- Private (Negotiation)
Start Date
No
string
No
The start date of the media product in the format MM/DD/YYYY HH:mm
End Date
No
string
No
The end date of the media product in the format MM/DD/YYYY HH:mm
Budget
No
float
No
A positive budget amount for the media product. It is always a float for a currency amount since it will be always monetary budget. Currencies will be shown in the advertiser's currency in standard units (not in 1/1,000,000s of a currency unit)
Frequency Enabled
Yes
string
Yes
Frequency Exposures
Required when "Frequency Enabled" is "TRUE"
integer
Yes
A positive integer amount for the number of impressions in a given Frequency Amount, that is, the x in 'Show x impressions over y period'.
Frequency Period
Required when "Frequency Enabled" is "TRUE"
string
Yes
- Minutes
- Hours
- Days
- Weeks
- Months
- Lifetime
Frequency Amount
Required when "Frequency Enabled" is "TRUE"
integer
Yes
Geography Targeting - Include
No
string, list
Yes
Language Targeting - Include
No
string, list
Yes
Language Targeting - Exclude
No
string, list
Yes
Channel Targeting - Include
No
string, list
Yes
List of channels
to include in targeting. List format = (UniversalChannel.id;UniversalChannel.id; etc.).
Channel Targeting - Exclude
No
string, list
Yes
List of channels
to include in targeting. List format = (UniversalChannel.id;UniversalChannel.id; etc.).
Category Targeting - Include
No
string, list
Yes
List of categories to include in targeting, from AdX vertical IDs
. List format = (Verticals.Id;Verticals.Id;etc.).
Category Targeting - Exclude
No
string, list
Yes
List of categories to exclude in targeting, from AdX vertical IDs
. List format = (Verticals.Id;Verticals.Id;etc.).
Audience Targeting - Include
No
string, list of list of pairs
Yes
List of audience lists
to include in targeting. For first-party audience lists, each audience is listed as a pair of UserList ID and recency setting. A pair is (1;1d;), where 1d is a sample recency representing 1 day recency. Recency is not available for third-party audiences, so the list format is (3;);(4;);. To "AND" and "OR" groups of audiences, follow this example: To combine pairs with and without recency: ' ((1;1d;);(2;365d;));((3;);(4;5m;);(5;all;));'. This means (list 1 with 1 day recency OR list 2 with 365day recency ) AND (list 3 without a specified recency OR list 4 with 5 minute recency OR list 5 with all users).
Valid recency values are:
all, 1m, 5m, 10m, 15m, 30m, 1h, 2h, 3h, 6h, 12h, 1d, 2d, 3d, 5d, 7d, 10d, 14d, 15d, 21d, 28d, 30d, 45d, 60d, 90d, 120d, 180d, 270d, 365d
Valid recency values are:
all, 1m, 5m, 10m, 15m, 30m, 1h, 2h, 3h, 6h, 12h, 1d, 2d, 3d, 5d, 7d, 10d, 14d, 15d, 21d, 28d, 30d, 45d, 60d, 90d, 120d, 180d, 270d, 365d
Audience Targeting - Exclude
No
string, list of list of pairs
Yes
List of audience lists to exclude in targeting. Each audience is listed as a pair of UserList ID and recency setting, if the audience list is a 1P audience list. A pair is (1;1d;), where 1d is a sample recency representing 1 day recency. However, for 3P audiences, recency is not available, so the list format is (3;);(4;);. List format= (UserList.id; recency optional;); (UserList.id; recency optional;);
Example: "(1;1d;);(2;);".
Valid recency values are:
all, 1m, 5m, 10m, 15m, 30m, 1h, 2h, 3h, 6h, 12h, 1d, 2d, 3d, 5d, 7d, 10d, 14d, 15d, 21d, 28d, 30d, 45d, 60d, 90d, 120d, 180d, 270d, 365d
Example: "(1;1d;);(2;);".
Valid recency values are:
all, 1m, 5m, 10m, 15m, 30m, 1h, 2h, 3h, 6h, 12h, 1d, 2d, 3d, 5d, 7d, 10d, 14d, 15d, 21d, 28d, 30d, 45d, 60d, 90d, 120d, 180d, 270d, 365d
Affinity & In Market Targeting - Include
No
string, list
Yes
Affinity & In Market Targeting - Exclude
No
string, list
Yes
Demographic Targeting Gender
No
string, list
Yes
List of genders to target. Select one or more of the acceptable values:
- Female
- Male
- Unknown
Demographic Targeting Age
No
string, list
Yes
Target to a user age range. Specify a from/to range by selecting a single From age and a single To age and whether to include unknown ages true/false. See the list of acceptable From/To ages.
Example 1: to target 18-55 and include unknown ages, specify the format {From; To ; Include unknown True/False} = 18;55;true;
Example 2: to target only users >35 years old and exclude unknown ages, specify the following = 35;+;false;.
Acceptable values for From:
Acceptable values for To:
Example 1: to target 18-55 and include unknown ages, specify the format {From; To ; Include unknown True/False} = 18;55;true;
Example 2: to target only users >35 years old and exclude unknown ages, specify the following = 35;+;false;.
Acceptable values for From:
- 18
- 25
- 35
- 45
- 55
- 65
Acceptable values for To:
- 25
- 35
- 45
- 55
- 65
- +
Demographic Targeting Parental Status
Yes
string, list
Yes
List of parental status to target. Select one or more of the acceptable values.
- Parent
- Not a parent
- Unknown
Device Targeting - Include
No
string, list
Yes
Video Player Size Targeting
No
string, list
Yes
List of video ad player size to target. Select one or more of the acceptable values:
- unknown
- small
- large
- HD
Private - Seller Name
No
string
No
The publisher's name in a deal. This field only applies to private media products.
Private - Order Id
No
string
No
The order id of a guaranteed deal. This field only applies to private media products.
Private - Inventory Source Id
No
string
No
The DBM id of the inventory source. This field only applies to private media products.
