User Properties¶
User properties allow you to store specific parameters for each player, aiding in audience segmentation, triggering Game Events, and customizing game logic with Scripts.
Setting Up User Properties¶
- For a new Condition, opt for User Property ► Primitive or User Property ► In Range:
- Pick a property like Level:
- Determine the comparator and state the comparative value:
Leverage User Properties with Scripts for reading and setting values, adapting game dynamics, and more.
Example: Adjust game difficulty when a player loses thrice in succession. Here, Lose Streak and Difficulty are tailored properties for the specific game. Dive deeper here.
Types of User Properties¶
User properties come in three kinds:
- Automatically tracked built-in properties by Balancy.
- Manual setup required built-in properties by Balancy.
- Developer-defined and managed custom properties.
Built-in properties¶
Automatically tracked are read-only. For others, a manual setup is essential.
System ► General Info¶
Access most properties via:
Balancy.LiveOps.Profile.GeneralInfo.<Property Name>
- Play Time (readonly) - Total gameplay duration in seconds.
- Session (readonly) - Session count. Begins at 1, increments with game relaunches or 10-minute pauses.
- Level - Denotes the user's level or progress.
- TrafficSource - Indicates where users originated, such as search engines, social platforms, or emails.
- TrafficCampaign - Represents campaigns, like ads or promotions, directing users to your platform.
- TutorialStep - Current step number in the tutorial.
- IsNewUser - Boolean indicating a new user's first session. Set automatically by Balancy but can be adjusted.
- DontDisturb - A user status flag. Explore its utilization here.
- ProfileId (readonly) - Balancy's unique identifier for users. Defaults to LocalUser without server connectivity.
- DeviceId (readonly) - Distinct device identifier.
- CustomId - Use this ID for integration with analytics systems or internal BI tools.
- App Version (readonly) - User's app version, e.g., 1.2.4.
- Engine Version (readonly) - App's engine version, e.g., Unity 2021.3.11f1.
- Platform (readonly) - Most recent platform accessed by the user.
- System Language (readonly) - User device's system language.
- Country (readonly) - User's geographical location.
- Time Since Purchase (readonly) - Duration in the game post last purchase. -1 if no purchases.
- Current Day (readonly) - User's latest online timestamp (Unix time since 1970).
- First Login Time (readonly) - User's initial app launch timestamp (Unix time since 1970).
- Last Login Time (readonly) - Last timestamp when the user logged in (Unix time since 1970).
System ► Payments¶
- Days For Purchase (readonly) - Mean days between purchases. Defaults are 0 (no purchase) or 50 (one purchase).
- Total Spend (readonly) - Cumulative in-game expenditure.
- Last Payment Time (readonly) - Timestamp of the last purchase (Unix time since 1970).
- Max Payment (readonly) - User's purchasing power. Determined by purchase history. The highest one-time purchase the user made.
- Payments Count (readonly) - Total transactions made by the user.
- Resources Multiplier (readonly) - Sales multiplier offering extra resources. Details here.
System ► Ads Info¶
- Interstitial Ads Period - Interstitial ad frequency. See example.
- Revenue Today (readonly) - Today's ad revenue per user. More on ad tracking here.
- Revenue Total (readonly) - User's total ad revenue. More on ad tracking here.
System ► Ads Info ► Ad Types (Rewarded, Interstitial, Custom)¶
- Revenue (readonly) - Accumulated revenue for the ad type.
- Count (readonly) - Total ad views for the ad type.
- Revenue Today (readonly) - Today's revenue for the ad type.
- Count Total (readonly) - Today's total ad views for the ad type.