SDK Methods
The following methods are available to use in the Monetate SDK. All methods are part of the personalization class.
For parameters that require event names, refer to SDK Event and Action Types for syntax.
This method generates a Monetate ID and returns it as a string. You can store this ID locally for future use.
React Native
React Web
iOS
Android
generateMonetateId Method
1static generateMonetateId(): string
generateMonetateId Method
1static generateMonetateId(): string
generateMonetateId Method
1public func generateMonetateID () -> String
generateMonetateId Method
1public static string generateMonetateId();
React Native
React Web
iOS
Android
generateMonetateId Method Example
1const monetateId = Personalization.generateMonetateId()
generateMonetateId Method Example
1const monetateId = Personalization.generateMonetateId()
generateMonetateId Method Example
1let monetateId = self.personalization.generateMonetateID()
generateMonetateId Method Example
1String monetateId = Personalization.generateMonetateId();
Reports an event to Monetate. This allows data to later be used for decisions within Monetate. Use this method to report events.
React Native
React Web
iOS
Android
report Method
1report(context: EventTypes, events: ContextData): void
report Method
1report(context: EventTypes, events: ContextData): void
report Method
1report(context: <ContextEnum>, event: <MEvent?>)
report Method
1public void report(String context, Object events){}
This method must be run in a thread.
The parameters are as follows:
Parameter | Required | Description |
|---|---|---|
context | Yes | The name of the event |
events | Yes | The event data |
React Native
React Web
iOS
Android
report Method Example
1const personalizationInstance = new Personalization(user, account);
2
3const cart = {
4 "cartLines": [{
5 "sku": "SKU1",
6 "pid": "PID1",
7 "quantity": 2,
8 "currency": "USD",
9 "value": "24.00"
10 }]
11};
12personalizationInstance.report(
13 EventTypes.ContextCart,
14 { cartLines: cart }
15);
report Method Example
1const personalizationInstance = new Personalization(user, account);
2
3const cart = {
4 "cartLines": [{
5 "sku": "SKU1",
6 "pid": "PID1",
7 "quantity": 2,
8 "currency": "USD",
9 "value": "24.00"
10 }]
11};
12personalizationInstance.report(
13 EventTypes.ContextCart,
14 { cartLines: cart }
15);
report Method Example
1objPersonalization.report(context: .RecClicks, event: RecClicks(recClicks: ["rt.1.xxx", "rt.1.yyy"]))
report Method Example
1Account account = new Account("localhost.org", "a-701b337c", "p", "localhost");
2User user = new User();
3user.setDeviceId("1109349827122");
4
5try
6{
7 Personalization personalization = new Personalization(user, account);
8 IpAddress address = new IpAddress();
9 address.setIpAddress("127.0.0.0.");
10 new Thread(new Runnable()
11 {
12 @Override
13 public void run()
14 {
15 personalization.report(EventTypes.ContextIpaddress, address);
16 }
17 }).start();
18}
19catch (AccountDetailsException e)
20{
21 e.printStackTrace();
22}
This method adds event data to the SDK's internal stack. Use this method to add events to the stack that you intend to use to trigger experiences. You can use multiple calls of this method to add multiple events to stack. Use this method with getActionsData when an experience requires data from more than one event.
React Native
React Web
iOS
Android
addEvent Method
1addEvent(context: EventTypes, events: ContextData): void
addEvent Method
1addEvent(context: EventTypes, events: ContextData): void
addEvent Method
1addEvent(context: <ContextEnum>, event: <MEvent?>)
addEvent Method
1public void addEvent(String context, Object event)
The parameters are as follows:
Parameter | Required | Description |
|---|---|---|
context | Yes | The name of the event |
events | Yes | The event data |
React Native
React Web
iOS
Android
addEvent Method Example
1personalizationInstance.addEvent(EventTypes.ContextIpAddress, {
2 ipAddress: "10.0.0.2",
3});
4
5personalizationInstance.addEvent(EventTypes.ContextPageView, {
6 url: "http://www.monetate.com/index.html",
7 pageType: "Home"
8});
addEvent Method Example
1personalizationInstance.addEvent(EventTypes.ContextIpAddress, {
2 ipAddress: "10.0.0.2",
3});
4
5personalizationInstance.addEvent(EventTypes.ContextPageView, {
6 url: "http://www.monetate.com/index.html",
7 pageType: "Home"
8});
addEvent Method Example
1objPersonalization.addEvent(context: .ScreenSize, event: ScreenSize(height: 1000, width: 400))
2
3objPersonalization.addEvent(context: .IpAddress, event: IPAddress(ipAddress: "192.168.1.52"))
4
5objPersonalization.addEvent(context: .PageView, event: PageView(pageType: "PDP", path: "n/a", url: "n/a", categories: [], breadcrumbs: []))
addEvent Method Example
1IpAddress ipAddress = new IpAddress();
2ipAddress.setIpAddress("1.0.0.0");
3
4ScreenSize screenSize = new ScreenSize();
5screenSize.setHeight(1011);
6screenSize.setWidth(2011);
7
8PageView pageView = new PageView();
9pageView.setPageType("Cartpage");
10pageView.setUrl("https://www.monetate.com");
11
12personalization.addEvent(EventTypes.ContextIpAddress, ipAddress);
13personalization.addEvent(EventTypes.ContextPageView, pageView);
14personalization.addEvent(EventTypes.ContextScreenSize, screenSize);
Requests an experience decision from Monetate based off the action type. You can specify multiple action types in an array to get multiple responses.
The experience decision depends on event data reported using addEvent calls. Use addEvent to add report all of the relevant events before you use this method to request a decision.
React Native
React Web
iOS
Android
getActionsData Method
1getActionsData(actionType: Array<string>, includeReporting?: boolean) : Promise<any>
The parameters are as follows:
Parameter | Description |
|---|---|
actionType | 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
1getActionsData(actionType: Array<string>, includeReporting?: boolean) : Promise<any>
The parameters are 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
1getActionsData(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 actions you want to request. You can specify multiple actions in an array to handle.
getActionsData Method
1public 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.
The following example specifies a single action.
React Native
React Web
iOS
Android
getActionsData Method Example
1personalizationInstance
2 .getActionsData("monetate:action:OmnichannelJson")
3 .then(res => {
4 recsData = res[0].actions;
5 })
6 .catch(error => {
7 console.warn('Error!', error);
8 });
getActionsData Method Example
1personalizationInstance
2 .getActionsData("monetate:action:OmnichannelJson")
3 .then(res => {
4 recsData = res[0].actions;
5 })
6 .catch(error => {
7 console.warn('Error!', error);
8 });
getActionsData Method Example
1objPersonalization.getActionsData(
2 requestId: "123456", includeReporting: false,
3 arrActionTypes: ["monetate:action:OmniChannelRecommendation"]
4).on { res in
5 if res.status == 200 {
6 self.handleRecommendations(res: res)
7 } else {
8 }
9}
getActionsData Method Example
1try
2{
3 Personalization personalization = new personalization(user, account);
4
5 // Events and context data
6 IpAddress ipAddress = new IpAddress();
7 ipAddress.setIpAddress("1.0.0.0");
8 ScreenSize screenSize = new ScreenSize();
9 screenSize.setHeight(1011);
10 screenSize.setWidth(2011);
11 PageView pageView = new PageView();
12 pageView.setPageType("Cartpage");
13 pageView.setUrl("https://www.monetate.com");
14
15 // addEvent
16 personalization.addEvent(EventTypes.ContextScreenSize, screenSize);
17 personalization.addEvent(EventTypes.ContextIpAddress, ipAddress);
18 personalization.addEvent(EventTypes.ContextPageView, pageView);
19
20 // getActionsData
21 String responseData;
22 new Thread(new Runnable()
23 {
24 @Override
25 public void run()
26 {
27 // Gets the responseData using getActionsData
28 responseData = personalization.getActionsData("monetate:action:OmnichannelJson", true);
29 // Once you receive the responseData from getActionsData, use the Handler and parse the required data from it
30 new Handler(Looper.getMainLooper()).post(new Runnable()
31 {
32 @Override
33 public void run()
34 {
35 // Parse the received responseData, get the requiredData from it and use it accordingly
36 try
37 {
38 // Example: textView.setText(requiredData);
39 }
40 catch (Exception ex)
41 {
42 // Catch any exception that occurs while parsing
43 ex.printStackTrace();
44 }
45 }
46 });
47 }
48 }).start();
49}
50catch (AccountDetailsException e)
51{
52 e.printStackTrace();
53}
The following example specifies multiple actions.
React Native
React Web
iOS
Android
getActionsData Method Example with Multiple Actions
1// For multiple actions, send an array
2// When an empty array in passed as an argument, it will fetch all the configured Omnichannel actions
3const requiredActions : [ "monetate:action:OmnichannelRecommendation"
4 , "monetate:action:SocialProofDataV2" ]
5personalizationInstance
6 .getActionsData(requiredActions)
7 .then(res => {
8 recsData = res[0].actions;
9 })
10 .catch(error => {
11 console.warn('Error!', error);
12 });
getActionsData Method Example with Multiple Actions
1// For multiple actions, send an array
2// When an empty array in passed as an argument, it will fetch all the configured Omnichannel actions
3const requiredActions : [ "monetate:action:OmnichannelRecommendation"
4 , "monetate:action:SocialProofDataV2" ]
5personalizationInstance
6 .getActionsData(requiredActions)
7 .then(res => {
8 recsData = res[0].actions;
9 })
10 .catch(error => {
11 console.warn('Error!', error);
12 });
getActionsData Method Example with Multiple Actions
1objPersonalization.getActionsData(
2 requestId: "123456", includeReporting: false,
3 arrActionTypes: ["monetate:action:OmniChannelJson", "monetate:action:OmniChannelRecommendation"]
4).on { res in
5 if res.status == 200 {
6 self.handleRecommendations(res: res)
7 } else {
8 }
9}
getActionsData Method Example with Multiple Actions
1try
2{
3 Personalization personalization = new personalization(user, account);
4
5 // Events and context data
6 IpAddress ipAddress = new IpAddress();
7 ipAddress.setIpAddress("1.0.0.0");
8 ScreenSize screenSize = new ScreenSize();
9 screenSize.setHeight(1011);
10 screenSize.setWidth(2011);
11 PageView pageView = new PageView();
12 pageView.setPageType("Cartpage");
13 pageView.setUrl("https://www.monetate.com");
14
15 // addEvent
16 personalization.addEvent(EventTypes.ContextScreenSize, screenSize);
17 personalization.addEvent(EventTypes.ContextIpAddress, ipAddress);
18 personalization.addEvent(EventTypes.ContextPageView, pageView);
19
20 // getActionsData
21 String responseData;
22 new Thread(new Runnable()
23 {
24 @Override
25 public void run()
26 {
27 // Gets the responseData using getActionsData
28 responseData = personalization.getActionsData(new String[]{"monetate:action:OmnichannelJson","monetate:action:OmnichannelRecommendation"}, true);
29 // Once you receive the responseData from getActionsData, use the Handler and parse the required data from it
30 new Handler(Looper.getMainLooper()).post(new Runnable()
31 {
32 @Override
33 public void run()
34 {
35 // Parse the received responseData, get the requiredData from it and use it accordingly
36 try
37 {
38 // Example: textView.setText(requiredData);
39 }
40 catch (Exception ex)
41 {
42 // Catch any exception that occurs while parsing
43 ex.printStackTrace();
44 }
45 }
46 });
47 }
48 }).start();
49}
50catch (AccountDetailsException e)
51{
52 e.printStackTrace();
53}
Reports an event and immediately requests a decision from Monetate. Use this method if an experience you want to trigger requires a single event. This method returns a JSON object that includes the response data.
The response data can then be used in your application. For example, you can use this method to obtain data to display as a banner on a page.
React Native
React Web
iOS
Android
getActions Method
1getActions(actionType, context?, eventData?, includeReporting?) : Promise<any>
The parameters are as follows:
Parameter | Description |
|---|---|
actionType | The type of action you want to request. You can specify multiple actions in an array to handle. |
context | The name of the event. |
eventData | The data associated with the event. |
includeReporting | Indicates whether the response will have impression reporting data |
getActions Method
1getActions(actionType, context?, eventData?, includeReporting?) : Promise<any>
Parameters:
- actionType is the type of action you want to request. You can specify multiple actions in an array to handle.
- context is name of the event.
- eventData is the data associated with the event.
- includeReporting indicates whether the response will have impression reporting data.
getActions Method
1objPersonalization.getActions(context: <ContextEnum>, requestId: <String>, includeReporting: <Bool>, arrActionTypes: <[String]>, event: <MEvent?>)
Parameters:
- context is name of the event.
- requestID is the request ID for the API.
- includeReporting indicates whether the response will have impression reporting data.
- arrActionTypes is the type of actions you want to request. You can specify multiple actions in an array to handle.
- event is the data associated with the event.
getActions Method
1public String getActions(String context, Object event, String[] actionTypes, boolean includeReports) {returns response;}
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.
- context is name of the event.
- event is the data associated with the event.
- includeReports indicates whether the response will have impression reporting data.
React Native
React Web
iOS
Android
getActions Method Example
1import React, { useEffect, useState} from "react" ;
2import { View , Text} from "react-native" ;
3import Personalization from '@personalization-js-sdk/react-native';
4import { ActionTypes, EventTypes } from "@personalization-js-sdk/common";
5
6const test = () => {
7 const personalizationInstance = new Personalization(account, user)
8 const [actionData, setActionData] = useState({});
9
10 const handleGetActions = () => {
11 const eventType = EventTypes.ContextCart;
12 personalizationInstance.getActions("monetate:action:OmnichannelJson", eventType)
13 .then((res) => {
14 if (res.length > 0) {
15 res[0].actions.map((action) => {
16 if (action.json.meta && action.json.meta.tool === 'react-native') {
17 const data = {
18 color: action.json.data.json.color,
19 text: action.json.data.json.text,
20 fontSize: action.json.data.json.fontSize,
21 style: action.json.data.json.style,
22 buttonText: action.json.data.json.buttonText,
23 buttonColor: action.json.data.json.buttonColor,
24 };
25 setActionData(prevState => {
26 return {
27 ...prevState,
28 decisionEventData: data,
29 }
30 });
31 } else {
32 console.warn('Meta Object not present in Omni JSON.');
33 }
34 });
35 }
36 })
37 .catch((error) => console.warn('Please try after some time!', error));
38 };
39
40 useEffect(() => {
41 handleGetActions();
42 }, []);
43
44 return <View>
45 <Text> {actionData.buttonText} //Render Data On UI
46 </View>;
47};
getActions Method Example
1import React, { useEffect, useState} from "react" ;
2import Personalization from '@personalization-js-sdk/web';
3import { ActionTypes, EventTypes } from "@personalization-js-sdk/common";
4
5const test = () => {
6 const personalizationInstance = new Personalization(account, user)
7 const [actionData, setActionData] = useState({});
8
9 const handleGetActions = () => {
10 const eventType = EventTypes.ContextCart;
11 personalizationInstance.getActions("monetate:action:OmnichannelJson", eventType)
12 .then((res) => {
13 if (res.length > 0) {
14 res[0].actions.map((action) => {
15 if (action.json.meta && action.json.meta.tool === 'web') {
16 const data = {
17 color: action.json.data.json.color,
18 text: action.json.data.json.text,
19 fontSize: action.json.data.json.fontSize,
20 style: action.json.data.json.style,
21 buttonText: action.json.data.json.buttonText,
22 buttonColor: action.json.data.json.buttonColor,
23 };
24 setActionData(prevState => {
25 return {
26 ...prevState,
27 decisionEventData: data,
28 }
29 });
30 } else {
31 console.warn('Meta Object not present in Omni JSON.');
32 }
33 });
34 }
35 })
36 .catch((error) => console.warn('Please try after some time!', error));
37 };
38
39 useEffect(() => {
40 handleGetActions();
41 }, []);
42
43 return <div>
44 <p> {actionData.buttonText} //Render Data On UI </p>
45 </div>;
46};
getActions Method Example
1import MarqueeLabel
2import UIKit
3import monetate_ios_sdk
4
5class CategoryViewController: UIViewController {
6
7 @IBOutlet weak var bottomLabel: MarqueeLabel!
8 @IBOutlet weak var bottomView: UIView!
9 @IBOutlet weak var constraintHeightBottomView: NSLayoutConstraint!
10 final var objPersonalization = Personalization(
11 account: Account(
12 instance: "p", domain: "localhost.org", name: "a-701b337c", shortname: "localhost"),
13 user: User(deviceId: "62bd2e2d-213d-463f-83bb-12c0b2530a14"))
14
15 override func viewDidLoad() {
16 super.viewDidLoad()
17 self.bottomView.isHidden = true
18 self.constraintHeightBottomView.constant = 0
19 bottomLabel.text = ""
20 }
21
22 override func viewWillAppear(_ animated: Bool) {
23 super.viewWillAppear(animated)
24 pageEvent()
25 }
26
27 func pageEvent() {
28 objPersonalization.getActions(
29 context: .PageView, requestId: "test_request_id", includeReporting: false,
30 arrActionTypes: ["monetate:action:OmniChannelJson"],
31 event: PageView(
32 pageType: "Homepage", path: "n/a", url: "n/a", categories: [], breadcrumbs: [])
33 ).on { (res) in
34 if res.status == 200 {
35 let data = JSON(res.data)
36 print(data)
37 self.handleAction(res: res)
38 } else {
39 }
40 }
41 }
42
43 fileprivate func handleAction(res: APIResponse) {
44 let data = JSON(res.data)
45 for item in data["data"]["responses"].arrayValue {
46 bottomLabel.animationCurve = .linear
47 bottomLabel.speed = .duration(5)
48 bottomLabel.fadeLength = 15.0
49
50 if item["requestId"].string == res.requestId {
51 for oneaction in item["actions"].arrayValue {
52 let component = oneaction["component"].string ?? ""
53 if component.lowercased() == "footer" {
54 if let json = oneaction["json"].dictionary {
55 print("final dict \(json)")
56 if let text = json["text"]?.string {
57 self.bottomView.isHidden = false
58 self.constraintHeightBottomView.constant = 60
59 bottomLabel.text = text
60 if let fontStyle = json["style"]?.string, let fontSize = json["fontSize"]?.double {
61 if fontStyle == "bold" {
62 bottomLabel.font = UIFont(name: "Roboto-Bold", size: fontSize)
63 } else if fontStyle == "normal" {
64 bottomLabel.font = UIFont(name: "Roboto-Regular", size: fontSize)
65 } else if fontStyle == "italic" {
66 bottomLabel.font = UIFont(name: "Roboto-Italic", size: fontSize)
67 }
68 }
69 if let color = json["color"]?.string {
70 bottomLabel.textColor = MiscClass.hexStringToUIColor(hex: color)
71 }
72 if let backgroundColor = json["background-color"]?.string {
73 bottomView.backgroundColor = MiscClass.hexStringToUIColor(hex: backgroundColor)
74 return
75 }
76 }
77 }
78 }
79 }
80 }
81 }
82 }
83}
getActions Method Example
1Account account = new Account("localhost.org", "a-701b337c", "p", "localhost");
2User user = new User();
3user.setDeviceId("1109349827122");
4
5try
6{
7 Personalization personalization = new Personalization(user, account);
8 IpAddress address = new IpAddress();
9 address.setIpAddress("127.0.0.0.");
10 String responseData;
11
12 new Thread(new Runnable()
13 {
14 @Override
15 public void run()
16 {
17 // Get the responseData using getActions
18 responseData = personalization.getActions(EventTypes.ContextIpAddress, address, new String[] {"monetate:action:OmnichannelJson"}, true);
19 // Once you receive the responseData from getActions, use the Handler and parse the required data from it
20 new Handler(Looper.getMainLooper()).post(new Runnable()
21 {
22 @Override
23 public void run()
24 {
25 // Parse the received responseData, get the requiredData from it and use it accordingly
26 try
27 {
28 // Example: textView.setText(requiredData);
29 }
30 catch (Exception ex)
31 {
32 // Catch any exception that occurs while parsing
33 ex.printStackTrace();
34 }
35 }
36 });
37 }
38 }).start();
39}
40catch (AccountDetailsException e)
41{
42 e.printStackTrace();
43}
Immediately sends all event data that are currently queued. Use this method if you want to report an event immediately. This method returns a response of success or failure.
This method might throw the following exceptions that you must handle:
- InterruptedException
- ExecutionException
- TimeoutException
React Native
React Web
iOS
Android
flush Method
1flush()
flush Method
1flush()
flush Method
1flush()
flush Method
1public String flush() throws InterruptedException, ExecutionException, TimeoutException {}
React Web
React Native
iOS
Android
flush Method Example
1const Personalization= new Personalization(account, user);
2
3PersonalizationInstance.report (
4 'monetate:context:IpAddress',
5 { ipAddress: 10.10.10.10 }
6),
7Personalization.flush();
You can also capture the method response in a variable:
flush Method Reponse Example
1const response = Personalization.flush()
flush Method Example
1const Personalization= new Personalization(account, user);
2
3PersonalizationInstance.report (
4 'monetate:context:IpAddress',
5 { ipAddress: 10.10.10.10 }
6),
7Personalization.flush();
You can also capture the method response in a variable:
flush Method Response Example
1const response = Personalization.flush()
flush Method Example
1objPersonalization.report(context: .RecClicks, event: RecClicks(recClicks: ["rt.1.xxx", "rt.1.yyy"]))
2objPersonalization.report(context: .RecImpressions, event: RecImpressions(recImpressions: ["rt.2.xxx", "rt.2.yyy"]))
3objPersonalization.flush()
flush Method Example
1try
2{
3 Personalization personalization = new Personalization(user, account);
4 IpAddress address = new IpAddress();
5 address.setIpAddress("127.0.0.0.");
6 new Thread(new Runnable()
7 {
8 @Override
9 public void run()
10 {
11 Personalization.report(EventTypes.ContextIpaddress, address);
12 personalization.flush();
13 }
14 }).start();
15}
16catch (Exception e)
17{
18 e.printStackTrace();
19}
Updates the customerId within the User object.
React Native
React Web
iOS
Android
setCustomerId Method
1setCustomerId(customerId)
setCustomerId Method
1setCustomerId(customerId)
setCustomerId Method
1setCustomerId(customerId)
setCustomerId Method
1public void setCustomerId(String customerId);
The parameter is as follows:
- customerId is a string containing the customer ID. (Required)
React Native
React Web
iOS
Android
setCustomerId Method Example
1personalizationInstance.setCustomerId("test_customer_id");
setCustomerId Method Example
1personalizationInstance.setCustomerId("test_customer_id");
setCustomerId Method Example
1objPersonalization.setCustomerId(customerId:"155468")
setCustomerId Method Example
1personalization.setCustomerId("test_customer_id");