promotions.yaml | Meridian handbook

engine-dmo

This feature is part of the DMO bundle (engine-dmo).

config/sites/<key>/promotions.yaml declares the paid promotion slots on a site and the label every promoted placement carries.

label: { en-GB: Promoted }
slots:
  - key: home-feature
    name: { en-GB: Home page feature }
    types: [event, listing]
    capacity: 2
    days: { min: 7, max: 28 }
    lead_time: 3d
    tiers: { min: silver }
    price: { amount: "90.00", currency: GBP, per: week }

engine-dmo dev slot add declares a slot with its id. See Promotions.

Key	Type	Default	Meaning
`label`	map of string	Required	The label every promoted placement shows, per locale, such as `Promoted`
`slots`	list of objects	`[]`	Places on the site a promotion can appear
`slots[].capacity`	integer		How many promotions it shows at once
`slots[].days`	object		The shortest and longest booking, `{ min, max }`, in days
`slots[].days.max`	integer		See the row above
`slots[].days.min`	integer		See the row above
`slots[].id`	string	Written for you	The element’s stable id. Written by `engine-dmo check --fix`; never write or change it by hand
`slots[].key`	string	Required	The slot’s key, which templates name
`slots[].landings`	list of string		With `scope: landing`, the landing families it appears on
`slots[].lead_time`	string		How far ahead a booking must start, such as `3d`
`slots[].name`	map of string		Its name per locale, shown to staff and members
`slots[].price`	object		The price: `amount` (a quoted decimal), `currency` and `per` (`day`, `week` or `placement`)
`slots[].price.amount`	any		See the row above
`slots[].price.currency`	string	The site’s currency	See the row above
`slots[].price.per`	day, placement, week		See the row above
`slots[].prices`	list of objects	`[]`	Prices that differ by landing place or category, each with `amount`, `places` and `categories`
`slots[].prices[].amount`	any		See the row above
`slots[].prices[].categories`	list of string		See the row above
`slots[].prices[].places`	list of string		See the row above
`slots[].scope`	landing, site	`site`	`site` (one slot for the site) or `landing` (a slot on each landing page)
`slots[].tiers`	any	Every tier	The membership tiers that may book it: a list of keys, or `{ min: <tier> }`
`slots[].types`	list of string	Required	The content types it can promote