Actions
Create a Recommendations Action

Omnichannel recommendations is an integrated product recommendations experience that is consistent across all platforms that you connect to Monetate. Whether a customer is viewing your storefront through a mobile app or your site, Omnichannel recommendations ensure a consistent experience.
You can set up a handler for an Omnichannel recommendations action by using two methods. The addEvents method defines the events that can trigger the action. The getActionsData method is then used as the trigger and requests the decision based on the defined events. getActionsData then returns a JSON object containing recommendations data that you can then handle in code.
Prerequisites
You must first create an Omnichannel experience in the Monetate platform for the methods to reference. Refer to Configure an Omnichannel Recommendations Action in the Monetate Knowledge Base for instructions.
Make note of the WHO settings﻿ because they correspond to events your code listens for. The example experience in this article uses the following WHO settings:
IP address is 1.0.0.2
Screen height is at least 500 pixels and screen width is at least 300 pixels
The example code in this article fulfills these conditions and will trigger the Omnichannel experience.
addEvent
This method adds event data to the SDK's internal stack.
React Native
React Web
iOS
Android
addEvent Method
addEvent(context: EventTypes, events: ContextData): void
addEvent(context: EventTypes, events: ContextData): void
﻿
The parameters are as follows:
context is name of the event.
events is the event data.
addEvent Method
addEvent(context: EventTypes, events: ContextData): void
addEvent(context: EventTypes, events: ContextData): void
﻿
The parameters are as follows:
context is name of the event.
events is the event data.
addEvent Method
addEvent(context: <ContextEnum>, event: <MEvent?>)
addEvent(context: <ContextEnum>, event: <MEvent?>)
﻿
The parameters are as follows:
context is name of the event. (Required)
event is the event data. (Required)
addEvent Method
public void addEvent(String context, Object event)
public void addEvent(String context, Object event)
﻿
The parameters are as follows:
context is name of the event. (Required)
event is the event data. (Required)
You can use this method multiple times to add all the necessary events for an experience you might want to trigger. The example code uses multiple method calls to fulfill the experience requirements.
Code Example
React Native
React Web
iOS
Android
addEvent Example
personalizationInstance.addEvent(EventTypes.ContextScreenSize, { width: 23, height: 34 });

personalizationInstance.addEvent(EventTypes.ContextIpAddress, {
  ipAddress: "10.0.0.2",
});

personalizationInstance.addEvent(EventTypes.ContextPageView, {
  url: "http://www.monetate.com/index.html",
  pageType: "Home"
});
personalizationInstance.addEvent(EventTypes.ContextScreenSize, { width: 23, height: 34 });

personalizationInstance.addEvent(EventTypes.ContextIpAddress, {
  ipAddress: "10.0.0.2",
});

personalizationInstance.addEvent(EventTypes.ContextPageView, {
  url: "http://www.monetate.com/index.html",
  pageType: "Home"
});
﻿
addEvent Example
personalizationInstance.addEvent(EventTypes.ContextScreenSize, { width: 23, height: 34 });

personalizationInstance.addEvent(EventTypes.ContextIpAddress, {
  ipAddress: "10.0.0.2",
});

personalizationInstance.addEvent(EventTypes.ContextPageView, {
  url: "http://www.monetate.com/index.html",
  pageType: "Home"
});
personalizationInstance.addEvent(EventTypes.ContextScreenSize, { width: 23, height: 34 });

personalizationInstance.addEvent(EventTypes.ContextIpAddress, {
  ipAddress: "10.0.0.2",
});

personalizationInstance.addEvent(EventTypes.ContextPageView, {
  url: "http://www.monetate.com/index.html",
  pageType: "Home"
});
﻿
addEvent Example
objPersonalization.addEvent(context: .ScreenSize, event: ScreenSize(height: 1000, width: 400))

objPersonalization.addEvent(context: .IpAddress, event: IPAddress(ipAddress: "192.168.1.52")) 

objPersonalization.addEvent(context: .PageView, event: PageView(pageType: "PDP", path: "n/a", url: "n/a", categories: [], breadcrumbs: [])) 
objPersonalization.addEvent(context: .ScreenSize, event: ScreenSize(height: 1000, width: 400))

objPersonalization.addEvent(context: .IpAddress, event: IPAddress(ipAddress: "192.168.1.52")) 

