SDK Objects

The Monetate SDK consists of the following classes.
Personalization Class
Personalization is the main class. You can use an instance of this to invoke the different methods of SDK.
React Web
React Native
iOS
Android
Import this class using the following code:
Code to Import personalization Class
import personalization from '@personalization-js-sdk/web';
import personalization from '@personalization-js-sdk/web';
﻿
account and user are objects, and must be initialized to use as arguments for creating an instance of personalization. Refer to the object descriptions in this documentation for information on how to initialize them.
Create an instance of this class using the following code:
JS
const personalizationInstance = personalization (  
  account,
  user
)
const personalizationInstance = personalization (  
  account,
  user
)
﻿
Import this class using the following code:
Code to Import personalization Class
import personalization from '@personalization-js-sdk/react-native';
import personalization from '@personalization-js-sdk/react-native';
﻿
account and user are objects, and must be initialized to use as arguments for creating an instance of personalization. Refer to the object descriptions in this documentation for information on how to initialize them.
Create an instance of this class using the following code:
Code to Create a personalization Class Instance
const personalizationInstance = personalization (  
  account,
  user
)
const personalizationInstance = personalization (  
  account,
  user
)
﻿
Code to Import personalization Class
import Foundation
import monetate_ios_sdk
import Foundation
import monetate_ios_sdk
﻿
account and user are classes, and must be initialized to use as arguments for creating an instance of personalization. Refer to the object descriptions in this documentation for information on how to initialize them.
Create an instance of this class using the following code:
Code to Create a personalization Class Instance
final var personalization = Personalization(account: Account(instance: "p", domain: "localhost.org", name: "a-701b337c", shortname: "localhost"), user: User(monetateId: "2.1454546575.1711006580023", deviceId: "62bd2e2d-213d-463f-83bb-12c0b2530a14", customerId: "12345")) 
final var personalization = Personalization(account: Account(instance: "p", domain: "localhost.org", name: "a-701b337c", shortname: "localhost"), user: User(monetateId: "2.1454546575.1711006580023", deviceId: "62bd2e2d-213d-463f-83bb-12c0b2530a14", customerId: "12345")) 
﻿
Create an instance of this class using the following code:
Code to Create a personalization Class Instance
Personalization personalization = new Personalization(user,account);
Personalization personalization = new Personalization(user,account);
﻿
account and user are classes, and must be initialized to use as arguments for creating an instance of personalization. Refer to the object descriptions in this documentation for information on how to initialize them.
If any of the parameters of the Account class are missing, then this class constructor throws the AccountDetailsException. You must handle the exception using this class. Here's an example:
Example Code to Handle AccountDetailsException
try    
  {
    Personalization  personalization = new Personalization(user, account);
  } catch (AccountDetailsException e) {
    e.printStackTrace();
  }
try    
  {
    Personalization  personalization = new Personalization(user, account);
  } catch (AccountDetailsException e) {
    e.printStackTrace();
  }
