Platform Overview
Configuration Instructions for In-store Screens Deployment
5 min read • Last updated 17 October 2024
Deployment Guide for In-store Screens
Configuration Instructions for In-store Screens Deployment
This guide provides an overview of the Broadsign configuration steps for deploying digital screens in a retail media network. The goal is to streamline the management and targeting of content across digital screens by geographical region. This facilitates targeted advertising and enhances the efficiency of content delivery and management within the Broadsign Control environment.
This includes the configuration process for setting up regional criteria, screen naming conventions, API integration, and testing procedures to ensure a successful deployment of digital screens in retail locations.
1. Criteria Setup and Assignment
- Log in to Broadsign Control Administrator: Begin by logging into your Broadsign Control Administrator panel.
- Learn About Creating Groups with Criteria:
- Please refer to the Broadsign documentation on criteria and conditions to understand how to create and manage groups effectively using criteria.
- Create Criteria for Regions:
- Create a new criterion for each region (e.g., Victoria, New South Wales).
- Ensure each criterion is clearly labelled to represent the geographical area it covers.
- Assign Criteria to Display Units:
- For each display unit, assign the appropriate regional criterion by selecting from your created criteria. This links each screen to a specific geographical region.
2. Naming Conventions
- Standardise Screen Naming: Follow a consistent naming format to help identify the location and region of each screen easily.
Example format:[Country Code] - [State/Region] - [City] - [Venue Type] - [Specific Location]
, e.g., AU - NSW - Sydney - Shopping Centre - Entrance. - Document Naming Conventions: Maintain a record of all naming conventions used. This documentation will assist in future troubleshooting and management of the display network.
3. API Integration
- API Setup:
- Ensure that your development team has access to the Broadsign Direct API documentation.
- Use the
/api/v1/screens
endpoint to fetch screen details and verify correct criteria assignments.
- Implement Criteria Filtering in API Calls:
- Modify your existing integration to include filters based on the criteria IDs when fetching screen availability or scheduling content.
- Test the API integration to ensure that screens are correctly grouped and targeted based on the regional criteria.
- Extract and share the below credentials from Broadsign Control
Name | Description | Example |
---|---|---|
baseUrl | Base endpoint to communicate with REST API | https://api.broadsign.com:10889/rest |
token | Token for authorization | adeadbeefbeddedadefacedbabe |
domainId | Domain id of organisation | 11234567 |
domain name | Domain name of organisation |
- Extract and share the below credentials from Broadsign Direct
Name | Description | Example |
---|---|---|
baseUrl | Base endpoint to communicate with REST API | https://api.broadsign.com:10889/rest |
Email of Zitcha user to be setup | retailerbroadsign@zitcha.com | |
password | Password of Zitcha user to be used | ***** |
4. Testing and Validation
- Internal Testing: Before going live, conduct thorough testing within your environment to ensure that all screens display content as expected according to their regional grouping.
Give us feedback
Was this article useful?