API Reference GS2-Guild Master Data Master Data Reference of GS2-Guild Reference of the format of master data and various models to be imported
{
"version" : "2024-04-25" ,
"guildModels" : [
{
"name" : "[string]Guild Model Name" ,
"metadata" : "[string?]Metadata" ,
"defaultMaximumMemberCount" : "[int]Maximum number of guild members that will be applied when creating a guild" ,
"maximumMemberCount" : "[int]Maximum number of guild members that can be applied" ,
"inactivityPeriodDays" : "[int]Number of days of inactivity of the guild master to select a new guild master from the guild members" ,
"roles" : [
{
"name" : "[string]Role Model Name" ,
"metadata" : "[string?]Metadata" ,
"policyDocument" : "[string]Policy document for permissions to apply to roles"
}
],
"guildMasterRole" : "[string]Role that guild masters have" ,
"guildMemberDefaultRole" : "[string]Role that guild members have in the initial state" ,
"rejoinCoolTimeMinutes" : "[int]Cool time until you can join again after leaving the guild (minutes)" ,
"maxConcurrentJoinGuilds" : "[int?]Maximum number of guilds that can be joined at the same time" ,
"maxConcurrentGuildMasterCount" : "[int?]Maximum number of guild masters that can exist at the same time"
}
]
} Type Condition Required Default Value Limits Description version string ✓
2024-04-25 Format version of master data guildModels List<GuildModel> ~ 100 items Guild ModelA guild model is an entity that sets the maximum number of people who can join the guild and the permission settings for each position within the guild.
Member Member
An entity that manages a list of guild members
Type Condition Required Default Value Limits Description userId string ✓
~ 128 chars User Id roleName string ✓
~ 128 chars Role Model Name metadata string ~ 512 chars Guild Member Metadata joinedAt long ✓
Now Join date
VerifyActionResult Verify action execution result
Type Condition Required Default Value Limits Description action String Enum enum {"Gs2Dictionary:VerifyEntryByUserId" ,"Gs2Distributor:IfExpressionByUserId" ,"Gs2Distributor:AndExpressionByUserId" ,"Gs2Distributor:OrExpressionByUserId" ,"Gs2Enchant:VerifyRarityParameterStatusByUserId" ,"Gs2Experience:VerifyRankByUserId" ,"Gs2Experience:VerifyRankCapByUserId" ,"Gs2Grade:VerifyGradeByUserId" ,"Gs2Grade:VerifyGradeUpMaterialByUserId" ,"Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName" ,"Gs2Guild:VerifyIncludeMemberByUserId" ,"Gs2Inventory:VerifyInventoryCurrentMaxCapacityByUserId" ,"Gs2Inventory:VerifyItemSetByUserId" ,"Gs2Inventory:VerifyReferenceOfByUserId" ,"Gs2Inventory:VerifySimpleItemByUserId" ,"Gs2Inventory:VerifyBigItemByUserId" ,"Gs2Limit:VerifyCounterByUserId" ,"Gs2Matchmaking:VerifyIncludeParticipantByUserId" ,"Gs2Mission:VerifyCompleteByUserId" ,"Gs2Mission:VerifyCounterValueByUserId" ,"Gs2Ranking2:VerifyGlobalRankingScoreByUserId" ,"Gs2Ranking2:VerifyClusterRankingScoreByUserId" ,"Gs2Ranking2:VerifySubscribeRankingScoreByUserId" ,"Gs2Schedule:VerifyTriggerByUserId" ,"Gs2Schedule:VerifyEventByUserId" ,"Gs2SerialKey:VerifyCodeByUserId" ,"Gs2Stamina:VerifyStaminaValueByUserId" ,"Gs2Stamina:VerifyStaminaMaxValueByUserId" ,"Gs2Stamina:VerifyStaminaRecoverIntervalMinutesByUserId" ,"Gs2Stamina:VerifyStaminaRecoverValueByUserId" ,"Gs2Stamina:VerifyStaminaOverflowValueByUserId" , } ✓
~ 128 chars Types of actions to be performed in the verify task verifyRequest string ✓
~ 524288 chars JSON string of the request used when executing the action statusCode int 0 ~ 999 Status code verifyResult string ~ 1048576 chars Result payload
ConsumeActionResult Consume action execution result
Type Condition Required Default Value Limits Description action String Enum enum {"Gs2AdReward:ConsumePointByUserId" ,"Gs2Dictionary:DeleteEntriesByUserId" ,"Gs2Enhance:DeleteProgressByUserId" ,"Gs2Exchange:DeleteAwaitByUserId" ,"Gs2Experience:SubExperienceByUserId" ,"Gs2Experience:SubRankCapByUserId" ,"Gs2Formation:SubMoldCapacityByUserId" ,"Gs2Grade:SubGradeByUserId" ,"Gs2Guild:DecreaseMaximumCurrentMaximumMemberCountByGuildName" ,"Gs2Idle:DecreaseMaximumIdleMinutesByUserId" ,"Gs2Inbox:OpenMessageByUserId" ,"Gs2Inbox:DeleteMessageByUserId" ,"Gs2Inventory:ConsumeItemSetByUserId" ,"Gs2Inventory:ConsumeSimpleItemsByUserId" ,"Gs2Inventory:ConsumeBigItemByUserId" ,"Gs2JobQueue:DeleteJobByUserId" ,"Gs2Limit:CountUpByUserId" ,"Gs2LoginReward:MarkReceivedByUserId" ,"Gs2Mission:ReceiveByUserId" ,"Gs2Mission:BatchReceiveByUserId" ,"Gs2Mission:DecreaseCounterByUserId" ,"Gs2Mission:ResetCounterByUserId" ,"Gs2Money:WithdrawByUserId" ,"Gs2Money:RecordReceipt" ,"Gs2Money2:WithdrawByUserId" ,"Gs2Money2:VerifyReceiptByUserId" ,"Gs2Quest:DeleteProgressByUserId" ,"Gs2Ranking2:CreateGlobalRankingReceivedRewardByUserId" ,"Gs2Ranking2:CreateClusterRankingReceivedRewardByUserId" ,"Gs2Schedule:DeleteTriggerByUserId" ,"Gs2SerialKey:UseByUserId" ,"Gs2Showcase:IncrementPurchaseCountByUserId" ,"Gs2SkillTree:MarkRestrainByUserId" ,"Gs2Stamina:DecreaseMaxValueByUserId" ,"Gs2Stamina:ConsumeStaminaByUserId" , } ✓
~ 128 chars Types of actions to be performed in the consume action consumeRequest string ✓
~ 524288 chars JSON string of the request used when executing the action statusCode int 0 ~ 999 Status code consumeResult string ~ 1048576 chars Result payload
AcquireActionResult Acquire action execution result
Type Condition Required Default Value Limits Description action String Enum enum {"Gs2AdReward:AcquirePointByUserId" ,"Gs2Dictionary:AddEntriesByUserId" ,"Gs2Enchant:ReDrawBalanceParameterStatusByUserId" ,"Gs2Enchant:SetBalanceParameterStatusByUserId" ,"Gs2Enchant:ReDrawRarityParameterStatusByUserId" ,"Gs2Enchant:AddRarityParameterStatusByUserId" ,"Gs2Enchant:SetRarityParameterStatusByUserId" ,"Gs2Enhance:DirectEnhanceByUserId" ,"Gs2Enhance:UnleashByUserId" ,"Gs2Enhance:CreateProgressByUserId" ,"Gs2Exchange:ExchangeByUserId" ,"Gs2Exchange:IncrementalExchangeByUserId" ,"Gs2Exchange:CreateAwaitByUserId" ,"Gs2Exchange:AcquireForceByUserId" ,"Gs2Exchange:SkipByUserId" ,"Gs2Experience:AddExperienceByUserId" ,"Gs2Experience:SetExperienceByUserId" ,"Gs2Experience:AddRankCapByUserId" ,"Gs2Experience:SetRankCapByUserId" ,"Gs2Experience:MultiplyAcquireActionsByUserId" ,"Gs2Formation:AddMoldCapacityByUserId" ,"Gs2Formation:SetMoldCapacityByUserId" ,"Gs2Formation:AcquireActionsToFormProperties" ,"Gs2Formation:SetFormByUserId" ,"Gs2Formation:AcquireActionsToPropertyFormProperties" ,"Gs2Friend:UpdateProfileByUserId" ,"Gs2Grade:AddGradeByUserId" ,"Gs2Grade:ApplyRankCapByUserId" ,"Gs2Grade:MultiplyAcquireActionsByUserId" ,"Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName" ,"Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName" ,"Gs2Idle:IncreaseMaximumIdleMinutesByUserId" ,"Gs2Idle:SetMaximumIdleMinutesByUserId" ,"Gs2Idle:ReceiveByUserId" ,"Gs2Inbox:SendMessageByUserId" ,"Gs2Inventory:AddCapacityByUserId" ,"Gs2Inventory:SetCapacityByUserId" ,"Gs2Inventory:AcquireItemSetByUserId" ,"Gs2Inventory:AcquireItemSetWithGradeByUserId" ,"Gs2Inventory:AddReferenceOfByUserId" ,"Gs2Inventory:DeleteReferenceOfByUserId" ,"Gs2Inventory:AcquireSimpleItemsByUserId" ,"Gs2Inventory:SetSimpleItemsByUserId" ,"Gs2Inventory:AcquireBigItemByUserId" ,"Gs2Inventory:SetBigItemByUserId" ,"Gs2JobQueue:PushByUserId" ,"Gs2Limit:CountDownByUserId" ,"Gs2Limit:DeleteCounterByUserId" ,"Gs2LoginReward:DeleteReceiveStatusByUserId" ,"Gs2LoginReward:UnmarkReceivedByUserId" ,"Gs2Lottery:DrawByUserId" ,"Gs2Lottery:ResetBoxByUserId" ,"Gs2Mission:RevertReceiveByUserId" ,"Gs2Mission:IncreaseCounterByUserId" ,"Gs2Mission:SetCounterByUserId" ,"Gs2Money:DepositByUserId" ,"Gs2Money:RevertRecordReceipt" ,"Gs2Money2:DepositByUserId" ,"Gs2Quest:CreateProgressByUserId" ,"Gs2Schedule:TriggerByUserId" ,"Gs2Schedule:ExtendTriggerByUserId" ,"Gs2Script:InvokeScript" ,"Gs2SerialKey:RevertUseByUserId" ,"Gs2SerialKey:IssueOnce" ,"Gs2Showcase:DecrementPurchaseCountByUserId" ,"Gs2Showcase:ForceReDrawByUserId" ,"Gs2SkillTree:MarkReleaseByUserId" ,"Gs2Stamina:RecoverStaminaByUserId" ,"Gs2Stamina:RaiseMaxValueByUserId" ,"Gs2Stamina:SetMaxValueByUserId" ,"Gs2Stamina:SetRecoverIntervalByUserId" ,"Gs2Stamina:SetRecoverValueByUserId" ,"Gs2StateMachine:StartStateMachineByUserId" , } ✓
~ 128 chars Types of actions to be performed in the acquire action acquireRequest string ✓
~ 524288 chars JSON string of the request used when executing the action statusCode int 0 ~ 999 Status code acquireResult string ~ 1048576 chars Result payload
TransactionResult Transaction execution results
Transaction execution results executed using server-side transaction auto-execution functionality
Type Condition Required Default Value Limits Description transactionId string ✓
36 ~ 36 chars Transaction ID verifyResults List<VerifyActionResult> 0 ~ 10 items List of verify action execution results consumeResults List<ConsumeActionResult> [] 0 ~ 10 items List of consume action execution results acquireResults List<AcquireActionResult> [] 0 ~ 100 items List of acquire action execution results hasError bool ✓
false Whether an error occurred during transaction execution
GuildModel Guild Model
A guild model is an entity that sets the maximum number of people who can join the guild and the permission settings for each position within the guild.
Type Condition Required Default Value Limits Description guildModelId string ✓
~ 1024 chars Guild Model GRN name string ✓
~ 128 chars Guild Model Name metadata string ~ 2048 chars Metadata defaultMaximumMemberCount int ✓
1 ~ 2147483646 Maximum number of guild members that will be applied when creating a guild maximumMemberCount int ✓
1 ~ 2147483646 Maximum number of guild members that can be applied inactivityPeriodDays int ✓
7 1 ~ 365 Number of days of inactivity of the guild master to select a new guild master from the guild members roles List<RoleModel> ✓
1 ~ 10 items List of permission settings for each position in the guild guildMasterRole string ✓
~ 128 chars Role that guild masters have guildMemberDefaultRole string ✓
~ 128 chars Role that guild members have in the initial state rejoinCoolTimeMinutes int ✓
0 0 ~ 2147483646 Cool time until you can join again after leaving the guild (minutes) maxConcurrentJoinGuilds int 1 ~ 10 Maximum number of guilds that can be joined at the same time maxConcurrentGuildMasterCount int 1 ~ 100 Maximum number of guild masters that can exist at the same time
RoleModel Role Model
The role model defines the role within the guild and sets the permissions for each role.
Type Condition Required Default Value Limits Description name string ✓
~ 128 chars Role Model Name metadata string ~ 2048 chars Metadata policyDocument string ✓
~ 10240 chars Policy document for permissions to apply to roles