Clicking on the Create button in the Image Message panel at the top of the Actions Management page will take you to a form that lets you create a new image message action that can deliver targeted, localized popup images to the player at certain points in the game.
The Action Name Panel lets you give your action a descriptive, meaningful name and contains 3 buttons that
- Create a New action
- Open an existing action
- Clone an existing action to a new action. Handy if you are setting up multiple similar actions.
This Action panel will become familiar as it is used by all the action management screens.
There are several elements to the Image Message builder, we will look at them in turn.
Image Message Frequency control.
This control lets you specify if the image message content should be delivered to the player every time the campaign step is triggered or just when the player enters the campaign step that the image message is attached to.
Button Image Panel
You can add buttons to your Image Message popup by clicking the “Add” button.
Buttons graphics can be added to an image message. Click on the button graphic thumbnail to upload or “select an image”.
The Action drop down list will define what should happen if the player clicks on the button, the options are:
- Do Nothing – Nothing will happen if the player clicks the button.
- Dismiss – The popup image will be dismissed if the player clicks the button
- URL – The player will be navigated to a URL when they click the button. If selected an additional input control will let you specify the URL the player will be sent to.
This can be used to deeplink to a different part of the game or to navigate the player to a page on the appStore or any other website.
- Action – will trigger the action name and value that you specify in the game via a callback.
The position of the button within the image message can be set by entering values in to the X and Y inputs, but it is far easier to drag them in to position in the preview window.
This button has been set to Action and the action value has been defined as COINS_100. This will result in a callback being triggered in the App containing an action value of COINS_100, this could then be used to trigger the delivery of a 100 coin gift. You will need to coordinate with your developer to ensure that any action values you might want to specify are instrumented and supported in your game client. The URL action will automatically spawn the default client side browser navigation.
The Localize button can be used to upload localized versions of the button.
Then assign them to the relevant territories and languages
These will be used to deliver localised image messages to the player based on the language and territory settings on their device.
Background Image Panel
The background image panel is used to upload and assign a background image. You can configure the scale and positioning as well as defining what will happen if the user clicks or touches the background image. The drop down list beside the “Select an Image” button lets you specify what should happen if a player touches or clicks on the background image. They are the same four options that are available on button actions. (Do Nothing , Dismiss, URL and Action). In this example clicking the background image will do nothing.
When you click the “Select and Image” button, you will have the opportunity to upload a new image or select a previously uploaded image. You can view the list of images as a grid or as thumbnails, the grid view will reveal the image size and some other details. Select the image you wish to use as the background then click the “Use Selected” button to insert it into the background.
Clicking the localization button on the background image will let you specify additional background images and associate them to various territories and languages in the same way as you would with buttons as described above.
The preview panel shows you what your image message will look like on various devices and will even show you localized content based on the territory and language you specify.
It will refresh as you modify the image layout controls. If you have added buttons to your image message you can click on them in the preview interface to drag them to the correct position relative to your background image.
Background Appearance Panel
The background appearance controls let you determine what the background, between the edges of the screen and your background image, should look like and what should happen if it is clicked.
The Appearance options are None, Clear and Dimmed
The actions that can be performed if a user clicks on the background are Dismiss and No Action. Dismiss will close the image popup
Game Parameters Panel
Game parameters can be added to an image message too. The procedure for adding them is exactly the same as adding them to a Game Parameters action.
Finally, don’t forget to Save your action.
Your newly saved action will now be listed on the Action Management Screen. There are two buttons beside each action so you can Edit or Delete it.
Your action will also now be available for use when you are setting up campaigns.
When an image message action is triggered by a campaign the resulting JSON will be passed back to the game in the Engage response.
N.B. – If you are using one of our SDKs it will be able to display the pop-up and help with the button callbacks, however, if you aren’t using one of our SDK your game will be responsible for parsing the JSON response, displaying the pop-up and handling the button callbacks.
The example above will respond with a JSON response as follows.
The response contains three sections :
- The image section contains all the information that the SDK, or your own custom display code will require to display the popup image, buttons and handle any callbacks.
- The parameters section contains any Game Parameters included in the image action that your game can use to personalize the game play experience for the player.
- The eventParams section contains campaign metadata that will be recorded in the imageMessageAction event so you can analyze and report on player interactions with your image message popup. The deltaDNA SDK will automatically record the imageMessageAction event from v4.5 onwards, you may need to add this event to your schema in the Event Manager tool.
"responseEngagementName": "Power Up Gift AB Test",
"responseVariantName": "B - Gift MoHawk",
"itemName": "Super MoHawk",