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

エンティティ

Namespace

ネームスペース

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

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

必須デフォルト値の制限説明
namestring~ 32文字ネームスペース名
descriptionstring~ 1024文字説明文
transactionSettingTransactionSettingトランザクション設定
missionCompleteScriptScriptSettingミッションを達成したときに実行するスクリプト
counterIncrementScriptScriptSettingカウンターを上昇したときに実行するスクリプト
receiveRewardsScriptScriptSetting報酬を受け取ったときに実行するスクリプト
completeNotificationNotificationSettingミッションのタスクを達成したときのプッシュ通知
logSettingLogSettingログの出力設定

GetAttr

説明
ItemNamespace作成したネームスペース

実装例

Type: GS2::Mission::Namespace
Properties:
  Name: namespace1
  Description: null
  TransactionSetting: 
    EnableAutoRun: false
    QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
    KeyId: grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001
  MissionCompleteScript: null
  CounterIncrementScript: null
  ReceiveRewardsScript: null
  CompleteNotification: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
from gs2_cdk import Stack, core, mission

class SampleStack(Stack):

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

print(SampleStack().yaml())  # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        new \Gs2Cdk\Mission\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\Mission\Model\Options\NamespaceOptions(
                transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
                    enableAutoRun: False,
                    distributorNamespaceId: ,
                    queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
                    options: new \Gs2Cdk\Core\Model\Options\TransactionSettingOptions(
                        keyId: "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-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.mission.model.Namespace(
            this,
            "namespace-0001",
            new io.gs2.cdk.mission.model.options.NamespaceOptions() {
                {
                    transactionSetting = new io.gs2.cdk.core.model.TransactionSetting(
                        false,
                        ,
                        "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
                        new io.gs2.cdk.core.model.options.TransactionSettingOptions(
                            "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
                        )
                    );
                    logSetting = new io.gs2.cdk.core.model.LogSetting(
                        "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                    );
                }
            }
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
import core from "@/gs2cdk/core";
import mission from "@/gs2cdk/mission";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new mission.model.Namespace(
            this,
            "namespace-0001",
            {
                transactionSetting: new core.TransactionSetting(
                    false,
                    ,
                    "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
                    {
                        "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
                    }
                ),
                logSetting: new core.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Mission.Model.Namespace(
            this,
            "namespace-0001",
            new Gs2Cdk.Gs2Mission.Model.Options.NamespaceOptions {
                transactionSetting = new Gs2Cdk.Core.Model.TransactionSetting(
                    false,
                    ,
                    "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
                    new Gs2Cdk.Core.Model.Options.TransactionSettingOptions(
                        KeyId = "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
                    }
                ),
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                ),
            }
        );
    }
}

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

CurrentMissionMaster

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

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

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

JSONファイルの形式についてはドキュメントを参照ください。

必須デフォルト値の制限説明
namespaceNamestring~ 32文字ネームスペース名
settingsstring~ 5242880文字マスターデータ

GetAttr

説明
ItemCurrentMissionMaster更新した現在有効なミッションマスター

実装例

Type: GS2::Mission::CurrentMissionMaster
Properties:
  NamespaceName: namespace1
  Settings: {
    "version": "2019-05-28",
    "groups": [
      {
        "name": "daily",
        "metadata": "DAILY",
        "tasks": [
          {
            "name": "quest_x10",
            "metadata": "QUEST_X10",
            "counterName": "quest_complete",
            "targetValue": 10,
            "completeAcquireActions": [
              {
                "action": "Gs2Experience:AddExperienceByUserId",
                "request": "{\\"experienceName\\": \\"basic\\", \\"userId\\": \\"#{userId}\\", \\"experienceModelName\\": \\"player\\", \\"propertyId\\": \\"player\\", \\"experienceValue\\": 10}"
              }
            ]
          },
          {
            "name": "quest_x20",
            "metadata": "QUEST_X20",
            "counterName": "quest_complete",
            "premiseMissionTaskName": "quest_x10",
            "targetValue": 20,
            "completeAcquireActions": [
              {
                "action": "Gs2Experience:AddExperienceByUserId",
                "request": "{\\"experienceName\\": \\"basic\\", \\"userId\\": \\"#{userId}\\", \\"experienceModelName\\": \\"player\\", \\"propertyId\\": \\"player\\", \\"experienceValue\\": 20}"
              }
            ]
          },
          {
            "name": "gacha",
            "metadata": "GACHA",
            "counterName": "lot_gacha",
            "targetValue": 1,
            "completeAcquireActions": [
              {
                "action": "Gs2Experience:AddExperienceByUserId",
                "request": "{\\"experienceName\\": \\"basic\\", \\"userId\\": \\"#{userId}\\", \\"experienceModelName\\": \\"player\\", \\"propertyId\\": \\"player\\", \\"experienceValue\\": 30}"
              }
            ]
          }
        ],
        "resetType": "daily",
        "resetHour": 10
      },
      {
        "name": "weekly",
        "metadata": "WEEKLY",
        "tasks": [
          {
            "name": "quest_x100",
            "metadata": "QUEST_X100",
            "counterName": "quest_complete",
            "targetValue": 100,
            "completeAcquireActions": [
              {
                "action": "Gs2Experience:AddExperienceByUserId",
                "request": "{\\"experienceName\\": \\"basic\\", \\"userId\\": \\"#{userId}\\", \\"experienceModelName\\": \\"player\\", \\"propertyId\\": \\"player\\", \\"experienceValue\\": 40}"
              }
            ]
          },
          {
            "name": "quest_x1000",
            "metadata": "QUEST_X1000",
            "counterName": "quest_complete",
            "premiseMissionTaskName": "quest_x100",
            "targetValue": 1000,
            "completeAcquireActions": [
              {
                "action": "Gs2Experience:AddExperienceByUserId",
                "request": "{\\"experienceName\\": \\"basic\\", \\"userId\\": \\"#{userId}\\", \\"experienceModelName\\": \\"player\\", \\"propertyId\\": \\"player\\", \\"experienceValue\\": 50}"
              }
            ]
          }
        ],
        "resetType": "weekly",
        "resetDayOfWeek": "monday",
        "resetHour": 10
      },
      {
        "name": "story",
        "metadata": "STORY",
        "tasks": [
          {
            "name": "quest_1-1",
            "metadata": "QUEST_1-1",
            "counterName": "quest1",
            "targetValue": 1
          },
          {
            "name": "quest_1-2",
            "metadata": "QUEST_1-2",
            "counterName": "quest1",
            "premiseMissionTaskName": "quest_1-1",
            "targetValue": 1
          },
          {
            "name": "quest_1-3",
            "metadata": "QUEST_1-3",
            "counterName": "quest1",
            "premiseMissionTaskName": "quest_1-2",
            "targetValue": 1
          },
          {
            "name": "quest_1-4",
            "metadata": "QUEST_1-4",
            "counterName": "quest1",
            "premiseMissionTaskName": "quest_1-3",
            "targetValue": 1
          },
          {
            "name": "quest_2-1",
            "metadata": "QUEST_2-1",
            "counterName": "quest2",
            "premiseMissionTaskName": "quest_1-4",
            "targetValue": 1
          }
        ],
        "resetType": "notReset"
      }
    ],
    "counters": [
      {
        "name": "quest_complete",
        "metadata": "QUEST_COMPLETE",
        "scopes": [
          {
            "resetType": "daily",
            "resetHour": 5
          },
          {
            "resetType": "weekly",
            "resetDayOfWeek": "monday",
            "resetHour": 5
          }
        ]
      },
      {
        "name": "lot_gacha",
        "metadata": "LOT_GACHA",
        "scopes": [
          {
            "resetType": "daily",
            "resetHour": 5
          }
        ]
      },
      {
        "name": "quest1",
        "metadata": "QUEST1",
        "scopes": [
          {
            "resetType": "notReset"
          }
        ]
      },
      {
        "name": "quest2",
        "metadata": "QUEST2",
        "scopes": [
          {
            "resetType": "notReset"
          }
        ]
      }
    ]
  }
from gs2_cdk import Stack, core, mission

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        mission.Namespace(
            stack=self,
            # 省略
        ).master_data(
            [
                mission.MissionGroupModel(
                    name='daily',
                    reset_type='daily',
                    options=mission.MissionGroupModelOptions(
                        metadata='DAILY',
                        tasks=[    {'name': 'quest_x10', 'metadata': 'QUEST_X10', 'counterName': 'quest_complete', 'targetValue': 10, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 10}'}]},
                            {'name': 'quest_x20', 'metadata': 'QUEST_X20', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x10', 'targetValue': 20, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 20}'}]},
                            {'name': 'gacha', 'metadata': 'GACHA', 'counterName': 'lot_gacha', 'targetValue': 1, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 30}'}]},
                            ],
                        reset_hour=10,
                    ),
                ),
                mission.MissionGroupModel(
                    name='weekly',
                    reset_type='weekly',
                    options=mission.MissionGroupModelOptions(
                        metadata='WEEKLY',
                        tasks=[    {'name': 'quest_x100', 'metadata': 'QUEST_X100', 'counterName': 'quest_complete', 'targetValue': 100, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 40}'}]},
                            {'name': 'quest_x1000', 'metadata': 'QUEST_X1000', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x100', 'targetValue': 1000, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 50}'}]},
                            ],
                        reset_day_of_week='monday',
                        reset_hour=10,
                    ),
                ),
                mission.MissionGroupModel(
                    name='story',
                    reset_type='notReset',
                    options=mission.MissionGroupModelOptions(
                        metadata='STORY',
                        tasks=[    {'name': 'quest_1-1', 'metadata': 'QUEST_1-1', 'counterName': 'quest1', 'targetValue': 1},
                            {'name': 'quest_1-2', 'metadata': 'QUEST_1-2', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-1', 'targetValue': 1},
                            {'name': 'quest_1-3', 'metadata': 'QUEST_1-3', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-2', 'targetValue': 1},
                            {'name': 'quest_1-4', 'metadata': 'QUEST_1-4', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-3', 'targetValue': 1},
                            {'name': 'quest_2-1', 'metadata': 'QUEST_2-1', 'counterName': 'quest2', 'premiseMissionTaskName': 'quest_1-4', 'targetValue': 1},
                            ],
                    ),
                ),
            ],
            [
                mission.CounterModel(
                    name='quest_complete',
                    scopes=[    {'resetType': 'daily', 'resetHour': 5},
                        {'resetType': 'weekly', 'resetDayOfWeek': 'monday', 'resetHour': 5},
                        ],
                    options=mission.CounterModelOptions(
                        metadata='QUEST_COMPLETE',
                    ),
                ),
                mission.CounterModel(
                    name='lot_gacha',
                    scopes=[    {'resetType': 'daily', 'resetHour': 5},
                        ],
                    options=mission.CounterModelOptions(
                        metadata='LOT_GACHA',
                    ),
                ),
                mission.CounterModel(
                    name='quest1',
                    scopes=[    {'resetType': 'notReset'},
                        ],
                    options=mission.CounterModelOptions(
                        metadata='QUEST1',
                    ),
                ),
                mission.CounterModel(
                    name='quest2',
                    scopes=[    {'resetType': 'notReset'},
                        ],
                    options=mission.CounterModelOptions(
                        metadata='QUEST2',
                    ),
                ),
            ],
        )

print(SampleStack().yaml())  # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Mission\Model\Namespace_(
            stack: $this,
            // 省略
        ))->masterData(
            [
                new \Gs2Cdk\Mission\Model\MissionGroupModel(
                    name:"daily",
                    resetType: \Gs2Cdk\Mission\Model\Enums\CurrentMissionMasterResetType::DAILY
                    options: new \Gs2Cdk\Mission\Model\Options\MissionGroupModelOptions(
                        metadata:"DAILY",
                        tasks:[    {'name': 'quest_x10', 'metadata': 'QUEST_X10', 'counterName': 'quest_complete', 'targetValue': 10, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 10}'}]},
                        {'name': 'quest_x20', 'metadata': 'QUEST_X20', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x10', 'targetValue': 20, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 20}'}]},
                        {'name': 'gacha', 'metadata': 'GACHA', 'counterName': 'lot_gacha', 'targetValue': 1, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 30}'}]},
                        ],
                        resetHour:10,
                    ),
                ),
                new \Gs2Cdk\Mission\Model\MissionGroupModel(
                    name:"weekly",
                    resetType: \Gs2Cdk\Mission\Model\Enums\CurrentMissionMasterResetType::WEEKLY
                    options: new \Gs2Cdk\Mission\Model\Options\MissionGroupModelOptions(
                        metadata:"WEEKLY",
                        tasks:[    {'name': 'quest_x100', 'metadata': 'QUEST_X100', 'counterName': 'quest_complete', 'targetValue': 100, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 40}'}]},
                        {'name': 'quest_x1000', 'metadata': 'QUEST_X1000', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x100', 'targetValue': 1000, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 50}'}]},
                        ],
                        resetDayOfWeek:"monday",
                        resetHour:10,
                    ),
                ),
                new \Gs2Cdk\Mission\Model\MissionGroupModel(
                    name:"story",
                    resetType: \Gs2Cdk\Mission\Model\Enums\CurrentMissionMasterResetType::NOT_RESET
                    options: new \Gs2Cdk\Mission\Model\Options\MissionGroupModelOptions(
                        metadata:"STORY",
                        tasks:[    {'name': 'quest_1-1', 'metadata': 'QUEST_1-1', 'counterName': 'quest1', 'targetValue': 1},
                        {'name': 'quest_1-2', 'metadata': 'QUEST_1-2', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-1', 'targetValue': 1},
                        {'name': 'quest_1-3', 'metadata': 'QUEST_1-3', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-2', 'targetValue': 1},
                        {'name': 'quest_1-4', 'metadata': 'QUEST_1-4', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-3', 'targetValue': 1},
                        {'name': 'quest_2-1', 'metadata': 'QUEST_2-1', 'counterName': 'quest2', 'premiseMissionTaskName': 'quest_1-4', 'targetValue': 1},
                        ],
                    ),
                ),
            ],
            [
                new \Gs2Cdk\Mission\Model\CounterModel(
                    name:"quest_complete",
                    scopes:[    {'resetType': 'daily', 'resetHour': 5},
                    {'resetType': 'weekly', 'resetDayOfWeek': 'monday', 'resetHour': 5},
                    ],
                    options: new \Gs2Cdk\Mission\Model\Options\CounterModelOptions(
                        metadata:"QUEST_COMPLETE",
                    ),
                ),
                new \Gs2Cdk\Mission\Model\CounterModel(
                    name:"lot_gacha",
                    scopes:[    {'resetType': 'daily', 'resetHour': 5},
                    ],
                    options: new \Gs2Cdk\Mission\Model\Options\CounterModelOptions(
                        metadata:"LOT_GACHA",
                    ),
                ),
                new \Gs2Cdk\Mission\Model\CounterModel(
                    name:"quest1",
                    scopes:[    {'resetType': 'notReset'},
                    ],
                    options: new \Gs2Cdk\Mission\Model\Options\CounterModelOptions(
                        metadata:"QUEST1",
                    ),
                ),
                new \Gs2Cdk\Mission\Model\CounterModel(
                    name:"quest2",
                    scopes:[    {'resetType': 'notReset'},
                    ],
                    options: new \Gs2Cdk\Mission\Model\Options\CounterModelOptions(
                        metadata:"QUEST2",
                    ),
                ),
            ],
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.mission.model.Namespace(
            this,
            // 省略
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.mission.model.MissionGroupModel(
                    "daily",
                    Daily,
                    new io.gs2.cdk.mission.model.options.MissionGroupModelOptions() {
                        {
                            metadata: "DAILY";
                            tasks: Arrays.asList(
                                {'name': 'quest_x10', 'metadata': 'QUEST_X10', 'counterName': 'quest_complete', 'targetValue': 10, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 10}'}]},
                            {'name': 'quest_x20', 'metadata': 'QUEST_X20', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x10', 'targetValue': 20, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 20}'}]},
                            {'name': 'gacha', 'metadata': 'GACHA', 'counterName': 'lot_gacha', 'targetValue': 1, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 30}'}]}
                            );
                            resetHour: 10;
                        }
                    }
                ),
                new io.gs2.cdk.mission.model.MissionGroupModel(
                    "weekly",
                    Weekly,
                    new io.gs2.cdk.mission.model.options.MissionGroupModelOptions() {
                        {
                            metadata: "WEEKLY";
                            tasks: Arrays.asList(
                                {'name': 'quest_x100', 'metadata': 'QUEST_X100', 'counterName': 'quest_complete', 'targetValue': 100, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 40}'}]},
                            {'name': 'quest_x1000', 'metadata': 'QUEST_X1000', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x100', 'targetValue': 1000, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 50}'}]}
                            );
                            resetDayOfWeek: "monday";
                            resetHour: 10;
                        }
                    }
                ),
                new io.gs2.cdk.mission.model.MissionGroupModel(
                    "story",
                    NotReset,
                    new io.gs2.cdk.mission.model.options.MissionGroupModelOptions() {
                        {
                            metadata: "STORY";
                            tasks: Arrays.asList(
                                {'name': 'quest_1-1', 'metadata': 'QUEST_1-1', 'counterName': 'quest1', 'targetValue': 1},
                            {'name': 'quest_1-2', 'metadata': 'QUEST_1-2', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-1', 'targetValue': 1},
                            {'name': 'quest_1-3', 'metadata': 'QUEST_1-3', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-2', 'targetValue': 1},
                            {'name': 'quest_1-4', 'metadata': 'QUEST_1-4', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-3', 'targetValue': 1},
                            {'name': 'quest_2-1', 'metadata': 'QUEST_2-1', 'counterName': 'quest2', 'premiseMissionTaskName': 'quest_1-4', 'targetValue': 1}
                            );
                        }
                    }
                )
            ),
            Arrays.asList(
                new io.gs2.cdk.mission.model.CounterModel(
                    "quest_complete",
                    Arrays.asList(
                        {'resetType': 'daily', 'resetHour': 5},
                    {'resetType': 'weekly', 'resetDayOfWeek': 'monday', 'resetHour': 5}
                    ),
                    new io.gs2.cdk.mission.model.options.CounterModelOptions() {
                        {
                            metadata: "QUEST_COMPLETE";
                        }
                    }
                ),
                new io.gs2.cdk.mission.model.CounterModel(
                    "lot_gacha",
                    Arrays.asList(
                        {'resetType': 'daily', 'resetHour': 5}
                    ),
                    new io.gs2.cdk.mission.model.options.CounterModelOptions() {
                        {
                            metadata: "LOT_GACHA";
                        }
                    }
                ),
                new io.gs2.cdk.mission.model.CounterModel(
                    "quest1",
                    Arrays.asList(
                        {'resetType': 'notReset'}
                    ),
                    new io.gs2.cdk.mission.model.options.CounterModelOptions() {
                        {
                            metadata: "QUEST1";
                        }
                    }
                ),
                new io.gs2.cdk.mission.model.CounterModel(
                    "quest2",
                    Arrays.asList(
                        {'resetType': 'notReset'}
                    ),
                    new io.gs2.cdk.mission.model.options.CounterModelOptions() {
                        {
                            metadata: "QUEST2";
                        }
                    }
                )
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
import core from "@/gs2cdk/core";
import mission from "@/gs2cdk/mission";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new mission.model.Namespace(
            this,
            // 省略
        ).masterData(
            [
                new mission.model.MissionGroupModel(
                    "daily",
                    mission.model.CurrentMissionMasterResetType.DAILY,
                    {
                        metadata: "DAILY",
                        tasks: [
                                {'name': 'quest_x10', 'metadata': 'QUEST_X10', 'counterName': 'quest_complete', 'targetValue': 10, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 10}'}]},
                            {'name': 'quest_x20', 'metadata': 'QUEST_X20', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x10', 'targetValue': 20, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 20}'}]},
                            {'name': 'gacha', 'metadata': 'GACHA', 'counterName': 'lot_gacha', 'targetValue': 1, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 30}'}]}
                            ],
                        resetHour: 10
                    }
                ),
                new mission.model.MissionGroupModel(
                    "weekly",
                    mission.model.CurrentMissionMasterResetType.WEEKLY,
                    {
                        metadata: "WEEKLY",
                        tasks: [
                                {'name': 'quest_x100', 'metadata': 'QUEST_X100', 'counterName': 'quest_complete', 'targetValue': 100, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 40}'}]},
                            {'name': 'quest_x1000', 'metadata': 'QUEST_X1000', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x100', 'targetValue': 1000, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 50}'}]}
                            ],
                        resetDayOfWeek: "monday",
                        resetHour: 10
                    }
                ),
                new mission.model.MissionGroupModel(
                    "story",
                    mission.model.CurrentMissionMasterResetType.NOT_RESET,
                    {
                        metadata: "STORY",
                        tasks: [
                                {'name': 'quest_1-1', 'metadata': 'QUEST_1-1', 'counterName': 'quest1', 'targetValue': 1},
                            {'name': 'quest_1-2', 'metadata': 'QUEST_1-2', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-1', 'targetValue': 1},
                            {'name': 'quest_1-3', 'metadata': 'QUEST_1-3', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-2', 'targetValue': 1},
                            {'name': 'quest_1-4', 'metadata': 'QUEST_1-4', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-3', 'targetValue': 1},
                            {'name': 'quest_2-1', 'metadata': 'QUEST_2-1', 'counterName': 'quest2', 'premiseMissionTaskName': 'quest_1-4', 'targetValue': 1}
                            ]
                    }
                )
            ],
            [
                new mission.model.CounterModel(
                    "quest_complete",
                    [
                        {'resetType': 'daily', 'resetHour': 5},
                    {'resetType': 'weekly', 'resetDayOfWeek': 'monday', 'resetHour': 5}
                    ],
                    {
                        metadata: "QUEST_COMPLETE"
                    }
                ),
                new mission.model.CounterModel(
                    "lot_gacha",
                    [
                        {'resetType': 'daily', 'resetHour': 5}
                    ],
                    {
                        metadata: "LOT_GACHA"
                    }
                ),
                new mission.model.CounterModel(
                    "quest1",
                    [
                        {'resetType': 'notReset'}
                    ],
                    {
                        metadata: "QUEST1"
                    }
                ),
                new mission.model.CounterModel(
                    "quest2",
                    [
                        {'resetType': 'notReset'}
                    ],
                    {
                        metadata: "QUEST2"
                    }
                )
            ]
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Mission.Model.Namespace(
            this,
            // 省略
        ).MasterData(
            new [] {
                new Gs2Cdk.Gs2Mission.Model.MissionGroupModel(
                    "daily",
                    Gs2Cdk.Gs2Mission.Model.Enums.CurrentMissionMasterResetType.Daily,
                    new Gs2Cdk.Gs2Mission.Model.Options.MissionGroupModelOptions {
                        metadata = "DAILY",
                        tasks = new Gs2Cdk.Gs2Mission.Model.MissionTaskModel[] {
                            {'name': 'quest_x10', 'metadata': 'QUEST_X10', 'counterName': 'quest_complete', 'targetValue': 10, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 10}'}]},
                        {'name': 'quest_x20', 'metadata': 'QUEST_X20', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x10', 'targetValue': 20, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 20}'}]},
                        {'name': 'gacha', 'metadata': 'GACHA', 'counterName': 'lot_gacha', 'targetValue': 1, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 30}'}]}
                        },
                        resetHour = 10,
                    }
                ),
                new Gs2Cdk.Gs2Mission.Model.MissionGroupModel(
                    "weekly",
                    Gs2Cdk.Gs2Mission.Model.Enums.CurrentMissionMasterResetType.Weekly,
                    new Gs2Cdk.Gs2Mission.Model.Options.MissionGroupModelOptions {
                        metadata = "WEEKLY",
                        tasks = new Gs2Cdk.Gs2Mission.Model.MissionTaskModel[] {
                            {'name': 'quest_x100', 'metadata': 'QUEST_X100', 'counterName': 'quest_complete', 'targetValue': 100, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 40}'}]},
                        {'name': 'quest_x1000', 'metadata': 'QUEST_X1000', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x100', 'targetValue': 1000, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 50}'}]}
                        },
                        resetDayOfWeek = "monday",
                        resetHour = 10,
                    }
                ),
                new Gs2Cdk.Gs2Mission.Model.MissionGroupModel(
                    "story",
                    Gs2Cdk.Gs2Mission.Model.Enums.CurrentMissionMasterResetType.NotReset,
                    new Gs2Cdk.Gs2Mission.Model.Options.MissionGroupModelOptions {
                        metadata = "STORY",
                        tasks = new Gs2Cdk.Gs2Mission.Model.MissionTaskModel[] {
                            {'name': 'quest_1-1', 'metadata': 'QUEST_1-1', 'counterName': 'quest1', 'targetValue': 1},
                        {'name': 'quest_1-2', 'metadata': 'QUEST_1-2', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-1', 'targetValue': 1},
                        {'name': 'quest_1-3', 'metadata': 'QUEST_1-3', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-2', 'targetValue': 1},
                        {'name': 'quest_1-4', 'metadata': 'QUEST_1-4', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-3', 'targetValue': 1},
                        {'name': 'quest_2-1', 'metadata': 'QUEST_2-1', 'counterName': 'quest2', 'premiseMissionTaskName': 'quest_1-4', 'targetValue': 1}
                        },
                    }
                )
            },
            new [] {
                new Gs2Cdk.Gs2Mission.Model.CounterModel(
                    "quest_complete",
                    new Gs2Cdk.Gs2Mission.Model.CounterScopeModel[] {
                        {'resetType': 'daily', 'resetHour': 5},
                    {'resetType': 'weekly', 'resetDayOfWeek': 'monday', 'resetHour': 5}
                    },
                    new Gs2Cdk.Gs2Mission.Model.Options.CounterModelOptions {
                        metadata = "QUEST_COMPLETE",
                    }
                ),
                new Gs2Cdk.Gs2Mission.Model.CounterModel(
                    "lot_gacha",
                    new Gs2Cdk.Gs2Mission.Model.CounterScopeModel[] {
                        {'resetType': 'daily', 'resetHour': 5}
                    },
                    new Gs2Cdk.Gs2Mission.Model.Options.CounterModelOptions {
                        metadata = "LOT_GACHA",
                    }
                ),
                new Gs2Cdk.Gs2Mission.Model.CounterModel(
                    "quest1",
                    new Gs2Cdk.Gs2Mission.Model.CounterScopeModel[] {
                        {'resetType': 'notReset'}
                    },
                    new Gs2Cdk.Gs2Mission.Model.Options.CounterModelOptions {
                        metadata = "QUEST1",
                    }
                ),
                new Gs2Cdk.Gs2Mission.Model.CounterModel(
                    "quest2",
                    new Gs2Cdk.Gs2Mission.Model.CounterScopeModel[] {
                        {'resetType': 'notReset'}
                    },
                    new Gs2Cdk.Gs2Mission.Model.Options.CounterModelOptions {
                        metadata = "QUEST2",
                    }
                )
            }
        );
    }
}

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

