About player properties

Segmentation is built against each player’s properties. These properties fundamentally define the audience segments. Satori provides a robust player properties system, ready to use without additional setup and easy to extend with custom data from your game.

This page covers the three types of player properties in Satori, how each is populated, and how to add or edit properties on an identity.

Understand property types #

There are three types of properties: default, computed, and custom. Any combination of default, computed, and custom properties can be used in segmenting players into audiences via filtering expressions.

Property types diagram showing Default, Computed, and Custom properties

Default properties #

Default properties are standard properties available out-of-the-box in Satori. Only some default properties are automatically derived for an identity at creation; others require input from the client.

PropertyTypeDerived automaticallyDescription
apiKeyNamestringYesThe API key (name) used when the identity was created.
buildNumbernumericNoThe build number of the client.
citystringYesSet at identity creation using geo-IP at sign-up. Empty string if it can’t be determined.
countryCodestringYesSet at identity creation using geo-IP at sign-up to determine the ISO 3166-2 country code. Empty string if it can’t be determined.
emailstringNoThe email associated with this identity, if set.
firstOpennumericYesTimestamp when the identity was first created in Satori (first authentication).
languagestringNoThe user’s preferred language.
platformstringNoThe platform of the client.
pushTokenAndroidstringNoThe Android token for this identity.
pushTokenFacebookA2UstringNoThe recipient user identifier on Facebook Platform.
pushTokenHuaweistringNoThe Huawei token for this identity.
pushTokenIosstringNoThe Apple iOS token for this identity.
pushTokenOneSignalPlayerIdstringNoThe recipient user identifier on OneSignal Platform.
regionstringYesSet at identity creation using geo-IP at sign-up to determine the ISO 3166-2 region. Empty string if it can’t be determined.
signUpnumericNoTimestamp when the user signed up for your game. Can be set by the client.
statestringYesSet at identity creation using geo-IP at sign-up to determine the state. Empty string if it can’t be determined.
subRegionstringYesSet at identity creation using geo-IP at sign-up to determine the ISO 3166-2 subregion. Empty string if it can’t be determined.
versionstringNoThe version of the client.

Computed properties #

Computed properties are determined by the flow of events as a player interacts with the game. Satori automatically generates and tracks a set of computed properties for each event defined in your game.

For example, if you define an event rewardedAdWatched in your game, you don’t need to define additional properties to track how many times the event occurred or when it occurred. Satori automatically generates these computed properties from the event stream as players interact with your game.

Computed properties follow this pattern:

Computed property patternDescription
<eventName>CountThe number of times the event has occurred in the lifetime of the user identity.
<eventName>SeenFirstThe timestamp of the first time the event occurred.
<eventName>SeenLastThe timestamp of the last time the event occurred.
<eventName>ValueFirstThe value of the first time the event occurred.
<eventName>ValueHighThe highest value of the event. Only applicable to events with numeric values.
<eventName>ValueLastThe value of the last time the event occurred.
<eventName>ValueLowThe lowest value of the event. Only applicable to events with numeric values.
<eventName>ValueSumThe sum of all values of the event. Only applicable to events with numeric values.

How to add a custom property #

The Property tab in the Taxonomy page displays the complete list of custom properties that have been created and must be accepted by Satori from clients, and the list of core properties that are automatically accepted by Satori.

Taxonomy Properties tab showing custom and core properties
Only properties already created via the Taxonomy > Properties tab can be added to an identity. If you need to create a new custom property, you must do so via the Taxonomy page first via the Create Custom Property button.

To add a new property to a player identity:

  1. Click + Add Property.
  2. Select the property type from the drop-down menu. The options are Default or Custom.
  3. Enter your desired property name or select it from the drop-down of available properties.
  4. Click Add. The newly added property appears in the list of properties for this identity, with no value assigned.
  5. Select the Value field for the property and enter the desired value.
  6. Click Save to finalize the changes.

In the player detail view, toggle Custom to see all custom-defined properties for that player.

ChurnPrediction custom property in identity detail view
Player property view with custom property filter toggled

Editing properties #

You can edit the value of any default or custom property. To do so:

  • Select the desired Value field and enter the new value.
  • Click Save to confirm the change, or Revert to undo and return to the original value.