Structured Data - v6 - Campaign

See the overview for an explanation of format.

Field

Required

Type

Writable

Description

Campaign Id

Required only when editing existing campaigns

integer

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

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

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

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

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

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

On February 28, 2025, frequency cap time periods greater than 30 days will no longer be accepted. Attempting to assign 'Lifetime' to this column will return an error.

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'.

On February 28, 2025, frequency cap time periods greater than 30 days will no longer be accepted. Attempting to assign the value 2 or greater to this column when 'Months' is assigned to the 'Frequency Period' column will return an error.

Campaign Budget Segments

string, list of lists

Yes

The set of budget segments for the campaign. List format = (ID; Name; Type; Amount; Start Date; End Date; External Budget Source; External Budget ID; Invoice Grouping ID; Prisma Client Code; Prisma Product Code; Prisma Estimate Code; Prisma Type; Supplier;).

Example '(; My Budget; IMPRESSIONS; 234; 01/01/2020 00:00; ; MEDIA_OCEAN; ExternalId; InvoiceId; Client; Product; Estimate; DISPLAY; MySupplier;)' Where ID and End Date are not provided.
Acceptable values are provided in the following table:

Column Name	Required	Description
ID	No	The unique ID of the campaign budget segment. This must be provided when editing a budget segment. If left blank, the budget segment will be written as new.
Name	Yes	The display name of the campaign budget segment.
Type	Yes	The type of the budget amount. Acceptable values are: Amount Impressions
Amount	Yes	A positive budget amount for the budget type. This could be a simple integer impression value, or a float for a currency amount. Currencies will be shown in the advertiser's currency in standard units (not in 1/1,000,000s of a currency unit).
Start Date	No	A timestamp for the flight start date of the budget segment in the format MM/DD/YYYY HH:mm. An unset start date is represented by a blank field value.
End Date	No	A timestamp for the flight end date of the budget segment in the format MM/DD/YYYY HH:mm. An unset end date is represented by a blank field value.
External Budget Source	Yes	The source of the budget segment. Acceptable values are: None Mediaocean
External Budget ID	Only for Mediaocean budget segments	If set, all impressions served against this budget segment will include this ID on the invoice if the customer has opted into budget-segment-level billing.
Invoice Grouping ID	No	If set, all budget segments with the same External Budget ID and Invoice Grouping ID will be aggregated into a single invoice if the customer has opted into budget-segment-level billing.
Prisma Client Code	Only for Mediaocean budget segments	Can only be set for Mediaocean budget segments. Google Payments Center supports searching and filtering on this field.
Prisma Product Code	Only for Mediaocean budget segments	Can only be set for Mediaocean budget segments. Google Payments Center supports searching and filtering on this field.
Prisma Estimate Code	Only for Mediaocean budget segments	Can only be set for Mediaocean budget segments. Google Payments Center supports searching and filtering on this field.
Prisma Type	Only for Mediaocean budget segments	Can only be set for Mediaocean budget segments. The Prisma type of the segment. Acceptable values are: Display Search Video Audio Social Fee
Prisma Supplier	Only for Mediaocean budget segments	Can only be set for Mediaocean budget segments. The entity allocated to this budget (DSP, site, etc.)

Demographic Targeting Gender

string, list

Yes

List of genders to target. Select one or more of the acceptable values:

Female
Male
Unknown

Demographic Targeting Age

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:

Demographic Targeting Household Income

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:

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

string, list

Yes

List of geographies to include in targeting. List format = (GeoLocation.id; GeoLocation.id;etc.).

Geography Targeting - Exclude

string, list

Yes

List of geographies to exclude in targeting. List format = (GeoLocation.id; GeoLocation.id; etc.).

Language Targeting - Include

string, list

Yes

List of languages to include in targeting. List format = (Language.id;Language.id;etc.).

Language Targeting - Exclude

string, list

Yes

List of languages to exclude in targeting. List format = (Language.id;Language.id;etc.).

Digital Content Labels - Exclude

string, list

Yes

List of the digital content labels to exclude. List format = (G;PG; etc.).

Brand Safety Sensitivity Setting

string

Yes

Choose the sensitivity setting to block inventory based on the subject matter of its surrounding content.

Do not block
Use Campaign Manager 360 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, (Sexual;Alcohol;Tobacco;etc.).

Sexual
Derogatory
Downloads & Sharing
Weapons
Gambling
Violence
Suggestive
Profanity
Alcohol
Drugs
Tobacco
Politics
Religion
Tragedy
Transportation Accidents
Sensitive social issues
Shocking

Third Party Verification Services

string

Yes

Third party verification services provider.

None
Integral Ad Science
DoubleVerify
Adloox

Third Party Verification Labels

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

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}

Position Targeting - Display On Screen

string, list

Yes

On screen display ad positions targeting. Select one or more of the acceptable values:

Above the fold
Below the fold
Unknown

Position Targeting - Video On Screen

string, list

Yes

On screen video ad positions targeting. Select one or more of the acceptable values:

Above the fold
Below the fold
Unknown

Position Targeting - Display Position In Content

string, list

Yes

Display ad content positions to target. Select one or more of the acceptable values:

In-Article
In-Feed
In-Banner
Interstitial
Unknown

Position Targeting - Video Position In Content

string, list

Yes

Video ad content positions to target. Select one or more of the acceptable values:

In-Article
In-Feed
In-Banner
Interstitial
Unknown Out-Stream
Pre-Roll
Mid-Roll
Post-Roll
Unknown In-Stream

Inventory Source Targeting - Authorized Seller Options

Required when "Type" is "Display" or "Video" or "Audio"

string

Yes

Setting to target authorized direct sellers, authorized direct seller and resellers, or authorized seller + unknown. "Authorized Direct" means only authorized sellers will be targeted. "Authorized Direct Sellers And Resellers" means targeting the authorized sellers and resellers. "Authorized and Non-Participating Publisher" means it will target authorized sellers, resellers, and unknown sellers.

Authorized Direct Sellers
Authorized Direct Sellers And Resellers
Authorized and Non-Participating Publisher

Inventory Source Targeting - Include

string, list

Yes

List of inventory to include in targeting. List format = (InventorySource.id; InventorySource.id;).

Inventory Source Targeting - Exclude

string, list

Yes

List of inventory to exclude in targeting. List format = (InventorySource.id; InventorySource.id;).

Inventory Source Targeting - Target New Exchanges

string

Yes

Setting to target new exchanges.

True
False

Environment Targeting

string, list

Yes

List of environments to target. Select one or more of the acceptable values. Please note that 'Web Not Optimized' cannot be selected without selecting 'Web'.

Web
Web Not Optimized
App