User Properties

Configure user tracking by setting user-level properties, unique user IDs, and custom parameters via the iOS User Properties documentation to enable detailed analytics in the Tapjoy dashboard.

Read time 2 minutes

Last updated 8 months ago

By setting various user properties, such as level, and ID, you can automatically get powerful analytics insights from the Tapjoy dashboard. For example, by setting user level whenever your user gains or passes level, you can get a picture of how your users are distributed throughout the levels of your game:


[Tapjoy setUserLevel:1]; // Set the user level to 1


Tapjoy.setUserLevel(1) // Set the user level to 1

This will let you see charts in the "Game Trend" section of the Analytics dashboard.

User ID

You can set a user ID.

Note

Some Offerwall SDK integrations do not need to do this.

The Tapjoy SDK will automatically generate a user ID for you. But there are certain situations in which you will want to specify your own user ID:

If you are using Tapjoy with self-managed currency, you must specify a user ID. This is so that when Tapjoy’s server sends your server a message that a user has earned some currency, it knows which user to identify as the recipient.
If you are using managed currency and want your users to be able to keep their currency balance across multiple devices, then you must specify your own user ID, and make sure it is the same across all devices for a given user.

Failure to set the user ID properly (or setting in in a situation where the Tapjoy SDK can set it for you) will result in users not getting rewarded for Tapjoy activities, or having user balances strangely appear and disappear.

If you plan on using Push to Earn campaigns, this will need to be set before the connect call.

Note

For data privacy and GDPR-compliance reasons, you cannot use email address, phone number, real name, or any other personally identifiable information in the user ID you set with this call.

If you need to set a user ID, you can do so with the following code (no dashboard setting is necessary):


[Tapjoy setUserID:@"A_UNIQUE_USER_ID"];


Tapjoy.setUserID("A_UNIQUE_USER_ID")

If you want to check the user ID there is a getter available:


NSString *userID = [Tapjoy getUserID];


let userID = Tapjoy.userID

Custom parameters

You can set custom parameters like so:


[Tapjoy setCustomParameter:@"[PARAMETER]"];


Tapjoy.setCustomParameter("[PARAMETER]")

Contact support for more information on this.

Notes

Call
```
setUserLevel
```
only once when an initialization or changes of user level happens.
To reset level information, send negative integer instead of level.
```
[Tapjoy setUserLevel:-1];
```

Documentation

Development

User Acquisition

Monetization

Industry