Overview
API endpoints for managing player groups, including membership, group inventory, virtual currencies, statistics, custom data, and messaging.
OperationCode
| Name | Code | Description |
|---|---|---|
| Add Member | addMember | Add a new member to an existing player group. |
| Add Segment | addSegment | Assign a segment tag to the specified group. |
| Change Group Currency | changeGroupCurrency | Modify the virtual currency balance for the group. |
| Change Group Statistics | changeGroupStatistics | Update one or more statistics associated with the group. |
| Create Group Item | createGroupItem | Add a new item to the group’s inventory. |
| Get Avatar | getAvatar | Retrieve the avatar image of the group. |
| Get Catalog Id | getCatalogId | Retrieve the catalog ID currently associated with the group. |
| Get Create Leaderboard | getCreateLeaderboard | Get leaderboard data ranked by group creation timestamps. |
| Get Currency Leaderboard | getCurrencyLeaderboard | Retrieve leaderboard ranked by group currency balances. |
| Get Currency Log | getCurrencyLog | Fetch historical logs of group currency transactions. |
| Get Custom Data | getCustomData | Retrieve key-value custom data entries defined for the group. |
| Get Display Name | getDisplayName | Fetch the display name associated with the group. |
| Get Group Currency | getGroupCurrency | Retrieve the current virtual currency balances of the group. |
| Get Group Data | getGroupData | Retrieve key-value data entries stored under the group profile. |
| Get Group Information | getGroupInformation | Fetch detailed metadata and profile fields associated with the group. |
| Get Group Inventory | getGroupInventory | Retrieve a list of items currently held in the group's inventory. |
| Get Group Message | getGroupMessage | Retrieve a specific message sent to or by the group. |
| Get Group Statistics | getGroupStatistics | Retrieve statistical data associated with the group. |
| Get Groups With Display Name | getGroupsWithDisplayName | Search for groups whose display names match a given pattern. |
| Get Groups With Segment | getGroupsWithSegment | List all groups assigned to a particular segment. |
| Get Groups With Tag | getGroupsWithTag | Return a list of groups that share a specific tag. |
| Get Members | getMembers | Retrieve a list of all members currently in the group. |
| Get Remove Status | getRemoveStatus | Check whether the group is flagged for removal. |
| Get Segment | getSegment | Retrieve all available group segment definitions. |
| Get Statistics Leaderboard Around Group | getStatisticsLeaderboardAroundGroup | Get a leaderboard centered around the group’s rank for a specific statistic. |
| Get Statistics Leaderboard | getStatisticsLeaderboard | Return the full leaderboard for a group-specific statistic. |
| Get Statistics Log | getStatisticsLog | Fetch a history of statistic modifications made to the group. |
| Get Tag | getTag | List all tags currently associated with the group. |
| Get Ts Create | getTsCreate | Retrieve the timestamp when the group was created. |
| Remove Group Item | removeGroupItem | Delete a specific item from the group's inventory. |
| Remove Member | removeMember | Remove a member from the group. |
| Remove Segment | removeSegment | Remove a segment tag previously assigned to the group. |
| Remove Tag | removeTag | Delete a tag previously associated with the group. |
| Send Group Message | sendGroupMessage | Send a message to all or specific members of the group. |
| Set Avatar | setAvatar | Update the group’s avatar image. |
| Set Custom Data | setCustomData | Create or update custom key-value data entries for the group. |
| Set Display Name | setDisplayName | Change the display name associated with the group. |
| Set Group Data | setGroupData | Modify or replace structured key-value data for the group. |
| Set Remove Status | setRemoveStatus | Mark the group for deletion or cancel a previous remove request. |
| Set Tag | setTag | Assign a tag to the group for organizational or filtering purposes. |