objPersonalization.addEvent(context: .PageView, event: PageView(pageType: "PDP", path: "n/a", url: "n/a", categories: [], breadcrumbs: [])) 
﻿
addEvent Example
personalization.addEvent(EventTypes.ContextIpAddress, new IpAddress("1.0.0.0"));
personalization.addEvent(EventTypes.ContextPageView, new PageView("home", "test.com",new String[] {"categoies"} ,new String[] {"breadcrums"}));
personalization.addEvent(EventTypes.ContextScreenSize, new ScreenSize(1011, 2011));
personalization.addEvent(EventTypes.ContextIpAddress, new IpAddress("1.0.0.0"));
personalization.addEvent(EventTypes.ContextPageView, new PageView("home", "test.com",new String[] {"categoies"} ,new String[] {"breadcrums"}));
personalization.addEvent(EventTypes.ContextScreenSize, new ScreenSize(1011, 2011));
﻿
getActionsData
This method sends the defined events to Monetate to trigger an experience. If the events fulfill the WHO settings of an experience, then that experience is triggered. A JSON object containing the experience response is then returned.
React Native
React Web
iOS
Android
getActionsData Method
getActionsData(actionType: Array<string>, includeReporting?: boolean) : Promise<any>
getActionsData(actionType: Array<string>, includeReporting?: boolean) : Promise<any>
﻿
The parameter is as follows:
actionType is the type of action you want to request. You can specify one action or multiple actions in an array to handle.
includeReporting indicates whether the response will have impression reporting data.
getActionsData Method
getActionsData(actionType: Array<string>, includeReporting?: boolean) : Promise<any>
getActionsData(actionType: Array<string>, includeReporting?: boolean) : Promise<any>
﻿
The parameter is as follows:
actionType is the type of action you want to request. You can specify one action or multiple actions in an array to handle.
includeReporting indicates whether the response will have impression reporting data.
getActionsData Method
getActionsData(requestId: <String>, includeReporting: <Bool>, arrActionTypes: <[String]>) 
getActionsData(requestId: <String>, includeReporting: <Bool>, arrActionTypes: <[String]>) 
﻿
The parameters are as follows:
requestID is the request ID for the API.
includeReporting indicates whether the response will have impression reporting data.
arrActionTypes is the type of action you want to request. You can specify one action or multiple actions in an array to handle.
getActionsData Method
public String getActionsData(String[] actionTypes, boolean includeReports)
public String getActionsData(String[] actionTypes, boolean includeReports)
﻿
The parameters are as follows:
actionTypes is the type of action you want to request. You can specify one action or multiple actions in an array to handle.
includeReports indicates whether the response will have impression reporting data.
Code Example
React Native
React Web
iOS
Android
getActionsData Example
let recData;
personalizationInstance
  .getActionsData("monetate:action:OmnichannelRecommendation")
  .then(res => {
    recsData = res[0].actions;
  })
  .catch(error => {
    console.warn('Error!', error);
  });
let recData;
personalizationInstance
  .getActionsData("monetate:action:OmnichannelRecommendation")
  .then(res => {
    recsData = res[0].actions;
  })
  .catch(error => {
    console.warn('Error!', error);
  });
﻿
getActionsData Example
let recData;
personalizationInstance
  .getActionsData("monetate:action:OmnichannelRecommendation")
  .then(res => {
    recsData = res[0].actions;
  })
  .catch(error => {
    console.warn('Error!', error);
  });
let recData;
personalizationInstance
  .getActionsData("monetate:action:OmnichannelRecommendation")
  .then(res => {
    recsData = res[0].actions;
  })
  .catch(error => {
    console.warn('Error!', error);
  });
﻿
getActionsData Example
objPersonalization.getActionsData(requestId: "123456", includeReporting: false, arrActionTypes:["monetate:action:OmniChannelRecommendation"]).on{res in 
  if res.status==200 {
    self.handleRecommendations(res: res)
  } else {
  }
 }
}
objPersonalization.getActionsData(requestId: "123456", includeReporting: false, arrActionTypes:["monetate:action:OmniChannelRecommendation"]).on{res in 
  if res.status==200 {
    self.handleRecommendations(res: res)
  } else {
  }
 }
}
﻿
getActionsData Example
String responseData = personalization.getActionsData(new String[]{"monetate:action:OmnichannelRecommendation"},true);
String responseData = personalization.getActionsData(new String[]{"monetate:action:OmnichannelRecommendation"},true);
﻿
Full Code Example
React Native
React Web
iOS
Android
Recommendations Action Full Example
// Add Context / Events
// -----------------------------------------------------
personalizationInstance.addEvent(EventTypes.ContextScreenSize,
{
  width: 23,
  height: 34
});
personalizationInstance.addEvent(EventTypes.ContextIpAddress,
{
  ipAddress: "10.0.0.2",
});
personalizationInstance.addEvent(EventTypes.ContextPageView,
{
  url: "http://www.monetate.com/index.html",
  pageType: "Home"
});
// ----------------------------------------------------
// Get Actions
let recData;
personalizationInstance
  .getActionsData("monetate:action:OmnichannelRecommendation")
  .then(res =>
  {
    recsData = res[0].actions;
  })
  .catch(error =>
  {
    console.warn('Error!', error);
  });
