Overview
Apply global settings shared across all games in the system.
Client
Require permission rules dashboard.setMasterGameSettings.selfEnable. See PermissionRules
HTTP
POST /api/rJson/dashboard/client/setMasterGameSettings
Request Headers
| Name | Type | Required | Description |
|---|---|---|---|
| Auth-Token | string | 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 | string | true | The SecretKey in SecretInfo with role must is Player. |
| Game-Id | string | 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 | string | 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 | The selected secret key is missing, wrong, or does not match the current route/game context. |
| MaxSizeRequestReject | -9 | The serialized request payload exceeded the maximum size accepted by the backend. |
| MaxRequestReject | -8 | The backend rejected the request because the current caller exceeded a request-rate limit. |
| MaxCCUReject | -7 | The backend rejected the request because the current concurrent-user/session limit was exceeded. |
| OperationNotAuthorized | -6 | The target operation exists, but the caller is not authorized for the selected role or target resource. |
| InvalidRequestParameters | -5 | The request shape or one or more request-member values are invalid. When available, inspect `invalidMembers` for field-level details. |
| OperationInvalid | -4 | The requested operation code is unknown or is not valid for the selected request type/role. |
| InternalServerError | -3 | The backend hit an unhandled internal failure before producing a valid business response. |
| OperationNotAllow | -2 | The operation is known and the secret key is valid, but the permission rules attached to the current secret key do not allow this operation in the current target context. This usually maps to missing `selfEnable`, `otherSelfEnable`, `serverSelfEnable`, or `adminSelfEnable` permission for the resolved request. |
| OperationTimeout | -1 | The request timed out before a response was received. This code may be synthesized by the SDK timeout layer as well as returned by the backend. |
| UnknownError | 0 | The request failed, but no more specific low-level return code was mapped. |
| Ok | 1 | The request completed successfully at protocol level and produced a response payload. Callers must still validate the business `errorCode` in that payload. |
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 | Description |
|---|---|---|
| Ok | 1 | The business operation completed successfully. |
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 | The backend rejected the member but did not map it to a more specific validation category. |
| DataRequired | 2 | The member is required but missing. |
| TypeInvalid | 3 | The member type does not match the expected runtime type. |
| StringNull | 4 | A required string member is null or empty when null is not allowed. |
| StringMinLength | 5 | A string member is shorter than the configured minimum length. |
| StringMaxLength | 6 | A string member is longer than the configured maximum length. |
| NumberMinValue | 7 | A numeric member is lower than the configured minimum value. |
| NumberMaxValue | 8 | A numeric member is higher than the configured maximum value. |
| NumberMustInt | 9 | A numeric member must be an integer but received a non-integer value. |
| GNHashtableNull | 10 | A required `GNHashtable` member is null. |
| GNHashtableMinLength | 11 | A `GNHashtable` member contains fewer entries than allowed. |
| GNHashtableMaxLength | 12 | A `GNHashtable` member contains more entries than allowed. |
| GNArrayNull | 13 | A required `GNArray` member is null. |
| GNArrayMinLength | 14 | A `GNArray` member contains fewer items than allowed. |
| GNArrayMaxLength | 15 | A `GNArray` member contains more items than allowed. |