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

Tags:

エンティティ

Namespace

ネームスペース

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

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

型必須デフォルト値の制限説明
namestring✓~ 128文字ネームスペース名
descriptionstring~ 1024文字説明文
transactionSettingTransactionSetting✓トランザクション設定
receiveScriptScriptSetting報酬を受け取る時に実行するスクリプト
logSettingLogSettingログの出力設定

GetAttr

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

実装例

Type: GS2::LoginReward::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
  ReceiveScript: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
from gs2_cdk import Stack, core, login_reward

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        login_reward.Namespace(
            stack=self,
            name="namespace-0001",
            options=login_reward.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\LoginReward\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\LoginReward\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.loginReward.model.Namespace(
            this,
            "namespace-0001",
            new io.gs2.cdk.loginReward.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 loginReward from "@/gs2cdk/loginReward";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new loginReward.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.Gs2LoginReward.Model.Namespace(
            this,
            "namespace-0001",
            new Gs2Cdk.Gs2LoginReward.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

CurrentBonusMaster

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

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

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

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

GetAttr

型説明
ItemCurrentBonusMaster更新した現在有効な陳列棚マスター

実装例

Type: GS2::LoginReward::CurrentBonusMaster
Properties:
  NamespaceName: namespace1
  Settings: {
    "version": "2023-07-11",
    "bonusModels": [
      {
        "name": "schedule",
        "mode": "schedule",
        "missedReceiveRelief": "disabled",
        "periodEventId": "grn:gs2:schedule:grn-0001",
        "rewards": [
          {
            "acquireActions": [
              {
                "action": "Gs2Stamina:RecoverStaminaByUserId",
                "request": 
                          "namespaceName": "stamina-0001",
                          "staminaName": "quest",
                          "userId": "#{userId}",
                          "recoverValue": 100

              }
            ]
          },
          {
            "acquireActions": [
              {
                "action": "Gs2Stamina:RecoverStaminaByUserId",
                "request": 
                          "namespaceName": "stamina-0001",
                          "staminaName": "quest",
                          "userId": "#{userId}",
                          "recoverValue": 100

              }
            ]
          },
          {
            "acquireActions": [
              {
                "action": "Gs2Stamina:RecoverStaminaByUserId",
                "request": 
                          "namespaceName": "stamina-0001",
                          "staminaName": "quest",
                          "userId": "#{userId}",
                          "recoverValue": 100

              }
            ]
          }
        ]
      },
      {
        "name": "streaming",
        "mode": "streaming",
        "missedReceiveRelief": "enabled",
        "resetHour": 15,
        "repeat": "enabled",
        "rewards": [
          {
            "acquireActions": [
              {
                "action": "Gs2Stamina:RecoverStaminaByUserId",
                "request": 
                          "namespaceName": "stamina-0001",
                          "staminaName": "quest",
                          "userId": "#{userId}",
                          "recoverValue": 100

              }
            ]
          },
          {
            "acquireActions": [
              {
                "action": "Gs2Stamina:RecoverStaminaByUserId",
                "request": 
                          "namespaceName": "stamina-0001",
                          "staminaName": "quest",
                          "userId": "#{userId}",
                          "recoverValue": 100

              }
            ]
          },
          {
            "acquireActions": [
              {
                "action": "Gs2Stamina:RecoverStaminaByUserId",
                "request": 
                          "namespaceName": "stamina-0001",
                          "staminaName": "quest",
                          "userId": "#{userId}",
                          "recoverValue": 100

              }
            ]
          }
        ],
        "missedReceiveReliefConsumeActions": [
          {
            "action": "Gs2Money:WithdrawByUserId",
            "request": 
                      "namespaceName": "money-0001",
                      "userId": "#{userId}",
                      "slot": 0,
                      "count": 200,
                      "paidOnly": false
          }
        ]
      }
    ]
  }
from gs2_cdk import Stack, core, login_reward

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        login_reward.Namespace(
            stack=self,
            # 省略
        ).master_data(
            bonus_models=[
                login_reward.BonusModel(
                    name='schedule',
                    mode='schedule',
                    missed_receive_relief='disabled',
                    options=login_reward.BonusModelOptions(
                        period_event_id='grn:gs2:schedule:grn-0001',
                        rewards=[
                            login_reward.Reward(
                                acquire_actions=[
                                    login_reward.AcquireAction(
                                        action='Gs2Stamina:RecoverStaminaByUserId',
                                        request=
                                        login_reward.str(
                                            namespace_name='stamina-0001',
                                            stamina_name='quest',
                                            user_id='#{userId}',
                                            recover_value=100
                                        )
                                    )
                                ]
                            ),
                            login_reward.Reward(
                                acquire_actions=[
                                    login_reward.AcquireAction(
                                        action='Gs2Stamina:RecoverStaminaByUserId',
                                        request=
                                        login_reward.str(
                                            namespace_name='stamina-0001',
                                            stamina_name='quest',
                                            user_id='#{userId}',
                                            recover_value=100
                                        )
                                    )
                                ]
                            ),
                            login_reward.Reward(
                                acquire_actions=[
                                    login_reward.AcquireAction(
                                        action='Gs2Stamina:RecoverStaminaByUserId',
                                        request=
                                        login_reward.str(
                                            namespace_name='stamina-0001',
                                            stamina_name='quest',
                                            user_id='#{userId}',
                                            recover_value=100
                                        )
                                    )
                                ]
                            ),
                        ],
                    ),
                ),
                login_reward.BonusModel(
                    name='streaming',
                    mode='streaming',
                    missed_receive_relief='enabled',
                    options=login_reward.BonusModelOptions(
                        reset_hour=15,
                        repeat='enabled',
                        rewards=[
                            login_reward.Reward(
                                acquire_actions=[
                                    login_reward.AcquireAction(
                                        action='Gs2Stamina:RecoverStaminaByUserId',
                                        request=
                                        login_reward.str(
                                            namespace_name='stamina-0001',
                                            stamina_name='quest',
                                            user_id='#{userId}',
                                            recover_value=100
                                        )
                                    )
                                ]
                            ),
                            login_reward.Reward(
                                acquire_actions=[
                                    login_reward.AcquireAction(
                                        action='Gs2Stamina:RecoverStaminaByUserId',
                                        request=
                                        login_reward.str(
                                            namespace_name='stamina-0001',
                                            stamina_name='quest',
                                            user_id='#{userId}',
                                            recover_value=100
                                        )
                                    )
                                ]
                            ),
                            login_reward.Reward(
                                acquire_actions=[
                                    login_reward.AcquireAction(
                                        action='Gs2Stamina:RecoverStaminaByUserId',
                                        request=
                                        login_reward.str(
                                            namespace_name='stamina-0001',
                                            stamina_name='quest',
                                            user_id='#{userId}',
                                            recover_value=100
                                        )
                                    )
                                ]
                            ),
                        ],
                        missed_receive_relief_consume_actions=[
                            login_reward.ConsumeAction(
                                action='Gs2Money:WithdrawByUserId',
                                request=
                                login_reward.str(
                                    namespace_name='money-0001',
                                    user_id='#{userId}',
                                    slot=0,
                                    count=200,
                                    paid_only=False
                                )
                            ),
                        ],
                    ),
                ),
            ],
        )

print(SampleStack().yaml())  # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\LoginReward\Model\Namespace_(
            stack: $this,
            // 省略
        ))->masterData(
            [
                new \Gs2Cdk\LoginReward\Model\BonusModel(
                    name:"schedule",
                    mode: \Gs2Cdk\LoginReward\Model\Enums\BonusModelMode::SCHEDULE,
                    missedReceiveRelief: \Gs2Cdk\LoginReward\Model\Enums\BonusModelMissedReceiveRelief::DISABLED,
                    options: new \Gs2Cdk\LoginReward\Model\Options\BonusModelOptions(
                        periodEventId:"grn:gs2:schedule:grn-0001",
                        rewards:[
                            new \Gs2Cdk\LoginReward\Model\Reward(
                                acquireActions: [
                                    new \Gs2Cdk\Core\Model\AcquireAction(
                                        action: "Gs2Stamina:RecoverStaminaByUserId",
                                        request: 
                                            namespaceName: "stamina-0001",
                                            staminaName: "quest",
                                            userId: "#{userId}",
                                            recoverValue: 100
                                        )
                                    )
                                ]
                            ),
                            new \Gs2Cdk\LoginReward\Model\Reward(
                                acquireActions: [
                                    new \Gs2Cdk\Core\Model\AcquireAction(
                                        action: "Gs2Stamina:RecoverStaminaByUserId",
                                        request: 
                                            namespaceName: "stamina-0001",
                                            staminaName: "quest",
                                            userId: "#{userId}",
                                            recoverValue: 100
                                        )
                                    )
                                ]
                            ),
                            new \Gs2Cdk\LoginReward\Model\Reward(
                                acquireActions: [
                                    new \Gs2Cdk\Core\Model\AcquireAction(
                                        action: "Gs2Stamina:RecoverStaminaByUserId",
                                        request: 
                                            namespaceName: "stamina-0001",
                                            staminaName: "quest",
                                            userId: "#{userId}",
                                            recoverValue: 100
                                        )
                                    )
                                ]
                            ),
                        ]
                    )
                ),
                new \Gs2Cdk\LoginReward\Model\BonusModel(
                    name:"streaming",
                    mode: \Gs2Cdk\LoginReward\Model\Enums\BonusModelMode::STREAMING,
                    missedReceiveRelief: \Gs2Cdk\LoginReward\Model\Enums\BonusModelMissedReceiveRelief::ENABLED,
                    options: new \Gs2Cdk\LoginReward\Model\Options\BonusModelOptions(
                        resetHour:15,
                        repeat:"enabled",
                        rewards:[
                            new \Gs2Cdk\LoginReward\Model\Reward(
                                acquireActions: [
                                    new \Gs2Cdk\Core\Model\AcquireAction(
                                        action: "Gs2Stamina:RecoverStaminaByUserId",
                                        request: 
                                            namespaceName: "stamina-0001",
                                            staminaName: "quest",
                                            userId: "#{userId}",
                                            recoverValue: 100
                                        )
                                    )
                                ]
                            ),
                            new \Gs2Cdk\LoginReward\Model\Reward(
                                acquireActions: [
                                    new \Gs2Cdk\Core\Model\AcquireAction(
                                        action: "Gs2Stamina:RecoverStaminaByUserId",
                                        request: 
                                            namespaceName: "stamina-0001",
                                            staminaName: "quest",
                                            userId: "#{userId}",
                                            recoverValue: 100
                                        )
                                    )
                                ]
                            ),
                            new \Gs2Cdk\LoginReward\Model\Reward(
                                acquireActions: [
                                    new \Gs2Cdk\Core\Model\AcquireAction(
                                        action: "Gs2Stamina:RecoverStaminaByUserId",
                                        request: 
                                            namespaceName: "stamina-0001",
                                            staminaName: "quest",
                                            userId: "#{userId}",
                                            recoverValue: 100
                                        )
                                    )
                                ]
                            ),
                        ],
                        missedReceiveReliefConsumeActions:[
                            new \Gs2Cdk\Core\Model\ConsumeAction(
                                action: "Gs2Money:WithdrawByUserId",
                                request: 
                                    namespaceName: "money-0001",
                                    userId: "#{userId}",
                                    slot: 0,
                                    count: 200,
                                    paidOnly: False
                                )
                            ),
                        ]
                    )
                )
            ]
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.loginReward.model.Namespace(
            this,
            // 省略
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.loginReward.model.BonusModel(
                    "schedule",
                    Schedule,
                    Disabled,
                    new io.gs2.cdk.loginReward.model.options.BonusModelOptions() {
                        {
                            periodEventId: "grn:gs2:schedule:grn-0001";
                            rewards: Arrays.asList(
                                new io.gs2.cdk.login_reward.model.Reward(
                                    Arrays.asList(
                                        new io.gs2.cdk.core.acquire_action(
                                            "Gs2Stamina:RecoverStaminaByUserId",
                                            
                                            new io.gs2.cdk.login_reward.model.StampSheetRequest(
                                                "stamina-0001",
                                                "quest",
                                                "#{userId}",
                                                100
                                            )
                                        )
                                    )
                                ),
                                new io.gs2.cdk.login_reward.model.Reward(
                                    Arrays.asList(
                                        new io.gs2.cdk.core.acquire_action(
                                            "Gs2Stamina:RecoverStaminaByUserId",
                                            
                                            new io.gs2.cdk.login_reward.model.StampSheetRequest(
                                                "stamina-0001",
                                                "quest",
                                                "#{userId}",
                                                100
                                            )
                                        )
                                    )
                                ),
                                new io.gs2.cdk.login_reward.model.Reward(
                                    Arrays.asList(
                                        new io.gs2.cdk.core.acquire_action(
                                            "Gs2Stamina:RecoverStaminaByUserId",
                                            
                                            new io.gs2.cdk.login_reward.model.StampSheetRequest(
                                                "stamina-0001",
                                                "quest",
                                                "#{userId}",
                                                100
                                            )
                                        )
                                    )
                                )
                            );
                        }
                    }
                ),
                new io.gs2.cdk.loginReward.model.BonusModel(
                    "streaming",
                    Streaming,
                    Enabled,
                    new io.gs2.cdk.loginReward.model.options.BonusModelOptions() {
                        {
                            resetHour: 15;
                            repeat: "enabled";
                            rewards: Arrays.asList(
                                new io.gs2.cdk.login_reward.model.Reward(
                                    Arrays.asList(
                                        new io.gs2.cdk.core.acquire_action(
                                            "Gs2Stamina:RecoverStaminaByUserId",
                                            
                                            new io.gs2.cdk.login_reward.model.StampSheetRequest(
                                                "stamina-0001",
                                                "quest",
                                                "#{userId}",
                                                100
                                            )
                                        )
                                    )
                                ),
                                new io.gs2.cdk.login_reward.model.Reward(
                                    Arrays.asList(
                                        new io.gs2.cdk.core.acquire_action(
                                            "Gs2Stamina:RecoverStaminaByUserId",
                                            
                                            new io.gs2.cdk.login_reward.model.StampSheetRequest(
                                                "stamina-0001",
                                                "quest",
                                                "#{userId}",
                                                100
                                            )
                                        )
                                    )
                                ),
                                new io.gs2.cdk.login_reward.model.Reward(
                                    Arrays.asList(
                                        new io.gs2.cdk.core.acquire_action(
                                            "Gs2Stamina:RecoverStaminaByUserId",
                                            
                                            new io.gs2.cdk.login_reward.model.StampSheetRequest(
                                                "stamina-0001",
                                                "quest",
                                                "#{userId}",
                                                100
                                            )
                                        )
                                    )
                                )
                            );
                            missedReceiveReliefConsumeActions: Arrays.asList(
                                new io.gs2.cdk.core.consume_action(
                                    "Gs2Money:WithdrawByUserId",
                                    
                                    new io.gs2.cdk.login_reward.model.StampTaskRequest(
                                        "money-0001",
                                        "#{userId}",
                                        0,
                                        200,
                                        false
                                    )
                                )
                            );
                        }
                    }
                )
            )
        );
    }
}

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new loginReward.model.Namespace(
            this,
            // 省略
        ).masterData(
            [
                new loginReward.model.BonusModel(
                    "schedule",
                    loginReward.model.BonusModelMode.SCHEDULE,
                    loginReward.model.BonusModelMissedReceiveRelief.DISABLED,
                    {
                        periodEventId: "grn:gs2:schedule:grn-0001",
                        rewards: [
                            new loginReward.model.Reward(
                                new AcquireAction[
                                    new AcquireAction(
                                        "Gs2Stamina:RecoverStaminaByUserId",

                                        new loginReward.model.string(
                                            "stamina-0001",
                                            "quest",
                                            "#{userId}",
                                            100
                                        )
                                    )
                                ]
                            ),
                            new loginReward.model.Reward(
                                new AcquireAction[
                                    new AcquireAction(
                                        "Gs2Stamina:RecoverStaminaByUserId",

                                        new loginReward.model.string(
                                            "stamina-0001",
                                            "quest",
                                            "#{userId}",
                                            100
                                        )
                                    )
                                ]
                            ),
                            new loginReward.model.Reward(
                                new AcquireAction[
                                    new AcquireAction(
                                        "Gs2Stamina:RecoverStaminaByUserId",

                                        new loginReward.model.string(
                                            "stamina-0001",
                                            "quest",
                                            "#{userId}",
                                            100
                                        )
                                    )
                                ]
                            ),
                        ]
                    }
                ),
                new loginReward.model.BonusModel(
                    "streaming",
                    loginReward.model.BonusModelMode.STREAMING,
                    loginReward.model.BonusModelMissedReceiveRelief.ENABLED,
                    {
                        resetHour: 15,
                        repeat: "enabled",
                        rewards: [
                            new loginReward.model.Reward(
                                new AcquireAction[
                                    new AcquireAction(
                                        "Gs2Stamina:RecoverStaminaByUserId",

                                        new loginReward.model.string(
                                            "stamina-0001",
                                            "quest",
                                            "#{userId}",
                                            100
                                        )
                                    )
                                ]
                            ),
                            new loginReward.model.Reward(
                                new AcquireAction[
                                    new AcquireAction(
                                        "Gs2Stamina:RecoverStaminaByUserId",

                                        new loginReward.model.string(
                                            "stamina-0001",
                                            "quest",
                                            "#{userId}",
                                            100
                                        )
                                    )
                                ]
                            ),
                            new loginReward.model.Reward(
                                new AcquireAction[
                                    new AcquireAction(
                                        "Gs2Stamina:RecoverStaminaByUserId",

                                        new loginReward.model.string(
                                            "stamina-0001",
                                            "quest",
                                            "#{userId}",
                                            100
                                        )
                                    )
                                ]
                            ),
                        ],
                        missedReceiveReliefConsumeActions: [
                            new ConsumeAction(
                                "Gs2Money:WithdrawByUserId",

                                new loginReward.model.string(
                                    "money-0001",
                                    "#{userId}",
                                    0,
                                    200,
                                    false
                                )
                            ),
                        ]
                    }
                )
            ]
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2LoginReward.Model.Namespace(
            this,
            // 省略
        ).MasterData(
            new [] {
                new Gs2Cdk.Gs2LoginReward.Model.BonusModel(
                    "schedule",
                    Gs2Cdk.Gs2LoginReward.Model.Enums.BonusModelMode.Schedule,
                    Gs2Cdk.Gs2LoginReward.Model.Enums.BonusModelMissedReceiveRelief.Disabled,
                    new Gs2Cdk.Gs2LoginReward.Model.Options.BonusModelOptions {
                        periodEventId = "grn:gs2:schedule:grn-0001",
                        rewards = new Gs2Cdk.Gs2LoginReward.Model.Reward[] {
                            new Gs2Cdk.Gs2LoginReward.Model.Reward(
                                acquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
                                    new Gs2Cdk.Core.Model.AcquireAction(
                                        action: "Gs2Stamina:RecoverStaminaByUserId",
                                        request: 
                                        new string(
                                            namespaceName: "stamina-0001",
                                            staminaName: "quest",
                                            userId: "#{userId}",
                                            recoverValue: 100
                                        )
                                    )
                                }
                            ),
                            new Gs2Cdk.Gs2LoginReward.Model.Reward(
                                acquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
                                    new Gs2Cdk.Core.Model.AcquireAction(
                                        action: "Gs2Stamina:RecoverStaminaByUserId",
                                        request: 
                                        new string(
                                            namespaceName: "stamina-0001",
                                            staminaName: "quest",
                                            userId: "#{userId}",
                                            recoverValue: 100
                                        )
                                    )
                                }
                            ),
                            new Gs2Cdk.Gs2LoginReward.Model.Reward(
                                acquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
                                    new Gs2Cdk.Core.Model.AcquireAction(
                                        action: "Gs2Stamina:RecoverStaminaByUserId",
                                        request: 
                                        new string(
                                            namespaceName: "stamina-0001",
                                            staminaName: "quest",
                                            userId: "#{userId}",
                                            recoverValue: 100
                                        )
                                    )
                                }
                            ),
                        }
                    }
                ),
                new Gs2Cdk.Gs2LoginReward.Model.BonusModel(
                    "streaming",
                    Gs2Cdk.Gs2LoginReward.Model.Enums.BonusModelMode.Streaming,
                    Gs2Cdk.Gs2LoginReward.Model.Enums.BonusModelMissedReceiveRelief.Enabled,
                    new Gs2Cdk.Gs2LoginReward.Model.Options.BonusModelOptions {
                        resetHour = 15,
                        repeat = "enabled",
                        rewards = new Gs2Cdk.Gs2LoginReward.Model.Reward[] {
                            new Gs2Cdk.Gs2LoginReward.Model.Reward(
                                acquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
                                    new Gs2Cdk.Core.Model.AcquireAction(
                                        action: "Gs2Stamina:RecoverStaminaByUserId",
                                        request: 
                                        new string(
                                            namespaceName: "stamina-0001",
                                            staminaName: "quest",
                                            userId: "#{userId}",
                                            recoverValue: 100
                                        )
                                    )
                                }
                            ),
                            new Gs2Cdk.Gs2LoginReward.Model.Reward(
                                acquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
                                    new Gs2Cdk.Core.Model.AcquireAction(
                                        action: "Gs2Stamina:RecoverStaminaByUserId",
                                        request: 
                                        new string(
                                            namespaceName: "stamina-0001",
                                            staminaName: "quest",
                                            userId: "#{userId}",
                                            recoverValue: 100
                                        )
                                    )
                                }
                            ),
                            new Gs2Cdk.Gs2LoginReward.Model.Reward(
                                acquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
                                    new Gs2Cdk.Core.Model.AcquireAction(
                                        action: "Gs2Stamina:RecoverStaminaByUserId",
                                        request: 
                                        new string(
                                            namespaceName: "stamina-0001",
                                            staminaName: "quest",
                                            userId: "#{userId}",
                                            recoverValue: 100
                                        )
                                    )
                                }
                            ),
                        },
                        missedReceiveReliefConsumeActions = new Gs2Cdk.Gs2LoginReward.Model.ConsumeAction[] {
                            new Gs2Cdk.Core.Model.ConsumeAction(
                                action: "Gs2Money:WithdrawByUserId",
                                request: 
                                new string(
                                    namespaceName: "money-0001",
                                    userId: "#{userId}",
                                    slot: 0,
                                    count: 200,
                                    paidOnly: false
                                )
                            ),
                        }
                    }
                )
            }
        );
    }
}

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

