Tracking User Attributes

Track user attributes and manage login and logout states using the MoEngage Unity SDK.

User Attributes are pieces of information you know about a user which could be demographics like age or gender, account-specific like plan, or even things like whether a user has seen a particular A/B test variation. It’s up to you! It is basically a customer identity that you can reference across the customer’s whole lifetime.

Implementing Login/Logout

• It’s important to set the User Attribute Unique ID when a user logs into your app.
• This is to merge the new user with the existing user, if any exists, and will help prevent creation of unnecessary/stale users.
• Setting the Unique ID is a critical piece to tie a user across devices and installs/uninstalls as well across all platforms (i.e. iOS, Android, Windows, The Web). Set the USER_ATTRIBUTE_UNIQUE_ID attribute as soon as the user is logged in. Unique ID can be something like an email ID, a username (unique), or a database ID or any Backend generated ID.
• Do not set this for the user who not logged in.

Login

c#

using MoEngage;
MoEngageClient.SetUniqueId("UNIQUE ID");

Note: The following values are not allowed in the UniqueID field: “unknown”, “guest”, “null”, “0”, “1”, “true”, “false”, “user_attribute_unique_id”, “(empty)”, “na”, “n/a”, "", “dummy_seller_code”, “user_id”, “id”, “customer_id”, “uid”, “userid”, “none”, “-2”, “-1”, “2”

Logout

The application needs to notify the MoEngage SDK whenever the user is logged out of the application. To notify the SDK, call the API whenever the user is logged out of the application.

c#

using MoEngage;
MoEngageClient.Logout();

In case the application is registering for push token it should pass the new push token to MoEngage SDK after user logout. For more information about passing push tokens, refer to Push Configuration for Android SDK.

Updating User Attribute Unique Id

Use the method setAlias() to update the user attribute unique id instead of setUniqueId() with a different value. Using the method setUniqueId() with a new value creates unintended users in MoEngage.

c#

using MoEngage;
MoEngageClient.SetAlias("Updated Unique Id");

Please make sure that you use SetAlias() for updating the Unique Identifier and not SetUniqueId() as calling SetUniqueId() with a new value will reset the current user and lead to the creation of unintended users in our system.

Tracking User Attributes

The SDK provides APIs to track commonly tracked user attributes like First Name, Last Name, Email-Id, etc. Please use the provided methods for tracking these attributes.

c#

using MoEngage;

MoEngageClient.SetFirstName("First Name");
MoEngageClient.SetLastName("Last Name");
MoEngageClient.SetEmail("Email");
MoEngageClient.SetPhoneNumber("Phone number");
MoEngageClient.SetGender(MoEUserGender.MALE); // MoEUserGender.FEMALE
MoEngageClient.SetUserLocation(new GeoLocation(23, 44));
MoEngageClient.SetBirthdate("2020-01-02T08:26:21.170Z"); // ISO Format : yyyy-MM-dd'T'HH:mm:ss.fff'Z'

For setting other User Attributes you can use the generic method SetUserAttribute(key, value)

c#

using MoEngage;
MoEngageClient.SetUserAttribute(key, value);

Tracking Date as user attributes

To track any date as user attributes use the SetUserAttributeISODate(). This API takes the attribute name and ISO Date as input.
Date Format - yyyy-MM-dd’T’HH:mm:ss.fff’Z’

Example:

c#

using MoEngage;
MoEngageClient.SetUserAttributeISODate("userAttrDate", "2019-01-02T08:26:21.170Z");

Tracking Location as user attributes

To track any location as user attributes use the SetUserAttributeLocation(). This API takes the attribute name and an instance of GeoLocation for coordinates as input.
Example:

c#

using MoEngage;
MoEngageClient.SetUserAttributeLocation("bangalore", new GeoLocation(23, 44));

Custom Boolean User Attribute

iOS(optional)

Starting from version 4.x.x of MoEngage.unityPackage, the default tracking for the custom boolean attribute will be changed to bool(true/false) from double(0/1). To configure this, enable should Track Boolean As Number variable of MoGameObject script as shown below to track the boolean as double . By default it is disabled to track boolean as true/false.

Refer to the example code below for tracking the boolean user attribute.

c#

using MoEngage;
// If `should Track Boolean As Number` is passed as true then `boolean attribute True` will tracked with value 1 else true
MoEngageClient.SetUserAttribute("boolean attribute true",true);
    
// If `should Track Boolean As Number` is passed as true then `boolean attribute false` will tracked with value 0 else false
MoEngageClient.SetUserAttribute("boolean attribute false",false);

Reserved keywords for User Attributes

Below is the list of keys that should not be used when tracking user attributes.

• USER_ATTRIBUTE_UNIQUE_ID
• USER_ATTRIBUTE_USER_EMAIL
• USER_ATTRIBUTE_USER_MOBILE
• USER_ATTRIBUTE_USER_NAME
• USER_ATTRIBUTE_USER_GENDER
• USER_ATTRIBUTE_USER_FIRST_NAME
• USER_ATTRIBUTE_USER_LAST_NAME
• USER_ATTRIBUTE_USER_BDAY
• USER_ATTRIBUTE_NOTIFICATION_PREF
• USER_ATTRIBUTE_OLD_ID
• MOE_TIME_FORMAT
• MOE_TIME_TIMEZONE
• USER_ATTRIBUTE_DND_START_TIME
• USER_ATTRIBUTE_DND_END_TIME
• MOE_GAID
• INSTALL
• UPDATE
• MOE_ISLAT
• status
• user_id