NotificationSetting

プッシュ通知に関する設定

GS2 のマイクロサービス内で何らかのイベントが発生した際に、プッシュ通知を送信するための設定です。 ここでいうプッシュ通知は GS2-Gateway の提供する WebSocket インターフェースを経由した処理であり、スマートフォンのプッシュ通知とは性質が異なります。 たとえば、マッチメイキングが完了した時やフレンドリクエストが届いた時など、ゲームクライアントの操作とは関係なく状態が変化した際に GS2-Gateway を経由してプッシュ通知をすることで、ゲームクライアントは状態の変化を検知することができます。

GS2-Gateway のプッシュ通知は通知先のデバイスがオフラインだった時に追加の処理としてモバイルプッシュ通知を送信できます。 モバイルプッシュ通知をうまく利用すれば、マッチメイキング中にゲームを終了しても、モバイルプッシュ通知を使用してプレイヤーに通知し、ゲームに戻ってくるフローを実現できる可能性があります。

必須デフォルト値の制限説明
gatewayNamespaceIdstring“grn:gs2:{region}:{ownerId}:gateway:default”~ 1024文字プッシュ通知に使用する GS2-Gateway のネームスペース
enableTransferMobileNotificationbool?falseモバイルプッシュ通知へ転送するか
soundstring{enableTransferMobileNotification} == true~ 1024文字モバイルプッシュ通知で使用するサウンドファイル名

