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 Native

React Web

iOS

Android

Import this class using the following code:

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:

const personalizationInstance = personalization (  
  account,
  user
)

Import this class using the following code:

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:

const personalizationInstance = personalization (  
  account,
  user
)

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:

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:

Personalization personalization = new Personalization(user,account);

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:

try    
  {
    Personalization  personalization = new Personalization(user, account);
  } catch (AccountDetailsException e) {
    e.printStackTrace();
  }

Account Object

This object contains information about the account. Configurable Engine Endpoint Support Across SDK (Android , IOS, React) Support has been introduced to configure the engine endpoint dynamically using the engineHostName field in the Account object.

Key Benefits:

Enables flexible endpoint selection based on environment (e.g., regional, staging, custom deployments)

Falls back to the default endpoint (engine.monetate.net) whenengineHost is not provided or set to null, empty

Usage Overview: Developers can optionally pass the engineHostName while initializing the Account object. If omitted, the SDK automatically uses the default production endpoint. refer to Engine Endpoint Configuration.

React Native

React Web

IOS

Android

Create an instance of this class using the following code:

const account = {
    domain: "", // Domain name
    name: "",// Account name
    instance: "",// Instance for the domain
    shortname: "", // Short name for the account
    engineHostName:""// Optional: Override engine endpoint
};

Create an instance of this class using the following code:

const account = {
    domain: "", // Domain name
    name: "",// Account name
    instance: "",// Instance for the domain
    shortname: "", // Short name for the account
    engineHostName:" "// Optional: Override engine endpoint
};

Create an instance of this class using the following code:

let newAccount = Account( 
  instance: "", //instance for the domain
  domain: "",// Domain name
  name: "", // Account name
  shortname: "", // short name for the account
  engineHostName: "")//  Optional: Override engine endpoint

Create an instance of this class using the following code:

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.setEngineHostName("")// Optional: Override engine endpoint

You must provide data for this class.

Code Example

React Web

React Native

iOS

Android

const account = {
  domain: "monetate.mybigcommerce.com",
  name: "a-3e41bf76",
  instance: "p",
  shortname: "monetatebc",
  engineHostName:"engine-us-east-1.monetate.net"
};

const account = {
  domain: "monetate.mybigcommerce.com",
  name: "a-3e41bf76",
  instance: "p",
  shortname: "monetatebc",
  engineHostName:"engine-us-east-1.monetate.net"
};

let account = Account(
  instance: "p",  
  domain: "localhost.org",  
  name: "a-701b448c",  
  shortname: "localhost",  
  engineHostName: "engine-us-east-1.monetate.net"
)

Account account = new Account();     
account.setDomain("monetate.mybigcommerce.com");
account.setName("a-3e41bf76");
account.setInstance("p");
account.setShortname("monetatebc");
account.setEngineHostName("engine-us-east-1.monetate.net");

User Object

This object contains information about the user.

React Native

React Web

iOS

Android

Create an instance of this class using the following code:

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:

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:

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:

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:

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.

Context Layer

Note: The Context Layer is currently supported on the Android and iOS SDKs only.The React SDK is not impacted by these changes.

Available from

Android : 1.0.8-A and later

React Native : 1.0.4-RN and later

React Web : 1.0.2-W and later

iOS : 2026.04.28 and later

The Context Layer is a core SDK component responsible for collecting, structuring, and storing all event-level and contextual data required by:

Reporting APIs (report methods)

getActions() method It acts as a unified data container, ensuring all downstream SDK operations receive only the required and validated inputs.

Once populated, a Context object can be used for:

Reporting data using report methods

Retrieving actions using getActions()

Supporting multi-context evaluation, where multiple contextual signals must match to return actions

The Context object serves as the single source of truth for all personalization input data.