// Add Context / Events
// -----------------------------------------------------
personalizationInstance.addEvent(EventTypes.ContextScreenSize,
{
  width: 23,
  height: 34
});
personalizationInstance.addEvent(EventTypes.ContextIpAddress,
{
  ipAddress: "10.0.0.2",
});
personalizationInstance.addEvent(EventTypes.ContextPageView,
{
  url: "http://www.monetate.com/index.html",
  pageType: "Home"
});
// ----------------------------------------------------
// Get Actions
let recData;
personalizationInstance
  .getActionsData("monetate:action:OmnichannelRecommendation")
  .then(res =>
  {
    recsData = res[0].actions;
  })
  .catch(error =>
  {
    console.warn('Error!', error);
  });
﻿
Recommendations Action Full Example
// Add Context / Events
//-------------------------------------------------------------------------
personalizationInstance.addEvent(EventTypes.ContextScreenSize, { width: 23, height: 34 });

personalizationInstance.addEvent(EventTypes.ContextIpAddress, {
  ipAddress: "10.0.0.2",
});

personalizationInstance.addEvent(EventTypes.ContextPageView, {
  url: "http://www.monetate.com/index.html",
  pageType: "Home"
});

// Get Actions
// ----------------------------------------------------
let recData;
personalizationInstance
  .getActionsData("monetate:action:OmnichannelRecommendation")
  .then(res => {
    recsData = res[0].actions;
  })
  .catch(error => {
    console.warn('Error!', error);
  });
// Add Context / Events
//-------------------------------------------------------------------------
personalizationInstance.addEvent(EventTypes.ContextScreenSize, { width: 23, height: 34 });

personalizationInstance.addEvent(EventTypes.ContextIpAddress, {
  ipAddress: "10.0.0.2",
});

personalizationInstance.addEvent(EventTypes.ContextPageView, {
  url: "http://www.monetate.com/index.html",
  pageType: "Home"
});

// Get Actions
// ----------------------------------------------------
let recData;
personalizationInstance
  .getActionsData("monetate:action:OmnichannelRecommendation")
  .then(res => {
    recsData = res[0].actions;
  })
  .catch(error => {
    console.warn('Error!', error);
  });
﻿
Recommendations Action Full Example
// Add Context / Events
//-------------------------------------------------------------------------
objPersonalization.addEvent(context: .ScreenSize, event: ScreenSize(height: 1000, width: 400))

objPersonalization.addEvent(context: .IpAddress, event: IPAddress(ipAddress: "192.168.1.52"))

objPersonalization.addEvent(
  context: .PageView,
  event: PageView(pageType: "PDP", path: "n/a", url: "n/a", categories: [], breadcrumbs: []))

// Get Actions
// ----------------------------------------------------
objPersonalization.getActionsData(
  requestId: "123456", 
  includeReporting: false,
  arrActionTypes: ["monetate:action:OmnichannelRecommendation"]
).on { res in
  if res.status == 200 {
    self.handleRecommendations(res: res)
  } else {
  }
}

private func handleRecommendations(res: APIResponse) {
  let data = JSON(res.data as Any)
  for item in data["data"]["responses"].arrayValue {
    if item["requestId"].string == res.requestId {
      for oneAction in item["actions"].arrayValue {
        if oneAction["component"].string == "iOS_InApp_Recs" {
          recProductArr.removeAll()
          self.recLabel.isHidden = false
          self.recLineSeperatorView.isHidden = false
          self.collectionView.isHidden = false

          for productDict in oneAction["items"].arrayValue {
            for cat in CategoryGeneratorforProducts.categories {
              for prdct in cat.products {
                if prdct.pid == productDict["id"].rawValue as! String {
                  prdct.recToken = productDict["recToken"].rawValue as? String
                  prdct.recSetId = productDict["recSetId"].rawValue as? Double
                  prdct.affinity = productDict["_affinity"].rawValue as? Double
                  prdct.rawAffinity = productDict["_rawAffinity"].rawValue as? Double
                  prdct.slotIndex = productDict["slotIndex"].rawValue as? Int
                  recProductArr.append(prdct)
                }
              }
            }
          }
          self.collectionView.reloadData()
          DispatchQueue.main.asyncAfter(
            deadline: .now() + 2.0,
            execute: {
              self.collectionView.reloadData()
            })
          return
        }
      }
    }
  }
}
// Add Context / Events
//-------------------------------------------------------------------------
objPersonalization.addEvent(context: .ScreenSize, event: ScreenSize(height: 1000, width: 400))

objPersonalization.addEvent(context: .IpAddress, event: IPAddress(ipAddress: "192.168.1.52"))

objPersonalization.addEvent(
  context: .PageView,
  event: PageView(pageType: "PDP", path: "n/a", url: "n/a", categories: [], breadcrumbs: []))

