User Properties
Managing user-level properties that can be used for segmentation and conditional logic in Streams.
Last updated
Was this helpful?
Managing user-level properties that can be used for segmentation and conditional logic in Streams.
Last updated
Was this helpful?
Properties can be defined at the user-level and later used for segmentation and conditional logic in Streams.
User properties can be managed from the browser by pushing commands to Fanplayr's array. The following operations are supported:
Sets a property on the user record. It overwrites any existing value for the same property name.
Usage:
key
String (required)
The name of the property to store.
value
any (required)
The value to store for the given property name.
maxAge
Number (optional)
Specifies the maximum duration in seconds to store the property.
Sets a property on the user record, only if it does not already exist.
Usage:
key
String (required)
The name of the property to store.
value
any (required)
The value to store for the given property name.
maxAge
Number (optional)
Specifies the maximum duration in seconds to store the property.
Increments or decrements a numeric property. If the property does not exist it is created and set to the amount specified.
Usage:
key
String (required)
The name of the property to store.
value
Number (optional)
The amount to increment by. Defaults to 1.
maxAge
Number (optional)
Specifies the maximum duration in seconds to store the property.
Removes a property on the user record.
Usage:
key
String (required)
The name of the property to remove.
An overall limit of approximately 20 KB can be stored for each user. Any updates to the user data that would exceed this limit are ignored and not persisted. The names, values and expiry information for each property count towards the overall limit.
User properties can also be updated via the action in streams: