playfab_ex v0.2.2 PlayfabEx.Admin.PlayStream
Link to this section Summary
Functions
Adds a given tag to a player profile. The tag’s namespace is automatically generated based on the source of the tag
Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change
List all segments that a player currently belongs to at this moment in time
Get all tags with a given Namespace (optional) from a player profile
Allows for paging through all players in a given segment. This API creates a snapshot of all player profiles that match the segment definition at the time of its creation and lives through the Total Seconds to Live, refreshing its life span on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected in the results. AB Test segments are currently not supported by this operation
Remove a given tag from a player profile. The tag’s namespace is automatically generated based on the source of the tag
Link to this section Functions
add_player_tag(map()) :: {:ok, map()} | {:error, String.t()}
Adds a given tag to a player profile. The tag’s namespace is automatically generated based on the source of the tag.
get_all_segments(map()) :: {:ok, map()} | {:error, String.t()}
Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change.
get_player_segments(map()) :: {:ok, map()} | {:error, String.t()}
List all segments that a player currently belongs to at this moment in time.
get_player_tags(map()) :: {:ok, map()} | {:error, String.t()}
Get all tags with a given Namespace (optional) from a player profile.
get_players_in_segment(map()) :: {:ok, map()} | {:error, String.t()}
Allows for paging through all players in a given segment. This API creates a snapshot of all player profiles that match the segment definition at the time of its creation and lives through the Total Seconds to Live, refreshing its life span on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected in the results. AB Test segments are currently not supported by this operation.
remove_player_tag(map()) :: {:ok, map()} | {:error, String.t()}
Remove a given tag from a player profile. The tag’s namespace is automatically generated based on the source of the tag.