GS2-Exchange GS2-Deploy/CDK リファレンス
エンティティ
Namespace
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。 GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| name | string | ✓ | ~ 32文字 | ネームスペース名 | |
| description | string | ~ 1024文字 | 説明文 | ||
| enableAwaitExchange | bool | ✓ | false | 交換結果の受け取りに待ち時間の発生する交換機能を利用するか | |
| enableDirectExchange | bool | ✓ | true | 直接交換APIの呼び出しを許可する。許可しない場合はスタンプシート経由でしか交換できない | |
| transactionSetting | TransactionSetting | ✓ | トランザクション設定 | ||
| exchangeScript | ScriptSetting | 交換を実行しようとした時に実行するスクリプト | |||
| logSetting | LogSetting | ログの出力設定 |
GetAttr
| 型 | 説明 | |
|---|---|---|
| Item | Namespace | 作成したネームスペース |
実装例
Type: GS2::Exchange::Namespace
Properties:
Name: namespace1
Description: null
EnableAwaitExchange: null
EnableDirectExchange: 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
ExchangeScript: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1from gs2_cdk import Stack, core, exchange
class SampleStack(Stack):
def __init__(self):
super().__init__()
exchange.Namespace(
stack=self,
name="namespace-0001",
transaction_setting=core.TransactionSetting(
enable_auto_run=False,
options=core.TransactionSettingOptions(
distributor_namespace_id=,
key_id='grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001',
queue_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001',
)
),
options=exchange.NamespaceOptions(
log_setting=core.LogSetting(
logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
),
),
)
print(SampleStack().yaml()) # Generate Templateclass SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
new \Gs2Cdk\Exchange\Model\Namespace_(
stack: $this,
name: "namespace-0001",
transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
enableAutoRun: False,
options: new \Gs2Cdk\Core\Model\Options\TransactionSettingOptions(
distributorNamespaceId: ,
keyId: "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
)
),
options: new \Gs2Cdk\Exchange\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.exchange.model.Namespace(
this,
"namespace-0001",
new io.gs2.cdk.core.model.TransactionSetting(
false,
new io.gs2.cdk.core.model.options.TransactionSettingOptions(
,
"grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
"grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
)
),
new io.gs2.cdk.exchange.model.options.NamespaceOptions() {
{
logSetting = new io.gs2.cdk.core.model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
);
}
}
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
import core from "@/gs2cdk/core";
import exchange from "@/gs2cdk/exchange";
class SampleStack extends core.Stack
{
public constructor() {
super();
new exchange.model.Namespace(
this,
"namespace-0001",
new core.TransactionSetting(
false,
{
,
"grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
"grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
}
),
{
logSetting: new core.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Exchange.Model.Namespace(
this,
"namespace-0001",
new Gs2Cdk.Core.Model.TransactionSetting(
false,
new Gs2Cdk.Core.Model.Options.TransactionSettingOptions(
DistributorNamespaceId = ,
KeyId = "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
QueueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
}
),
new Gs2Cdk.Gs2Exchange.Model.Options.NamespaceOptions {
logSetting = new Gs2Cdk.Core.Model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
),
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate TemplateCurrentRateMaster
現在有効なマスターデータ
GS2ではマスターデータの管理にJSON形式のファイルを使用します。 ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
JSONファイルの形式についてはドキュメントを参照ください。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | |
| settings | string | ✓ | ~ 5242880文字 | マスターデータ |
GetAttr
| 型 | 説明 | |
|---|---|---|
| Item | CurrentRateMaster | 更新した現在有効な交換レート設定 |
実装例
Type: GS2::Exchange::CurrentRateMaster
Properties:
NamespaceName: namespace1
Settings: {
"version": "2019-08-19",
"rateModels": [
{
"name": "material_n_to_r",
"metadata": "N2R",
"timingType": "await",
"enableSkip": false,
"lockTime": 50,
"consumeActions": [
{
"action": "Gs2Inventory:ConsumeItemSetByUserId",
"request": "{\\"namespaceName\\": \\"category-0001\\", \\"inventoryName\\": \\"item\\", \\"itemName\\": \\"item-0001\\", \\"userId\\": \\"#{userId}\\", \\"consumeCount\\": 10}"
}
],
"acquireActions": [
{
"action": "Gs2Inventory:AcquireItemSetByUserId",
"request": "{\\"namespaceName\\": \\"category-0001\\", \\"inventoryName\\": \\"item\\", \\"itemName\\": \\"item-0002\\", \\"userId\\": \\"#{userId}\\", \\"acquireCount\\": 1}"
}
]
},
{
"name": "material_r_to_n",
"metadata": "N2R",
"timingType": "await",
"enableSkip": false,
"lockTime": 50,
"consumeActions": [
{
"action": "Gs2Inventory:ConsumeItemSetByUserId",
"request": "{\\"namespaceName\\": \\"category-0001\\", \\"inventoryName\\": \\"item\\", \\"itemName\\": \\"item-0002\\", \\"userId\\": \\"#{userId}\\", \\"consumeCount\\": 1}"
}
],
"acquireActions": [
{
"action": "Gs2Inventory:AcquireItemSetByUserId",
"request": "{\\"namespaceName\\": \\"category-0001\\", \\"inventoryName\\": \\"item\\", \\"itemName\\": \\"item-0001\\", \\"userId\\": \\"#{userId}\\", \\"acquireCount\\": 10}"
}
]
}
]
}from gs2_cdk import Stack, core, exchange
class SampleStack(Stack):
def __init__(self):
super().__init__()
exchange.Namespace(
stack=self,
# 省略
).master_data(
[
exchange.RateModel(
name='material_n_to_r',
timing_type='await',
options=exchange.RateModelOptions(
metadata='N2R',
consume_actions=[ {'action': 'Gs2Inventory:ConsumeItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0001", "userId": "#{userId}", "consumeCount": 10}'},
],
lock_time=50,
acquire_actions=[ {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0002", "userId": "#{userId}", "acquireCount": 1}'},
],
),
),
exchange.RateModel(
name='material_r_to_n',
timing_type='await',
options=exchange.RateModelOptions(
metadata='N2R',
consume_actions=[ {'action': 'Gs2Inventory:ConsumeItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0002", "userId": "#{userId}", "consumeCount": 1}'},
],
lock_time=50,
acquire_actions=[ {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0001", "userId": "#{userId}", "acquireCount": 10}'},
],
),
),
],
)
print(SampleStack().yaml()) # Generate Templateclass SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
(new \Gs2Cdk\Exchange\Model\Namespace_(
stack: $this,
// 省略
))->masterData(
[
new \Gs2Cdk\Exchange\Model\RateModel(
name:"material_n_to_r",
timingType:"await",
options: new \Gs2Cdk\Exchange\Model\Options\RateModelOptions(
metadata:"N2R",
consumeActions:[ {'action': 'Gs2Inventory:ConsumeItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0001", "userId": "#{userId}", "consumeCount": 10}'},
],
lockTime:50,
acquireActions:[ {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0002", "userId": "#{userId}", "acquireCount": 1}'},
],
),
),
new \Gs2Cdk\Exchange\Model\RateModel(
name:"material_r_to_n",
timingType:"await",
options: new \Gs2Cdk\Exchange\Model\Options\RateModelOptions(
metadata:"N2R",
consumeActions:[ {'action': 'Gs2Inventory:ConsumeItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0002", "userId": "#{userId}", "consumeCount": 1}'},
],
lockTime:50,
acquireActions:[ {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0001", "userId": "#{userId}", "acquireCount": 10}'},
],
),
),
],
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.exchange.model.Namespace(
this,
// 省略
).masterData(
Arrays.asList(
new io.gs2.cdk.exchange.model.RateModel(
"material_n_to_r",
"await",
new io.gs2.cdk.exchange.model.options.RateModelOptions() {
{
metadata: "N2R";
consumeActions: Arrays.asList(
{'action': 'Gs2Inventory:ConsumeItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0001", "userId": "#{userId}", "consumeCount": 10}'}
);
lockTime: 50;
acquireActions: Arrays.asList(
{'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0002", "userId": "#{userId}", "acquireCount": 1}'}
);
}
}
),
new io.gs2.cdk.exchange.model.RateModel(
"material_r_to_n",
"await",
new io.gs2.cdk.exchange.model.options.RateModelOptions() {
{
metadata: "N2R";
consumeActions: Arrays.asList(
{'action': 'Gs2Inventory:ConsumeItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0002", "userId": "#{userId}", "consumeCount": 1}'}
);
lockTime: 50;
acquireActions: Arrays.asList(
{'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0001", "userId": "#{userId}", "acquireCount": 10}'}
);
}
}
)
)
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
import core from "@/gs2cdk/core";
import exchange from "@/gs2cdk/exchange";
class SampleStack extends core.Stack
{
public constructor() {
super();
new exchange.model.Namespace(
this,
// 省略
).masterData(
[
new exchange.model.RateModel(
"material_n_to_r",
"await",
{
metadata: "N2R",
consumeActions: [
{'action': 'Gs2Inventory:ConsumeItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0001", "userId": "#{userId}", "consumeCount": 10}'}
],
lockTime: 50,
acquireActions: [
{'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0002", "userId": "#{userId}", "acquireCount": 1}'}
]
}
),
new exchange.model.RateModel(
"material_r_to_n",
"await",
{
metadata: "N2R",
consumeActions: [
{'action': 'Gs2Inventory:ConsumeItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0002", "userId": "#{userId}", "consumeCount": 1}'}
],
lockTime: 50,
acquireActions: [
{'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0001", "userId": "#{userId}", "acquireCount": 10}'}
]
}
)
]
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Exchange.Model.Namespace(
this,
// 省略
).MasterData(
new [] {
new Gs2Cdk.Gs2Exchange.Model.RateModel(
"material_n_to_r",
"await",
new Gs2Cdk.Gs2Exchange.Model.Options.RateModelOptions {
metadata = "N2R",
consumeActions = new Gs2Cdk.Gs2Exchange.Model.ConsumeAction[] {
{'action': 'Gs2Inventory:ConsumeItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0001", "userId": "#{userId}", "consumeCount": 10}'}
},
lockTime = 50,
acquireActions = new Gs2Cdk.Gs2Exchange.Model.AcquireAction[] {
{'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0002", "userId": "#{userId}", "acquireCount": 1}'}
},
}
),
new Gs2Cdk.Gs2Exchange.Model.RateModel(
"material_r_to_n",
"await",
new Gs2Cdk.Gs2Exchange.Model.Options.RateModelOptions {
metadata = "N2R",
consumeActions = new Gs2Cdk.Gs2Exchange.Model.ConsumeAction[] {
{'action': 'Gs2Inventory:ConsumeItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0002", "userId": "#{userId}", "consumeCount": 1}'}
},
lockTime = 50,
acquireActions = new Gs2Cdk.Gs2Exchange.Model.AcquireAction[] {
{'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0001", "userId": "#{userId}", "acquireCount": 10}'}
},
}
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate TemplateAcquireAction
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| action | enum [] | ✓ | ~ 128文字 | スタンプシートを使用して実行するアクションの種類 | |
| request | string | ✓ | ~ 1048576文字 | リクエストのJSON |
ConsumeAction
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| action | enum [] | ✓ | ~ 128文字 | スタンプタスクで実行するアクションの種類 | |
| request | string | ✓ | ~ 1048576文字 | 入手リクエストのJSON |
Config
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| key | string | ~ 64文字 | 名前 | ||
| value | string | ~ 51200文字 | 値 |
GitHubCheckoutSetting
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| 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文字 | タグ名 |
ScriptSetting
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| 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 |
LogSetting
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| loggingNamespaceId | string | ✓ | ~ 1024文字 | ネームスペースGRN |
TransactionSetting
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| enableAutoRun | bool | ✓ | false | 発行したスタンプシートをサーバーサイドで自動的に実行するか | |
| distributorNamespaceId | string | {enableAutoRun} | ~ 1024文字 | スタンプシートの実行に使用する GS2-Distributor ネームスペース | |
| keyId | string | !{enableAutoRun} | ~ 1024文字 | スタンプシートの署名に使用する GS2-Key の暗号鍵 | |
| queueNamespaceId | string | ~ 1024文字 | スタンプシートの実行に使用する GS2-JobQueue のネームスペース |