Structured Data - v10 - Campaign

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
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
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'. Frequency cap time periods must be 30 days or less.
Campaign Budget Segments	No	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.)