playfab_ex v0.2.0 PlayfabEx.Admin.Default.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

Link to this function add_player_tag(params)
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.

@link https://api.playfab.com/documentation/admin/method/AddPlayerTag

Link to this function get_all_segments(params)
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.

@link https://api.playfab.com/documentation/admin/method/GetAllSegments

Link to this function get_player_segments(params)
get_player_segments(map()) :: {:ok, map()} | {:error, String.t()}

List all segments that a player currently belongs to at this moment in time.

@link https://api.playfab.com/documentation/admin/method/GetPlayerSegments

Link to this function get_player_tags(params)
get_player_tags(map()) :: {:ok, map()} | {:error, String.t()}

Get all tags with a given Namespace (optional) from a player profile.

@link https://api.playfab.com/documentation/admin/method/GetPlayerTags

Link to this function get_players_in_segment(params)
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.

@link https://api.playfab.com/documentation/admin/method/GetPlayersInSegment

Link to this function remove_player_tag(params)
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.

@link https://api.playfab.com/documentation/admin/method/RemovePlayerTag