Structured Data - v4 - Campaign

See the overview for an explanation of format.

FieldRequiredTypeWritableDescription
Campaign IdRequired only when editing existing campaignsintegerNoNumeric ID value of the campaign. If left blank, a new Campaign ID will be created and a unique ID will be assigned. Optionally, when creating a new Campaign, you can use a custom identifier for the purpose of assigning Insertion Orders to the new Campaign. The format for a custom identifier is "ext[custom identifier]", for example, ext123. When the file is uploaded and processed, all custom identifiers will be replaced with DBM-assigned IDs and the objects will be associated (for example, Insertion Order to Campaign) based on the custom identifiers.
Advertiser IdYesintegerNoNumeric ID value of the advertiser. It must be a valid existing advertiser ID
NameYesstringYesThe name of the entry.
TimestampRequired when editing existing entriesintegerNoThe timestamp for the entry, this is used by the system to verify that the entry has not changed between downloading and uploading.
StatusYesstringYesThe status setting for the entry.
  • Active
  • Paused
  • Archived
  • Deleted
Campaign GoalYesstringYesSelect one of the applicable campaign goals:
  • Raise awareness of my brand or product
  • Drive online action or visits
  • Drive offline or in-store sales
  • Drive app installs or engagements
Campaign Goal KPIYesstringYesSelect one of the applicable campaign goal KPI:
  • CPM
  • Viewable %
  • CPIAVC
  • CPA
  • CPC
  • CTR
  • Other
Campaign Goal KPI ValueYesfloatYesA positive number for campaign goal KPI. For campaign goal KPI 'Viewable %' and 'CTR' enter the value for this field in percentage, e.g. 80% would be entered as '80'. For KPI 'Other', this field is a short description of objective.
Creative TypesYesstring, listYesList of creative types you expect to use.
  • Display
  • Video
  • Audio
Campaign BudgetNofloatYesA positive budget amount for the campaign. 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)
Campaign Start DateYesstringYesThe start date of the campaign in the format MM/DD/YYYY HH:mm
Campaign End DateNostringYesThe end date of the campaign in the format MM/DD/YYYY HH:mm
Frequency EnabledYesstringYesEnables/disables impression-based frequency capping on the line item.
  • TRUE
  • FALSE
Frequency ExposuresRequired when "Frequency Enabled" is "TRUE"integerYesA positive integer amount for the number of impressions in a given Line Item Frequency Amount, that is, the x in 'Show x impressions over y period'.
Frequency PeriodRequired when "Frequency Enabled" is "TRUE"stringYesSpecifies the time period unit for the frequency cap. For TrueView line items, supported periods are Days, Weeks, Months.
  • Minutes
  • Hours
  • Days
  • Weeks
  • Months
  • Lifetime
Frequency AmountRequired when "Frequency Enabled" is "TRUE"integerYesA positive integer amount for length of time of the Frequency Period type, that is, the y in 'Show x impressions over y period'. This amount is not supported for TrueView line items.
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 Household IncomeNostring, listYesTarget a household income range. Specify a from/to range by selecting a single Top_of_Range income range and a single Bottom_of_Range income range and whether to include households with unknown income true/false. See the list of acceptable Top_of_Range/Bottom_of_Range ranges.
Example 1: to target the top 10% to 50% of households and include households with unknown income, specify the format {Top_of_Range; Bottom_of_Range; Include unknown True/False} = Top 10%;41-50%;true;
Example 2: to target only the lower 50% of households and exclude households with unknown income, specify the format {Top_of_Range; Bottom_of_Range; Include unknown True/False} = Lower 50%;Lower 50%;true;
Acceptable values for Top_of_Range/Bottom_of_Range:
  • Top 10%
  • 11-20%
  • 21-30%
  • 31-40%
  • 41-50%
  • Lower 50%

Demographic Targeting Parental StatusYesstring, listYesList of parental status to target. Select one or more of the acceptable values.
  • Parent
  • Not a parent
  • Unknown
Geography Targeting - IncludeNostring, listYesList of geographies to include in targeting. List format = (GeoLocation.id; GeoLocation.id;etc.).
Geography Targeting - ExcludeNostring, listYesList of geographies to exclude 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.).
Brand Safety LabelsNostring, listYesList of the digital content labels to target. List format = (G;PG; etc.).
  • G
  • PG
  • T
  • MA
  • ?
Brand Safety Sensitivity SettingNostringYesChoose the sensitivity setting to block inventory based on the subject matter of its surrounding content.
  • Do not block
  • Use DoubleClick Verification
  • Use custom
Brand Safety Custom SettingsRequired when "Brand Safety Custom Setting" is "Use Custom"string, listYesIf the Brand Safety Sensitivity Setting is 'Use custom', specify the list of standard content classifiers. For example, (Adult;Alcohol;Tobacco;etc.).
  • Adult
  • Derogatory
  • Downloads & Sharing
  • Weapons
  • Gambling
  • Violence
  • Suggestive
  • Profanity
  • Alcohol
  • Drugs
  • Tobacco
  • Politics
  • Religion
  • Tragedy
  • Transportation Accidents
  • Sensitive social issues
Third Party Verification ServicesNostringYesThird party verification services provider.
  • None
  • Integral Ad Science
  • DoubleVerify
  • Adloox
Third Party Verification LabelsNostring, listYesIf Third Party Verification Services is not "None", specify a list of labels supported by the selected provider.
Viewability Targeting Active ViewNostringYesTarget predicted viewability percentages. Percentages are represented as floats. One of {0.1,0.2,0.3,0.4,0.5,0.6,0.7,0.8,0.9}
Viewability Targeting Ad Position - IncludeNostringYesTarget ad positions. Select one or none of the acceptable values:
  • All
  • ATF
  • BTF
  • Unknown
Viewability Targeting Ad Position - ExcludeNostringYesExclude ad positions in targeting. Select one or none of the acceptable values:
  • ATF
  • BTF
  • Unknown
Inventory Source Targeting - IncludeNostring, listYesList of inventory to include in targeting. List format = (InventorySource.id; InventorySource.id;).
Inventory Source Targeting - ExcludeNostring, listYesList of inventory to exclude in targeting. List format = (InventorySource.id; InventorySource.id;).
Inventory Source Targeting - Target New ExchangesNostringYesSetting to target new exchanges.
  • True
  • False
Environment TargetingRequired when "Type" is "Display" or "Video" or "Audio"string, listYesList of environments to target. List format = (Desktop Web; Mobile App; etc.).
For Display Environment:
  • Desktop Web
  • Mobile Web
  • Mobile App
  • Mobile App Interstitial
  • Desktop Web on Mobile
For Video:
  • Desktop Web Video
  • Desktop Web Game
  • Desktop Web In-Read
  • Desktop Web In-Feed
  • Mobile Web Video
  • Mobile App Video
  • Mobile App Video Interstitial
For Audio:
  • Desktop Web Audio
  • Mobile Web Audio
  • Mobile App Audio