Introduction
A microsite is actively used as a landing page for Addressable TV campaigns. It offers a variety of features to provide additional information to viewers and collect their contact details in a GDPR compliant way.
HbbTV
Coupon Application
End-User Usage in Television
A microsite is based on views that are full-screen 720p images. Each view can have a functionality that takes place when the user presses the OK button.
On this application, the user can view different pages/views. To move between pages users can use the remote control's left and right buttons. The admin can assign different actions to several other buttons of the application.
When adding actions to color buttons it is good to remember in some cases those actions will not be run.
On phone number pages:
- By default setting, the button 'OK' is tied to sending the phone number forward and the green button will do the action tied to the button. The admin can change the green button to do this sending action instead, and in this case the 'OK' button will do its normal action. If confirmation is not active then this sending will happen immediately after pressing the button.
- If confirmation is active then 'OK' or 'Green' button will open a confirmation view. Confirmation uses the same button as sending - 'OK' or 'Green' based on admin setting. Cancellation of the 'Confirmation' is either 'Back' button (with 'OK' button) or 'Red' button (with 'Green' button).
- 'Yellow' button will always remove values from 'Phone number' field. On phone number pages it is not possible to perform 'Yellow' button's action.
Other pages and button actions that are not mentioned above. Those special actions overwrite these actions.
- OK button will do the 'Target' action on pages.
- Color buttons do actions that admin has assigned them on settings page.
Configuration and Features
Supported URL Parameters
|
Parameter
|
Type
|
Example
|
Description
|
|
itemIndex
|
Number
|
itemIndex=1
|
Determines which item is displayed as the Microsite is loaded. Note that the first item is 0.
|
|
activateTarget
|
Boolean
|
activateTarget=true
|
Whether or not the item target should be launched immediately after loading the Microsite, without requiring user input. Only applied if the itemIndex parameter is also provided!
|
|
exitOnVideoEnd
|
Boolean
|
exitOnVideoEnd=true
|
If true, the Microsite application will exit when video playback of an item target ends instead of returning to the list of items. Only relevant with items where target is set to an Asset.
|
|
historyBack
|
String
|
historyBack=http%3A%2F%2Fsuite.icareus.com
|
If provided, pressing the 'Back' button will redirect the user to the given URL. Should be URL encoded for maximum functionality. Please note that Icareus Applications normally add this parameter automatically.
|
|
channelId
|
Number
|
channelId=12345
|
Used for analytics reporting, when enabled in the application's configuration. Should be a valid Suite Linear Channel ID.
|
All parameters are optional.
Info tab
On this tab the admin can change the application's name and the URL where the application can be found.
Items tab
On this tab the admin can decide which pages of the application will be shown, and in which order. On basic view admin can rearrange the order of he pages using the up and down arrows, and disable items by clicking the 'Remove' button. Clicking the 'Remove' button does not actually remove the item, but it will disable it so it won't be displayed when the application is loaded.
Microsite items. Up Arrow, Down Arrow, Remove button
With the Add button (bottom of tab) the admin can add new pages to the application. The admin can edit the existing page by clicking it. Add/Edit page opens in a separate view.
Add new item/Edit item
Below is the image of the 'Add new item' view. 'Edit item' has the same fields.
- Thumbnail image is the image that is shown on the Items listing.
- Banner image is the image shown in the application to the end user.
- Show phone number input. Shows or hides the phone number input field (available to end user).
- Target. Where the user will be moved when he presses the 'OK' button on the remote. There are different type of targets. These are:
- None. No target. User will not be moved away from this page when he presses 'OK' -button. Other buttons can still send user to other applications or services.
- URL. User will be sent to another URL address. Target URL can be given in a different field. Given URL must include HTTP(S)://
- Asset ID. User is sent to an asset (video, audio etc). ID of this asset can be given in a separate field.
- Image. The image can be uploaded with the 'upload image' field. This image is then shown to the user after pressing the 'Ok' button.
After admin has filled necessary fields, they must then click the 'Add' or 'Save' button when editing to save a new page or made changes.
Settings tab
In this view, the admin can define different settings to decide how this application is run on the user's television.
Positional data must be given with pixels.
Color values must be given as hexadecimal RGB
- Transition style. Defines how the transition is shown when moving between pages provided in the Items view. Default 'None'
- None. No transition. New page just replaces the existing one.
- Fade in. Original page fades out while new page fades in.
- Slide In. New page slides in from one side of the screen, based on user interaction.
- Auto scroll. The application automatically switches pages after a certain time. The time value is given in the field 'Auto scroll time' in seconds. Value '0' means that moving between pages is disabled and it is only possible to move by user interaction.
- Use green button to send phone number instead of ok button. If checked, application will use the green button to send the phone number forward. This will also set the 'Red' button to cancel confirmation if confirmation is activated.
- Broadcast window. Here you can define if the broadcast is shown and where on the screen.
- Show broadcast window. If checked, broadcast is shown on the screen.
- X-position and Y-position (pixels). Where the broadcast window will be located. This position tells the top left most position of the window.
- Width and Height (pixels). Size of the broadcast window.
- Broadcast overlay. If broadcast is not possible to show, here you can set the image that is shown in its place.
- Phone number window. Whether the phone number is shown or not has to be defined in the 'Edit Items' or 'Add Items'. Here you can only give other values of the phone number field.
- Default prefix. The phone number field offers some default prefix.
- Font size and color. Font and the size of the phone number.
- X-position, Y-position, Width and Height. Where the phone number window will be located. This position tells the top left most position of the window.
- Coupon application. On what application the phone number will be saved.
- Success and error message. Messages that will be shown to end user based on if sending the phone number succeeded or failed.
- Confirmation popup. The confirmation popup will be shown if there is text in the 'Confirmation text' field. This can be used to ask for GDPR from the user. Confirmation uses 'OK' and 'Back' buttons by default to send or cancel the action. If user has set the 'Green' button to work as the 'Ok' button then confirmation will use 'Green' and 'Red' buttons to do those same actions. The confirmation popup will show these buttons in the view automatically.
- If text given here is too big to fit in the confirmation box, the user can use down and up arrows on his remote to move up and down the text
- Confirmation text. The text that is shown to the user. You can use HTML tags to visualize the text.
- Be careful. Using HTML tags might also cause the page to work incorrectly.
- Confirmation text font color and background color. Here you can set the color values of the confirmation text field.
- Header's text font color and background color. Here you can set the color values of the header text field.
- Text for send and cancel buttons. Text shown to the user with the 'send' and 'cancel send' buttons.
- X-position, Y-position, Width and Height. Where the confirmation popup will be located. This position tells the top left most position of the window.
- Button text, actions, and Analytics. These are same as are in all applications.
Related Articles
Introduction to Addressable TV
INTRODUCTION Icareus Suite enables broadcasters to maximise their revenue with Addressable TV formats. Icareus Suite in collaboration with Icareus Playout can be used to trigger and synchronise Display Ads and replace the broadcasted commercials with ...
Managing Applications
MANAGING APPLICATIONS APPLICATIONS INTRODUCTION AND MAIN FEATURES 1. INTRODUCTION Application management is targeted for managing especially the applications running on TV devices. Icareus Suite applications are value added services or applications, ...
Applications API (ENG)
INTRODUCTION This API is used to manage Applications. You can create new Applications, edit existing Applications and upload new images for existing Applications. Currently only creation/editing of HbbTV Coupon Applications is supported! API PATH ...
ActiveAd Configuration
Introduction In order to successfully display Active Ads on a device, the following things are required: HbbTV Launcher Application Active Ad Campaign Creative Adding an Active Ad Campaign Campaigns can be added in Icareus Suite by navigating to ...
Managing AddressableTV Campaigns
Introduction Addressable TV Ad formats that are run on broadcast networks require configuration on both Icareus Suite (campaigns, creatives, integrations, ...) and Icareus Playout (HbbTV signalling, broadcast synchronization, etc). Requirements for ...