GS2-SkillTree GS2-Deploy/CDK リファレンス

GS2-Deployのスタックの作成に使用するテンプレートのフォーマットと、CDKによる各種言語のテンプレート出力の実装例

エンティティ

Namespace

ネームスペース

ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。
GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。

そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。

	型	必須	値の制限	説明
name	string	✓	~ 128文字	ネームスペース名
description	string		~ 1024文字	説明文
transactionSetting	TransactionSetting	✓		トランザクション設定
releaseScript	ScriptSetting			ノード開放時に実行するスクリプト
restrainScript	ScriptSetting			ノード開放状態を未解放状態に戻す時に実行するスクリプト
logSetting	LogSetting			ログの出力設定

GetAttr

!GetAttrタグで取得可能なリソースの生成結果

	型	説明
Item	Namespace	作成したネームスペース

実装例

Type: GS2::SkillTree::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSetting: 
    EnableAutoRun: true
    QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
    KeyId: grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001
  ReleaseScript: null
  RestrainScript: 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/skillTree"
    "github.com/gs2io/gs2-golang-cdk/inventory"
    "github.com/openlyinc/pointy"
)

SampleStack := core.NewStack()
skillTree.NewNamespace(
    &SampleStack,
    "namespace-0001",
    skillTree.NamespaceOptions{
        TransactionSetting: core.NewTransactionSetting(
            core.TransactionSettingOptions{
                QueueNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-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\SkillTree\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\SkillTree\Model\Options\NamespaceOptions(
                transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
                    new \Gs2Cdk\Core\Model\TransactionSettingOptions(
                        queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-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.skillTree.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.skillTree.model.options.NamespaceOptions()
                        .withTransactionSetting(new io.gs2.cdk.core.model.TransactionSetting(
                            new io.gs2.cdk.core.model.options.TransactionSettingOptions()
                                .withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-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.Gs2SkillTree.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: new Gs2Cdk.Gs2SkillTree.Model.Options.NamespaceOptions
            {
                transactionSetting = new Gs2Cdk.Core.Model.TransactionSetting(
                    options: new Gs2Cdk.Core.Model.TransactionSettingOptions
                    {
                        queueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-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 skillTree from "@/gs2cdk/skillTree";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new skillTree.model.Namespace(
            this,
            "namespace-0001",
            {
                transactionSetting: new core.TransactionSetting(
                    {
                        queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-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, skill_tree

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        skill_tree.Namespace(
            stack=self,
            name='namespace-0001',
            options=skill_tree.NamespaceOptions(
                transaction_setting=core.TransactionSetting(
                    options=core.TransactionSettingOptions(
                        queue_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001',
                    )
                ),
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

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

CurrentTreeMaster

現在有効なマスターデータ

GS2ではマスターデータの管理にJSON形式のファイルを使用します。
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。

JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが
よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。

Note

JSONファイルの形式については GS2-SkillTree マスターデータリファレンスをご参照ください。

型

有効化条件

必須

デフォルト

値の制限

説明

namespaceName

string

✓

~ 128文字

ネームスペース名

mode

文字列列挙型
enum {
“direct”,
“preUpload”
}

✓

“direct”

~ 128文字

更新モード

定義	説明
“direct”	設定を直接更新
“preUpload”	設定をアップロードしてから更新

settings

string

{mode} == “direct”

✓

~ 5242880文字

マスターデータ
mode が “direct” であれば必須

uploadToken

string

{mode} == “preUpload”

✓

~ 1024文字

プレアップロードで取得したトークン
mode が “preUpload” であれば必須

GetAttr

!GetAttrタグで取得可能なリソースの生成結果

	型	説明
Item	CurrentTreeMaster	更新した現在有効なマスターデータ

実装例

Type: GS2::SkillTree::CurrentTreeMaster
Properties:
  NamespaceName: namespace-0001
  Mode: null
  Settings: {
    "version": "2023-09-06",
    "nodeModels": [
      {
        "name": "node-0001",
        "releaseConsumeActions": [
          {
            "action": "Gs2Inventory:ConsumeItemSetByUserId",
            "request": {
              "namespaceName": "namespace-0001",
              "inventoryName": "item",
              "itemName": "item-0001",
              "userId": "#{userId}",
              "consumeCount": 10
            }
          }
        ],
        "restrainReturnRate": 0.5,
        "metadata": "NODE-0001"
      },
      {
        "name": "node-0002",
        "releaseConsumeActions": [
          {
            "action": "Gs2Inventory:ConsumeItemSetByUserId",
            "request": {
              "namespaceName": "namespace-0001",
              "inventoryName": "item",
              "itemName": "item-0001",
              "userId": "#{userId}",
              "consumeCount": 15
            }
          }
        ],
        "restrainReturnRate": 0.5,
        "metadata": "NODE-0002",
        "premiseNodeNames": [
          "node-0001"
        ]
      },
      {
        "name": "node-0003",
        "releaseConsumeActions": [
          {
            "action": "Gs2Inventory:ConsumeItemSetByUserId",
            "request": {
              "namespaceName": "namespace-0001",
              "inventoryName": "item",
              "itemName": "item-0001",
              "userId": "#{userId}",
              "consumeCount": 20
            }
          },
          {
            "action": "Gs2Inventory:ConsumeItemSetByUserId",
            "request": {
              "namespaceName": "namespace-0001",
              "inventoryName": "item",
              "itemName": "item-0002",
              "userId": "#{userId}",
              "consumeCount": 2
            }
          }
        ],
        "restrainReturnRate": 0.5,
        "metadata": "NODE-0003",
        "premiseNodeNames": [
          "node-0002"
        ]
      }
    ]
  }
  UploadToken: null

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

SampleStack := core.NewStack()
skillTree.NewNamespace(
    &SampleStack,
    "namespace-0001",
    skillTree.NamespaceOptions{},
).MasterData(
    []skillTree.NodeModel{
        skillTree.NewNodeModel(
            "node-0001",
            []core.ConsumeAction{
                inventory.ConsumeItemSetByUserId(
                    "namespace-0001",
                    "inventory-0001",
                    "item-0001",
                    1,
                    nil,
                ),
            },
            0.5,
            skillTree.NodeModelOptions{
                Metadata: pointy.String("NODE-0001"),
            },
        ),
        skillTree.NewNodeModel(
            "node-0002",
            []core.ConsumeAction{
                inventory.ConsumeItemSetByUserId(
                    "namespace-0001",
                    "inventory-0001",
                    "item-0001",
                    1,
                    nil,
                ),
            },
            0.5,
            skillTree.NodeModelOptions{
                Metadata: pointy.String("NODE-0002"),
                PremiseNodeNames: []string{
                    "node-0001",
                },
            },
        ),
        skillTree.NewNodeModel(
            "node-0003",
            []core.ConsumeAction{
                inventory.ConsumeItemSetByUserId(
                    "namespace-0001",
                    "inventory-0001",
                    "item-0001",
                    1,
                    nil,
                ),
                inventory.ConsumeItemSetByUserId(
                    "namespace-0001",
                    "inventory-0001",
                    "item-0001",
                    1,
                    nil,
                ),
            },
            0.5,
            skillTree.NodeModelOptions{
                Metadata: pointy.String("NODE-0003"),
                PremiseNodeNames: []string{
                    "node-0002",
                },
            },
        ),
    },
)

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

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\SkillTree\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\SkillTree\Model\NodeModel(
                    name:"node-0001",
                    releaseConsumeActions:[
                        new \Gs2Cdk\Inventory\StampSheet\ConsumeItemSetByUserId(
                            namespaceName:"namespace-0001",
                            inventoryName: "item",
                            itemName: "item-0001",
                            userId: "#{userId}",
                            consumeCount: 10
                        ),
                    ],
                    restrainReturnRate:0.5,
                    options: new \Gs2Cdk\SkillTree\Model\Options\NodeModelOptions(
                        metadata:"NODE-0001"
                    )
                ),
                new \Gs2Cdk\SkillTree\Model\NodeModel(
                    name:"node-0002",
                    releaseConsumeActions:[
                        new \Gs2Cdk\Inventory\StampSheet\ConsumeItemSetByUserId(
                            namespaceName:"namespace-0001",
                            inventoryName: "item",
                            itemName: "item-0001",
                            userId: "#{userId}",
                            consumeCount: 15
                        ),
                    ],
                    restrainReturnRate:0.5,
                    options: new \Gs2Cdk\SkillTree\Model\Options\NodeModelOptions(
                        metadata:"NODE-0002",
                        premiseNodeNames:[
                            "node-0001",
                        ]
                    )
                ),
                new \Gs2Cdk\SkillTree\Model\NodeModel(
                    name:"node-0003",
                    releaseConsumeActions:[
                        new \Gs2Cdk\Inventory\StampSheet\ConsumeItemSetByUserId(
                            namespaceName:"namespace-0001",
                            inventoryName: "item",
                            itemName: "item-0001",
                            userId: "#{userId}",
                            consumeCount: 20
                        ),
                        new \Gs2Cdk\Inventory\StampSheet\ConsumeItemSetByUserId(
                            namespaceName:"namespace-0001",
                            inventoryName: "item",
                            itemName: "item-0002",
                            userId: "#{userId}",
                            consumeCount: 2
                        ),
                    ],
                    restrainReturnRate:0.5,
                    options: new \Gs2Cdk\SkillTree\Model\Options\NodeModelOptions(
                        metadata:"NODE-0003",
                        premiseNodeNames:[
                            "node-0002",
                        ]
                    )
                )
            ]
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.skillTree.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.skillTree.model.NodeModel(
                    "node-0001",
                    Arrays.asList(
                        new io.gs2.cdk.inventory.stampSheet.ConsumeItemSetByUserId(
                            "namespace-0001",
                            "inventory-0001",
                            "item-0001",
                            1L,
                            null,
                            "#{userId}"
                        )
                    ),
                    0.5f,
                    new io.gs2.cdk.skillTree.model.options.NodeModelOptions()
                        .withMetadata("NODE-0001")
                ),
                new io.gs2.cdk.skillTree.model.NodeModel(
                    "node-0002",
                    Arrays.asList(
                        new io.gs2.cdk.inventory.stampSheet.ConsumeItemSetByUserId(
                            "namespace-0001",
                            "inventory-0001",
                            "item-0001",
                            1L,
                            null,
                            "#{userId}"
                        )
                    ),
                    0.5f,
                    new io.gs2.cdk.skillTree.model.options.NodeModelOptions()
                        .withMetadata("NODE-0002")
                        .withPremiseNodeNames(Arrays.asList(
                            "node-0001"
                        ))
                ),
                new io.gs2.cdk.skillTree.model.NodeModel(
                    "node-0003",
                    Arrays.asList(
                        new io.gs2.cdk.inventory.stampSheet.ConsumeItemSetByUserId(
                            "namespace-0001",
                            "inventory-0001",
                            "item-0001",
                            1L,
                            null,
                            "#{userId}"
                        ),
                        new io.gs2.cdk.inventory.stampSheet.ConsumeItemSetByUserId(
                            "namespace-0001",
                            "inventory-0001",
                            "item-0001",
                            1L,
                            null,
                            "#{userId}"
                        )
                    ),
                    0.5f,
                    new io.gs2.cdk.skillTree.model.options.NodeModelOptions()
                        .withMetadata("NODE-0003")
                        .withPremiseNodeNames(Arrays.asList(
                            "node-0002"
                        ))
                )
            )
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2SkillTree.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2SkillTree.Model.NodeModel[] {
                new Gs2Cdk.Gs2SkillTree.Model.NodeModel(
                    name: "node-0001",
                    releaseConsumeActions: new Gs2Cdk.Core.Model.ConsumeAction[]
                    {
                        new Gs2Cdk.Gs2Inventory.StampSheet.ConsumeItemSetByUserId(
                            namespaceName: "namespace-0001",
                            inventoryName: "item",
                            itemName: "item-0001",
                            userId: "#{userId}",
                            consumeCount: 10
                        )
                    },
                    restrainReturnRate: 0.5f,
                    options: new Gs2Cdk.Gs2SkillTree.Model.Options.NodeModelOptions
                    {
                        metadata = "NODE-0001"
                    }
                ),
                new Gs2Cdk.Gs2SkillTree.Model.NodeModel(
                    name: "node-0002",
                    releaseConsumeActions: new Gs2Cdk.Core.Model.ConsumeAction[]
                    {
                        new Gs2Cdk.Gs2Inventory.StampSheet.ConsumeItemSetByUserId(
                            namespaceName: "namespace-0001",
                            inventoryName: "item",
                            itemName: "item-0001",
                            userId: "#{userId}",
                            consumeCount: 15
                        )
                    },
                    restrainReturnRate: 0.5f,
                    options: new Gs2Cdk.Gs2SkillTree.Model.Options.NodeModelOptions
                    {
                        metadata = "NODE-0002",
                        premiseNodeNames = new string[]
                        {
                            "node-0001"
                        }
                    }
                ),
                new Gs2Cdk.Gs2SkillTree.Model.NodeModel(
                    name: "node-0003",
                    releaseConsumeActions: new Gs2Cdk.Core.Model.ConsumeAction[]
                    {
                        new Gs2Cdk.Gs2Inventory.StampSheet.ConsumeItemSetByUserId(
                            namespaceName: "namespace-0001",
                            inventoryName: "item",
                            itemName: "item-0001",
                            userId: "#{userId}",
                            consumeCount: 20
                        ),
                        new Gs2Cdk.Gs2Inventory.StampSheet.ConsumeItemSetByUserId(
                            namespaceName: "namespace-0001",
                            inventoryName: "item",
                            itemName: "item-0002",
                            userId: "#{userId}",
                            consumeCount: 2
                        )
                    },
                    restrainReturnRate: 0.5f,
                    options: new Gs2Cdk.Gs2SkillTree.Model.Options.NodeModelOptions
                    {
                        metadata = "NODE-0003",
                        premiseNodeNames = new string[]
                        {
                            "node-0002"
                        }
                    }
                )
            }
        );
    }
}

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new skillTree.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new skillTree.model.NodeModel(
                    "node-0001",
                    [
                        new inventory.stampSheet.ConsumeItemSetByUserId(
                            "namespace-0001",
                            "inventory-0001",
                            "item-0001",
                            1,
                            "#{userId}"
                        ),
                    ],
                    0.5,
                    {
                        metadata: "NODE-0001"
                    }
                ),
                new skillTree.model.NodeModel(
                    "node-0002",
                    [
                        new inventory.stampSheet.ConsumeItemSetByUserId(
                            "namespace-0001",
                            "inventory-0001",
                            "item-0001",
                            1,
                            "#{userId}"
                        ),
                    ],
                    0.5,
                    {
                        metadata: "NODE-0002",
                        premiseNodeNames: [
                            "node-0001",
                        ]
                    }
                ),
                new skillTree.model.NodeModel(
                    "node-0003",
                    [
                        new inventory.stampSheet.ConsumeItemSetByUserId(
                            "namespace-0001",
                            "inventory-0001",
                            "item-0001",
                            1,
                            "#{userId}"
                        ),
                        new inventory.stampSheet.ConsumeItemSetByUserId(
                            "namespace-0001",
                            "inventory-0001",
                            "item-0001",
                            1,
                            "#{userId}"
                        ),
                    ],
                    0.5,
                    {
                        metadata: "NODE-0003",
                        premiseNodeNames: [
                            "node-0002",
                        ]
                    }
                )
            ]
        );
    }
}

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

from gs2_cdk import Stack, core, skill_tree

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        skill_tree.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            node_models=[
                skill_tree.NodeModel(
                    name='node-0001',
                    release_consume_actions=[
                        inventory.ConsumeItemSetByUserId(
                            namespace_name='namespace-0001',
                            inventory_name='inventory-0001',
                            item_name='item-0001',
                            consume_count=1,
                            user_id='#{userId}'
                        ),
                    ],
                    restrain_return_rate=0.5,
                    options=skill_tree.NodeModelOptions(
                        metadata = 'NODE-0001'
                    ),
                ),
                skill_tree.NodeModel(
                    name='node-0002',
                    release_consume_actions=[
                        inventory.ConsumeItemSetByUserId(
                            namespace_name='namespace-0001',
                            inventory_name='inventory-0001',
                            item_name='item-0001',
                            consume_count=1,
                            user_id='#{userId}'
                        ),
                    ],
                    restrain_return_rate=0.5,
                    options=skill_tree.NodeModelOptions(
                        metadata = 'NODE-0002',
                        premise_node_names = [
                            'node-0001',
                        ]
                    ),
                ),
                skill_tree.NodeModel(
                    name='node-0003',
                    release_consume_actions=[
                        inventory.ConsumeItemSetByUserId(
                            namespace_name='namespace-0001',
                            inventory_name='inventory-0001',
                            item_name='item-0001',
                            consume_count=1,
                            user_id='#{userId}'
                        ),
                        inventory.ConsumeItemSetByUserId(
                            namespace_name='namespace-0001',
                            inventory_name='inventory-0001',
                            item_name='item-0001',
                            consume_count=1,
                            user_id='#{userId}'
                        ),
                    ],
                    restrain_return_rate=0.5,
                    options=skill_tree.NodeModelOptions(
                        metadata = 'NODE-0003',
                        premise_node_names = [
                            'node-0002',
                        ]
                    ),
                ),
            ],
        )

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

Config

コンフィグ設定

トランザクションの変数に適用する設定値

	型	有効化条件	必須	デフォルト	値の制限	説明
key	string		✓		~ 64文字	名前
value	string				~ 51200文字	値

ConsumeAction

消費アクション

	型	有効化条件	必須	デフォルト	値の制限	説明
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文字	消費アクションで実行するアクションの種類
request	string		✓		~ 524288文字	リクエストのJSON

VerifyAction

検証アクション

	型	有効化条件	必須	デフォルト	値の制限	説明
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文字	検証アクションで実行するアクションの種類
request	string		✓		~ 524288文字	リクエストのJSON

AcquireAction

入手アクション

	型	有効化条件	必須	デフォルト	値の制限	説明
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", "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文字	入手アクションで実行するアクションの種類
request	string		✓		~ 524288文字	リクエストのJSON

VerifyActionResult

検証アクションの実行結果

	型	必須	値の制限	説明
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文字	検証アクションで実行するアクションの種類
verifyRequest	string	✓	~ 524288文字	リクエストのJSON
statusCode	int		0 ~ 999	ステータスコード
verifyResult	string		~ 1048576文字	結果内容

ConsumeActionResult

消費アクションの実行結果

	型	必須	値の制限	説明
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文字	消費アクションで実行するアクションの種類
consumeRequest	string	✓	~ 524288文字	リクエストのJSON
statusCode	int		0 ~ 999	ステータスコード
consumeResult	string		~ 1048576文字	結果内容

AcquireActionResult

入手アクションの実行結果

	型	必須	値の制限	説明
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", "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文字	入手アクションで実行するアクションの種類
acquireRequest	string	✓	~ 524288文字	リクエストのJSON
statusCode	int		0 ~ 999	ステータスコード
acquireResult	string		~ 1048576文字	結果内容

TransactionResult

トランザクション実行結果

サーバーサイドでのトランザクションの自動実行機能を利用して実行されたトランザクションの実行結果

	型	必須	デフォルト	値の制限	説明
transactionId	string	✓		36 ~ 36文字	トランザクションID
verifyResults	List<VerifyActionResult>			0 ~ 10 items	検証アクションの実行結果リスト
consumeResults	List<ConsumeActionResult>		[]	0 ~ 10 items	消費アクションの実行結果リスト
acquireResults	List<AcquireActionResult>		[]	0 ~ 100 items	入手アクションの実行結果リスト
hasError	bool	✓	false		トランザクション実行中にエラーが発生したかどうか

GitHubCheckoutSetting

GitHubからマスターデータをチェックアウトする設定

型

有効化条件

必須

デフォルト

値の制限

説明

apiKeyId

string

✓

~ 1024文字

GitHub のAPIキーGRN

repositoryName

string

✓

~ 1024文字

リポジトリ名

sourcePath

string

✓

~ 1024文字

ソースコードのファイルパス

referenceType

文字列列挙型
enum {
  “commit_hash”,
  “branch”,
  “tag”
}

✓

~ 128文字

コードの取得元

定義	説明
“commit_hash”	コミットハッシュ
“branch”	ブランチ
“tag”	タグ

commitHash

string

{referenceType} == “commit_hash”

✓

~ 1024文字

コミットハッシュ
referenceType が “commit_hash” であれば必須

branchName

string

{referenceType} == “branch”

✓

~ 1024文字

ブランチ名
referenceType が “branch” であれば必須

tagName

string

{referenceType} == “tag”

✓

~ 1024文字

タグ名
referenceType が “tag” であれば必須

ScriptSetting

スクリプト設定

GS2 ではマイクロサービスのイベントに関連づけて、カスタムスクリプトを実行することができます。
このモデルは、スクリプトの実行をトリガーするための設定を保持します。

スクリプトの実行方式は大きく2種類あり、それは「同期実行」と「非同期実行」です。
同期実行は、スクリプトの実行が完了するまで処理がブロックされます。
かわりに、スクリプトの実行結果を使ってAPIの実行を止めたり、APIの結果を改ざんすることができます。

一方、非同期実行は、スクリプトの実行が完了するまで処理がブロックされません。
かわりに、スクリプトの実行結果を使ってAPIの実行を止めたり、APIの結果を改ざんすることはできません。
しかし、非同期実行は、スクリプトの実行が完了するまで処理がブロックされないため、APIの応答に影響を与えないため、原則非同期実行を使用することをおすすめします。

非同期実行には実行方式が2種類あり、GS2-Script と Amazon EventBridge があります。
Amazon EventBridge を使用することで、Lua 以外の言語で処理を記述することができます。

型

有効化条件

必須

デフォルト

値の制限

説明

triggerScriptId

string

~ 1024文字

処理時に実行するスクリプト

doneTriggerTargetType

文字列列挙型
enum {
  “none”,
  “gs2_script”,
  “aws”
}

✓

“none”

~ 128文字

完了通知の通知先

定義	説明
“none”	なし
“gs2_script”	GS2-Script
“aws”	Amazon EventBridge

doneTriggerScriptId

string

{doneTriggerTargetType} == “gs2_script”

~ 1024文字

完了時に実行するスクリプト
doneTriggerTargetType が “gs2_script” であれば有効

doneTriggerQueueNamespaceId

string

{doneTriggerTargetType} == “gs2_script”

~ 1024文字

完了時のスクリプトを実行するためのジョブキューのネームスペース
doneTriggerTargetType が “gs2_script” であれば有効

TransactionSetting

トランザクション設定

	型	有効化条件	必須	デフォルト	値の制限	説明
enableAutoRun	bool		✓	false		発行したトランザクションをサーバーサイドで自動的に実行するか
enableAtomicCommit	bool	{enableAutoRun} == true	✓	false		トランザクションの実行をアトミックにコミットするか enableAutoRun が true であれば必須
transactionUseDistributor	bool	{enableAtomicCommit} == true	✓	false		トランザクションを非同期処理で実行する enableAtomicCommit が true であれば必須
commitScriptResultInUseDistributor	bool	{transactionUseDistributor} == true	✓	false		スクリプトの結果コミット処理を非同期処理で実行するか transactionUseDistributor が true であれば必須
acquireActionUseJobQueue	bool	{enableAtomicCommit} == true	✓	false		入手アクションを実行する際に GS2-JobQueue を使用するか enableAtomicCommit が true であれば必須
distributorNamespaceId	string		✓	“grn:gs2:{region}:{ownerId}:distributor:default”	~ 1024文字	トランザクションの実行に使用する GS2-Distributor ネームスペース
queueNamespaceId	string		✓	“grn:gs2:{region}:{ownerId}:queue:default”	~ 1024文字	トランザクションの実行に使用する GS2-JobQueue のネームスペース

LogSetting

ログの書き出し設定

ログデータの書き出し設定を管理します。この型は、ログデータを書き出すために使用されるログ名前空間の識別子（Namespace ID）を保持します。
ログ名前空間IDは、ログデータを集約し、保存する対象の GS2-Log の名前空間を指定します。
この設定を通じて、この名前空間以下のAPIリクエスト・レスポンスログデータが対象の GS2-Log へ出力されるようになります。
GS2-Log にはリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。

	型	有効化条件	必須	デフォルト	値の制限	説明
loggingNamespaceId	string		✓		~ 1024文字	ログを出力する GS2-Log のネームスペースGRN