GS2-Deploy/CDK Reference of GS2-Distributor

Template format used to create GS2-Deploy stacks and examples of template output implementation in various languages using CDK

Entities

Namespace

Namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project. Basically, GS2 services have a layer called namespace, and different namespaces are treated as completely different data spaces, even for the same service.

Therefore, it is necessary to create a namespace before starting to use each service.

	Type	Require	Limitation	Description
name	string	✓	~ 128 chars	Namespace name
description	string		~ 1024 chars	Description
assumeUserId	string		~ 1024 chars	User GRN
autoRunStampSheetNotification	NotificationSetting	✓		Push notification when transaction auto-execution is complete(Old specification)
autoRunTransactionNotification	NotificationSetting	✓		Push notification when transaction auto-execution is complete
logSetting	LogSetting			Log output settings

GetAttr

Generation results of resources that can be obtained with the !GetAttr tag

	Type	Description
Item	Namespace	Namespace created

Implementation Example

Type: GS2::Distributor::Namespace
Properties:
  Name: namespace-0001
  Description: null
  AssumeUserId: grn:gs2::YourOwnerId:identifier:user:user-0001
  AutoRunStampSheetNotification: null
  AutoRunTransactionNotification: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001

import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/distributor"
    "github.com/openlyinc/pointy"
)

SampleStack := core.NewStack()
distributor.NewNamespace(
    &SampleStack,
    "namespace-0001",
    distributor.NamespaceOptions{
        AssumeUserId: pointy.String("grn:gs2::YourOwnerId:identifier:user:user-0001"),
        LogSetting: &core.LogSetting{
            LoggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
        },
    },
)

println(SampleStack.Yaml())  // Generate Template

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        new \Gs2Cdk\Distributor\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\Distributor\Model\Options\NamespaceOptions(
                assumeUserId: "grn:gs2::YourOwnerId:identifier:user:user-0001",
                logSetting: new \Gs2Cdk\Core\Model\LogSetting(
                    loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            )
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.distributor.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.distributor.model.options.NamespaceOptions()
                        .withAssumeUserId("grn:gs2::YourOwnerId:identifier:user:user-0001")
                        .withLogSetting(new io.gs2.cdk.core.model.LogSetting(
                            "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                        ))
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Distributor.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: new Gs2Cdk.Gs2Distributor.Model.Options.NamespaceOptions
            {
                assumeUserId = "grn:gs2::YourOwnerId:identifier:user:user-0001",
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template

import core from "@/gs2cdk/core";
import distributor from "@/gs2cdk/distributor";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new distributor.model.Namespace(
            this,
            "namespace-0001",
            {
                assumeUserId: "grn:gs2::YourOwnerId:identifier:user:user-0001",
                logSetting: new core.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template

from gs2_cdk import Stack, core, distributor

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        distributor.Namespace(
            stack=self,
            name='namespace-0001',
            options=distributor.NamespaceOptions(
                assume_user_id='grn:gs2::YourOwnerId:identifier:user:user-0001',
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

print(SampleStack().yaml())  # Generate Template

CurrentDistributorMaster

Currently available master data

GS2 uses JSON format files for master data management. By uploading the file, you can actually reflect the settings on the server.

We provide a master data editor on the management console as a way to create JSON files, but we also provide a master data editor on the management console as a way to create JSON files. The service can also be used by creating a tool more appropriate for game management and exporting a JSON file in the appropriate format.

Note

Please refer to Master Data Reference of GS2-Distributor for the JSON file format.

	Type	Require	Default	Limitation	Description
namespaceName	string	✓		~ 128 chars	Namespace name
mode	string	✓	“direct”	~ 128 chars	Update mode
settings	string	{mode} == “direct”		~ 5242880 chars	Master data
uploadToken	string	{mode} == “preUpload”		~ 1024 chars	Token used to reflect results after upload

GetAttr

Generation results of resources that can be obtained with the !GetAttr tag

	Type	Description
Item	CurrentDistributorMaster	Updated and currently available delivery settings

Implementation Example

Type: GS2::Distributor::CurrentDistributorMaster
Properties:
  NamespaceName: namespace-0001
  Mode: null
  Settings: {
    "version": "2019-03-01",
    "distributorModels": [
      {
        "name": "basic",
        "metadata": "BASIC",
        "inboxNamespaceId": "grn:gs2:ap-northeast-1:YourOwnerId:inbox:inbox-0001"
      },
      {
        "name": "special",
        "metadata": "SPECIAL",
        "inboxNamespaceId": "grn:gs2:ap-northeast-1:YourOwnerId:inbox:inbox-0001",
        "whiteListTargetIds": [
          "test"
        ]
      }
    ]
  }
  UploadToken: null

import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/distributor"
    "github.com/openlyinc/pointy"
)

SampleStack := core.NewStack()
distributor.NewNamespace(
    &SampleStack,
    "namespace-0001",
    distributor.NamespaceOptions{},
).MasterData(
    []distributor.DistributorModel{
        distributor.NewDistributorModel(
            "basic",
            distributor.DistributorModelOptions{
                Metadata: pointy.String("BASIC"),
                InboxNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:inbox:inbox-0001"),
            },
        ),
        distributor.NewDistributorModel(
            "special",
            distributor.DistributorModelOptions{
                Metadata: pointy.String("SPECIAL"),
                InboxNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:inbox:inbox-0001"),
                WhiteListTargetIds: []string{
                    "test",
                },
            },
        ),
    },
)

println(SampleStack.Yaml())  // Generate Template

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Distributor\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\Distributor\Model\DistributorModel(
                    name:"basic",
                    options: new \Gs2Cdk\Distributor\Model\Options\DistributorModelOptions(
                        metadata:"BASIC",
                        inboxNamespaceId:"grn:gs2:ap-northeast-1:YourOwnerId:inbox:inbox-0001"
                    )
                ),
                new \Gs2Cdk\Distributor\Model\DistributorModel(
                    name:"special",
                    options: new \Gs2Cdk\Distributor\Model\Options\DistributorModelOptions(
                        metadata:"SPECIAL",
                        inboxNamespaceId:"grn:gs2:ap-northeast-1:YourOwnerId:inbox:inbox-0001",
                        whiteListTargetIds:[
                            "test",
                        ]
                    )
                )
            ]
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.distributor.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.distributor.model.DistributorModel(
                    "basic",
                    new io.gs2.cdk.distributor.model.options.DistributorModelOptions()
                        .withMetadata("BASIC")
                        .withInboxNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:inbox:inbox-0001")
                ),
                new io.gs2.cdk.distributor.model.DistributorModel(
                    "special",
                    new io.gs2.cdk.distributor.model.options.DistributorModelOptions()
                        .withMetadata("SPECIAL")
                        .withInboxNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:inbox:inbox-0001")
                        .withWhiteListTargetIds(Arrays.asList(
                            "test"
                        ))
                )
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Distributor.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2Distributor.Model.DistributorModel[] {
                new Gs2Cdk.Gs2Distributor.Model.DistributorModel(
                    name: "basic",
                    options: new Gs2Cdk.Gs2Distributor.Model.Options.DistributorModelOptions
                    {
                        metadata = "BASIC",
                        inboxNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:inbox:inbox-0001"
                    }
                ),
                new Gs2Cdk.Gs2Distributor.Model.DistributorModel(
                    name: "special",
                    options: new Gs2Cdk.Gs2Distributor.Model.Options.DistributorModelOptions
                    {
                        metadata = "SPECIAL",
                        inboxNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:inbox:inbox-0001",
                        whiteListTargetIds = new string[]
                        {
                            "test"
                        }
                    }
                )
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template

import core from "@/gs2cdk/core";
import distributor from "@/gs2cdk/distributor";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new distributor.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new distributor.model.DistributorModel(
                    "basic",
                    {
                        metadata: "BASIC",
                        inboxNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:inbox:inbox-0001"
                    }
                ),
                new distributor.model.DistributorModel(
                    "special",
                    {
                        metadata: "SPECIAL",
                        inboxNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:inbox:inbox-0001",
                        whiteListTargetIds: [
                            "test",
                        ]
                    }
                )
            ]
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template

from gs2_cdk import Stack, core, distributor

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        distributor.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            distributor_models=[
                distributor.DistributorModel(
                    name='basic',
                    options=distributor.DistributorModelOptions(
                        metadata = 'BASIC',
                        inbox_namespace_id = 'grn:gs2:ap-northeast-1:YourOwnerId:inbox:inbox-0001'
                    ),
                ),
                distributor.DistributorModel(
                    name='special',
                    options=distributor.DistributorModelOptions(
                        metadata = 'SPECIAL',
                        inbox_namespace_id = 'grn:gs2:ap-northeast-1:YourOwnerId:inbox:inbox-0001',
                        white_list_target_ids = [
                            'test',
                        ]
                    ),
                ),
            ],
        )

print(SampleStack().yaml())  # Generate Template

BatchRequestPayload

API Batch Request

	Type	Require	Limitation	Description
requestId	string	✓	~ 128 chars	Request ID
service	enum { “account”, “adReward”, “auth”, “buff”, “chat”, “datastore”, “deploy”, “dictionary”, “distributor”, “enchant”, “enhance”, “exchange”, “experience”, “formation”, “friend”, “gateway”, “grade”, “guard”, “guild”, “identifier”, “idle”, “inbox”, “inventory”, “jobQueue”, “key”, “limit”, “lock”, “log”, “loginReward”, “lottery”, “matchmaking”, “megaField”, “mission”, “money”, “money2”, “news”, “quest”, “ranking”, “ranking2”, “realtime”, “schedule”, “script”, “seasonRating”, “serialKey”, “showcase”, “skillTree”, “stamina”, “stateMachine”, “version” }	✓	~ 128 chars	Service
methodName	string	✓	~ 128 chars	Method Name
parameter	string	✓	~ 10240 chars	Method Name

Enumeration type definition to specify as service

Enumerator String Definition	Description
account	GS2-Account
adReward	GS2-AdReward
auth	GS2-Auth
buff	GS2-Buff
chat	GS2-Chat
datastore	GS2-Datastore
deploy	GS2-Deploy
dictionary	GS2-Dictionary
distributor	GS2-Distributor
enchant	GS2-Enchant
enhance	GS2-Enhance
exchange	GS2-Exchange
experience	GS2-Experience
formation	GS2-Formation
friend	GS2-Friend
gateway	GS2-Gateway
grade	GS2-Grade
guard	GS2-Guard
guild	GS2-Guild
identifier	GS2-Identifier
idle	GS2-Idle
inbox	GS2-Inbox
inventory	GS2-Inventory
jobQueue	GS2-JobQueue
key	GS2-Key
limit	GS2-Limit
lock	GS2-Lock
log	GS2-Log
loginReward	GS2-LoginReward
lottery	GS2-Lottery
matchmaking	GS2-Matchmaking
megaField	GS2-MegaField
mission	GS2-Mission
money	GS2-Money
money2	GS2-Money2
news	GS2-News
quest	GS2-Quest
ranking	GS2-Ranking
ranking2	GS2-Ranking2
realtime	GS2-Realtime
schedule	GS2-Schedule
script	GS2-Script
seasonRating	GS2-SeasonRating
serialKey	GS2-SerialKey
showcase	GS2-Showcase
skillTree	GS2-SkillTree
stamina	GS2-Stamina
stateMachine	GS2-StateMachine
version	GS2-Version

BatchResultPayload

API Batch Result

	Type	Require	Limitation	Description
requestId	string	✓	~ 128 chars	Request ID
statusCode	int	✓	100 ~ 1000	Status Code
resultPayload	string	✓	~ 10240 chars	Response

AcquireAction

Acquire Action

	Type	Require	Default	Limitation	Description
action	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", "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
request	string	✓		~ 524288 chars	JSON of request

ConsumeAction

Consume Action

	Type	Require	Default	Limitation	Description
action	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
request	string	✓		~ 524288 chars	JSON of request

VerifyAction

Verify Action

	Type	Require	Default	Limitation	Description
action	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
request	string	✓		~ 524288 chars	JSON of request

AcquireActionResult

Acquire action execution result

	Type	Require	Limitation	Description
action	enum { }	✓	~ 128 chars	Types of actions to be performed in the acquire action
acquireRequest	string	✓	~ 524288 chars	JSON of request
statusCode	int		~ 999	Status code
acquireResult	string		~ 1048576 chars	Result payload

Enumeration type definition to specify as action

Enumerator String Definition	Description

ConsumeActionResult

Consume action execution result

	Type	Require	Limitation	Description
action	enum { }	✓	~ 128 chars	Types of actions to be performed in the consume action
consumeRequest	string	✓	~ 524288 chars	JSON of request
statusCode	int		~ 999	Status code
consumeResult	string		~ 1048576 chars	Result payload

Enumeration type definition to specify as action

Enumerator String Definition	Description

VerifyActionResult

Verify action execution result

	Type	Require	Limitation	Description
action	enum { }	✓	~ 128 chars	Types of actions to be performed in the verify task
verifyRequest	string	✓	~ 524288 chars	JSON of request
statusCode	int		~ 999	Status code
verifyResult	string		~ 1048576 chars	Result payload

Enumeration type definition to specify as action

Enumerator String Definition	Description

Config

Configration

Set values to be applied to transaction variables

	Type	Require	Default	Limitation	Description
key	string	✓		~ 64 chars	Name
value	string			~ 51200 chars	Value

GitHubCheckoutSetting

Setup to check out master data from GitHub

	Type	Require	Limitation	Description
apiKeyId	string	✓	~ 1024 chars	GitHub API key GRN
repositoryName	string	✓	~ 1024 chars	Repository Name
sourcePath	string	✓	~ 1024 chars	Source code file path
referenceType	enum { “commit_hash”, “branch”, “tag” }	✓	~ 128 chars	Source of code
commitHash	string	{referenceType} == “commit_hash”	~ 1024 chars	Commit hash
branchName	string	{referenceType} == “branch”	~ 1024 chars	Branch Name
tagName	string	{referenceType} == “tag”	~ 1024 chars	Tag Name

Enumeration type definition to specify as referenceType

Enumerator String Definition	Description
commit_hash	Commit hash
branch	Branch
tag	Tag

DistributeResource

Distribute Resource

	Type	Require	Default	Limitation	Description
action	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", "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
request	string	✓		~ 524288 chars	JSON of request

LogSetting

Log setting

This type manages log output settings. This type holds the identifier of the log namespace used to output log data. The log namespace ID specifies the GS2-Log namespace to aggregate and store the log data. Through this setting, API request and response log data under this namespace will be output to the target GS2-Log. GS2-Log provides logs in real time, which can be used for system monitoring, analysis, debugging, etc.

	Type	Require	Default	Limitation	Description
loggingNamespaceId	string	✓		~ 1024 chars	Namespace GRN

NotificationSetting

Push notification settings

This is a setting for sending push notifications when an event occurs in a GS2 microservice. The push notification here refers to the processing via the WebSocket interface provided by GS2-Gateway, and is different from the push notification of a smartphone. For example, when a matchmaking is completed or a friend request is received, the GS2-Gateway can send a push notification via the WebSocket interface, and the game client can detect the change of the state.

GS2-Gateway’s push notifications can be used to send additional processing to mobile push notifications when the destination device is offline. If you use mobile push notifications well, you may be able to realize a flow in which you can notify the player by using mobile push notifications even if you end the game during matchmaking and return to the game.

	Type	Require	Default	Limitation	Description
gatewayNamespaceId	string	✓	“grn:gs2:{region}:{ownerId}:gateway:default”	~ 1024 chars	GS2-Gateway namespace to use for push notifications
enableTransferMobileNotification	bool?		false		Forwarding to mobile push notification
sound	string	{enableTransferMobileNotification} == true		~ 1024 chars	Sound file name to be used for mobile push notifications