Overview
Apply global settings shared across all games in the system.
Client
Require permission rules masterAdmin.setMasterGameSettings.selfEnable. See PermissionRules
HTTP
POST /api/rJson/masterAdmin/client/setMasterGameSettings
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 |
|---|---|---|---|
| thirtPartySettings | ThirtPartyParam | ThirtPartySettings parameter. See ThirtPartyParam | |
| masterPlayerSettings | MasterPlayerSettingsParam | MasterPlayerSettings parameter. See MasterPlayerSettingsParam | |
| emailSettings | EmailSettingsParam | EmailSettings parameter. See EmailSettingsParam | |
| pushNotificationSettings | PushNotificationSettingsParam | PushNotificationSettings parameter. See PushNotificationSettingsParam |
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 |
ThirtPartyParam
Parameters used to configure or control a related operation.
| Code | Type | Required | Description |
|---|---|---|---|
| googleSettings | ThirtPartyGoogleSettingsParam | GoogleSettings used in ThirtPartyParam. See ThirtPartyGoogleSettingsParam | |
| facebookSettings | ThirtPartyFacebookSettingsParam | FacebookSettings used in ThirtPartyParam. See ThirtPartyFacebookSettingsParam | |
| appleSettings | ThirtPartyAppleSettingsParam | AppleSettings used in ThirtPartyParam. See ThirtPartyAppleSettingsParam | |
| googlePlayGameSettings | ThirtPartyGooglePlayGameSettingsParam | GooglePlayGameSettings used in ThirtPartyParam. See ThirtPartyGooglePlayGameSettingsParam | |
| gameCenterSettings | ThirtPartyGameCenterSettingsParam | GameCenterSettings used in ThirtPartyParam. See ThirtPartyGameCenterSettingsParam |
ThirtPartyGoogleSettingsParam
Configuration structure defining backend behavior or system-level preferences.
| Code | Type | Required | Description |
|---|---|---|---|
| googleClientId | string | true | GoogleClientId used in ThirtPartyGoogleSettingsParam. |
| packageId | string | true | PackageId used in ThirtPartyGoogleSettingsParam. |
| publicRSAKey | string | true | Key used to reference the value or setting. |
ThirtPartyFacebookSettingsParam
Configuration structure defining backend behavior or system-level preferences.
| Code | Type | Required | Description |
|---|---|---|---|
| facebookAppId | string | true | FacebookAppId used in ThirtPartyFacebookSettingsParam. |
| facebookAppToken | string | true | FacebookAppToken used in ThirtPartyFacebookSettingsParam. |
| facebookInappSecret | string | true | Secret string used for authentication or encryption. |
ThirtPartyAppleSettingsParam
Configuration structure defining backend behavior or system-level preferences.
| Code | Type | Required | Description |
|---|---|---|---|
| appleClientId | string | true | AppleClientId used in ThirtPartyAppleSettingsParam. |
| sandboxEnable | boolean | true | SandboxEnable used in ThirtPartyAppleSettingsParam. |
| issuerId | string | true | IssuerId used in ThirtPartyAppleSettingsParam. |
| keyId | string | true | Key used to reference the value or setting. |
| p8Content | string | true | P8Content used in ThirtPartyAppleSettingsParam. |
ThirtPartyGooglePlayGameSettingsParam
Configuration structure defining backend behavior or system-level preferences.
| Code | Type | Required | Description |
|---|---|---|---|
| redirectUri | string | true | RedirectUri used in ThirtPartyGooglePlayGameSettingsParam. |
| clientId | string | true | ClientId used in ThirtPartyGooglePlayGameSettingsParam. |
| clientSecret | string | true | Secret string used for authentication or encryption. |
| applicationId | string | true | ApplicationId used in ThirtPartyGooglePlayGameSettingsParam. |
ThirtPartyGameCenterSettingsParam
Configuration structure defining backend behavior or system-level preferences.
| Code | Type | Required | Description |
|---|---|---|---|
| packageId | string | true | PackageId used in ThirtPartyGameCenterSettingsParam. |
MasterPlayerSettingsParam
Configuration structure defining backend behavior or system-level preferences.
| Code | Type | Required | Description |
|---|---|---|---|
| genericServiceSettings | GenericServiceSettingsParam[] | GenericServiceSettings used in MasterPlayerSettingsParam. See GenericServiceSettingsParam | |
| playerCurrenciesSettings | CurrencySettingsParam[] | PlayerCurrenciesSettings used in MasterPlayerSettingsParam. See CurrencySettingsParam | |
| playerStatisticsSettings | StatisticsSettingsParam[] | PlayerStatisticsSettings used in MasterPlayerSettingsParam. See StatisticsSettingsParam | |
| playerDatasSettings | DataSettingsParam[] | PlayerDatasSettings used in MasterPlayerSettingsParam. See DataSettingsParam | |
| customDatasSettings | DataSettingsParam[] | CustomDatasSettings used in MasterPlayerSettingsParam. See DataSettingsParam | |
| tagsSettings | TagSettingsParam[] | TagsSettings used in MasterPlayerSettingsParam. See TagSettingsParam |
GenericServiceSettingsParam
Configuration structure defining backend behavior or system-level preferences.
| Code | Type | Required | Description |
|---|---|---|---|
| serviceName | string | true | ServiceName used in GenericServiceSettingsParam. (2 - 32 characters) |
CurrencySettingsParam
Configuration structure defining backend behavior or system-level preferences.
| Code | Type | Required | Description |
|---|---|---|---|
| key | string | true | Key used to reference the value or setting. (2 - 32 characters) |
| initialValue | number | true | Value assigned to the configuration or key. |
| description | string | true | Description used in CurrencySettingsParam. |
| index | boolean | true | Index used in CurrencySettingsParam. |
StatisticsSettingsParam
Configuration structure defining backend behavior or system-level preferences.
| Code | Type | Required | Description |
|---|---|---|---|
| key | string | true | Key used to reference the value or setting. (2 - 32 characters) |
| statisticsAggregationMethod | number int | true | StatisticsAggregationMethod used in StatisticsSettingsParam. |
| maximumValue | number | Value assigned to the configuration or key. (Default: null) | |
| minimumValue | number | Value assigned to the configuration or key. (Default: null) | |
| initialValue | number | true | Value assigned to the configuration or key. |
| description | string | true | Description used in StatisticsSettingsParam. |
| index | boolean | true | Index used in StatisticsSettingsParam. |
DataSettingsParam
Configuration structure defining backend behavior or system-level preferences.
| Code | Type | Required | Description |
|---|---|---|---|
| key | string | true | Key used to reference the value or setting. (2 - 32 characters) |
| description | string | true | Description used in DataSettingsParam. |
| permission | number int | true | Permissions configuration or role-based access control settings. |
TagSettingsParam
Configuration structure defining backend behavior or system-level preferences.
| Code | Type | Required | Description |
|---|---|---|---|
| key | string | true | Key used to reference the value or setting. (2 - 32 characters) |
| description | string | true | Description used in TagSettingsParam. |
| index | boolean | true | Index used in TagSettingsParam. |
EmailSettingsParam
Configuration structure defining backend behavior or system-level preferences.
| Code | Type | Required | Description |
|---|---|---|---|
| sendFrom | string | true | SendFrom used in EmailSettingsParam. |
| secure | boolean | true | Secure used in EmailSettingsParam. |
| host | string | true | Host used in EmailSettingsParam. |
| port | number | true | Port used in EmailSettingsParam. |
| username | string | true | Username used in EmailSettingsParam. |
| password | string | true | Password string used for authentication or modification. |
PushNotificationSettingsParam
Configuration structure defining backend behavior or system-level preferences.
| Code | Type | Required | Description |
|---|---|---|---|
| projectId | string | true | ProjectId used in PushNotificationSettingsParam. |
| clientEmail | string | true | ClientEmail used in PushNotificationSettingsParam. |
| privateKey | string | true | Key used to reference the value or setting. |
ErrorCode
| Name | Code |
|---|---|
| Ok | 1 |
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. |