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

エンティティ

Namespace

ネームスペース

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

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

	型	必須	値の制限	説明
name	string	✓	~ 128文字	ネームスペースの名前
currencyUsagePriority	string	✓	~ 128文字	消費優先度
description	string		~ 1024文字	説明文
sharedFreeCurrency	bool	✓		無償課金通貨を異なるスロットで共有するか
platformSetting	PlatformSetting	✓		ストアプラットフォーム設定
depositBalanceScript	ScriptSetting			ウォレット残高を加算したときに実行するスクリプト
withdrawBalanceScript	ScriptSetting			ウォレット残高を消費したときに実行するスクリプト
logSetting	LogSetting			ログの出力設定

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

定義	説明
PrioritizeFree	無償通貨を優先して使用する
PrioritizePaid	有償通貨を優先して使用する

GetAttr

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

実装例

Type: GS2::Money2::Namespace
Properties:
  Name: namespace1
  CurrencyUsagePriority: PrioritizeFree
  Description: null
  SharedFreeCurrency: false
  PlatformSetting: null
  DepositBalanceScript: null
  WithdrawBalanceScript: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1

from gs2_cdk import Stack, core, money2

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        money2.Namespace(
            stack=self,
            name="namespace-0001",
            currency_usage_priority=money2.NamespaceCurrencyUsagePriority.PRIORITIZE_FREE,
            shared_free_currency=False,
            options=money2.NamespaceOptions(
                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\Money2\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            currencyUsagePriority: \Gs2Cdk\Money2\Model\Enum\NamespaceCurrencyUsagePriority::PRIORITIZE_FREE,
            sharedFreeCurrency: False,
            options: new \Gs2Cdk\Money2\Model\Options\NamespaceOptions(
                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.money2.model.Namespace(
            this,
            "namespace-0001",
            io.gs2.cdk.money2.model.enums.NamespaceCurrencyUsagePriority.PRIORITIZE_FREE,
            false,
            new io.gs2.cdk.money2.model.options.NamespaceOptions() {
                {
                    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 money2 from "@/gs2cdk/money2";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new money2.model.Namespace(
            this,
            "namespace-0001",
            money2.model.NamespaceCurrencyUsagePriority.PRIORITIZE_FREE,
            false,
            {
                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.Gs2Money2.Model.Namespace(
            this,
            "namespace-0001",
            Gs2Cdk.Gs2Money2.Model.Enums.NamespaceCurrencyUsagePriority.PrioritizeFree,
            false,
            new Gs2Cdk.Gs2Money2.Model.Options.NamespaceOptions {
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    LoggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

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

CurrentModelMaster

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

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

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

Note

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

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

GetAttr

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

実装例

Type: GS2::Money2::CurrentModelMaster
Properties:
  NamespaceName: namespace1
  Settings: {
    "version": "2024-06-20",
    "storeContentModels": [
      {
        "name": "content-0001",
        "appleAppStore":
          {
            "productId": "io.gs2.sample.apple.product1"
          },
        "googlePlay":
          {
            "productId": "io.gs2.sample.google.product1"
          }
      },
      {
        "name": "content-0002",
        "appleAppStore":
          {
            "productId": "io.gs2.sample.apple.product2"
          },
        "googlePlay":
          {
            "productId": "io.gs2.sample.google.product2"
          }
      },
      {
        "name": "apple-only-0001",
        "appleAppStore":
          {
            "productId": "io.gs2.sample.apple.product3"
          }
      },
      {
        "name": "google-only-0001",
        "googlePlay":
          {
            "productId": "io.gs2.sample.apple.product3"
          }
      }
    ]
  }

from gs2_cdk import Stack, core, money2

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        money2.Namespace(
            stack=self,
            # 省略
        ).master_data(
            store_content_models=[
                money2.StoreContentModel(
                    name='content-0001',
                    options=money2.StoreContentModelOptions(
                        apple_app_store=money2.AppleAppStoreContent(
                            product_id='io.gs2.sample.apple.product1'
                        ),
                        google_play=money2.GooglePlayContent(
                            product_id='io.gs2.sample.google.product1'
                        ),
                    ),
                ),
                money2.StoreContentModel(
                    name='content-0002',
                    options=money2.StoreContentModelOptions(
                        apple_app_store=money2.AppleAppStoreContent(
                            product_id='io.gs2.sample.apple.product2'
                        ),
                        google_play=money2.GooglePlayContent(
                            product_id='io.gs2.sample.google.product2'
                        ),
                    ),
                ),
                money2.StoreContentModel(
                    name='apple-only-0001',
                    options=money2.StoreContentModelOptions(
                        apple_app_store=money2.AppleAppStoreContent(
                            product_id='io.gs2.sample.apple.product3'
                        ),
                    ),
                ),
                money2.StoreContentModel(
                    name='google-only-0001',
                    options=money2.StoreContentModelOptions(
                        google_play=money2.GooglePlayContent(
                            product_id='io.gs2.sample.apple.product3'
                        ),
                    ),
                ),
            ],
        )

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

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Money2\Model\Namespace_(
            stack: $this,
            // 省略
        ))->masterData(
            [
                new \Gs2Cdk\Money2\Model\StoreContentModel(
                    name:"content-0001",
                    options: new \Gs2Cdk\Money2\Model\Options\StoreContentModelOptions(
                        appleAppStore:new \Gs2Cdk\Money2\Model\AppleAppStoreContent(
                            productId: "io.gs2.sample.apple.product1"
                        ),
                        googlePlay:new \Gs2Cdk\Money2\Model\GooglePlayContent(
                            productId: "io.gs2.sample.google.product1"
                        )
                    )
                ),
                new \Gs2Cdk\Money2\Model\StoreContentModel(
                    name:"content-0002",
                    options: new \Gs2Cdk\Money2\Model\Options\StoreContentModelOptions(
                        appleAppStore:new \Gs2Cdk\Money2\Model\AppleAppStoreContent(
                            productId: "io.gs2.sample.apple.product2"
                        ),
                        googlePlay:new \Gs2Cdk\Money2\Model\GooglePlayContent(
                            productId: "io.gs2.sample.google.product2"
                        )
                    )
                ),
                new \Gs2Cdk\Money2\Model\StoreContentModel(
                    name:"apple-only-0001",
                    options: new \Gs2Cdk\Money2\Model\Options\StoreContentModelOptions(
                        appleAppStore:new \Gs2Cdk\Money2\Model\AppleAppStoreContent(
                            productId: "io.gs2.sample.apple.product3"
                        )
                    )
                ),
                new \Gs2Cdk\Money2\Model\StoreContentModel(
                    name:"google-only-0001",
                    options: new \Gs2Cdk\Money2\Model\Options\StoreContentModelOptions(
                        googlePlay:new \Gs2Cdk\Money2\Model\GooglePlayContent(
                            productId: "io.gs2.sample.apple.product3"
                        )
                    )
                )
            ]
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.money2.model.Namespace(
            this,
            // 省略
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.money2.model.StoreContentModel(
                    "content-0001",
                    new io.gs2.cdk.money2.model.options.StoreContentModelOptions() {
                        {
                            appleAppStore: new io.gs2.cdk.money2.model.AppleAppStoreContent(
                                "io.gs2.sample.apple.product1"
                            );
                            googlePlay: new io.gs2.cdk.money2.model.GooglePlayContent(
                                "io.gs2.sample.google.product1"
                            );
                        }
                    }
                ),
                new io.gs2.cdk.money2.model.StoreContentModel(
                    "content-0002",
                    new io.gs2.cdk.money2.model.options.StoreContentModelOptions() {
                        {
                            appleAppStore: new io.gs2.cdk.money2.model.AppleAppStoreContent(
                                "io.gs2.sample.apple.product2"
                            );
                            googlePlay: new io.gs2.cdk.money2.model.GooglePlayContent(
                                "io.gs2.sample.google.product2"
                            );
                        }
                    }
                ),
                new io.gs2.cdk.money2.model.StoreContentModel(
                    "apple-only-0001",
                    new io.gs2.cdk.money2.model.options.StoreContentModelOptions() {
                        {
                            appleAppStore: new io.gs2.cdk.money2.model.AppleAppStoreContent(
                                "io.gs2.sample.apple.product3"
                            );
                        }
                    }
                ),
                new io.gs2.cdk.money2.model.StoreContentModel(
                    "google-only-0001",
                    new io.gs2.cdk.money2.model.options.StoreContentModelOptions() {
                        {
                            googlePlay: new io.gs2.cdk.money2.model.GooglePlayContent(
                                "io.gs2.sample.apple.product3"
                            );
                        }
                    }
                )
            )
        );
    }
}

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new money2.model.Namespace(
            this,
            // 省略
        ).masterData(
            [
                new money2.model.StoreContentModel(
                    "content-0001",
                    {
                        appleAppStore: new money2.model.AppleAppStoreContent(
                            "io.gs2.sample.apple.product1"
                        ),
                        googlePlay: new money2.model.GooglePlayContent(
                            "io.gs2.sample.google.product1"
                        )
                    }
                ),
                new money2.model.StoreContentModel(
                    "content-0002",
                    {
                        appleAppStore: new money2.model.AppleAppStoreContent(
                            "io.gs2.sample.apple.product2"
                        ),
                        googlePlay: new money2.model.GooglePlayContent(
                            "io.gs2.sample.google.product2"
                        )
                    }
                ),
                new money2.model.StoreContentModel(
                    "apple-only-0001",
                    {
                        appleAppStore: new money2.model.AppleAppStoreContent(
                            "io.gs2.sample.apple.product3"
                        )
                    }
                ),
                new money2.model.StoreContentModel(
                    "google-only-0001",
                    {
                        googlePlay: new money2.model.GooglePlayContent(
                            "io.gs2.sample.apple.product3"
                        )
                    }
                )
            ]
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Money2.Model.Namespace(
            this,
            // 省略
        ).MasterData(
            new [] {
                new Gs2Cdk.Gs2Money2.Model.StoreContentModel(
                    "content-0001",
                    new Gs2Cdk.Gs2Money2.Model.Options.StoreContentModelOptions {
                        appleAppStore = new Gs2Cdk.Gs2Money2.Model.AppleAppStoreContent(
                            productId: "io.gs2.sample.apple.product1"
                        ),
                        googlePlay = new Gs2Cdk.Gs2Money2.Model.GooglePlayContent(
                            productId: "io.gs2.sample.google.product1"
                        )
                    }
                ),
                new Gs2Cdk.Gs2Money2.Model.StoreContentModel(
                    "content-0002",
                    new Gs2Cdk.Gs2Money2.Model.Options.StoreContentModelOptions {
                        appleAppStore = new Gs2Cdk.Gs2Money2.Model.AppleAppStoreContent(
                            productId: "io.gs2.sample.apple.product2"
                        ),
                        googlePlay = new Gs2Cdk.Gs2Money2.Model.GooglePlayContent(
                            productId: "io.gs2.sample.google.product2"
                        )
                    }
                ),
                new Gs2Cdk.Gs2Money2.Model.StoreContentModel(
                    "apple-only-0001",
                    new Gs2Cdk.Gs2Money2.Model.Options.StoreContentModelOptions {
                        appleAppStore = new Gs2Cdk.Gs2Money2.Model.AppleAppStoreContent(
                            productId: "io.gs2.sample.apple.product3"
                        )
                    }
                ),
                new Gs2Cdk.Gs2Money2.Model.StoreContentModel(
                    "google-only-0001",
                    new Gs2Cdk.Gs2Money2.Model.Options.StoreContentModelOptions {
                        googlePlay = new Gs2Cdk.Gs2Money2.Model.GooglePlayContent(
                            productId: "io.gs2.sample.apple.product3"
                        )
                    }
                )
            }
        );
    }
}

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

Receipt

ストアプラットフォームのレシート

	型	必須	値の制限	説明
Store	enum { “AppleAppStore”, “GooglePlay”, “fake” }	✓	~ 128文字	ストア
TransactionID	string	✓	~ 1024文字	トランザクションID
Payload	string	✓	~ 1048576文字	ペイロード

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

定義	説明
AppleAppStore	Apple App Store
GooglePlay	Google Play
fake	Fake

PlatformSetting

ストアプラットフォームの設定

	型	説明
appleAppStore	AppleAppStoreSetting	Apple AppStore の設定
googlePlay	GooglePlaySetting	Google Play の設定
fake	FakeSetting	Fake(Unity Editor) の設定

AppleAppStoreSetting

Apple AppStore の設定

	型	必須	デフォルト	値の制限	説明
bundleId	string			~ 1024文字	Apple AppStore のバンドルID

GooglePlaySetting

Google Play の設定

	型	必須	デフォルト	値の制限	説明
packageName	string			~ 5120文字	Google Play で配信するパッケージ名
publicKey	string			~ 5120文字	署名検証に使用する暗号鍵

FakeSetting

デバッグ用の偽のプラットフォームの設定

	型	必須	デフォルト	値の制限	説明
acceptFakeReceipt	enum { “Accept”, “Reject” }	✓	“Reject”	~ 128文字	UnityEditorが出力する偽のレシートで決済できるようにするか

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

定義	説明
Accept	受け入れる
Reject	拒否する

WalletSummary

ウォレットの状態

	型	必須	値の制限	説明
paid	int	✓	~ 2147483646	有償課金通貨
free	int	✓	~ 2147483646	無償課金通貨
total	int	✓	~ 2147483646	総数

DepositTransaction

入金トランザクション

	型	必須	値の制限	説明
price	float	✓	~ 100000.0	購入価格
currency	string	{price} > 0	~ 8文字	通貨コード
count	int	✓	~ 2147483646	所持量
depositedAt	long			入金日時 (UNIX時間単位：ミリ秒)

VerifyReceiptEvent

入金イベント

	型	必須	値の制限	説明
contentName	string	✓	~ 128文字	ストアコンテンツモデル名
platform	enum { “AppleAppStore”, “GooglePlay”, “fake” }	✓	~ 128文字	ストアプラットフォーム
appleAppStoreVerifyReceiptEvent	AppleAppStoreVerifyReceiptEvent			Apple AppStore のレシート検証イベント
googlePlayVerifyReceiptEvent	GooglePlayVerifyReceiptEvent			Google Play のレシート検証イベント

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

定義	説明
AppleAppStore	Apple AppStore
GooglePlay	Google Play
fake	Fake

DepositEvent

入金イベント

	型	必須	デフォルト	値の制限	説明
slot	int	✓		~ 100000000	スロット番号
depositTransactions	List<DepositTransaction>		[]	~ 1000 items	入金トランザクションリスト
status	WalletSummary	✓			ウォレットの状態

WithdrawEvent

出金イベント

	型	必須	デフォルト	値の制限	説明
slot	int	✓		~ 100000000	スロット番号
withdrawDetails	List<DepositTransaction>		[]	~ 1000 items	出金したウォレットの詳細リスト
status	WalletSummary	✓			ウォレットの状態

AppleAppStoreVerifyReceiptEvent

Apple AppStore のレシート

	型	必須	デフォルト	値の制限	説明
environment	enum { “sandbox”, “production” }	✓		~ 128文字	環境

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

定義	説明
sandbox	Sandbox
production	Production

GooglePlayVerifyReceiptEvent

Google Play のレシート検証イベント

	型	必須	デフォルト	値の制限	説明
purchaseToken	string			~ 4096文字	Purchase Token

AppleAppStoreContent

Apple AppStore のコンテンツ

	型	必須	デフォルト	値の制限	説明
productId	string			~ 1024文字	プロダクトID

GooglePlayContent

Google Play のコンテンツ

	型	必須	デフォルト	値の制限	説明
productId	string			~ 1024文字	プロダクトID

GitHubCheckoutSetting

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

	型	必須	値の制限	説明
apiKeyId	string	✓	~ 1024文字	GitHub のAPIキーGRN
repositoryName	string	✓	~ 1024文字	リポジトリ名
sourcePath	string	✓	~ 1024文字	ソースコードのファイルパス
referenceType	enum { “commit_hash”, “branch”, “tag” }	✓	~ 128文字	コードの取得元
commitHash	string	{referenceType} == “commit_hash”	~ 1024文字	コミットハッシュ
branchName	string	{referenceType} == “branch”	~ 1024文字	ブランチ名
tagName	string	{referenceType} == “tag”	~ 1024文字	タグ名

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

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

ScriptSetting

スクリプト設定

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

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

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

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

	型	必須	デフォルト	値の制限	説明
triggerScriptId	string			~ 1024文字	スクリプトGRN
doneTriggerTargetType	enum { “none”, “gs2_script”, “aws” }	✓	“none”	~ 128文字	完了通知の通知先
doneTriggerScriptId	string	{doneTriggerTargetType} == “gs2_script”		~ 1024文字	スクリプトGRN
doneTriggerQueueNamespaceId	string	{doneTriggerTargetType} == “gs2_script”		~ 1024文字	ネームスペースGRN

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

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

LogSetting

ログの書き出し設定

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

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