Coming soon: Changes to environment and position targeting in Structured Data Files. Learn more.

Structured Data - v5 - Media Product

See the overview for an explanation of format.

FieldRequiredTypeWritableDescription
Product IdNointegerNoNumeric ID value of the media product.
Plan IdNointegerNoNumeric ID value of the media proposal.
Campaign IdNointegerNo
NameYesstringYesThe name of the entry.
TypeNostringNoType 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 DateNostringNoThe start date of the media product in the format MM/DD/YYYY HH:mm
End DateNostringNoThe end date of the media product in the format MM/DD/YYYY HH:mm
BudgetNofloatNoA 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 EnabledYesstringYes
Frequency ExposuresRequired when "Frequency Enabled" is "TRUE"integerYesA 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 PeriodRequired when "Frequency Enabled" is "TRUE"stringYes
Frequency AmountRequired when "Frequency Enabled" is "TRUE"integerYes
Geography Targeting - IncludeNostring, listYesList of geographies to include in targeting. List format = (GeoLocation.id; GeoLocation.id;etc.).
Language Targeting - IncludeNostring, listYesList of languages to include in targeting. List format = (Language.id;Language.id;etc.).
Language Targeting - ExcludeNostring, listYesList of languages to exclude in targeting. List format = (Language.id;Language.id;etc.).
Channel Targeting - IncludeNostring, listYesList of channels to include in targeting. List format = (UniversalChannel.id;UniversalChannel.id; etc.).
Channel Targeting - ExcludeNostring, listYesList of channels to include in targeting. List format = (UniversalChannel.id;UniversalChannel.id; etc.).
Category Targeting - IncludeNostring, listYesList of categories to include in targeting, from AdX vertical IDs. List format = (Verticals.Id;Verticals.Id;etc.).
Category Targeting - ExcludeNostring, listYesList of categories to exclude in targeting, from AdX vertical IDs. List format = (Verticals.Id;Verticals.Id;etc.).
Audience Targeting - IncludeNostring, list of list of pairsYesList 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
Audience Targeting - ExcludeNostring, list of list of pairsYesList 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
Affinity & In Market Targeting - IncludeNostring, listYes
Affinity & In Market Targeting - ExcludeNostring, listYes
Demographic Targeting GenderNostring, listYesList of genders to target. Select one or more of the acceptable values:
  • Female
  • Male
  • Unknown
Demographic Targeting AgeNostring, listYesTarget 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:
  • 18
  • 25
  • 35
  • 45
  • 55
  • 65

Acceptable values for To:
  • 25
  • 35
  • 45
  • 55
  • 65
  • +
Demographic Targeting Parental StatusYesstring, listYesList of parental status to target. Select one or more of the acceptable values.
  • Parent
  • Not a parent
  • Unknown
Device Targeting - IncludeNostring, listYesList of devices to include in targeting. List format = (DeviceCriteria.id;DeviceCriteria.id;etc.).
Video Player Size TargetingNostring, listYesList of video ad player size to target. Select one or more of the acceptable values:
  • unknown
  • small
  • large
  • HD
Private - Seller NameNostringNoThe publisher's name in a deal. This field only applies to private media products.
Private - Order IdNostringNoThe order id of a guaranteed deal. This field only applies to private media products.
Private - Inventory Source IdNostringNoThe DBM id of the inventory source. This field only applies to private media products.