ImageMessagePanel

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.

ImageMessageAction

The Action Panel lets you give your action a descriptive, meaningful name and contains 3 buttons that

1) Create a New action

2) Open an existing action

3) 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.

Background Image Panel

backgroundImage

Use the background image panel to upload a background image and configure the scale and positioning as well as defining what will happen if the user clicks or touches the background image.

imageloader

When you upload an image, you will be shown a preview of it and any other images you have uploaded. Select the image you wish to use as the background then click the “Use Selected Image” to insert it into the background. The drop down list beside the “Select Image” button lets you specify what should happen if a player touches or clicks on the background image. There are four possible outcomes.

  • Do Nothing
    Nothing will happen if the user touches the image
  • Dismiss
    The pop-up image will be dismissed if the player touches the image
  • URL
    The app will open a web browser and navigate to the specified URL
  • Action
    An specific action should be performed by the app, you can also specify the name of the action.

In this example clicking the background image will do nothing, but we will also add a couple of buttons and setup actions on them.

Preview Panel

PreviewPanel

The preview panel shows you what your image message will look like on various devices. 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.

Button Image Panel

button-panel

Buttons can be added to an image message. Use the “Select File” button to upload and select the button images and the Action drop down list to define what should happen if the player clicks on the button. This button has been set to URL and a webpage has been specified. This will result in the App spawning a web browser session and navigating to the specified URL. This behaviour can be used to take the player to specific pages in the app store if you are wanting to encourage a user to Rate your game or download another game.

New Button Panel

new-button

Additional buttons can be added to your image message by clicking the “Add” button on the new button panel.

Background Appearance Panel

background

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

gamepearametersempty

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.

Save-Panel

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.

Actions-List-Image

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.