Broadsign Product IDs
This page list the various IDs used by the Broadsign products and the relation between them.
This is the ID of the Player. Adding a new Player to the network requires a new registration. Each Player is uniquely identified by its MAC Address. Consequently, each registration must use a distinct MAC Address, as duplicate entries are rejected. While a Player can only be linked to one Display Unit at a time, multiple Players can be assigned to a single Display Unit.
When Could the ID Change?
A Player ID remains constant and unique, never changing over time. However, its association can change if it is mapped to a different Display Unit. It's crucial for a Player to always be associated with a Display Unit; otherwise, it will not receive content.
The ID of the corresponding display unit screen in our Content and Network Management solution. This information is optional.
This parameter cannot be edited in the Broadsign Platform. Changes must be done in our Content and Network Management solution.
In the Content and Network Management solution, Display Units are comparable to programming channels on a television broadcast network. Their layout and scheduling availability is dictated by their assigned Day Parts. Any Player assigned to a Display Unit will display the content scheduled to it. This concept mirrors the scenario of many televisions showing the programming of the channel into which they are tuned. Display Units consist of Day Parts which in turn consist of Frames.
The parameter is available in the Digital Inventory page, and when performing one of the following actions:
- Quick Screen Update: Inventory Column Details
- Bulk Screen Update .csv file: Inventory CSV File Column Details
- Bulk Screen Update interface: Bulk Screens Inventory Update
- Audience Information Update .csv file: Audience CSV File Column Details
- Audience Information Update interface: Update the Audience Information
When Could the ID Change?
In theory, a Display Unit should remain constant. However, there have been instances where a double-sided unit that previously used one Display Unit with multiple Frames may require two Players instead of two Frames. In such cases, a new Display Unit would be created, and a Frame would be removed from the previous Day Part.
Day Parts represent blocks of time within a Display Unit, each with defined playback characteristics. All Players associated with the Display Unit adhere to these Day Parts. Characteristics of Day Parts include frame layout and hours of operation.
When Could the ID Change?
A Day Part associated with a Player might change when the block of time transitions between 'active' and 'inactive' states. This could occur during temporary opening hours.
Blocking Day Parts serve to prevent the screen from displaying content and are integral to TOC and POC processes. If a blocking Day Part is active, it always takes precedence over any other Day Part, irrespective of its weight.
A Frame sits within the Day Part of the Display Unit. Frames represent sections of the Player's screen where content can be scheduled for display. You can target content to frames using campaigns. While Frames map to Screen IDs in the Guaranteed Campaigns module, they do not necessarily maintain a one-to-one relationship.
When Could the ID Change?
If a screen uses different Day Parts, then the Frame ID associated with the Screen ID will change depending on when the Day Part is active. However, if the Day Parts use different geometries, then the Frame is considered a new entity and has its own Screen ID in the Guaranteed Campaigns module.
Loop policies are used to establish rules for loop generation and playback capabilities, including parameters such as loop length, slot length, synchronization, loop transformation, and content restrictions. These policies are associated with Frames, governing the behavior and characteristics of content playback within those frames.
When Could the ID Change?
A Loop Policy is always associated with a Frame. However, this association may change periodically if a new requirement arises for a Frame that shares a Loop Policy with other Frames.
Configuration profiles are collections of settings for Players on the network. These are often split by Player versions, products, and player needs.
This parameter cannot be edited in the Broadsign Platform. Changes must be done in our Content and Network Management solution.
When Could the ID Change?
This ID can change for various reasons. One likely scenario is during the deployment phase, especially if the customer is experimenting with different configurations to identify the most suitable settings for their player. In such scenarios, switching from one configuration to another may be simpler than solely editing the same configuration.
Criteria resources specify custom characteristics for Display Units, Frames and Ad Copies. They are used like tags for content targeting, screen grouping, and screen selection when creating Campaigns.
When Could the ID Change?
Criteria can undergo frequent changes, particularly when they are utilized ad hoc for site-specific ad copies and contents. Users often employ criteria manually, leading to common modifications.
Campaigns serve as the primary mechanism through which Broadsign targets and schedules content to Display Units. A campaign comprises all relevant information pertaining to a content piece in your loop. This includes schedules, content, duration, and meta-information.
Instead of manually defining playlists, each Player dynamically constructs its playlist based on the campaigns targeted to it.
When Could the ID Change?
Campaigns associated with a screen will change regularly. Screens within a campaign can also change due to an amendment. However, a campaign will never change its ID as it is its own entity.
Campaigns map to line items in the Guaranteed Campaigns module and they will never change their association, they will always be 1 to 1.
Events are special campaigns. You can schedule an event, outside of a regular playback loop, to appear at a predefined time. Events can also repeat daily, weekly, monthly or yearly. Events will override the standard playlist and take control of the screen for the duration of the event.
When Could the ID Change?
Events associated with a screen will change regularly. Screens within an event can also change due to an amendment. However, an event will never change its ID as it is its own entity.
Ad Copies are any piece of content used on screens for campaigns, events and fillers. Ad Copies represent individual media files that are imported into the system and stored in the Broadsign Server. A standard Ad Copy is often a basic image or video file, but Broadsign supports several special types.
When Could the ID Change?
Everytime an Ad Copy is uploaded into Broadsign, it is given a unique ID. If the same file is uploaded again, it is given a new ID as the same file can be used for different campaigns and scenarios.
Bundles are groups of Ad Copies that you can schedule, as a whole, in the Content and Network Management solution. As a result, you can schedule several different versions of the same ad at once. As standard, every campaign will use bundles even if there is only one Ad Copy inside.
Each resource in the Content and Network Management solution can be organized into folders. All will sit within their parent resource folder (Campaigns, Ad Copies, Players, Display Units, and so on), but can be split to better organize and structure. Each of these folders will have their own individual ID that can be used to quickly find resources.
When Could the ID Change?
Can change a lot, but the parent will always stay the same. You cannot move a resource out of its category. You cannot group different resource types.
Screen IDs are the individual IDs of each screen in the Guaranteed Campaigns Inventory. Screen IDs map to Frames in the Content and Network Management solution, but it is not always one to one.
When Could the ID Change?
Screen IDs associated with Frames can change for a number of reason. A change in Day Part can cause a Screen ID to be associated with a different Frame as they use the same geometry.
Proposals act as the container for all Guaranteed Campaigns line items. They are not mapped to an individual campaign, but instead, multiple campaigns can be mapped to a single proposal.
Proposal Line Items map to campaigns in the Content and Network Management solution. They are a one to one relationship. Once a proposal item goes to a Submitted status, this will trigger a campaign to be generated in the Content and Network Management solution.
It is possible to sell multiple screens as a single entity, called screen group, as opposed to individual screens. This allows you to sell quantity over specific screens, and sell inventory as groups. Screen groups are created in and imported from the Content and Network Management solution. They cannot be created in the Guaranteed Campaigns module. They are Display Units that have been assigned the same criteria type. The type must be Grouping. All other criteria types are not supported.
You must also associate one or more Display Units to a particular criterion. The creation of a screen group will create a new Screen ID (or Group ID) that becomes the entity. All Screen IDs that are part of the group become unusable and instead you must book using the new Group ID.
Individual IDs given to a screen that is in the Broadsign Platform. This will map to the following:
- Guaranteed Campaigns Module: A Screen ID
- Programmatic Campaigns Module: Programmatic Campaigns Module IDs
- Content and Network Management Solution: A Frame ID / Skin
When Could the ID Change?
Behaves the same way as a Screen ID. If a change is made that would consider the screen to be a brand new entity, the Screen ID change would also cause a Platform ID change.
Screen venue type ID. See options in Screen Venue Types.
Example: 80701
The parameter is available in the Digital Inventory page, and when performing one of the following actions:
- Quick Screen Update: Inventory Column Details
- Bulk Screen Update .csv file: Inventory CSV File Column Details
- Bulk Screen Update interface: Bulk Screens Inventory Update
When Could the ID Change?
This ID can be changed manually in the Broadsign Platform.
Field available to the Publisher in which they can insert a reference ID for this screen. The field is limited to 255 characters.
The Reference ID is optional and offers an extra layer of information if Publishers have their own screen identification system.
External IDs can also be entered via the Content and Network Management solution.
Individual IDs given to screens that are transactable in the Programmatic Campaigns module.
These Programmatic IDs can either be a Reach Device ID or a Platform ID.
When Could the ID Change?
The Reach Device ID should only change if the screen had a Reach Device ID and it was removed, or when a new screen is created. When a screen is created, the Reach Device ID is the Platform ID.
The original Reach Device ID available in the Programmatic Campaigns module before migrating to the Broadsign Platform. In that case, the Reach Device ID is synchronized with its corresponding Platform ID.
If the original Reach Device ID does not exist because the screen was created after being onboarded onto the Broadsign Platform, then the Platform ID will be used as the Programmatic Device ID.