The SDK consists of the following classes.
Personalization Class
Personalization is the main class and creates the object used for all SDK activities. This class contains the methods to invoke the SDK functionality and the subclasses that contain further data.
React
Import this class using the following code:
import personalization from '@personalization-js-sdk/react-native';
Create an instance of this class using the following code:
const personalizationInstance = personalization ( account, user )
account
and user
are subclasses, and must be initialized to use as arguments for creating an instance of personalization
. Refer to the objects below for information on how to initialize them.
Account Object
This object contains information about the account.
React
Export this class using the following code:
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 these variables.
Example code:
const account = { domain: "monetate.mybigcommerce.com", name: "a-3e41bf76", instance: "p", shortname: "monetatebc", };
User Object
This object contains information about the user.
React
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.
You can define the Monetate ID as "auto" to make the SDK automatically generate the ID. If you do this, you must store the generated Monetate ID on your end.
The customer ID is optional. If this ID is defined, you must also pass it in all calls along with one of the other IDs. If you need to later change the customer ID, use the setCustomerId
method.