﻿
Account Object
This object contains information about the account.
React Web
React Native
iOS
Android
Export this class using the following code:
Code to Export account Object
export const account = {
  domain: '', // Domain name
  name: '', // Account name
  instance: '', // Instance for the domain
  shortname: '', // Short name for the account
};
export const account = {
  domain: '', // Domain name
  name: '', // Account name
  instance: '', // Instance for the domain
  shortname: '', // Short name for the account
};
﻿
You must provide data for this object.
Export this object using the following code:
Code to Export account Object
export const account = {
  domain: '', // Domain name
  name: '', // Account name
  instance: '', // Instance for the domain
  shortname: '', // Short name for the account
};
export const account = {
  domain: '', // Domain name
  name: '', // Account name
  instance: '', // Instance for the domain
  shortname: '', // Short name for the account
};
﻿
You must provide data for this object.
Export this class using the following code:
Code to Export Account Object
let account = Account(
  instance: ,  // Instance for the domain
  domain: ,  // Domain name
  name: ,  // Account name
  shortname:  // Short name for the account
)
let account = Account(
  instance: ,  // Instance for the domain
  domain: ,  // Domain name
  name: ,  // Account name
  shortname:  // Short name for the account
)
﻿
You must provide data for this class.
Create an instance of this class using the following code:
Code to Export account Object
Account account = new Account();     
account.setDomain(""); // Domain name
account.setName(""); // Account name
account.setInstance(""); // Instance for the domain
account.setShortname(""); // Short name for the account
Account account = new Account();     
account.setDomain(""); // Domain name
account.setName(""); // Account name
account.setInstance(""); // Instance for the domain
account.setShortname(""); // Short name for the account
﻿
You must provide data for this class.
Code Example
React Web
React Native
iOS
Android
Example Code to Export account Object
const account = {
  domain: "monetate.mybigcommerce.com",
  name: "a-3e41bf76",
  instance: "p",
  shortname: "monetatebc",
};
const account = {
  domain: "monetate.mybigcommerce.com",
  name: "a-3e41bf76",
  instance: "p",
  shortname: "monetatebc",
};
﻿
Example Code to Export account Object
const account = {
  domain: "monetate.mybigcommerce.com",
  name: "a-3e41bf76",
  instance: "p",
  shortname: "monetatebc",
};
const account = {
  domain: "monetate.mybigcommerce.com",
  name: "a-3e41bf76",
  instance: "p",
  shortname: "monetatebc",
};
﻿
Example Code to Export Account Object
let account = Account(
  instance: "p",  // Instance for the domain
  domain: "localhost.org",  // Domain name
  name: "a-701b448c",  // Account name
  shortname: "localhost"  // Short name for the account
)
let account = Account(
  instance: "p",  // Instance for the domain
  domain: "localhost.org",  // Domain name
  name: "a-701b448c",  // Account name
  shortname: "localhost"  // Short name for the account
)
﻿
Example Code to Export Account Object
Account account = new Account();     
account.setDomain("monetate.mybigcommerce.com");
account.setName("a-3e41bf76");
account.setInstance("p");
account.setShortname("monetatebc");
Account account = new Account();     
account.setDomain("monetate.mybigcommerce.com");
account.setName("a-3e41bf76");
account.setInstance("p");
account.setShortname("monetatebc");
﻿
User Object
This object contains information about the user.
React Web
React Native
iOS
Android
Create an instance of this class using the following code:
Code to Create user Object Instance
export const user = {
  deviceId: '', // Device ID
  monetateId: '', // Monetate ID
  customerId: '', // Customer ID
};
export const user = {
  deviceId: '', // Device ID
  monetateId: '', // Monetate ID
  customerId: '', // Customer ID
};
﻿
When creating this object, you must provide either the device ID or the Monetate ID. The recommended ID to use is the device ID.
monetateId — This is used for customer identification. You can generate this ID using the generateMonetateId﻿ method of the Personalization class.
deviceId — This identifies the mobile device ID and is provided by the customer. Used for customer identification. The recommended ID to use.
customerId — This ID is optional. If you define it here, you must also pass it in calls with the other ID you use. You can later change the customer ID with the setCustomerId﻿ method.
You can store the device ID or Monetate ID locally to identify the same customer later.
Create an instance of this class using the following code:
Code to Create user Object Instance
export const user = {
  deviceId: '', // Device ID
  monetateId: '', // Monetate ID
  customerId: '', // Customer ID
};
export const user = {
  deviceId: '', // Device ID
  monetateId: '', // Monetate ID
  customerId: '', // Customer ID
};
﻿
When creating this object, you must provide either the device ID or the Monetate ID. The recommended ID to use is the device ID.
monetateId — Used for customer identification. You can generate this ID using the generateMonetateId﻿ method of the Personalization class.
deviceId — The mobile device ID and is provided by the customer. Used for customer identification. The recommended ID to use.
customerId — This ID is optional. If you define it here, you must also pass it in calls with the other ID you use. You can later change the customer ID with the setCustomerId﻿ method.
You can store the device ID or Monetate ID locally to identify the same customer later.
﻿
Create an instance of this class using the following code:
Code to Create User Object Instance
let user = User(
  monetateId: ,  // Monetate ID
  deviceId: ,  // Device ID
  customerId:   // Customer ID.
)
let user = User(
  monetateId: ,  // Monetate ID
  deviceId: ,  // Device ID
  customerId:   // Customer ID.
)
﻿
When creating this object, you must set either the device ID or the Monetate ID with the above method calls. The recommended ID to use is the device ID.
monetateId — An ID generated from the Monetate server. You can generate this ID using the generateMonetateId﻿ method of the Personalization class.
deviceId — The ID of the customer's device. The recommended ID to use.
customerId — The ID of the customer. This ID is optional. If you define it here, you must also pass it in calls with the other ID you use. You can later change the customer ID with the setCustomerId﻿ method.
When you create a Personalization object for the first time, there is no Monetate ID to associate with the User object. You must first initialize a User object with a device ID. After you do that, you can generate a Monetate ID for the User object by calling the generateMonetateID method. The following example code demonstrates how to do this:
Example Code to Call the generateMonetateID Method
final var objPersonalization = Personalization(account: Account(instance: "p", domain: "localhost.org", name: "a-701b337c", shortname: "localhost"), user: User(deviceId: "62bd2e2d-213d-463f-83bb-12c0b2530a14", customerId: "12345")) 
let monetateId =  objPersonalization.generateMonetateID()
final var objPersonalization = Personalization(account: Account(instance: "p", domain: "localhost.org", name: "a-701b337c", shortname: "localhost"), user: User(deviceId: "62bd2e2d-213d-463f-83bb-12c0b2530a14", customerId: "12345")) 
let monetateId =  objPersonalization.generateMonetateID()
﻿
Create an instance of this class using the following code:
Code to Create User Object Instance
User user = new User();
// Set only one of these IDs
user.setDeviceId("1109349827122"); // Device ID
user.setMonetateId("2.1189737281.1718190856247"); // Monetate ID
// Set the customer ID only if you have one
user.setCustomerId("customer@xyz1234567"); // Customer ID
User user = new User();
// Set only one of these IDs
user.setDeviceId("1109349827122"); // Device ID
user.setMonetateId("2.1189737281.1718190856247"); // Monetate ID
// Set the customer ID only if you have one
user.setCustomerId("customer@xyz1234567"); // Customer ID
﻿
When creating this class, you must set either the device ID or the Monetate ID with the above method calls. The recommended ID to use is the device ID.
monetateId— Used for customer identification. You can generate this ID using the generateMonetateId﻿ method of the Personalization class.
deviceId — The mobile device ID and is provided by the customer. Used for customer identification. The recommended ID to use.
customerId — This ID is optional. If you define it here, you must also pass it in calls with the other ID you use. You can later change the customer ID with the setCustomerId﻿ method.
You can store the device ID or Monetate ID locally to identify the same customer later.
﻿
Updated 25 Sep 2024
Install the Monetate SDKs
SDK Methods