Reward

報酬

型必須デフォルト値の制限説明
acquireActionsList<AcquireAction>✓1 ~ 10 items入手アクションリスト

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",
"Gs2Mission:ReceiveByUserId",
"Gs2Mission:BatchReceiveByUserId",
"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

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:CreateAwaitByUserId",
"Gs2Exchange:AcquireForceByUserId",
"Gs2Exchange:SkipByUserId",
"Gs2Experience:AddExperienceByUserId",
"Gs2Experience:SetExperienceByUserId",
"Gs2Experience:AddRankCapByUserId",
"Gs2Experience:SetRankCapByUserId",
"Gs2Experience:MultiplyAcquireActionsByUserId",
"Gs2Formation:AddMoldCapacityByUserId",
"Gs2Formation:SetMoldCapacityByUserId",
"Gs2Formation:AcquireActionsToFormProperties",
"Gs2Formation:SetFormByUserId",
"Gs2Formation:AcquireActionsToPropertyFormProperties",
"Gs2Friend:UpdateProfileByUserId",
"Gs2Grade:AddGradeByUserId",
"Gs2Grade:ApplyRankCapByUserId",
"Gs2Grade:MultiplyAcquireActionsByUserId",
"Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Idle:IncreaseMaximumIdleMinutesByUserId",
"Gs2Idle:SetMaximumIdleMinutesByUserId",
"Gs2Idle:ReceiveByUserId",
"Gs2Inbox:SendMessageByUserId",
"Gs2Inventory:AddCapacityByUserId",
"Gs2Inventory:SetCapacityByUserId",
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetWithGradeByUserId",
"Gs2Inventory:AddReferenceOfByUserId",
"Gs2Inventory:DeleteReferenceOfByUserId",
"Gs2Inventory:AcquireSimpleItemsByUserId",
"Gs2Inventory:SetSimpleItemsByUserId",
"Gs2Inventory:AcquireBigItemByUserId",
"Gs2Inventory:SetBigItemByUserId",
"Gs2JobQueue:PushByUserId",
"Gs2Limit:CountDownByUserId",
"Gs2Limit:DeleteCounterByUserId",
"Gs2LoginReward:DeleteReceiveStatusByUserId",
"Gs2LoginReward:UnmarkReceivedByUserId",
"Gs2Lottery:DrawByUserId",
"Gs2Lottery:ResetBoxByUserId",
"Gs2Mission:RevertReceiveByUserId",
"Gs2Mission:IncreaseCounterByUserId",
"Gs2Mission:SetCounterByUserId",
"Gs2Money:DepositByUserId",
"Gs2Money:RevertRecordReceipt",
"Gs2Money2:DepositByUserId",
"Gs2Quest:CreateProgressByUserId",
"Gs2Schedule:TriggerByUserId",
"Gs2Script:InvokeScript",
"Gs2SerialKey:RevertUseByUserId",
"Gs2SerialKey:IssueOnce",
"Gs2Showcase:DecrementPurchaseCountByUserId",
"Gs2Showcase:ForceReDrawByUserId",
"Gs2SkillTree:MarkReleaseByUserId",
"Gs2Stamina:RecoverStaminaByUserId",
"Gs2Stamina:RaiseMaxValueByUserId",
"Gs2Stamina:SetMaxValueByUserId",
"Gs2Stamina:SetRecoverIntervalByUserId",
"Gs2Stamina:SetRecoverValueByUserId",
"Gs2StateMachine:StartStateMachineByUserId",
}
✓~ 128文字入手アクションで実行するアクションの種類
requeststring✓~ 1048576文字リクエストのJSON