CounterScopeModel

カウンターリセットタイミングモデル

必須デフォルト値の制限説明
resetTypeenum [
“notReset”,
“daily”,
“weekly”,
“monthly”
]
~ 128文字リセットタイミング
resetDayOfMonthint{resetType} == “monthly”1 ~ 31リセットをする日にち(月の日数を超える場合は、最終日として扱われます)
resetDayOfWeekenum [
“sunday”,
“monday”,
“tuesday”,
“wednesday”,
“thursday”,
“friday”,
“saturday”
]
{resetType} == “weekly”~ 128文字リセットする曜日
resetHourint{resetType} in [“monthly”, “weekly”, “daily”]~ 23リセット時刻

ScopedValue

リセットタイミング

必須デフォルト値の制限説明
resetTypeenum [
“notReset”,
“daily”,
“weekly”,
“monthly”
]
~ 128文字リセットタイミング
valuelong0~ 9223372036854775805カウント
nextResetAtlong次回リセットタイミング
updatedAtlong最終更新日時

AcquireAction

入手アクション

必須デフォルト値の制限説明
actionenum [
"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:UnlockIncrementalExchangeByUserId",
"Gs2Exchange:CreateAwaitByUserId",
"Gs2Exchange:SkipByUserId",
"Gs2Experience:AddExperienceByUserId",
"Gs2Experience:SetExperienceByUserId",
"Gs2Experience:AddRankCapByUserId",
"Gs2Experience:SetRankCapByUserId",
"Gs2Experience:MultiplyAcquireActionsByUserId",
"Gs2Formation:AddMoldCapacityByUserId",
"Gs2Formation:SetMoldCapacityByUserId",
"Gs2Formation:AcquireActionsToFormProperties",
"Gs2Formation:SetFormByUserId",
"Gs2Formation:AcquireActionsToPropertyFormProperties",
"Gs2Grade:AddGradeByUserId",
"Gs2Grade:ApplyRankCapByUserId",
"Gs2Grade:MultiplyAcquireActionsByUserId",
"Gs2Idle:IncreaseMaximumIdleMinutesByUserId",
"Gs2Idle:SetMaximumIdleMinutesByUserId",
"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",
"Gs2Money:DepositByUserId",
"Gs2Money:RevertRecordReceipt",
"Gs2Quest:CreateProgressByUserId",
"Gs2Schedule:TriggerByUserId",
"Gs2SerialKey:RevertUseByUserId",
"Gs2Showcase:DecrementPurchaseCountByUserId",
"Gs2Showcase:ForceReDrawByUserId",
"Gs2SkillTree:MarkReleaseByUserId",
"Gs2Stamina:RecoverStaminaByUserId",
"Gs2Stamina:RaiseMaxValueByUserId",
"Gs2Stamina:SetMaxValueByUserId",
"Gs2Stamina:SetRecoverIntervalByUserId",
"Gs2Stamina:SetRecoverValueByUserId",
"Gs2StateMachine:StartStateMachineByUserId",
]
~ 128文字スタンプシートを使用して実行するアクションの種類
requeststring~ 1048576文字リクエストのJSON

