See the overview for an explanation of format.
Field
Required
Type
Writable
Description
Campaign Id
Required only when editing existing campaigns
integer
No
Numeric 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 Id
Yes
integer
No
Numeric ID value of the advertiser. It must be a valid existing advertiser ID
Name
Yes
string
Yes
The name of the entry.
Timestamp
Required when editing existing entries
integer
No
The timestamp for the entry, this is used by the system to verify that the entry has not changed between downloading and uploading.
Status
Yes
string
Yes
The status setting for the entry.
- Active
- Paused
- Archived
- Deleted
Campaign Goal
Yes
string
Yes
Select 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 KPI
Yes
string
Yes
Select one of the applicable campaign goal KPI:
- CPM
- Viewable %
- CPIAVC
- CPA
- CPC
- CTR
- Other
Campaign Goal KPI Value
Yes
float
Yes
A 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 Types
Yes
string, list
Yes
List of creative types you expect to use.
- Display
- Video
- Audio
Campaign Budget
No
float
Yes
A 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 Date
Yes
string
Yes
The start date of the campaign in the format MM/DD/YYYY HH:mm
Campaign End Date
No
string
Yes
The end date of the campaign in the format MM/DD/YYYY HH:mm
Frequency Enabled
Yes
string
Yes
Enables/disables impression-based frequency capping on the campaign.
- TRUE
- FALSE
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
Specifies the time period unit for the frequency cap.
- Minutes
- Hours
- Days
- Weeks
- Months
- Lifetime
Frequency Amount
Required when "Frequency Enabled" is "TRUE"
integer
Yes
A positive integer amount for length of time of the Frequency Period type, that is, the y in 'Show x impressions over y period'.
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 Household Income
No
string, list
Yes
Target 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:
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 Status
Yes
string, list
Yes
List of parental status to target. Select one or more of the acceptable values.
- Parent
- Not a parent
- Unknown
Geography Targeting - Include
No
string, list
Yes
Geography Targeting - Exclude
No
string, list
Yes
Language Targeting - Include
No
string, list
Yes
Language Targeting - Exclude
No
string, list
Yes
Digital Content Labels - Exclude
No
string, list
Yes
List of the digital content labels to exclude. List format = (G;PG; etc.).
- G
- PG
- T
- MA
- ?
Brand Safety Sensitivity Setting
No
string
Yes
Choose the sensitivity setting to block inventory based on the subject matter of its surrounding content.
- Do not block
- Use Campaign Manager Verification
- Use custom
Brand Safety Custom Settings
Required when "Brand Safety Custom Setting" is "Use Custom"
string, list
Yes
If 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
- Shocking
Third Party Verification Services
No
string
Yes
Third party verification services provider.
- None
- Integral Ad Science
- DoubleVerify
- Adloox
Third Party Verification Labels
No
string, list
Yes
If Third Party Verification Services is not "None", specify a list of labels
supported by the selected provider.
Viewability Targeting Active View
No
string
Yes
Target 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 - Include
No
string
Yes
Target ad positions. Select one or none of the acceptable values:
- All
- ATF
- BTF
- Unknown
Viewability Targeting Ad Position - Exclude
No
string
Yes
Exclude ad positions in targeting. Select one or none of the acceptable values:
- ATF
- BTF
- Unknown
Inventory Source Targeting - Authorized Seller Only
Required when "Type" is "Display" or "Video" or "Audio"
string
Yes
Setting to target authorized seller only, authorized seller and resellers, or authorized seller + unknown. "Authorized Direct" means only authorized sellers will be targeted. TRUE means targeting the authorized sellers and resellers. FALSE means it will target authorized sellers, resellers, and unknown sellers.
- TRUE
- FALSE
- Authorized Direct
Inventory Source Targeting - Include
No
string, list
Yes
Inventory Source Targeting - Exclude
No
string, list
Yes
Inventory Source Targeting - Target New Exchanges
No
string
Yes
Setting to target new exchanges.
- True
- False
Environment Targeting
Required when "Type" is "Display" or "Video" or "Audio"
string, list
Yes
List of environments to target. List format = (Desktop Web; Mobile App; etc.).
For Display Environment:
For Display Environment:
- Desktop Web
- Mobile Web
- Mobile App
- Mobile App Interstitial
- Desktop Web on Mobile
- Desktop Web Video
- Desktop Web Game
- Desktop Web In-Read
- Desktop Web In-Feed
- Mobile Web Video
- Mobile App Video
- Mobile App Video Interstitial
- Desktop Web Audio
- Mobile Web Audio
- Mobile App Audio
