User attributes

How it works

Attributes are user features that are stored as key-value pairs. With the help of the attributes you can:

• segment users
• prepare personal storefronts for each group of users in your Web Shop
• transfer user information between different publishing platforms

There are 2 types of user attributes:

• User-editable. The values for this type of attributes are entered by a user or specified according to the in-game logic on the client side. For example, the name and character stats, game difficulty level, etc.

• Read-only. The values for this type of attributes are entered and edited on the server side of your application. We recommend that you use them for configuration of game character stats or user parameters that shouldn’t change regularly. For example, chance to get a bonus, game character key parameters, user categories, etc.

If needed, to ensure integrity of transmitted data you can set attribute validation rules in JSON Schema format in Publisher Account. You can manage the attributes using the Login API methods or webhooks. You can also edit the attributes’ values in your Publisher Account.

How to get it

To set up user attributes:

1. Open your project in your Publisher Account and go to the Login section.
2. Click Configure in the pane of a Login project.
3. Go to the User database block and select the User attributes schema section.

4. Specify the attribute validation rules in JSON Schema format (optional):

1. • In the properties object, specify a set of user attributes and their properties. Allowed data types: string, number, integer, or boolean. The object’s depth: 1.
   • In the additionalProperties object, specify whether it is possible to create additional fields not listed in the properties object. Set the value to true if you want to allow additional fields or false to disallow.
   • In the required array, specify a list of required attributes.
   • Set the value of the type field to object.

{
	"$schema": "https://json-schema.org/draft/2020-12/schema",
	"properties": {
		"game": {
			"description": "Name of the game played by user.",
			"type": "string"
		},
		"age": {
			"description": "User's age.",
			"type": "integer"
		},
		"had_ban": {
                 "description": "Whether the user was banned.",
			"type": "boolean"
		},
		"last_purchase": {
                 "description": "Date of user's last purchase.",
			"type": "string",
		}
	},
	"additionalProperties": false,
	"required": [
		"age",
		"game",
		"last_purchase"
	],
	"type": "object"
}

5. On your website or application, use the following Login API methods to implement the logic of working with user attributes:
   • for managing the JSON Schema:
     • Delete Schema
     • Get Schema
     • Update Schema
     • Update user’s attributes from server
     • Update user’s read-only attributes from server
     • Update user’s attribute from client

1. • for updating data in storage:
     • Update user’s attributes from server
     • Update user’s read-only attributes from server
     • Auth by custom ID
     • Update user’s attribute from client

1. • for getting data from storage:
     • Get user’s attributes from client
     • Get user’s read-only attributes from client
     • Get users by attribute from server
     • Get user’s attributes from server
     • Get user’s read-only attributes from server

How to edit user attributes values

To edit user attributes values:

1. Open your project in your Publisher Account and go to the Login section.
2. Click Configure in the pane of a Login project.
3. Go to the User database block and select the Users section.

4. Find the user in the table and click Attributes in the corresponding string.

5. In the pop-up window, select the attribute you want to edit, click on the pencil sign to edit the value, and click Save.