Config

コンフィグ設定

スタンプシートの変数に適用する設定値

必須デフォルト値の制限説明
keystring~ 64文字名前
valuestring~ 51200文字

LogSetting

ログの書き出し設定

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

必須デフォルト値の制限説明
loggingNamespaceIdstring~ 1024文字ネームスペースGRN

GitHubCheckoutSetting

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

必須デフォルト値の制限説明
apiKeyIdstring~ 1024文字GitHub のAPIキーGRN
repositoryNamestring~ 1024文字リポジトリ名
sourcePathstring~ 1024文字ソースコードのファイルパス
referenceTypeenum [
“commit_hash”,
“branch”,
“tag”
]
~ 128文字コードの取得元
commitHashstring{referenceType} == “commit_hash”~ 1024文字コミットハッシュ
branchNamestring{referenceType} == “branch”~ 1024文字ブランチ名
tagNamestring{referenceType} == “tag”~ 1024文字タグ名

ScriptSetting

スクリプト設定

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

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

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

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

必須デフォルト値の制限説明
triggerScriptIdstring~ 1024文字スクリプトGRN
doneTriggerTargetTypeenum [
“none”,
“gs2_script”,
“aws”
]
“none”~ 128文字完了通知の通知先
doneTriggerScriptIdstring{doneTriggerTargetType} == “gs2_script”~ 1024文字スクリプトGRN
doneTriggerQueueNamespaceIdstring{doneTriggerTargetType} == “gs2_script”~ 1024文字ネームスペースGRN

TransactionSetting

トランザクション設定

必須デフォルト値の制限説明
enableAutoRunboolfalse発行したスタンプシートをサーバーサイドで自動的に実行するか
distributorNamespaceIdstring“grn:gs2:{region}:{ownerId}:distributor:default”~ 1024文字スタンプシートの実行に使用する GS2-Distributor ネームスペース
keyIdstring!{enableAutoRun}“grn:gs2:{region}:{ownerId}:key:default:key:default”~ 1024文字スタンプシートの署名に使用する GS2-Key の暗号鍵
queueNamespaceIdstring“grn:gs2:{region}:{ownerId}:queue:default”~ 1024文字スタンプシートの実行に使用する GS2-JobQueue のネームスペース