User manual
Write your campaigns in a JSON file and import them into AdMaster in one step. Move campaigns from another traffic system, or create them with your own tools.
This guide is for anyone who writes the JSON file: you, your IT team, or a program that exports campaigns from another system. You can also download one of the examples and change it.
Using an AI assistant? Beta
Connect AdMaster to the AI tool of your choice and describe the campaign in your own words. Your AI assistant creates it in AdMaster for you, with no file to write. See how it works.
AI can make mistakes. Always have a person check everything your AI assistant does.
You need permission to create campaigns. Without it, the Import campaign button is not shown.
A file can hold one campaign (one object, { ... }) or more campaigns (a list, [ { ... }, { ... } ]). You can select more than one file at a time.
Import has two steps. Nothing is saved in the first step.
Step 1: Preview. AdMaster does a test run and shows the result for each campaign:
If a station name in the file does not exist in your account, you see a list. Choose the right station there. If you choose none, AdMaster uses the first station in your account.
Click Back to change the file or the text. Your file and text stay in place.
Step 2: Create. Click Create campaigns. AdMaster creates the campaigns, the new customers and agencies, and the spots. Each campaign is created on its own: if one campaign has an error, the others are still created.
Warnings do not stop the import. Read them before you click Create campaigns.
A segment is one part of a campaign: its dates, days, hours and number of plays. One campaign can have as many segments as you need, for example one for weekday mornings and one for the weekend.
This example creates one campaign with two spots and one segment. It plays 4 times a day, Monday to Friday, between 06:00 and 09:59.
{
"schema_version": 1,
"campaign": {
"basics": {
"name": "Spring Sale March 2027",
"customer": {"name": "Green Valley Furniture"},
"agency": {"name": "Bright Media Agency"},
"currency": "EUR"
},
"flight": {"start_date": "2027-03-01", "end_date": "2027-03-31"},
"stations": [{"name": "Radio One"}],
"spots": [
{"label": "A", "name": "Spring Sale 30s", "duration": 30},
{"label": "B", "name": "Spring Sale 20s", "duration": 20}
],
"schedule": {
"type": "variable",
"segments": [
{
"number": "Morning drive",
"start_date": "2027-03-01",
"end_date": "2027-03-31",
"weekdays": [true, true, true, true, true, false, false],
"hours": {"min": 6, "max": 10, "plays": 4},
"spot_shuffle": "percentage",
"spots": [{"label": "A", "percentage": 60}, {"label": "B", "percentage": 40}]
}
]
}
}
}
What happens:
A manual schedule lists every play by hand: one spot, in one hour, on one day. Use "type": "manual" and a list called entries.
{
"schema_version": 1,
"campaign": {
"basics": {
"name": "Weekend Offer March 2027",
"customer": {"name": "Green Valley Furniture"},
"agency": {"name": "Bright Media Agency"}
},
"flight": {"start_date": "2027-03-06", "end_date": "2027-03-07"},
"stations": [{"name": "Radio One"}],
"spots": [
{"label": "A", "name": "Weekend Offer 30s", "duration": 30},
{"label": "B", "name": "Weekend Offer 15s", "duration": 15}
],
"schedule": {
"type": "manual",
"entries": [
{"datetime": "2027-03-06T08:00:00", "spot": {"label": "A"}},
{
"datetime": "2027-03-06T08:00:00",
"spot": {"label": "B"},
"position": 90
},
{
"datetime": "2027-03-06T17:00:00",
"spot": {"label": "A"},
"plays": 2,
"breaks": [0]
},
{
"datetime": "2027-03-07T09:00:00",
"spot": {"label": "B"},
"price_amount": 150
}
]
}
}
}
What happens:
All dates and names are text. Field names are in lower case.
| Field | Type | Required | Default | Note |
|---|---|---|---|---|
| schema_version | number | Yes | - | Must be 1. Other numbers are refused. |
| campaign | object | Yes | - | Holds everything below. |
| Field | Type | Required | Default | Note |
|---|---|---|---|---|
| name | text | No | Customer name | Up to 255 characters. If a campaign with this name already exists, you get a warning, and the import still works. |
| customer | object | Yes | - | { "name": "..." }. Without a customer name, the campaign cannot be imported. |
| customer.name | text | Yes | - | AdMaster finds the customer by name, in upper or lower case. It also checks the business name. If nothing matches, a new customer is created. |
| customer.type_of_business | text | No | empty | Only for a new customer. Must match a business category in your account. Import does not create business categories. |
| agency | object | No | none | { "name": "..." }. Works like customer, but AdMaster looks only among agencies. |
| salesperson | object | No | empty | { "email": "...", "name": "..." }. AdMaster checks the email first, then the full name, among the users of your account. If no one matches, the field stays empty. |
| currency | text | No | - | The currency of the prices in the file, for example "EUR". If it is not the currency of your account, you get a warning. AdMaster does not convert amounts. |
| separation | text | No | auto | auto, manual or none. |
| priority | text | No | normal | normal, lower or lowest. |
AdMaster ignores campaign.uuid, campaign.status and basics.number if they are in the file. A new campaign always gets its own number and status.
| Field | Type | Required | Default | Note |
|---|---|---|---|---|
| start_date | date | Recommended | Today | Format YYYY-MM-DD. If it is missing or wrong, AdMaster uses today and shows a warning. |
| end_date | date | Recommended | Start date + 29 days | Format YYYY-MM-DD. The whole end day is included. If it is missing, wrong, or before the start date, AdMaster uses the default and shows a warning. |
| unlimited | true/false | No | false | If true, the campaign has no end date. |
| limits | object | No | no limits | budget, plays and seconds. Each one is { "enabled": true, "value": 1000 }. |
For a manual schedule, AdMaster sets the campaign dates from the first and the last schedule row. You can still give start_date and end_date to avoid the date warnings.
A list of stations: [ { "name": "Radio One" } ].
| Field | Type | Required | Default | Note |
|---|---|---|---|---|
| name | text | Yes (or uuid) | - | The station name exactly as in your account, in upper or lower case. Part of a name does not match. |
| uuid | text | No | - | The station ID. AdMaster checks it first. An ID from another account does not match. |
If the list is empty, AdMaster uses the stations named in the segments. If there are none, it uses the first station in your account and shows a warning.
A list of spots. Import creates one new spot for each item.
| Field | Type | Required | Default | Note |
|---|---|---|---|---|
| label | text | Yes, if you link the spot by its label | next free label | A short name, for example A or 1. Up to 30 characters. Every label must be different. A missing or repeated label is replaced with a new one. |
| name | text | No | Campaign name + label | The spot name. Up to 255 characters. |
| duration | number | No | 30 | Length in seconds. If it is missing, 0 or less, AdMaster uses 30. |
| uuid | text | No | - | Your own ID for the spot. It is used only to link the spot inside the file. |
| Field | Type | Required | Default | Note |
|---|---|---|---|---|
| type | text | No | variable | variable, static or manual. See below. |
| segments | list | For variable and static | empty | The segments. Ignored for manual, with a warning. |
| entries | list | For manual | empty | The schedule rows. Ignored for other types, with a warning. |
Schedule types:
One campaign uses one type. Variable and static segments cannot be mixed in one campaign.
| Field | Type | Required | Default | Note |
|---|---|---|---|---|
| number | text | No | Order number | The segment name. Up to 40 characters. |
| order_number | number | No | Place in the list | Sort order. |
| start_date | date | No | Campaign start | YYYY-MM-DD. |
| end_date | date | No | Campaign end | YYYY-MM-DD. If it is before start_date, the campaign has an error. |
| type | text | No | Same as schedule.type | variable or static. |
| weekdays | list of 7 true/false | No | all true | Monday first. See Formats. |
| hours | object or list | Recommended | whole day (variable) | See the two tables below. A variable segment without hours uses the whole day (0 to 24) with 1 play, and you get a warning. |
| stations | list | No | all campaign stations | Only stations of the campaign are used. Others are skipped, with a warning. |
| spots | list | Recommended | none | Links to the spots. See Spots. Without spots, nothing airs. |
| spot_shuffle | text | No | random | random, consecutive or percentage. Use percentage to apply the percentages of the spots. |
| position | number | No | none | Place in the break, 1 to 100. See Formats. |
| breaks | list of numbers | No | all breaks | The breaks the spot may play in. The first break is 0. |
| unlimited | true/false | No | false | If true, the segment has no end date. |
| pricing | object | No | no price | { "type": "...", "config": { ... } }. Types: flat, none, per_day, per_month, per_play, per_second, per_week. config is { "amount": 120 }, the price in the currency of your account. For none, leave it empty: {}. A wrong price gives a warning, and the segment is created without a price. |
Hours for a variable segment (an object):
| Field | Type | Required | Note |
|---|---|---|---|
| min | whole number | Yes | First hour, 0 to 24. |
| max | whole number | Yes | End hour, 0 to 24. The hour max itself is not included. See Formats. |
| plays | whole number | Yes | Plays each day. Up to 1000. A bigger number is changed to 1000, with a warning. |
| inverse | true/false | No (default false) | If true, the segment plays outside the hours from min to max. |
| is_different_plays | true/false | No | If true, you must also give different_plays. |
| different_plays | list of 7 numbers | If is_different_plays is true | Plays on each day of the week, Monday first. |
Hours for a static segment (a list): [ { "hour": 7, "plays": 1 }, { "hour": 8, "plays": 2 } ]. hour is a whole number from 0 to 23. plays is a whole number, up to 20 in each hour. A bigger number is changed to 20, with a warning.
| Field | Type | Required | Default | Note |
|---|---|---|---|---|
| datetime | text | Yes | - | YYYY-MM-DDTHH:MM:SS, for example 2027-03-06T08:00:00, in station local time. A date without a time is not valid. |
| spot | object | Yes | - | A link to a spot in the same file: { "label": "A" }. |
| plays | whole number | No | 1 | From 1 to 20. A bigger number becomes 20, a wrong number becomes 1. Both give a warning. |
| breaks | list of numbers | No | all breaks | The breaks the spot may play in. The first break is 0. Wrong values are removed, with a warning. If no value is left, the row uses all breaks. |
| position | whole number | No | none | Place in the break, 1 to 100. A wrong value is ignored, with a warning. |
| price_amount | number | No | station price | The price of this row. 0 means free. A wrong value is ignored, with a warning. |
A row has no station field. A manual schedule goes to all stations of the campaign.
Import does not create spot groups (reminder spots). A row with spot_group is skipped, with a warning.
Spots are created without spot files. You do not need the audio or video files before the import.
A segment (in spots) or a schedule row (in spot) points to a spot in campaign.spots of the same file. AdMaster checks, in this order:
The easiest way is to give every spot a short label and link it by the label only:
"spots": [ { "label": "A", "name": "Spring Sale 30s", "duration": 30 } ]
...
"spots": [ { "label": "A", "percentage": 60 } ]
A warning means the import works, but AdMaster changed or skipped something. Read the warnings in the preview. [X] and [Y] stand for the values in your file.
An error means this campaign is not imported. The other campaigns in the same import are not affected. The preview shows the error in a red card.
Send us the file and the message you see in the preview at support@admaster.info. We answer on working days, from 9:00 to 21:00 CET.