Overview
Fetch metadata and content of a secret record using its identifier.
Client
Require permission rules masterAdmin.getSecretInfoInformation.selfEnable. See PermissionRules
HTTP
POST /api/rJson/masterAdmin/client/getSecretInfoInformation
Request Headers
| Name | Required | Description |
|---|---|---|
| Auth-Token | true | A token used to authenticate the user. It is issued after successful login from the client type authenticate (e.g., loginByAccount, loginWithCustomId, etc.) or when an admin logs in via the GearN Dashboard. This token identifies the request sender and determines their access level. |
| Secret-Key | true | The SecretKey in SecretInfo with role must is Player. |
| Game-Id | Optional if the gameId in the SecretInfo use in headers Secret-Key has assign a valid value, if not, let unique identifier of the game this request is targeting. | |
| Content-Type | true | application/json |
Request Body
| Code | Type | Required | Description |
|---|---|---|---|
| secretKey | string | true | Secret authentication key for enhanced validation. (6 - 64 characters) |
Response Body
200 Ok
| Code | Type | Required | Description |
|---|---|---|---|
| returnCode | ReturnCode | true | Additional metadata that can be attached to any request. Especially useful when working with advanced features such as EventCallbackScript. See ReturnCode |
| debugMessage | string | A developer-oriented message that provides additional context useful for debugging and internal logging. This field is not intended for end-users and may include stack traces, validation failures, or internal error diagnostics. | |
| invalidRequestParameters | InvalidMember[] | Just had data when the returnCode is InvalidRequestParameters.A list of members that failed validation or could not be processed during the request. Each entry typically includes identifying information and an error reason. This is useful for partial success scenarios where some members are accepted and others are rejected. See InvalidMember | |
| parameters | ResponseData | Just had data when the returnCode is Ok. A dynamic set of key-value pairs included in the response to provide additional context or metadata. These parameters may vary depending on the operation and typically contain optional fields such as timestamps, identifiers, or computed values relevant to the result. See ResponseData |
ReturnCode
| Name | Code | Description |
|---|---|---|
| SecretInvalid | -10 | Secret token is invalid (removed, expired or does not contains). |
| MaxSizeRequestReject | -9 | Request rejected due to exceeding maximum allowed size. |
| MaxRequestReject | -8 | Request rejected because the number of requests has exceeded the allowed limit per user or IP or exceeds the total number of pending requests the server is waiting to process.. |
| MaxCCUReject | -7 | Connection rejected due to exceeding the allowed CCU (Concurrent Users). |
| OperationNotAuthorized | -6 | You are not authorized to perform this operation. Possibly due to missing or invalid token, or insufficient permissions. |
| InvalidRequestParameters | -5 | Request parameters are invalid or missing. |
| OperationInvalid | -4 | The requested operation is invalid or not supported. |
| InternalServerError | -3 | Internal server error. Could be due to an unhandled exception or logic failure. |
| OperationNotAllow | -2 | This operation is not allowed in the current context. |
| OperationTimeout | -1 | The operation timed out. No response received within the expected time. |
| UnknownError | 0 | An unknown error occurred. The cause could not be determined. |
| Ok | 1 | Success. The operation completed successfully and returned a valid result. |
ResponseData
| Code | Type | Required | Description |
|---|---|---|---|
| errorCode | ErrorCode | A string that represents the status of the operation. It indicates whether the request was successful or failed due to a specific error condition. See ErrorCode | |
| secretKey | string | true | Secret string used for authentication or encryption. |
| gameId | string | true | Identifier of the game project. |
| role | number | true | Assigned role within a scope (e.g., admin, viewer). |
| tsCreate | number | true | Timestamp indicating when the entity was created. |
| creatorId | string | true | CreatorId used in GetSecretInfoInformationResponseData. |
| remove | boolean | true | Remove used in GetSecretInfoInformationResponseData. |
| tsExpire | number | true | TsExpire used in GetSecretInfoInformationResponseData. |
| description | string | true | Description used in GetSecretInfoInformationResponseData. |
| permissionParam | PermissionParam | true | Permissions configuration or role-based access control settings. See PermissionParam |
PermissionParam
Parameters used to configure or control a related operation.
| Code | Type | Required | Description |
|---|---|---|---|
| authenticate | AuthenticatePermissionRulesParam | Authenticate used in PermissionParam. See AuthenticatePermissionRulesParam | |
| masterPlayer | MasterPlayerPermissionRulesParam | MasterPlayer used in PermissionParam. See MasterPlayerPermissionRulesParam | |
| gamePlayer | GamePlayerPermissionRulesParam | GamePlayer used in PermissionParam. See GamePlayerPermissionRulesParam | |
| characterPlayer | CharacterPlayerPermissionRulesParam | CharacterPlayer used in PermissionParam. See CharacterPlayerPermissionRulesParam | |
| content | ContentPermissionRulesParam | Content used in PermissionParam. See ContentPermissionRulesParam | |
| group | GroupPermissionRulesParam | Group used in PermissionParam. See GroupPermissionRulesParam | |
| inventory | InventoryPermissionRulesParam | Inventory used in PermissionParam. See InventoryPermissionRulesParam | |
| storeInventory | StoreInventoryPermissionRulesParam | StoreInventory used in PermissionParam. See StoreInventoryPermissionRulesParam | |
| masterAdmin | MasterAdminPermissionRulesParam | MasterAdmin used in PermissionParam. See MasterAdminPermissionRulesParam | |
| multiplayer | MultiplayerPermissionRulesParam | Multiplayer used in PermissionParam. See MultiplayerPermissionRulesParam | |
| cloudScript | CloudScriptPermissionRulesParam | CloudScript used in PermissionParam. See CloudScriptPermissionRulesParam |
AuthenticatePermissionRulesParam
Defines fine-grained permission rules for administrative access control.
| Code | Type | Required | Description |
|---|---|---|---|
| loginByAccount | PermissionRulesParam | The number of loginbyac entries. See PermissionRulesParam | |
| loginByAndroidDeviceId | PermissionRulesParam | LoginByAndroidDeviceId used in AuthenticatePermissionRulesParam. See PermissionRulesParam | |
| loginByApple | PermissionRulesParam | LoginByApple used in AuthenticatePermissionRulesParam. See PermissionRulesParam | |
| loginByCustomDeviceId | PermissionRulesParam | LoginByCustomDeviceId used in AuthenticatePermissionRulesParam. See PermissionRulesParam | |
| loginByCustomId | PermissionRulesParam | LoginByCustomId used in AuthenticatePermissionRulesParam. See PermissionRulesParam | |
| loginByFacebook | PermissionRulesParam | LoginByFacebook used in AuthenticatePermissionRulesParam. See PermissionRulesParam | |
| loginByGenericService | PermissionRulesParam | LoginByGenericService used in AuthenticatePermissionRulesParam. See PermissionRulesParam | |
| loginByGoogle | PermissionRulesParam | LoginByGoogle used in AuthenticatePermissionRulesParam. See PermissionRulesParam | |
| loginByGooglePlayGameService | PermissionRulesParam | LoginByGooglePlayGameService used in AuthenticatePermissionRulesParam. See PermissionRulesParam | |
| loginByGameCenter | PermissionRulesParam | LoginByGameCenter used in AuthenticatePermissionRulesParam. See PermissionRulesParam | |
| loginByiOSDeviceId | PermissionRulesParam | LoginByiOSDeviceId used in AuthenticatePermissionRulesParam. See PermissionRulesParam | |
| loginByWindowsPhoneDeviceId | PermissionRulesParam | LoginByWindowsPhoneDeviceId used in AuthenticatePermissionRulesParam. See PermissionRulesParam | |
| registerAccount | PermissionRulesParam | The number of registerac entries. See PermissionRulesParam | |
| loginByEditorDeviceId | PermissionRulesParam | LoginByEditorDeviceId used in AuthenticatePermissionRulesParam. See PermissionRulesParam | |
| loginByLinuxDeviceId | PermissionRulesParam | LoginByLinuxDeviceId used in AuthenticatePermissionRulesParam. See PermissionRulesParam | |
| loginByMacOSDeviceId | PermissionRulesParam | LoginByMacOSDeviceId used in AuthenticatePermissionRulesParam. See PermissionRulesParam | |
| loginByWindowsDeviceId | PermissionRulesParam | LoginByWindowsDeviceId used in AuthenticatePermissionRulesParam. See PermissionRulesParam | |
| refreshAuthToken | PermissionRulesParam | RefreshAuthToken used in AuthenticatePermissionRulesParam. See PermissionRulesParam |
PermissionRulesParam
Defines fine-grained permission rules for administrative access control.
| Code | Type | Required | Description |
|---|---|---|---|
| selfEnable | boolean | SelfEnable used in PermissionRulesParam. | |
| otherSelfEnable | boolean | OtherSelfEnable used in PermissionRulesParam. | |
| adminSelfEnable | boolean | AdminSelfEnable used in PermissionRulesParam. | |
| serverSelfEnable | boolean | ServerSelfEnable used in PermissionRulesParam. |
MasterPlayerPermissionRulesParam
Defines fine-grained permission rules for administrative access control.
| Code | Type | Required | Description |
|---|---|---|---|
| linkAccount | PermissionRulesParam | The number of linkac entries. See PermissionRulesParam | |
| linkAndroidDeviceId | PermissionRulesParam | LinkAndroidDeviceId used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| linkApple | PermissionRulesParam | LinkApple used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| linkCustomDeviceId | PermissionRulesParam | LinkCustomDeviceId used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| linkCustomId | PermissionRulesParam | LinkCustomId used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| linkEditorDeviceId | PermissionRulesParam | LinkEditorDeviceId used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| linkFacebook | PermissionRulesParam | LinkFacebook used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| linkGenericService | PermissionRulesParam | LinkGenericService used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| linkGoogle | PermissionRulesParam | LinkGoogle used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| linkGooglePlayGameService | PermissionRulesParam | LinkGooglePlayGameService used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| linkGameCenter | PermissionRulesParam | LinkGameCenter used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| linkiOSDeviceId | PermissionRulesParam | LinkiOSDeviceId used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| linkLinuxDeviceId | PermissionRulesParam | LinkLinuxDeviceId used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| linkMacOSDeviceId | PermissionRulesParam | LinkMacOSDeviceId used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| linkWindowsDeviceId | PermissionRulesParam | LinkWindowsDeviceId used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| linkWindowsPhoneDeviceId | PermissionRulesParam | LinkWindowsPhoneDeviceId used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| unlinkAccount | PermissionRulesParam | The number of unlinkac entries. See PermissionRulesParam | |
| unlinkAndroidDeviceId | PermissionRulesParam | UnlinkAndroidDeviceId used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| unlinkApple | PermissionRulesParam | UnlinkApple used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| unlinkCustomDeviceId | PermissionRulesParam | UnlinkCustomDeviceId used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| unlinkCustomId | PermissionRulesParam | UnlinkCustomId used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| unlinkEditorDeviceId | PermissionRulesParam | UnlinkEditorDeviceId used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| unlinkFacebook | PermissionRulesParam | UnlinkFacebook used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| unlinkGenericService | PermissionRulesParam | UnlinkGenericService used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| unlinkGoogle | PermissionRulesParam | UnlinkGoogle used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| unlinkGooglePlayGameService | PermissionRulesParam | UnlinkGooglePlayGameService used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| unlinkGameCenter | PermissionRulesParam | UnlinkGameCenter used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| unlinkiOSDeviceId | PermissionRulesParam | UnlinkiOSDeviceId used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| unlinkLinuxDeviceId | PermissionRulesParam | UnlinkLinuxDeviceId used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| unlinkMacOSDeviceId | PermissionRulesParam | UnlinkMacOSDeviceId used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| unlinkWindowsDeviceId | PermissionRulesParam | UnlinkWindowsDeviceId used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| unlinkWindowsPhoneDeviceId | PermissionRulesParam | UnlinkWindowsPhoneDeviceId used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| addSegment | PermissionRulesParam | AddSegment used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| removeSegment | PermissionRulesParam | RemoveSegment used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getSegment | PermissionRulesParam | GetSegment used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| setTag | PermissionRulesParam | SetTag used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| removeTag | PermissionRulesParam | RemoveTag used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getTag | PermissionRulesParam | GetTag used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getDisplayName | PermissionRulesParam | GetDisplayName used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| setDisplayName | PermissionRulesParam | SetDisplayName used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getTsCreate | PermissionRulesParam | Timestamp indicating when the entity was created. See PermissionRulesParam | |
| getIpAddressCreate | PermissionRulesParam | GetIpAddressCreate used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| setTsLastLogin | PermissionRulesParam | SetTsLastLogin used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getTsLastLogin | PermissionRulesParam | GetTsLastLogin used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| setPlayerBan | PermissionRulesParam | SetPlayerBan used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayerBan | PermissionRulesParam | GetPlayerBan used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| setCountryCode | PermissionRulesParam | SetCountryCode used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getCountryCode | PermissionRulesParam | GetCountryCode used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| changeAccountPassword | PermissionRulesParam | Password string used for authentication or modification. See PermissionRulesParam | |
| resetAccountPassword | PermissionRulesParam | Password string used for authentication or modification. See PermissionRulesParam | |
| setAvatar | PermissionRulesParam | SetAvatar used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getAvatar | PermissionRulesParam | GetAvatar used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| changePlayerCurrency | PermissionRulesParam | ChangePlayerCurrency used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayerCurrency | PermissionRulesParam | GetPlayerCurrency used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| changePlayerStatistics | PermissionRulesParam | ChangePlayerStatistics used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayerStatistics | PermissionRulesParam | GetPlayerStatistics used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getStatisticsLeaderboard | PermissionRulesParam | GetStatisticsLeaderboard used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getStatisticsLeaderboardAroundPlayer | PermissionRulesParam | GetStatisticsLeaderboardAroundPlayer used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getCustomData | PermissionRulesParam | GetCustomData used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| setCustomData | PermissionRulesParam | SetCustomData used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| setPlayerData | PermissionRulesParam | SetPlayerData used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayerData | PermissionRulesParam | GetPlayerData used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayerInformation | PermissionRulesParam | GetPlayerInformation used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayersWithApple | PermissionRulesParam | GetPlayersWithApple used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayersWithFacebook | PermissionRulesParam | GetPlayersWithFacebook used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayersWithGoogle | PermissionRulesParam | GetPlayersWithGoogle used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayersWithGenericService | PermissionRulesParam | GetPlayersWithGenericService used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayersWithSegment | PermissionRulesParam | GetPlayersWithSegment used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayersWithTag | PermissionRulesParam | GetPlayersWithTag used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayersWithGooglePlayGameService | PermissionRulesParam | GetPlayersWithGooglePlayGameService used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayersWithGameCenter | PermissionRulesParam | GetPlayersWithGameCenter used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getExternal | PermissionRulesParam | GetExternal used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayersWithDisplayName | PermissionRulesParam | GetPlayersWithDisplayName used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getEmail | PermissionRulesParam | GetEmail used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| setEmail | PermissionRulesParam | SetEmail used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getCurrencyLeaderboard | PermissionRulesParam | GetCurrencyLeaderboard used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getLastLoginLeaderboard | PermissionRulesParam | GetLastLoginLeaderboard used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getCreateLeaderboard | PermissionRulesParam | GetCreateLeaderboard used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getStatisticsLog | PermissionRulesParam | GetStatisticsLog used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getCurrencyLog | PermissionRulesParam | GetCurrencyLog used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| sendSocketOperationEvent | PermissionRulesParam | SendSocketOperationEvent used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| sendEmail | PermissionRulesParam | SendEmail used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| sendPushNotification | PermissionRulesParam | SendPushNotification used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| addPushNotification | PermissionRulesParam | AddPushNotification used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| removePushNotification | PermissionRulesParam | RemovePushNotification used in MasterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getPushNotification | PermissionRulesParam | GetPushNotification used in MasterPlayerPermissionRulesParam. See PermissionRulesParam |
GamePlayerPermissionRulesParam
Defines fine-grained permission rules for administrative access control.
| Code | Type | Required | Description |
|---|---|---|---|
| addSegment | PermissionRulesParam | AddSegment used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| removeSegment | PermissionRulesParam | RemoveSegment used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getSegment | PermissionRulesParam | GetSegment used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| setTag | PermissionRulesParam | SetTag used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| removeTag | PermissionRulesParam | RemoveTag used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getTag | PermissionRulesParam | GetTag used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getDisplayName | PermissionRulesParam | GetDisplayName used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| setDisplayName | PermissionRulesParam | SetDisplayName used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getTsCreate | PermissionRulesParam | Timestamp indicating when the entity was created. See PermissionRulesParam | |
| getIpAddressCreate | PermissionRulesParam | GetIpAddressCreate used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getTsLastLogin | PermissionRulesParam | GetTsLastLogin used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| setPlayerBan | PermissionRulesParam | SetPlayerBan used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayerBan | PermissionRulesParam | GetPlayerBan used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| setCountryCode | PermissionRulesParam | SetCountryCode used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getCountryCode | PermissionRulesParam | GetCountryCode used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| setAvatar | PermissionRulesParam | SetAvatar used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getAvatar | PermissionRulesParam | GetAvatar used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| changePlayerCurrency | PermissionRulesParam | ChangePlayerCurrency used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayerCurrency | PermissionRulesParam | GetPlayerCurrency used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| changePlayerStatistics | PermissionRulesParam | ChangePlayerStatistics used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayerStatistics | PermissionRulesParam | GetPlayerStatistics used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getStatisticsLeaderboard | PermissionRulesParam | GetStatisticsLeaderboard used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getStatisticsLeaderboardAroundPlayer | PermissionRulesParam | GetStatisticsLeaderboardAroundPlayer used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getCustomData | PermissionRulesParam | GetCustomData used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| setCustomData | PermissionRulesParam | SetCustomData used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| setPlayerData | PermissionRulesParam | SetPlayerData used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayerData | PermissionRulesParam | GetPlayerData used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayerInformation | PermissionRulesParam | GetPlayerInformation used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayersWithSegment | PermissionRulesParam | GetPlayersWithSegment used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayersWithTag | PermissionRulesParam | GetPlayersWithTag used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayerCharacter | PermissionRulesParam | GetPlayerCharacter used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayerInventory | PermissionRulesParam | GetPlayerInventory used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayerGroup | PermissionRulesParam | GetPlayerGroup used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayerFriend | PermissionRulesParam | GetPlayerFriend used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| removePlayerItem | PermissionRulesParam | RemovePlayerItem used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getOnlineStatus | PermissionRulesParam | Status of the object (e.g., active, disabled, removed). See PermissionRulesParam | |
| createGroup | PermissionRulesParam | CreateGroup used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| createPlayerItem | PermissionRulesParam | CreatePlayerItem used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| createPlayerCharacter | PermissionRulesParam | CreatePlayerCharacter used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| addPlayerFriend | PermissionRulesParam | AddPlayerFriend used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| removePlayerFriend | PermissionRulesParam | RemovePlayerFriend used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| removePlayerCharacter | PermissionRulesParam | RemovePlayerCharacter used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| joinGroup | PermissionRulesParam | JoinGroup used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| leaveGroup | PermissionRulesParam | LeaveGroup used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayersWithDisplayName | PermissionRulesParam | GetPlayersWithDisplayName used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getFriendStatisticsLeaderboardAroundPlayer | PermissionRulesParam | GetFriendStatisticsLeaderboardAroundPlayer used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getFriendStatisticsLeaderboard | PermissionRulesParam | GetFriendStatisticsLeaderboard used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getCurrencyLeaderboard | PermissionRulesParam | GetCurrencyLeaderboard used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getCreateLeaderboard | PermissionRulesParam | GetCreateLeaderboard used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getLastLoginLeaderboard | PermissionRulesParam | GetLastLoginLeaderboard used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getStatisticsLog | PermissionRulesParam | GetStatisticsLog used in GamePlayerPermissionRulesParam. See PermissionRulesParam | |
| getCurrencyLog | PermissionRulesParam | GetCurrencyLog used in GamePlayerPermissionRulesParam. See PermissionRulesParam |
CharacterPlayerPermissionRulesParam
Defines fine-grained permission rules for administrative access control.
| Code | Type | Required | Description |
|---|---|---|---|
| addSegment | PermissionRulesParam | AddSegment used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| removeSegment | PermissionRulesParam | RemoveSegment used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getSegment | PermissionRulesParam | GetSegment used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| setTag | PermissionRulesParam | SetTag used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| removeTag | PermissionRulesParam | RemoveTag used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getTag | PermissionRulesParam | GetTag used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getDisplayName | PermissionRulesParam | GetDisplayName used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| setDisplayName | PermissionRulesParam | SetDisplayName used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getTsCreate | PermissionRulesParam | Timestamp indicating when the entity was created. See PermissionRulesParam | |
| getIpAddressCreate | PermissionRulesParam | GetIpAddressCreate used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getTsLastLogin | PermissionRulesParam | GetTsLastLogin used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| setPlayerBan | PermissionRulesParam | SetPlayerBan used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayerBan | PermissionRulesParam | GetPlayerBan used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| setCountryCode | PermissionRulesParam | SetCountryCode used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getCountryCode | PermissionRulesParam | GetCountryCode used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| setAvatar | PermissionRulesParam | SetAvatar used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getAvatar | PermissionRulesParam | GetAvatar used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| changePlayerCurrency | PermissionRulesParam | ChangePlayerCurrency used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayerCurrency | PermissionRulesParam | GetPlayerCurrency used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| changePlayerStatistics | PermissionRulesParam | ChangePlayerStatistics used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayerStatistics | PermissionRulesParam | GetPlayerStatistics used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getStatisticsLeaderboard | PermissionRulesParam | GetStatisticsLeaderboard used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getStatisticsLeaderboardAroundPlayer | PermissionRulesParam | GetStatisticsLeaderboardAroundPlayer used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getCustomData | PermissionRulesParam | GetCustomData used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| setCustomData | PermissionRulesParam | SetCustomData used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| setPlayerData | PermissionRulesParam | SetPlayerData used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayerData | PermissionRulesParam | GetPlayerData used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayerInformation | PermissionRulesParam | GetPlayerInformation used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayersWithSegment | PermissionRulesParam | GetPlayersWithSegment used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayersWithTag | PermissionRulesParam | GetPlayersWithTag used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getCatalogId | PermissionRulesParam | GetCatalogId used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getOwner | PermissionRulesParam | GetOwner used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getRemoveStatus | PermissionRulesParam | Status of the object (e.g., active, disabled, removed). See PermissionRulesParam | |
| getPlayerFriend | PermissionRulesParam | GetPlayerFriend used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayerGroup | PermissionRulesParam | GetPlayerGroup used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayerInventory | PermissionRulesParam | GetPlayerInventory used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| removePlayerItem | PermissionRulesParam | RemovePlayerItem used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| createPlayerItem | PermissionRulesParam | CreatePlayerItem used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| createGroup | PermissionRulesParam | CreateGroup used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| joinGroup | PermissionRulesParam | JoinGroup used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| leaveGroup | PermissionRulesParam | LeaveGroup used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| setOwner | PermissionRulesParam | SetOwner used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| addPlayerFriend | PermissionRulesParam | AddPlayerFriend used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| removePlayerFriend | PermissionRulesParam | RemovePlayerFriend used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getPlayersWithDisplayName | PermissionRulesParam | GetPlayersWithDisplayName used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| setRemoveStatus | PermissionRulesParam | Status of the object (e.g., active, disabled, removed). See PermissionRulesParam | |
| getFriendStatisticsLeaderboardAroundPlayer | PermissionRulesParam | GetFriendStatisticsLeaderboardAroundPlayer used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getFriendStatisticsLeaderboard | PermissionRulesParam | GetFriendStatisticsLeaderboard used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getCurrencyLeaderboard | PermissionRulesParam | GetCurrencyLeaderboard used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getCreateLeaderboard | PermissionRulesParam | GetCreateLeaderboard used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getLastLoginLeaderboard | PermissionRulesParam | GetLastLoginLeaderboard used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getStatisticsLog | PermissionRulesParam | GetStatisticsLog used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam | |
| getCurrencyLog | PermissionRulesParam | GetCurrencyLog used in CharacterPlayerPermissionRulesParam. See PermissionRulesParam |
ContentPermissionRulesParam
Defines fine-grained permission rules for administrative access control.
| Code | Type | Required | Description |
|---|---|---|---|
| getContentData | PermissionRulesParam | GetContentData used in ContentPermissionRulesParam. See PermissionRulesParam | |
| setContentData | PermissionRulesParam | SetContentData used in ContentPermissionRulesParam. See PermissionRulesParam | |
| createNewFileUploadInfo | PermissionRulesParam | CreateNewFileUploadInfo used in ContentPermissionRulesParam. See PermissionRulesParam | |
| getFileUploadInfoList | PermissionRulesParam | List of getfileuploadinfo items. See PermissionRulesParam | |
| getFileUploadInfo | PermissionRulesParam | GetFileUploadInfo used in ContentPermissionRulesParam. See PermissionRulesParam | |
| removeFileUploadInfo | PermissionRulesParam | RemoveFileUploadInfo used in ContentPermissionRulesParam. See PermissionRulesParam | |
| requestDownloadFileUploadInfo | PermissionRulesParam | RequestDownloadFileUploadInfo used in ContentPermissionRulesParam. See PermissionRulesParam |
GroupPermissionRulesParam
Defines fine-grained permission rules for administrative access control.
| Code | Type | Required | Description |
|---|---|---|---|
| addSegment | PermissionRulesParam | AddSegment used in GroupPermissionRulesParam. See PermissionRulesParam | |
| removeSegment | PermissionRulesParam | RemoveSegment used in GroupPermissionRulesParam. See PermissionRulesParam | |
| getSegment | PermissionRulesParam | GetSegment used in GroupPermissionRulesParam. See PermissionRulesParam | |
| setTag | PermissionRulesParam | SetTag used in GroupPermissionRulesParam. See PermissionRulesParam | |
| removeTag | PermissionRulesParam | RemoveTag used in GroupPermissionRulesParam. See PermissionRulesParam | |
| getTag | PermissionRulesParam | GetTag used in GroupPermissionRulesParam. See PermissionRulesParam | |
| getDisplayName | PermissionRulesParam | GetDisplayName used in GroupPermissionRulesParam. See PermissionRulesParam | |
| setDisplayName | PermissionRulesParam | SetDisplayName used in GroupPermissionRulesParam. See PermissionRulesParam | |
| getTsCreate | PermissionRulesParam | Timestamp indicating when the entity was created. See PermissionRulesParam | |
| setAvatar | PermissionRulesParam | SetAvatar used in GroupPermissionRulesParam. See PermissionRulesParam | |
| getAvatar | PermissionRulesParam | GetAvatar used in GroupPermissionRulesParam. See PermissionRulesParam | |
| changeGroupCurrency | PermissionRulesParam | ChangeGroupCurrency used in GroupPermissionRulesParam. See PermissionRulesParam | |
| getGroupCurrency | PermissionRulesParam | GetGroupCurrency used in GroupPermissionRulesParam. See PermissionRulesParam | |
| changeGroupStatistics | PermissionRulesParam | ChangeGroupStatistics used in GroupPermissionRulesParam. See PermissionRulesParam | |
| getGroupStatistics | PermissionRulesParam | GetGroupStatistics used in GroupPermissionRulesParam. See PermissionRulesParam | |
| getStatisticsLeaderboard | PermissionRulesParam | GetStatisticsLeaderboard used in GroupPermissionRulesParam. See PermissionRulesParam | |
| getStatisticsLeaderboardAroundGroup | PermissionRulesParam | GetStatisticsLeaderboardAroundGroup used in GroupPermissionRulesParam. See PermissionRulesParam | |
| getCustomData | PermissionRulesParam | GetCustomData used in GroupPermissionRulesParam. See PermissionRulesParam | |
| setCustomData | PermissionRulesParam | SetCustomData used in GroupPermissionRulesParam. See PermissionRulesParam | |
| setGroupData | PermissionRulesParam | SetGroupData used in GroupPermissionRulesParam. See PermissionRulesParam | |
| getGroupData | PermissionRulesParam | GetGroupData used in GroupPermissionRulesParam. See PermissionRulesParam | |
| getGroupInformation | PermissionRulesParam | GetGroupInformation used in GroupPermissionRulesParam. See PermissionRulesParam | |
| getGroupsWithSegment | PermissionRulesParam | GetGroupsWithSegment used in GroupPermissionRulesParam. See PermissionRulesParam | |
| getGroupsWithTag | PermissionRulesParam | GetGroupsWithTag used in GroupPermissionRulesParam. See PermissionRulesParam | |
| getCatalogId | PermissionRulesParam | GetCatalogId used in GroupPermissionRulesParam. See PermissionRulesParam | |
| getRemoveStatus | PermissionRulesParam | Status of the object (e.g., active, disabled, removed). See PermissionRulesParam | |
| getGroupInventory | PermissionRulesParam | GetGroupInventory used in GroupPermissionRulesParam. See PermissionRulesParam | |
| removeGroupItem | PermissionRulesParam | RemoveGroupItem used in GroupPermissionRulesParam. See PermissionRulesParam | |
| createGroupItem | PermissionRulesParam | CreateGroupItem used in GroupPermissionRulesParam. See PermissionRulesParam | |
| getMembers | PermissionRulesParam | GetMembers used in GroupPermissionRulesParam. See PermissionRulesParam | |
| addMember | PermissionRulesParam | AddMember used in GroupPermissionRulesParam. See PermissionRulesParam | |
| removeMember | PermissionRulesParam | RemoveMember used in GroupPermissionRulesParam. See PermissionRulesParam | |
| sendGroupMessage | PermissionRulesParam | SendGroupMessage used in GroupPermissionRulesParam. See PermissionRulesParam | |
| getGroupMessage | PermissionRulesParam | GetGroupMessage used in GroupPermissionRulesParam. See PermissionRulesParam | |
| setRemoveStatus | PermissionRulesParam | Status of the object (e.g., active, disabled, removed). See PermissionRulesParam | |
| getGroupsWithDisplayName | PermissionRulesParam | GetGroupsWithDisplayName used in GroupPermissionRulesParam. See PermissionRulesParam | |
| getCurrencyLeaderboard | PermissionRulesParam | GetCurrencyLeaderboard used in GroupPermissionRulesParam. See PermissionRulesParam | |
| getCreateLeaderboard | PermissionRulesParam | GetCreateLeaderboard used in GroupPermissionRulesParam. See PermissionRulesParam | |
| getStatisticsLog | PermissionRulesParam | GetStatisticsLog used in GroupPermissionRulesParam. See PermissionRulesParam | |
| getCurrencyLog | PermissionRulesParam | GetCurrencyLog used in GroupPermissionRulesParam. See PermissionRulesParam |
InventoryPermissionRulesParam
Defines fine-grained permission rules for administrative access control.
| Code | Type | Required | Description |
|---|---|---|---|
| addSegment | PermissionRulesParam | AddSegment used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| removeSegment | PermissionRulesParam | RemoveSegment used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| getSegment | PermissionRulesParam | GetSegment used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| setTag | PermissionRulesParam | SetTag used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| removeTag | PermissionRulesParam | RemoveTag used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| getTag | PermissionRulesParam | GetTag used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| getDisplayName | PermissionRulesParam | GetDisplayName used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| setDisplayName | PermissionRulesParam | SetDisplayName used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| getTsCreate | PermissionRulesParam | Timestamp indicating when the entity was created. See PermissionRulesParam | |
| setAvatar | PermissionRulesParam | SetAvatar used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| getAvatar | PermissionRulesParam | GetAvatar used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| changeItemStatistics | PermissionRulesParam | ChangeItemStatistics used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| getItemStatistics | PermissionRulesParam | GetItemStatistics used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| getStatisticsLeaderboard | PermissionRulesParam | GetStatisticsLeaderboard used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| getStatisticsLeaderboardAroundItem | PermissionRulesParam | GetStatisticsLeaderboardAroundItem used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| getCustomData | PermissionRulesParam | GetCustomData used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| setCustomData | PermissionRulesParam | SetCustomData used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| setItemData | PermissionRulesParam | SetItemData used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| getItemData | PermissionRulesParam | GetItemData used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| getItemInformation | PermissionRulesParam | GetItemInformation used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| getItemsWithSegment | PermissionRulesParam | GetItemsWithSegment used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| getItemsWithTag | PermissionRulesParam | GetItemsWithTag used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| getCatalogId | PermissionRulesParam | GetCatalogId used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| getClassId | PermissionRulesParam | GetClassId used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| getItemType | PermissionRulesParam | GetItemType used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| getAmount | PermissionRulesParam | GetAmount used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| getOwner | PermissionRulesParam | GetOwner used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| getRemoveStatus | PermissionRulesParam | Status of the object (e.g., active, disabled, removed). See PermissionRulesParam | |
| setAmount | PermissionRulesParam | SetAmount used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| setOwner | PermissionRulesParam | SetOwner used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| setRemoveStatus | PermissionRulesParam | Status of the object (e.g., active, disabled, removed). See PermissionRulesParam | |
| getItemsWithDisplayName | PermissionRulesParam | GetItemsWithDisplayName used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| getCreateLeaderboard | PermissionRulesParam | GetCreateLeaderboard used in InventoryPermissionRulesParam. See PermissionRulesParam | |
| getStatisticsLog | PermissionRulesParam | GetStatisticsLog used in InventoryPermissionRulesParam. See PermissionRulesParam |
StoreInventoryPermissionRulesParam
Defines fine-grained permission rules for administrative access control.
| Code | Type | Required | Description |
|---|---|---|---|
| buyStoreItem | PermissionRulesParam | BuyStoreItem used in StoreInventoryPermissionRulesParam. See PermissionRulesParam | |
| getStoreItemInformation | PermissionRulesParam | GetStoreItemInformation used in StoreInventoryPermissionRulesParam. See PermissionRulesParam | |
| getStoreItemsWithTag | PermissionRulesParam | GetStoreItemsWithTag used in StoreInventoryPermissionRulesParam. See PermissionRulesParam | |
| createStoreItem | PermissionRulesParam | CreateStoreItem used in StoreInventoryPermissionRulesParam. See PermissionRulesParam | |
| setRemoveStatus | PermissionRulesParam | Status of the object (e.g., active, disabled, removed). See PermissionRulesParam | |
| setStoreItemInformation | PermissionRulesParam | SetStoreItemInformation used in StoreInventoryPermissionRulesParam. See PermissionRulesParam | |
| validateAppleAppStoreReceipt | PermissionRulesParam | ValidateAppleAppStoreReceipt used in StoreInventoryPermissionRulesParam. See PermissionRulesParam | |
| validateGooglePlayStoreReceipt | PermissionRulesParam | ValidateGooglePlayStoreReceipt used in StoreInventoryPermissionRulesParam. See PermissionRulesParam | |
| validateFacebookStoreReceipt | PermissionRulesParam | ValidateFacebookStoreReceipt used in StoreInventoryPermissionRulesParam. See PermissionRulesParam | |
| getCreateLeaderboard | PermissionRulesParam | GetCreateLeaderboard used in StoreInventoryPermissionRulesParam. See PermissionRulesParam | |
| presentStoreItem | PermissionRulesParam | PresentStoreItem used in StoreInventoryPermissionRulesParam. See PermissionRulesParam | |
| getStoreLog | PermissionRulesParam | GetStoreLog used in StoreInventoryPermissionRulesParam. See PermissionRulesParam | |
| getStoreUsed | PermissionRulesParam | GetStoreUsed used in StoreInventoryPermissionRulesParam. See PermissionRulesParam | |
| removeStoreUsed | PermissionRulesParam | RemoveStoreUsed used in StoreInventoryPermissionRulesParam. See PermissionRulesParam |
MasterAdminPermissionRulesParam
Defines fine-grained permission rules for administrative access control.
| Code | Type | Required | Description |
|---|---|---|---|
| setMasterGameSettings | PermissionRulesParam | SetMasterGameSettings used in MasterAdminPermissionRulesParam. See PermissionRulesParam | |
| createAdminAccount | PermissionRulesParam | The number of createadminac entries. See PermissionRulesParam | |
| removeAdminAccount | PermissionRulesParam | The number of removeadminac entries. See PermissionRulesParam | |
| setPasswordAdminAccount | PermissionRulesParam | Password string used for authentication or modification. See PermissionRulesParam | |
| setSecretKeyAdminAccount | PermissionRulesParam | Secret string used for authentication or encryption. See PermissionRulesParam | |
| setGameInformation | PermissionRulesParam | SetGameInformation used in MasterAdminPermissionRulesParam. See PermissionRulesParam | |
| createGame | PermissionRulesParam | CreateGame used in MasterAdminPermissionRulesParam. See PermissionRulesParam | |
| changePasswordAdminAccount | PermissionRulesParam | Password string used for authentication or modification. See PermissionRulesParam | |
| getAdminAccountList | PermissionRulesParam | List of getadminaccount items. See PermissionRulesParam | |
| getGameInformation | PermissionRulesParam | GetGameInformation used in MasterAdminPermissionRulesParam. See PermissionRulesParam | |
| getGameList | PermissionRulesParam | List of getgame items. See PermissionRulesParam | |
| getMasterGameSettings | PermissionRulesParam | GetMasterGameSettings used in MasterAdminPermissionRulesParam. See PermissionRulesParam | |
| getServerLog | PermissionRulesParam | GetServerLog used in MasterAdminPermissionRulesParam. See PermissionRulesParam | |
| getSecretInfoInformation | PermissionRulesParam | Secret string used for authentication or encryption. See PermissionRulesParam | |
| getSecretInfoList | PermissionRulesParam | Secret string used for authentication or encryption. See PermissionRulesParam | |
| createSecretInfo | PermissionRulesParam | Secret string used for authentication or encryption. See PermissionRulesParam | |
| setSecretInfoInformation | PermissionRulesParam | Secret string used for authentication or encryption. See PermissionRulesParam | |
| getUsernameAdminAccount | PermissionRulesParam | The number of getusernameadminac entries. See PermissionRulesParam | |
| getAnalytics | PermissionRulesParam | GetAnalytics used in MasterAdminPermissionRulesParam. See PermissionRulesParam | |
| getEventCallbackCloudScript | PermissionRulesParam | GetEventCallbackCloudScript used in MasterAdminPermissionRulesParam. See PermissionRulesParam | |
| setEventCallbackCloudScript | PermissionRulesParam | SetEventCallbackCloudScript used in MasterAdminPermissionRulesParam. See PermissionRulesParam | |
| resetStatisticsLeaderboard | PermissionRulesParam | ResetStatisticsLeaderboard used in MasterAdminPermissionRulesParam. See PermissionRulesParam | |
| getBackupStatisticsLeaderboardVersion | PermissionRulesParam | GetBackupStatisticsLeaderboardVersion used in MasterAdminPermissionRulesParam. See PermissionRulesParam | |
| deleteInDatabase | PermissionRulesParam | DeleteInDatabase used in MasterAdminPermissionRulesParam. See PermissionRulesParam |
MultiplayerPermissionRulesParam
Defines fine-grained permission rules for administrative access control.
| Code | Type | Required | Description |
|---|---|---|---|
| cancelAllMatchmakingTicket | PermissionRulesParam | CancelAllMatchmakingTicket used in MultiplayerPermissionRulesParam. See PermissionRulesParam | |
| cancelMatchmakingTicket | PermissionRulesParam | CancelMatchmakingTicket used in MultiplayerPermissionRulesParam. See PermissionRulesParam | |
| createMatchmakingTicket | PermissionRulesParam | CreateMatchmakingTicket used in MultiplayerPermissionRulesParam. See PermissionRulesParam | |
| getMatchmakingTicket | PermissionRulesParam | GetMatchmakingTicket used in MultiplayerPermissionRulesParam. See PermissionRulesParam | |
| getMatch | PermissionRulesParam | GetMatch used in MultiplayerPermissionRulesParam. See PermissionRulesParam | |
| getQueueStatistics | PermissionRulesParam | GetQueueStatistics used in MultiplayerPermissionRulesParam. See PermissionRulesParam | |
| joinMatchmakingTicket | PermissionRulesParam | JoinMatchmakingTicket used in MultiplayerPermissionRulesParam. See PermissionRulesParam | |
| listMatchmakingTicketsForPlayer | PermissionRulesParam | ListMatchmakingTicketsForPlayer used in MultiplayerPermissionRulesParam. See PermissionRulesParam | |
| getAllMatchmakingTicket | PermissionRulesParam | GetAllMatchmakingTicket used in MultiplayerPermissionRulesParam. See PermissionRulesParam | |
| getAllMatch | PermissionRulesParam | GetAllMatch used in MultiplayerPermissionRulesParam. See PermissionRulesParam |
CloudScriptPermissionRulesParam
Defines fine-grained permission rules for administrative access control.
| Code | Type | Required | Description |
|---|---|---|---|
| addFunction | PermissionRulesParam | AddFunction used in CloudScriptPermissionRulesParam. See PermissionRulesParam | |
| getFunctions | PermissionRulesParam | GetFunctions used in CloudScriptPermissionRulesParam. See PermissionRulesParam | |
| editFunction | PermissionRulesParam | EditFunction used in CloudScriptPermissionRulesParam. See PermissionRulesParam | |
| executeFunction | PermissionRulesParam | ExecuteFunction used in CloudScriptPermissionRulesParam. See PermissionRulesParam | |
| getFunction | PermissionRulesParam | GetFunction used in CloudScriptPermissionRulesParam. See PermissionRulesParam |
ErrorCode
| Name | Code |
|---|---|
| Ok | 1 |
| SecretInfoNotFound | 24 |
InvalidMember
| Code | Type | Description |
|---|---|---|
| code | string | The parameterCode invalid. |
| invalidMemberType | InvalidMemberType | The invalid member type of this parameterCode. See InvalidMemberType |
InvalidMemberType
| Name | Code | Description |
|---|---|---|
| UnknownError | 1 | An unspecified or unexpected error has occurred. |
| DataRequired | 2 | A required data field is missing or not provided. |
| TypeInvalid | 3 | The data type provided does not match the expected type. |
| StringNull | 4 | A string value is null or has not been assigned. |
| StringMinLength | 5 | The string value is shorter than the minimum required length. |
| StringMaxLength | 6 | The string value exceeds the maximum allowed length. |
| NumberMinValue | 7 | The numeric value is less than the minimum allowed value. |
| NumberMaxValue | 8 | The numeric value exceeds the maximum allowed value. |
| NumberMustInt | 9 | The numeric value must be an integer but is not. |
| GNHashtableNull | 10 | The hashtable object is null or not provided. |
| GNHashtableMinLength | 11 | The hashtable contains fewer entries than the minimum required. |
| GNHashtableMaxLength | 12 | The hashtable contains more entries than the maximum allowed. |
| GNArrayNull | 13 | The array object is null or not provided. |
| GNArrayMinLength | 14 | The array contains fewer elements than the minimum required. |
| GNArrayMaxLength | 15 | The array contains more elements than the maximum allowed. |