Tracking User Attributes 11.x.x

User attributes are specific traits of a user such as an email, username, mobile, gender and so on. User Attributes helps target users based on these attributes across devices or installs or to personalize the messages.

User Login and Logout

It is important that you handle user login and logout as mentioned below. There is a definite possibility that your data gets corrupted if this is not done properly.

Ensure that you have the unique id for your app users and pass that information to MoEngage SDK using the setUniqueId(). The unique id is used to identify a user across installs and platforms and provide a unified view. After the user logs out of your app, it is necessary to call logout() so that we create a new user.

Ensure that you call the following methods on user log in or log out.

Login

Kotlin Java
//UNIQUE_ID is used to uniquely identify a user.
MoEHelper.getInstance(context).setUniqueId(UNIQUE_ID)
 

NOTE

If you need to update the unique id, do not call the login method with the new unique id value. Using the method setUniqueId() with a new value creates unintended users in MoEngage.

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.

KotlinJava
MoEHelper.getInstance(context).logoutUser()

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.

Java
MoEHelper.getInstance(getContext()).setAlias();

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.

KotlinJava
MoEHelper.getInstance(context).setFirstName()
MoEHelper.getInstance(context).setLastName()
MoEHelper.getInstance(context).setFullName()
MoEHelper.getInstance(context).setUserLocation()
MoEHelper.getInstance(context).setGender()
MoEHelper.getInstance(context).setNumber()
MoEHelper.getInstance(context).setBirthDate()
MoEHelper.getInstance(context).setEmail()
 

NOTE

SetNumber - User Phone number or Mobile Number is tracked as a string to work properly in MoEngage systems.

For setting other User Attributes, use the generic method setUserAttribute(key,value)

 

Kotlin Java
// Tracking a String Attribute
MoEHelper.getInstance(context).setUserAttribute("locality", "SF")
// Tracking a Date Attribute
MoEHelper.getInstance(context).setUserAttribute("signedUpOn", Date())
// Tracking a location attribute
MoEHelper.getInstance(context).setUserAttribute("lastLocation", GeoLocation(40.77, 73.98))

The following apply to user attributes tracking:

  • Date attributes are passed as Date objects.
  • User Attributes names should not have the following:
    • dot(.)
    • start with dollar sign($)

Do not use the following set of reserved keywords used by the SDK for 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
  • MOE_TIME_FORMAT
  • MOE_TIME_TIMEZONE
  • 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
  • MOE_ISLAT
  • status
Was this article helpful?
0 out of 0 found this helpful