// Get Actions
// ----------------------------------------------------
objPersonalization.getActionsData(
  requestId: "123456", 
  includeReporting: false,
  arrActionTypes: ["monetate:action:OmnichannelRecommendation"]
).on { res in
  if res.status == 200 {
    self.handleRecommendations(res: res)
  } else {
  }
}

private func handleRecommendations(res: APIResponse) {
  let data = JSON(res.data as Any)
  for item in data["data"]["responses"].arrayValue {
    if item["requestId"].string == res.requestId {
      for oneAction in item["actions"].arrayValue {
        if oneAction["component"].string == "iOS_InApp_Recs" {
          recProductArr.removeAll()
          self.recLabel.isHidden = false
          self.recLineSeperatorView.isHidden = false
          self.collectionView.isHidden = false

          for productDict in oneAction["items"].arrayValue {
            for cat in CategoryGeneratorforProducts.categories {
              for prdct in cat.products {
                if prdct.pid == productDict["id"].rawValue as! String {
                  prdct.recToken = productDict["recToken"].rawValue as? String
                  prdct.recSetId = productDict["recSetId"].rawValue as? Double
                  prdct.affinity = productDict["_affinity"].rawValue as? Double
                  prdct.rawAffinity = productDict["_rawAffinity"].rawValue as? Double
                  prdct.slotIndex = productDict["slotIndex"].rawValue as? Int
                  recProductArr.append(prdct)
                }
              }
            }
          }
          self.collectionView.reloadData()
          DispatchQueue.main.asyncAfter(
            deadline: .now() + 2.0,
            execute: {
              self.collectionView.reloadData()
            })
          return
        }
      }
    }
  }
}
﻿
Recommendations Action Full Example
Personalization personalization = new personalization(user, account);

// Events and context data
IpAddress ipAddress = new IpAddress();
ipAddress.setIpAddress("1.0.0.0");
ScreenSize screenSize = new ScreenSize();
screenSize.setHeight(1011);
screenSize.setWidth(2011);
PageView pageView = new PageView();
pageView.setPageType("Cartpage");
pageView.setUrl("https://www.monetate.com");

// addEvent
personalization.addEvent(EventTypes.ContextScreenSize, screenSize);
personalization.addEvent(EventTypes.ContextIpAddress, ipAddress);
personalization.addEvent(EventTypes.ContextPageView, pageView);

// getActionsData
String responseData;
new Thread(new Runnable()
{
  @Override
  public void run()
  {
    // Gets the responseData using getActionsData
    responseData = personalization.getActionsData(new String[]
    {
      "monetate:action:OmnichannelRecommendation"
    }, true);
    // Once you receive the responseData from getActionsData, use the Handlerand parse the required data from it 
    new Handler(Looper.getMainLooper()).post(new Runnable()
    {
      @Override
      public void run()
      {
        // Parse the received responseData, get the requiredData from it and use it accordingly
        try
        {
          // Example: textView.setText(requiredData);
        }
        catch (Exception ex)
        {
          // Catch any exception that occurs while parsing 
          ex.printStackTrace();
        }
      }
    });
  }
}).start();
Personalization personalization = new personalization(user, account);

// Events and context data
IpAddress ipAddress = new IpAddress();
ipAddress.setIpAddress("1.0.0.0");
ScreenSize screenSize = new ScreenSize();
screenSize.setHeight(1011);
screenSize.setWidth(2011);
PageView pageView = new PageView();
pageView.setPageType("Cartpage");
pageView.setUrl("https://www.monetate.com");

// addEvent
personalization.addEvent(EventTypes.ContextScreenSize, screenSize);
personalization.addEvent(EventTypes.ContextIpAddress, ipAddress);
personalization.addEvent(EventTypes.ContextPageView, pageView);

// getActionsData
String responseData;
new Thread(new Runnable()
{
  @Override
  public void run()
  {
    // Gets the responseData using getActionsData
    responseData = personalization.getActionsData(new String[]
    {
      "monetate:action:OmnichannelRecommendation"
    }, true);
    // Once you receive the responseData from getActionsData, use the Handlerand parse the required data from it 
    new Handler(Looper.getMainLooper()).post(new Runnable()
    {
      @Override
      public void run()
      {
        // Parse the received responseData, get the requiredData from it and use it accordingly
        try
        {
          // Example: textView.setText(requiredData);
        }
        catch (Exception ex)
        {
          // Catch any exception that occurs while parsing 
          ex.printStackTrace();
        }
      }
    });
  }
}).start();
﻿
You must handle the getActions method in a Thread or AsyncTask. To update the main thread, you can use either Handler or runOnUiThread. This full code example uses Thread and Handler to update the main thread and change the UI.
﻿
Updated 24 Oct 2024
Create an Image-Based Badging Action
Create Social Proof Actions