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

エンティティ

Namespace

ネームスペース

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

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

型必須デフォルト値の制限説明
namestring✓~ 128文字ネームスペース名
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(
                    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: True,
                    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(){
                        {
                            queueNamespaceId = "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(
                        loggingNamespaceId = "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(
                    ,
                    "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(
                    new Gs2Cdk.Core.Model.Options.TransactionSettingOptions {
                        queueNamespaceId = "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(
                    LoggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

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

CurrentMissionMaster

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

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

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

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

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

GetAttr

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

実装例

Type: GS2::Mission::CurrentMissionMaster
Properties:
  NamespaceName: namespace1
  Settings: {
    "version": "2019-05-28",
    "groups": [
      {
        "name": "daily",
        "resetType": "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
      },
      {
        "name": "weekly",
        "resetType": "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
      },
      {
        "name": "story",
        "resetType": "notReset",
        "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
          }
        ]
      }
    ],
    "counters": [
      {
        "name": "quest_complete",
        "scopes": [
          {
            "resetType": "daily",
            "resetHour": 5
          },
          {
            "resetType": "weekly",
            "resetDayOfWeek": "monday",
            "resetHour": 5
          }
        ],
        "metadata": "QUEST_COMPLETE"
      },
      {
        "name": "lot_gacha",
        "scopes": [
          {
            "resetType": "daily",
            "resetHour": 5
          }
        ],
        "metadata": "LOT_GACHA"
      },
      {
        "name": "quest1",
        "scopes": [
          {
            "resetType": "notReset"
          }
        ],
        "metadata": "QUEST1"
      },
      {
        "name": "quest2",
        "scopes": [
          {
            "resetType": "notReset"
          }
        ],
        "metadata": "QUEST2"
      }
    ]
  }
from gs2_cdk import Stack, core, mission

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        mission.Namespace(
            stack=self,
            # 省略
        ).master_data(
            groups=[
                mission.MissionGroupModel(
                    name='daily',
                    reset_type='daily',
                    options=mission.MissionGroupModelOptions(
                        metadata='DAILY',
                        tasks=[
                            mission.MissionTaskModel(
                                name='quest_x10',
                                metadata='QUEST_X10',
                                counter_name='quest_complete',
                                target_value=10,
                                complete_acquire_actions=[
                                    mission.AcquireAction(
                                        action='Gs2Experience:AddExperienceByUserId',
                                        request='{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 10}'
                                    )
                                ]
                            ),
                            mission.MissionTaskModel(
                                name='quest_x20',
                                metadata='QUEST_X20',
                                counter_name='quest_complete',
                                premise_mission_task_name='quest_x10',
                                target_value=20,
                                complete_acquire_actions=[
                                    mission.AcquireAction(
                                        action='Gs2Experience:AddExperienceByUserId',
                                        request='{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 20}'
                                    )
                                ]
                            ),
                            mission.MissionTaskModel(
                                name='gacha',
                                metadata='GACHA',
                                counter_name='lot_gacha',
                                target_value=1,
                                complete_acquire_actions=[
                                    mission.AcquireAction(
                                        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=[
                            mission.MissionTaskModel(
                                name='quest_x100',
                                metadata='QUEST_X100',
                                counter_name='quest_complete',
                                target_value=100,
                                complete_acquire_actions=[
                                    mission.AcquireAction(
                                        action='Gs2Experience:AddExperienceByUserId',
                                        request='{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 40}'
                                    )
                                ]
                            ),
                            mission.MissionTaskModel(
                                name='quest_x1000',
                                metadata='QUEST_X1000',
                                counter_name='quest_complete',
                                premise_mission_task_name='quest_x100',
                                target_value=1000,
                                complete_acquire_actions=[
                                    mission.AcquireAction(
                                        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=[
                            mission.MissionTaskModel(
                                name='quest_1-1',
                                metadata='QUEST_1-1',
                                counter_name='quest1',
                                target_value=1
                            ),
                            mission.MissionTaskModel(
                                name='quest_1-2',
                                metadata='QUEST_1-2',
                                counter_name='quest1',
                                premise_mission_task_name='quest_1-1',
                                target_value=1
                            ),
                            mission.MissionTaskModel(
                                name='quest_1-3',
                                metadata='QUEST_1-3',
                                counter_name='quest1',
                                premise_mission_task_name='quest_1-2',
                                target_value=1
                            ),
                            mission.MissionTaskModel(
                                name='quest_1-4',
                                metadata='QUEST_1-4',
                                counter_name='quest1',
                                premise_mission_task_name='quest_1-3',
                                target_value=1
                            ),
                            mission.MissionTaskModel(
                                name='quest_2-1',
                                metadata='QUEST_2-1',
                                counter_name='quest2',
                                premise_mission_task_name='quest_1-4',
                                target_value=1
                            ),
                        ],
                    ),
                ),
            ],
            counters=[
                mission.CounterModel(
                    name='quest_complete',
                    scopes=[
                            mission.CounterScopeModel(
                                reset_type='daily',
                                reset_hour=5
                            ),
                            mission.CounterScopeModel(
                                reset_type='weekly',
                                reset_day_of_week='monday',
                                reset_hour=5
                            ),
                        ],
                    options=mission.CounterModelOptions(
                        metadata='QUEST_COMPLETE',
                    ),
                ),
                mission.CounterModel(
                    name='lot_gacha',
                    scopes=[
                            mission.CounterScopeModel(
                                reset_type='daily',
                                reset_hour=5
                            ),
                        ],
                    options=mission.CounterModelOptions(
                        metadata='LOT_GACHA',
                    ),
                ),
                mission.CounterModel(
                    name='quest1',
                    scopes=[
                            mission.CounterScopeModel(
                                reset_type='notReset'
                            ),
                        ],
                    options=mission.CounterModelOptions(
                        metadata='QUEST1',
                    ),
                ),
                mission.CounterModel(
                    name='quest2',
                    scopes=[
                            mission.CounterScopeModel(
                                reset_type='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\MissionGroupModelResetType::DAILY,
                    options: new \Gs2Cdk\Mission\Model\Options\MissionGroupModelOptions(
                        metadata:"DAILY",
                        tasks:[
                            new \Gs2Cdk\Mission\Model\MissionTaskModel(
                                name: "quest_x10",
                                metadata: "QUEST_X10",
                                counterName: "quest_complete",
                                targetValue: 10,
                                completeAcquireActions: [
                                    new \Gs2Cdk\Core\Model\AcquireAction(
                                        action: "Gs2Experience:AddExperienceByUserId",
                                        request: "{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 10}"
                                    )
                                ]
                            ),
                            new \Gs2Cdk\Mission\Model\MissionTaskModel(
                                name: "quest_x20",
                                metadata: "QUEST_X20",
                                counterName: "quest_complete",
                                premiseMissionTaskName: "quest_x10",
                                targetValue: 20,
                                completeAcquireActions: [
                                    new \Gs2Cdk\Core\Model\AcquireAction(
                                        action: "Gs2Experience:AddExperienceByUserId",
                                        request: "{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 20}"
                                    )
                                ]
                            ),
                            new \Gs2Cdk\Mission\Model\MissionTaskModel(
                                name: "gacha",
                                metadata: "GACHA",
                                counterName: "lot_gacha",
                                targetValue: 1,
                                completeAcquireActions: [
                                    new \Gs2Cdk\Core\Model\AcquireAction(
                                        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\MissionGroupModelResetType::WEEKLY,
                    options: new \Gs2Cdk\Mission\Model\Options\MissionGroupModelOptions(
                        metadata:"WEEKLY",
                        tasks:[
                            new \Gs2Cdk\Mission\Model\MissionTaskModel(
                                name: "quest_x100",
                                metadata: "QUEST_X100",
                                counterName: "quest_complete",
                                targetValue: 100,
                                completeAcquireActions: [
                                    new \Gs2Cdk\Core\Model\AcquireAction(
                                        action: "Gs2Experience:AddExperienceByUserId",
                                        request: "{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 40}"
                                    )
                                ]
                            ),
                            new \Gs2Cdk\Mission\Model\MissionTaskModel(
                                name: "quest_x1000",
                                metadata: "QUEST_X1000",
                                counterName: "quest_complete",
                                premiseMissionTaskName: "quest_x100",
                                targetValue: 1000,
                                completeAcquireActions: [
                                    new \Gs2Cdk\Core\Model\AcquireAction(
                                        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\MissionGroupModelResetType::NOT_RESET,
                    options: new \Gs2Cdk\Mission\Model\Options\MissionGroupModelOptions(
                        metadata:"STORY",
                        tasks:[
                            new \Gs2Cdk\Mission\Model\MissionTaskModel(
                                name: "quest_1-1",
                                metadata: "QUEST_1-1",
                                counterName: "quest1",
                                targetValue: 1
                            ),
                            new \Gs2Cdk\Mission\Model\MissionTaskModel(
                                name: "quest_1-2",
                                metadata: "QUEST_1-2",
                                counterName: "quest1",
                                premiseMissionTaskName: "quest_1-1",
                                targetValue: 1
                            ),
                            new \Gs2Cdk\Mission\Model\MissionTaskModel(
                                name: "quest_1-3",
                                metadata: "QUEST_1-3",
                                counterName: "quest1",
                                premiseMissionTaskName: "quest_1-2",
                                targetValue: 1
                            ),
                            new \Gs2Cdk\Mission\Model\MissionTaskModel(
                                name: "quest_1-4",
                                metadata: "QUEST_1-4",
                                counterName: "quest1",
                                premiseMissionTaskName: "quest_1-3",
                                targetValue: 1
                            ),
                            new \Gs2Cdk\Mission\Model\MissionTaskModel(
                                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:[
                        new \Gs2Cdk\Mission\Model\CounterScopeModel(
                            resetType: "daily",
                            resetHour: 5
                        ),
                        new \Gs2Cdk\Mission\Model\CounterScopeModel(
                            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:[
                        new \Gs2Cdk\Mission\Model\CounterScopeModel(
                            resetType: "daily",
                            resetHour: 5
                        ),
                    ],
                    options: new \Gs2Cdk\Mission\Model\Options\CounterModelOptions(
                        metadata:"LOT_GACHA"
                    )
                ),
                new \Gs2Cdk\Mission\Model\CounterModel(
                    name:"quest1",
                    scopes:[
                        new \Gs2Cdk\Mission\Model\CounterScopeModel(
                            resetType: "notReset"
                        ),
                    ],
                    options: new \Gs2Cdk\Mission\Model\Options\CounterModelOptions(
                        metadata:"QUEST1"
                    )
                ),
                new \Gs2Cdk\Mission\Model\CounterModel(
                    name:"quest2",
                    scopes:[
                        new \Gs2Cdk\Mission\Model\CounterScopeModel(
                            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(
                                new io.gs2.cdk.mission.model.MissionTaskModel(
                                    "quest_x10",
                                    "QUEST_X10",
                                    "quest_complete",
                                    10L,
                                    Arrays.asList(
                                        new io.gs2.cdk.core.acquire_action(
                                            "Gs2Experience:AddExperienceByUserId",
                                            "{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 10}"
                                        )
                                    )
                                ),
                                new io.gs2.cdk.mission.model.MissionTaskModel(
                                    "quest_x20",
                                    "QUEST_X20",
                                    "quest_complete",
                                    "quest_x10",
                                    20L,
                                    Arrays.asList(
                                        new io.gs2.cdk.core.acquire_action(
                                            "Gs2Experience:AddExperienceByUserId",
                                            "{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 20}"
                                        )
                                    )
                                ),
                                new io.gs2.cdk.mission.model.MissionTaskModel(
                                    "gacha",
                                    "GACHA",
                                    "lot_gacha",
                                    1L,
                                    Arrays.asList(
                                        new io.gs2.cdk.core.acquire_action(
                                            "Gs2Experience:AddExperienceByUserId",
                                            "{\"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(
                                new io.gs2.cdk.mission.model.MissionTaskModel(
                                    "quest_x100",
                                    "QUEST_X100",
                                    "quest_complete",
                                    100L,
                                    Arrays.asList(
                                        new io.gs2.cdk.core.acquire_action(
                                            "Gs2Experience:AddExperienceByUserId",
                                            "{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 40}"
                                        )
                                    )
                                ),
                                new io.gs2.cdk.mission.model.MissionTaskModel(
                                    "quest_x1000",
                                    "QUEST_X1000",
                                    "quest_complete",
                                    "quest_x100",
                                    1000L,
                                    Arrays.asList(
                                        new io.gs2.cdk.core.acquire_action(
                                            "Gs2Experience:AddExperienceByUserId",
                                            "{\"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(
                                new io.gs2.cdk.mission.model.MissionTaskModel(
                                    "quest_1-1",
                                    "QUEST_1-1",
                                    "quest1",
                                    1L
                                ),
                                new io.gs2.cdk.mission.model.MissionTaskModel(
                                    "quest_1-2",
                                    "QUEST_1-2",
                                    "quest1",
                                    "quest_1-1",
                                    1L
                                ),
                                new io.gs2.cdk.mission.model.MissionTaskModel(
                                    "quest_1-3",
                                    "QUEST_1-3",
                                    "quest1",
                                    "quest_1-2",
                                    1L
                                ),
                                new io.gs2.cdk.mission.model.MissionTaskModel(
                                    "quest_1-4",
                                    "QUEST_1-4",
                                    "quest1",
                                    "quest_1-3",
                                    1L
                                ),
                                new io.gs2.cdk.mission.model.MissionTaskModel(
                                    "quest_2-1",
                                    "QUEST_2-1",
                                    "quest2",
                                    "quest_1-4",
                                    1L
                                )
                            );
                        }
                    }
                )
            ),
            Arrays.asList(
                new io.gs2.cdk.mission.model.CounterModel(
                    "quest_complete",
                    Arrays.asList(
                        new io.gs2.cdk.mission.model.CounterScopeModel(
                            "daily",
                            5
                        ),
                        new io.gs2.cdk.mission.model.CounterScopeModel(
                            "weekly",
                            "monday",
                            5
                        )
                    ),
                    new io.gs2.cdk.mission.model.options.CounterModelOptions() {
                        {
                            metadata: "QUEST_COMPLETE";
                        }
                    }
                ),
                new io.gs2.cdk.mission.model.CounterModel(
                    "lot_gacha",
                    Arrays.asList(
                        new io.gs2.cdk.mission.model.CounterScopeModel(
                            "daily",
                            5
                        )
                    ),
                    new io.gs2.cdk.mission.model.options.CounterModelOptions() {
                        {
                            metadata: "LOT_GACHA";
                        }
                    }
                ),
                new io.gs2.cdk.mission.model.CounterModel(
                    "quest1",
                    Arrays.asList(
                        new io.gs2.cdk.mission.model.CounterScopeModel(
                            "notReset"
                        )
                    ),
                    new io.gs2.cdk.mission.model.options.CounterModelOptions() {
                        {
                            metadata: "QUEST1";
                        }
                    }
                ),
                new io.gs2.cdk.mission.model.CounterModel(
                    "quest2",
                    Arrays.asList(
                        new io.gs2.cdk.mission.model.CounterScopeModel(
                            "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.MissionGroupModelResetType.DAILY,
                    {
                        metadata: "DAILY",
                        tasks: [
                            new mission.model.MissionTaskModel(
                                "quest_x10",
                                "QUEST_X10",
                                "quest_complete",
                                10,
                                new AcquireAction[
                                    new AcquireAction(
                                        "Gs2Experience:AddExperienceByUserId",
                                        "{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 10}"
                                    )
                                ]
                            ),
                            new mission.model.MissionTaskModel(
                                "quest_x20",
                                "QUEST_X20",
                                "quest_complete",
                                "quest_x10",
                                20,
                                new AcquireAction[
                                    new AcquireAction(
                                        "Gs2Experience:AddExperienceByUserId",
                                        "{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 20}"
                                    )
                                ]
                            ),
                            new mission.model.MissionTaskModel(
                                "gacha",
                                "GACHA",
                                "lot_gacha",
                                1,
                                new AcquireAction[
                                    new AcquireAction(
                                        "Gs2Experience:AddExperienceByUserId",
                                        "{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 30}"
                                    )
                                ]
                            ),
                        ],
                        resetHour: 10
                    }
                ),
                new mission.model.MissionGroupModel(
                    "weekly",
                    mission.model.MissionGroupModelResetType.WEEKLY,
                    {
                        metadata: "WEEKLY",
                        tasks: [
                            new mission.model.MissionTaskModel(
                                "quest_x100",
                                "QUEST_X100",
                                "quest_complete",
                                100,
                                new AcquireAction[
                                    new AcquireAction(
                                        "Gs2Experience:AddExperienceByUserId",
                                        "{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 40}"
                                    )
                                ]
                            ),
                            new mission.model.MissionTaskModel(
                                "quest_x1000",
                                "QUEST_X1000",
                                "quest_complete",
                                "quest_x100",
                                1000,
                                new AcquireAction[
                                    new AcquireAction(
                                        "Gs2Experience:AddExperienceByUserId",
                                        "{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 50}"
                                    )
                                ]
                            ),
                        ],
                        resetDayOfWeek: "monday",
                        resetHour: 10
                    }
                ),
                new mission.model.MissionGroupModel(
                    "story",
                    mission.model.MissionGroupModelResetType.NOT_RESET,
                    {
                        metadata: "STORY",
                        tasks: [
                            new mission.model.MissionTaskModel(
                                "quest_1-1",
                                "QUEST_1-1",
                                "quest1",
                                1
                            ),
                            new mission.model.MissionTaskModel(
                                "quest_1-2",
                                "QUEST_1-2",
                                "quest1",
                                "quest_1-1",
                                1
                            ),
                            new mission.model.MissionTaskModel(
                                "quest_1-3",
                                "QUEST_1-3",
                                "quest1",
                                "quest_1-2",
                                1
                            ),
                            new mission.model.MissionTaskModel(
                                "quest_1-4",
                                "QUEST_1-4",
                                "quest1",
                                "quest_1-3",
                                1
                            ),
                            new mission.model.MissionTaskModel(
                                "quest_2-1",
                                "QUEST_2-1",
                                "quest2",
                                "quest_1-4",
                                1
                            ),
                        ]
                    }
                )
            ],
            [
                new mission.model.CounterModel(
                    "quest_complete",
                    [
                        new mission.model.CounterScopeModel(
                            "daily",
                            5
                        ),
                        new mission.model.CounterScopeModel(
                            "weekly",
                            "monday",
                            5
                        ),
                    ],
                    {
                        metadata: "QUEST_COMPLETE"
                    }
                ),
                new mission.model.CounterModel(
                    "lot_gacha",
                    [
                        new mission.model.CounterScopeModel(
                            "daily",
                            5
                        ),
                    ],
                    {
                        metadata: "LOT_GACHA"
                    }
                ),
                new mission.model.CounterModel(
                    "quest1",
                    [
                        new mission.model.CounterScopeModel(
                            "notReset"
                        ),
                    ],
                    {
                        metadata: "QUEST1"
                    }
                ),
                new mission.model.CounterModel(
                    "quest2",
                    [
                        new mission.model.CounterScopeModel(
                            "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.MissionGroupModelResetType.Daily,
                    new Gs2Cdk.Gs2Mission.Model.Options.MissionGroupModelOptions {
                        metadata = "DAILY",
                        tasks = new Gs2Cdk.Gs2Mission.Model.MissionTaskModel[] {
                            new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
                                name: "quest_x10",
                                metadata: "QUEST_X10",
                                counterName: "quest_complete",
                                targetValue: 10L,
                                completeAcquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
                                    new Gs2Cdk.Core.Model.AcquireAction(
                                        action: "Gs2Experience:AddExperienceByUserId",
                                        request: "{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 10}"
                                    )
                                }
                            ),
                            new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
                                name: "quest_x20",
                                metadata: "QUEST_X20",
                                counterName: "quest_complete",
                                premiseMissionTaskName: "quest_x10",
                                targetValue: 20L,
                                completeAcquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
                                    new Gs2Cdk.Core.Model.AcquireAction(
                                        action: "Gs2Experience:AddExperienceByUserId",
                                        request: "{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 20}"
                                    )
                                }
                            ),
                            new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
                                name: "gacha",
                                metadata: "GACHA",
                                counterName: "lot_gacha",
                                targetValue: 1L,
                                completeAcquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
                                    new Gs2Cdk.Core.Model.AcquireAction(
                                        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.MissionGroupModelResetType.Weekly,
                    new Gs2Cdk.Gs2Mission.Model.Options.MissionGroupModelOptions {
                        metadata = "WEEKLY",
                        tasks = new Gs2Cdk.Gs2Mission.Model.MissionTaskModel[] {
                            new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
                                name: "quest_x100",
                                metadata: "QUEST_X100",
                                counterName: "quest_complete",
                                targetValue: 100L,
                                completeAcquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
                                    new Gs2Cdk.Core.Model.AcquireAction(
                                        action: "Gs2Experience:AddExperienceByUserId",
                                        request: "{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 40}"
                                    )
                                }
                            ),
                            new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
                                name: "quest_x1000",
                                metadata: "QUEST_X1000",
                                counterName: "quest_complete",
                                premiseMissionTaskName: "quest_x100",
                                targetValue: 1000L,
                                completeAcquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
                                    new Gs2Cdk.Core.Model.AcquireAction(
                                        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.MissionGroupModelResetType.NotReset,
                    new Gs2Cdk.Gs2Mission.Model.Options.MissionGroupModelOptions {
                        metadata = "STORY",
                        tasks = new Gs2Cdk.Gs2Mission.Model.MissionTaskModel[] {
                            new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
                                name: "quest_1-1",
                                metadata: "QUEST_1-1",
                                counterName: "quest1",
                                targetValue: 1L
                            ),
                            new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
                                name: "quest_1-2",
                                metadata: "QUEST_1-2",
                                counterName: "quest1",
                                premiseMissionTaskName: "quest_1-1",
                                targetValue: 1L
                            ),
                            new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
                                name: "quest_1-3",
                                metadata: "QUEST_1-3",
                                counterName: "quest1",
                                premiseMissionTaskName: "quest_1-2",
                                targetValue: 1L
                            ),
                            new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
                                name: "quest_1-4",
                                metadata: "QUEST_1-4",
                                counterName: "quest1",
                                premiseMissionTaskName: "quest_1-3",
                                targetValue: 1L
                            ),
                            new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
                                name: "quest_2-1",
                                metadata: "QUEST_2-1",
                                counterName: "quest2",
                                premiseMissionTaskName: "quest_1-4",
                                targetValue: 1L
                            ),
                        }
                    }
                )
            },
            new [] {
                new Gs2Cdk.Gs2Mission.Model.CounterModel(
                    "quest_complete",
                    new Gs2Cdk.Gs2Mission.Model.CounterScopeModel[] {
                        new Gs2Cdk.Gs2Mission.Model.CounterScopeModel(
                            resetType: "daily",
                            resetHour: 5
                        ),
                        new Gs2Cdk.Gs2Mission.Model.CounterScopeModel(
                            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[] {
                        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[] {
                        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[] {
                        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文字リセットタイミング
valuelong✓0~ 9223372036854775805カウント
nextResetAtlong次回リセットタイミング
updatedAtlong✓最終更新日時

TargetCounterModel

目標カウンター

ミッションの達成目標となるカウンターの情報

型必須デフォルト値の制限説明
counterNamestring✓~ 128文字カウンター名
resetTypeenum [
“notReset”,
“daily”,
“weekly”,
“monthly”
]
~ 128文字目標リセットタイミング
valuelong✓1 ~ 9223372036854775805目標値

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",
"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",
"Gs2SerialKey:RevertUseByUserId",
"Gs2Showcase:DecrementPurchaseCountByUserId",
"Gs2Showcase:ForceReDrawByUserId",
"Gs2SkillTree:MarkReleaseByUserId",
"Gs2Stamina:RecoverStaminaByUserId",
"Gs2Stamina:RaiseMaxValueByUserId",
"Gs2Stamina:SetMaxValueByUserId",
"Gs2Stamina:SetRecoverIntervalByUserId",
"Gs2Stamina:SetRecoverValueByUserId",
"Gs2StateMachine:StartStateMachineByUserId",
]
✓~ 128文字入手アクションで実行するアクションの種類
requeststring✓~ 1048576文字リクエストのJSON

ConsumeAction

消費アクション

型必須デフォルト値の制限説明
actionenum [
"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",
"Gs2Matchmaking:VerifyIncludeParticipantByUserId",
"Gs2Mission:ReceiveByUserId",
"Gs2Mission:DecreaseCounterByUserId",
"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文字消費アクションで実行するアクションの種類
requeststring✓~ 1048576文字リクエストのJSON

VerifyAction

検証アクション

型必須デフォルト値の制限説明
actionenum [
"Gs2Dictionary:VerifyEntryByUserId",
"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",
"Gs2Mission:VerifyCompleteByUserId",
"Gs2Mission:VerifyCounterValueByUserId",
"Gs2Schedule:VerifyEventByUserId",
]
✓~ 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

トランザクション設定

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