PlayerStats

public interface PlayerStats implements Freezable<PlayerStats> Parcelable

The PlayerStats API allows you to retrieve information about the player's activity in your application.

Constant Summary

float UNSET_VALUE The default value for each field when there isn't enough data to calculate.

Inherited Constant Summary

Public Method Summary

abstract float
getAverageSessionLength()
The average session length of the player in minutes.
abstract float
getChurnProbability()
This method was deprecated. This field will always return UNSET_VALUE.
abstract int
getDaysSinceLastPlayed()
The approximate number of days since the player last played.
abstract float
getHighSpenderProbability()
This method was deprecated. This field will always return UNSET_VALUE.
abstract int
getNumberOfPurchases()
The approximate number of in-app purchases for the player.
abstract int
getNumberOfSessions()
The approximate number of sessions of the player.
abstract float
getSessionPercentile()
The approximation of sessions percentile for the player.
abstract float
getSpendPercentile()
The approximate spend percentile of the player.
abstract float
getSpendProbability()
This method was deprecated. This field will always return UNSET_VALUE.
abstract float
getTotalSpendNext28Days()
This method was deprecated. This field will always return UNSET_VALUE.

Inherited Method Summary

Constants

public static final float UNSET_VALUE

The default value for each field when there isn't enough data to calculate. Please check the value against this before using it.

Constant Value: -1.0

Public Methods

public abstract float getAverageSessionLength ()

The average session length of the player in minutes. Session length is determined by the time that a player is signed in to Google Play Games services.

Returns

public abstract float getChurnProbability ()

This method was deprecated.
This field will always return UNSET_VALUE.

The approximate probability of the player not returning to play the game. Higher values indicate that a player is less likely to return.

Returns
  • A decimal number between 0 and 1 (inclusive) or UNSET_VALUE.

public abstract int getDaysSinceLastPlayed ()

The approximate number of days since the player last played.

Returns

public abstract float getHighSpenderProbability ()

This method was deprecated.
This field will always return UNSET_VALUE.

The probability that the player may spend a large amount relative to other players. Higher values indicate that a player is more likely to spend large amounts.

Returns
  • A decimal number between 0 and 1 (inclusive) or UNSET_VALUE.

public abstract int getNumberOfPurchases ()

The approximate number of in-app purchases for the player.

Returns

public abstract int getNumberOfSessions ()

The approximate number of sessions of the player. Sessions are determined by the number of times that a player signs in to Google Play Games services.

Returns

public abstract float getSessionPercentile ()

The approximation of sessions percentile for the player. This value indicates how many sessions the current player has played in comparison to the rest of this game's player base. Higher numbers indicate that this player has played more sessions.

Returns
  • A decimal number between 0 and 1 (inclusive) or UNSET_VALUE.

public abstract float getSpendPercentile ()

The approximate spend percentile of the player. This value indicates how much the current player has spent in comparison to the rest of this game's player base. Higher numbers indicate that this player has spent more.

Returns
  • A decimal number between 0 and 1 (inclusive) or UNSET_VALUE.

public abstract float getSpendProbability ()

This method was deprecated.
This field will always return UNSET_VALUE.

The approximate probability of the player choosing to spend in this game. Higher values indicate that a player is more likely to spend.

Returns
  • A decimal number between 0 and 1 (inclusive) or UNSET_VALUE.

public abstract float getTotalSpendNext28Days ()

This method was deprecated.
This field will always return UNSET_VALUE.

The predicted amount in USD that the player will spend over the next 28 days.

Returns
  • The estimated spend total over the next 28 days in USD, or UNSET_VALUE.