Structured Data - v10 - 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
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 campaign.
  • TRUE
  • FALSE
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"stringYesSpecifies the time period unit for the frequency cap.
  • Minutes
  • Hours
  • Days
  • Weeks
  • Months
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'.

Frequency cap time periods must be 30 days or less.
Campaign Budget SegmentsNostring, list of listsYesThe 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 NameRequiredDescription
    IDNoThe 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.
    NameYesThe display name of the campaign budget segment.
    TypeYesThe type of the budget amount. Acceptable values are:
    • Amount
    • Impressions
    AmountYesA 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 DateNoA 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 DateNoA 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 SourceYesThe source of the budget segment. Acceptable values are:
    • None
    • Mediaocean
    External Budget IDOnly for Mediaocean budget segmentsIf 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 IDNoIf 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 CodeOnly for Mediaocean budget segmentsCan only be set for Mediaocean budget segments. Google Payments Center supports searching and filtering on this field.
    Prisma Product CodeOnly for Mediaocean budget segmentsCan only be set for Mediaocean budget segments. Google Payments Center supports searching and filtering on this field.
    Prisma Estimate CodeOnly for Mediaocean budget segmentsCan only be set for Mediaocean budget segments. Google Payments Center supports searching and filtering on this field.
    Prisma TypeOnly for Mediaocean budget segmentsCan only be set for Mediaocean budget segments. The Prisma type of the segment. Acceptable values are:
    • Display
    • Search
    • Video
    • Audio
    • Social
    • Fee
    Prisma SupplierOnly for Mediaocean budget segmentsCan only be set for Mediaocean budget segments. The entity allocated to this budget (DSP, site, etc.)