Understand decoded optimization data objects

After the optimization data has been base64 decoded, you will end up with a JSON payload similar to the one below. Please refer to the sample app code to understand how this can be achieved in your app.

top-banner decoded JSON response

{
   "actions":[
      {
         "name":"Product 1B - top banner",
         "asset":{
            "content":"{ \"image\": \"https://raw.githubusercontent.com/thunderheadone/one-sdk-android/master/examples/optimizing-programmatically-using-json-example/app/src/main/assets/product_1b.png"}",
            "mimeType":"application/json",
            "contentUrl":null,
            "responses":[
               {
"code":"dGlkPWFjZjk5ZjgyLWQ4ZmItZjJiYy0zYzNhLWQ3NmE0MzgwNGI3MCxhYz0xMjQyNDYxMDMsY250PTEyNTEwNTc1MixvcD0xMTMzNzM3ODQscnQ9UE9TSVRJVkVfQ0xJQ0ssc2s9T05FLURaODdZWEQ5OEYtOTQwNQ",
                  "sentiment":"positive",
                  "label":null,
                  "imageUrl":null,
                  "targetUrl":null,
                  "target":null
               }
            ]
         },
         "proposition":{
            "code":""
         }
      }
   ]
}

card-item decoded JSON response

{
   "actions":[
      {
         "name":"Product 2B - card item",
         "asset":{
            "content":"{ \"image\": \"https://raw.githubusercontent.com/thunderheadone/one-sdk-android/master/examples/optimizing-programmatically-using-json-example/app/src/main/assets/product_2b.png"}",
            "mimeType":"application/json",
            "contentUrl":null,
            "responses":[
               {
"code":"dGlkPWFjZjk5ZjgyLWQ4ZmItZjJiYy0zYzNhLWQ3NmE0MzgwNGI3MCxhYz0xMjQyNDYxMDQsY250PTEyNTEwNTc1NCxvcD0xMTMzNzM3ODUscnQ9UE9TSVRJVkVfQ0xJQ0ssc2s9T05FLURaODdZWEQ5OEYtOTQwNQ",
                  "sentiment":"positive",
                  "label":null,
                  "imageUrl":null,
                  "targetUrl":null,
                  "target":null
               }
            ]
         },
         "proposition":{
            "code":""
         }
      }
   ]
}

JSON response parameters

The decoded optimization data response contains the following elements:

  • actions – an array of actions.
    • name – the name of the action as defined in MXO.
    • asset – the asset selected by the action.
      • content – the asset content as defined in MXO.
      • responses – positive, negative and/or neutral. For more information about responses, see What are customer responses? and Understanding asset responses.
      • code – the code sent to MXO when the user taps on the content.
      • sentiment – typically "positive".

Response elements

NameTypeDescription
actionArrayArray of actions that are relevant to the user.
action.nameStringAction name, defines on MXO.
action.assetObjectAsset assigned to this action, and matching the configuration in MXO.
action.asset.contentObjectContent of the asset.
action.asset.mime.typeStringData mime type for the asset. Assumed to be application/json in our example.
action.asset.contentUrlStringLink to the URL where the asset content is hosted.
action.asset.responsesArrayResponse array associated with the asset. Contains a list of all the responses that can be sent back for an asset to record the user sentiment.
action.asset.responses.labelStringResponse labels configured for the asset.
action.asset.responses.targetStringLocation where the target URl for the response should open. Either external or in_app.
action.asset.responses.sentimentStringResponse sentiment. Either positive, neutral, or negative.
action.asset.responses.imageUrlStringResponse image URL. Not used in this example.
action.asset.responses.codeStringResponse code. The unique response code to send back to MXO to record the specific sentiment.
action.asset.responses.targetUrlStringResponse target URL. The mini-notification target URL.