Other admin tools reference
Every field and behaviour of the four smallest admin CRUD pages — system banner templates, VPAID frameworks, auto placements and additional entity fields — plus the neighbouring Targeting presets pages and the permission behind each page; the companion to the Other admin tools guide.
The companion to Other admin tools, which has the shared routine, the caveats and the fix-it checklist; this page holds every field of the four smallest pages, the neighbouring Targeting presets pages and the permission behind each page. The three bigger tools have a reference of their own: Custom ad units and sizes, Video requirement presets and Upstream macro presets.
System banner templates
Admin → Creatives & tags → System banner templates. A banner template is a reusable HTML/JS body the ad server interpolates per impression, which an advertiser then picks on a Template creative and fills the properties of.
The editor here is the same editor as the account-side one — Template information, Target related templates, Template files, Template properties, Export/Import, Template test. It is documented once, in Create and manage banner templates; everything in that page’s Options & fields, property-type table and grid actions applies verbatim. What follows is only what is different about the admin copy.
| Admin-specific behaviour | Detail |
|---|---|
| New templates are global | A template created (or imported) here is marked global. Accounts see it in the creative’s Template picker with a “(global)” suffix and cannot edit it. Templates an account user creates are not global — see Create and manage banner templates. |
| The grid is not global-only | Account-owned templates are listed here too, tagged “(local)” after the title. |
| Filters | A Search box plus Type, Placement type and Status dropdowns, which the account grid does not have. |
| No Share action | Sharing is an account-side concept; the admin grid offers Add / Edit / Export / Import / Import as new / Delete only. |
Template types and the content macro each expects in the body — the one thing the account page states only by name:
| Type | Body must contain |
|---|---|
| General | nothing special — the whole body is the creative |
| Content Adapter (deprecated) | $$CONTENT$$ |
| Placement Content Adapter | $$AD_CONTENT$$ (the older $$NATIVE_CONTENT_JSON$$ is still accepted) |
| Video Companion | nothing special |
VPAID frameworks
Admin → Creatives & tags → VPAID frameworks. A VPAID framework is the JavaScript adapter Epom hands to the video player so it can run an interactive creative from a specific integration.
| Field | What it does |
|---|---|
| Name | Framework label, shown in the creative’s framework dropdown. Required. It is also the served filename — the adapter is published as …/vpaid/<id>/<Name>.js. |
| Active | When off, the framework is hidden from the creative dropdown. Defaults on. |
| File | The single JavaScript adapter, uploaded as one .js file. Required when you create a framework; when you edit one, leave it empty to keep the stored file. Download current file re-fetches the stored one. |
Framework parameters (a second card, present only on a saved framework) are the knobs the
advertiser fills in per creative. Each is a Name (the label), a Key (what the adapter
receives), an optional Default value and a Required flag. Type is displayed but
locked — String is the only implemented parameter type.
At serve time, an in-stream VPAID Framework creative produces a VAST <Linear> whose
<MediaFile apiFramework="VPAID"> is the adapter’s URL, and whose <AdParameters> is a JSON
object of the parameter values. Epom adds skipOffset, clickThrough, bannerUrl and the
viewability trackers to that object itself.
Auto placements
Admin → Ad serving → Auto placements. Each row is a template for a placement Epom creates automatically when a new site is set up.
| Field | What it does |
|---|---|
| Name | Template name, max 64 characters, trimmed on save. Required. Also the name given to the generated placement, and what generation de-duplicates against. |
| Type | The placement type to create — Site, Mobile Site, Non-standard, Video, Application, Email, Click-through or Native. Required. |
| Size | An ad unit, filtered to the picked type and to non-custom units. Optional in the form, but a row without a size is skipped when placements are generated, so set one. |
| Active | Only active rows are used during generation. The grid shows this as a Status column reading Active or Inactive. |
The grid lists Name, Type, Size and Status.
When generation runs. Four paths create a site and then ask for auto placements: publisher signup (site created from the user card), approving a site on the network Sites page, saving a new site from the account Publishers UI, and creating a site through the REST API. Two conditions gate it, and both must hold or nothing happens and nothing is reported:
- the site’s network status is Approved at that moment, and
- the acting user’s role grants Automatic placements creation for approved sites.
What it creates. A zone named “<site name> Placements” (reused if it already exists; a zone created now gets the default zone rules), then one placement per active auto-placement row. Each generated placement gets the template’s type and size, the default labels configured for that object type and placement type, an automatic link to the site’s categories, and the default placement rules.
Additional entity fields configuration
Admin → Ad serving → Additional entity fields configuration. This page adds a custom free-text field to an entity type’s edit form.
| Field | What it does |
|---|---|
| Name | Machine-readable field name, e.g. custom_field_1. Required, 1–64 characters. |
| Title | The label shown on the form. Required, 1–128 characters. |
| Entity | Which entity gets the field: Site, Zone, Placement, Advertiser, Campaign or Banner. Required. |
Once saved, the field appears as a plain text input on the Basic info card of every entity of that type, labelled with its Title, and account users can type a value per entity — up to 255 characters. There is no type system: every additional field is free text.
The grid lists ID, Name, Title and Entity type. The entity is shown there as the
raw enum name — SITE, ADVERTISER, PLACEMENT — while the edit form’s picker uses the
friendly labels; same value, two spellings.
Also in these sidebar groups
The Targeting presets group is a different subject, documented elsewhere:
| Page | Where |
|---|---|
| Preset domain / IP ranges / application package group management (Targeting presets) | Reusable domain, IP-range and app-package lists for targeting. Fully covered — building a group here, and using it in a rule — in Preset groups. |
| Custom parameters (Targeting presets) | The registry of the cp. parameters your tags send — Register the custom parameters your ad tags send. |
Permissions
| Permission (Admin UI) | Opens |
|---|---|
| Custom Ad Units & Sizes | Custom ad units & sizes |
| System Banner Templates | System banner templates |
| VPAID Frameworks | VPAID frameworks |
| Video Requirement Presets | Video requirement presets (release 153 gives it to every role that holds Custom Ad Units & Sizes) |
| Upstream Macro Presets | Upstream macro presets (release 154 gives it to every role that holds Video Requirement Presets) |
| Auto Placements | Auto placements — plus the account-side Automatic placements creation for approved sites on the site’s creator or approver for anything to be generated |
| Additional Entities Fields Configuration | Additional entity fields configuration |
Network managers with the Video Creative Requirements permission read the video-spec list (it is what Use a publisher spec offers them) and pick an upstream preset per video placement from the active ones; they manage neither.
Over the API
The additional-field values, the video requirement preset and upstream macro preset operations, and the ad-unit list are on the hub: Over the API.
Related
- Other admin tools
- Custom ad units and sizes
- Video requirement presets
- Upstream macro presets
- Create and manage banner templates
- Video creatives — where a VPAID framework is chosen
- Rules & platform defaults — the default VPAID framework is set there
- Preset groups