Documentation

Did you find this helpful?

Players: Players Page

Monitoring players

It is possible to inspect players you have in your title using Players Page. You can access Players Page through:

Game Manager > "Players" left-menu > "Players" tab

You are able to inspect the list of registered player as a table. The table contains general information about the player. You can click Player ID label (blue) to inspect details about particular player. You can use search query field to look up players.

Search Techniques

Search query field consumes queries of two types: simplistic and complex.

Simplistic query accepts 1 or more tokens separated by space, searches through all player fields and looks strictly for one of the tokens. It is possible to use wildcard symbol (*) in tokens to make query more flexible.

Example: on the screeshot above we choose 2 users: Lee and Vicky. Display names and IDs are among searchable fields, so, based only on that information from the screenshot, we have 4 tokens at our disposal: Lee, Vicky, 3BB0E45D6CB3304A, 962B724F659A776A. Remember, you can use any searchable player field to look for the token. Our goal is to test a few quering techniques:

  1. "Lee" is a value of "DisplayName" field for one of the players (Lee). Search query results into one matching entry.
  2. No player has "Vic" as value of any field.  Search query results in no entries.
  3. "3BB0E45D6CB3304A" is value of "ID" field for one of the players (Vicky). Search query results into one matching entry.
  4. "962B724F659A776A" is value of "ID" field for one of the players (Lee). Search query results into one matching entry.
  5. This query involves 2 tokens: "Lee" and "Vicky'. Those correspond to "DisplayName" fields for some players (Lee and Vicky). Search query results into 2 entries.
  6. This query involves 2 tokens: "3BB0E45D6CB3304A" and "Lee". Vicky has "ID" field set to "3BB0E45D6CB3304A". Lee has "DisplayName" field set to "Lee". Query results into 2 entries.
  7. Wildcard expression "Vic*" will look for all players with fields set to something starting with "Vic". Query results into 3 values. Note: this example is bad, because all three located fields are display names. If you had play wih ID starting from "Vic" it would be yielded with this query.
  8. Combined strict token "Lee" and wildcard token "Vick*". Results in 3 players. 1 corresponds to "Lee" and 2 others have display names starting with "Vick"

Complex Queries add more flexibility introducing field referencing (dot notation, camelCase), operands, grouping using parenthesis, operators AND/OR/NOT and value descriptors. 

The basic element of complex query is query expression in format fieldName:valueDescriptor. The search engine will then look for all players that have certain field (denoted by fieldName) with value (denoted by valueDescriptor):

  • fieldName is a searchable player field in camel case (DisplayName becomes displayName). It is possible to use dot notation to dig into nested properties: virtualCurrencyBalances.GM. 
  • valueDescriptor is, obviously, something that describes desired value. It can be a token (ex. "ABC"). It can be a wildcard token (ex. "AB*C"). It can be range descriptor (ex. date range value [2016 TO now]).

Let's learn by example:

  1. displayName:Lee - looks for players with field "DisplayName" set (strictly) to "Lee". Results into 1 entry.
  2. displayName:(NOT Lee) - looks for players with field "DisplayName" set to anything but "Lee". Results into all entries but player Lee.
  3. displayName:(Lee OR Vick*) - looks for player with field "DisplayName" set to either "Lee" or something that starts from "Vick". Results into 3 entries.
  4. playerId:3BB0E45D6CB3304A OR displayName:Lee - looks for player with field "DisplayName" set to "Lee" or with field "PlayerId" set to "3BB0E45D6CB3304A". Results into 2 matching entries.



Did you find this helpful?