Skip to content

Player Properties

Player Properties are game-specific attributes that can be used to target players when running Live Ops campaigns. The most common use case for Player Properties is storing progression related information, such as player rank, experience or how many levels they have completed. Storing this type information allows you to target highly engaged and valuable players with special offers, rewards and incentives.

Defining Properties

Player Properties are defined from the Dashboard Game View, under the "Player Properties" tab.

PlayerPropertiesSet

Each game can define up to 5 player properties. Properties can be one of 4 types, String, Integer, Date and Boolean.

Type Description Example Input
String A text string that represents a known specific value. String Values can be up to 180 characters in length. { "Tier" : "Bronze" }
Boolean Boolean values true or false. A Boolean field will accept and transform 1, "1" to true, and 0, "0" to false. { "HasPlayedMultiplayer" : false }
DateTime An ISO8601 date formatted string. Time is required. { "LastUpgrade" : "2015-01-01T12:10:30" }
Integer A signed 64-bit integer. { "XP" : 3212 }

Updating Player Properties

Player Properties can be updated using the SetProperties method. By default, this method is restricted to Cloud Code only but can be updated through the game API Access Control. Player Property updates are partial, so you only need to provide the properties you wish to update. To clear a property, you should provide the value of the property as null.

Player Properties can be loaded within your game using the GetProperties method. GetProperties will return a key for every defined property, with the value as null if a value has not yet been defined for the player.

Segmenting on Player Properties

Once defined, player properties can be used as Segmentation criteria when creating A/B Tests, Permanent Override guide, or Scheduled Events.

See our guide on Segmentation for more details.