VerifyAction

検証アクション

型必須デフォルト値の制限説明
actionenum {
"Gs2Dictionary:VerifyEntryByUserId",
"Gs2Distributor:IfExpressionByUserId",
"Gs2Distributor:AndExpressionByUserId",
"Gs2Distributor:OrExpressionByUserId",
"Gs2Enchant:VerifyRarityParameterStatusByUserId",
"Gs2Experience:VerifyRankByUserId",
"Gs2Experience:VerifyRankCapByUserId",
"Gs2Grade:VerifyGradeByUserId",
"Gs2Grade:VerifyGradeUpMaterialByUserId",
"Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName",
"Gs2Guild:VerifyIncludeMemberByUserId",
"Gs2Inventory:VerifyInventoryCurrentMaxCapacityByUserId",
"Gs2Inventory:VerifyItemSetByUserId",
"Gs2Inventory:VerifyReferenceOfByUserId",
"Gs2Inventory:VerifySimpleItemByUserId",
"Gs2Inventory:VerifyBigItemByUserId",
"Gs2Limit:VerifyCounterByUserId",
"Gs2Matchmaking:VerifyIncludeParticipantByUserId",
"Gs2Mission:VerifyCompleteByUserId",
"Gs2Mission:VerifyCounterValueByUserId",
"Gs2Ranking2:VerifyGlobalRankingScoreByUserId",
"Gs2Ranking2:VerifyClusterRankingScoreByUserId",
"Gs2Ranking2:VerifySubscribeRankingScoreByUserId",
"Gs2Schedule:VerifyTriggerByUserId",
"Gs2Schedule:VerifyEventByUserId",
"Gs2SerialKey:VerifyCodeByUserId",
}
✓~ 128文字検証アクションで実行するアクションの種類
requeststring✓~ 1048576文字リクエストのJSON

Config

コンフィグ設定

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

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

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文字タグ名

referenceType に指定する列挙型の定義

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

LogSetting

ログの書き出し設定

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

型必須デフォルト値の制限説明
loggingNamespaceIdstring✓~ 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 のネームスペース

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

doneTriggerTargetType に指定する列挙型の定義

定義説明
noneなし
gs2_scriptGS2-Script
awsAmazon EventBridge