GS2-Showcase GS2-Deploy/CDK リファレンス
エンティティ
Namespace
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。 GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| name | string | ✓ | ~ 128文字 | ネームスペース名 | |
| description | string | ~ 1024文字 | 説明文 | ||
| transactionSetting | TransactionSetting | ✓ | トランザクション設定 | ||
| buyScript | ScriptSetting | 購入を実行しようとした時に実行するスクリプト | |||
| logSetting | LogSetting | ログの出力設定 |
GetAttr
| 型 | 説明 | |
|---|---|---|
| Item | Namespace | 作成したネームスペース |
実装例
Type: GS2::Showcase::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
BuyScript: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1from gs2_cdk import Stack, core, showcase
class SampleStack(Stack):
def __init__(self):
super().__init__()
showcase.Namespace(
stack=self,
name="namespace-0001",
options=showcase.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 Templateclass SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
new \Gs2Cdk\Showcase\Model\Namespace_(
stack: $this,
name: "namespace-0001",
options: new \Gs2Cdk\Showcase\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.showcase.model.Namespace(
this,
"namespace-0001",
new io.gs2.cdk.showcase.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 Templateimport core from "@/gs2cdk/core";
import showcase from "@/gs2cdk/showcase";
class SampleStack extends core.Stack
{
public constructor() {
super();
new showcase.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.Gs2Showcase.Model.Namespace(
this,
"namespace-0001",
new Gs2Cdk.Gs2Showcase.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 TemplateCurrentShowcaseMaster
現在有効なマスターデータ
GS2ではマスターデータの管理にJSON形式のファイルを使用します。 ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
JSONファイルの形式についてはドキュメントを参照ください。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 | |
| settings | string | ✓ | ~ 5242880文字 | マスターデータ |
GetAttr
| 型 | 説明 | |
|---|---|---|
| Item | CurrentShowcaseMaster | 更新した現在有効な陳列棚マスター |
実装例
Type: GS2::Showcase::CurrentShowcaseMaster
Properties:
NamespaceName: namespace1
Settings: {
"version": "2019-04-04",
"showcases": [
{
"name": "gem",
"displayItems": [
{
"type": "salesItem",
"salesItem":
"name": "gem_3000",
"metadata": "GEM_3000",
"consumeActions": [
{
"action": "Gs2Money:InAppPurchase",
"request": "Gs2Money:InAppPurchase:request"
}
],
"acquireActions": [
{
"action": "Gs2Money:DepositByUserId",
"request": "Gs2Money:DepositByUserId:request"
}
]
},
{
"type": "salesItemGroup",
"salesPeriodEventId": "grn:gs2:ap-northeast-1:YourOwnerId:schedule:schedule-0001:event:event-0001",
"salesItemGroup":
"name": "step_gem",
"metadata": "STEP_GEM",
"salesItems": [
{
"name": "step1_gem_1000",
"metadata": "STEP1_GEM_1000",
"consumeActions": [
{
"action": "Gs2Money:InAppPurchase",
"request": "Gs2Money:InAppPurchase:request"
},
{
"action": "Gs2Limit:CountUpByUserId",
"request": "Gs2Limit:CountUpByUserId:request"
}
],
"acquireActions": [
{
"action": "Gs2Money:DepositByUserId",
"request": "Gs2Money:DepositByUserId:request"
}
]
},
{
"name": "step2_gem_2000",
"metadata": "STEP1_GEM_2000",
"consumeActions": [
{
"action": "Gs2Money:InAppPurchase",
"request": "Gs2Money:InAppPurchase:request"
},
{
"action": "Gs2Limit:CountUpByUserId",
"request": "Gs2Limit:CountUpByUserId:request"
}
],
"acquireActions": [
{
"action": "Gs2Money:DepositByUserId",
"request": "Gs2Money:DepositByUserId:request"
}
]
}
]
}
],
"metadata": "GEM"
},
{
"name": "gacha",
"displayItems": [
{
"type": "salesItem",
"salesItem":
"name": "single",
"metadata": "SINGLE",
"consumeActions": [
{
"action": "Gs2Money:WithdrawByUserId",
"request": "{\"moneyName\": \"money-0001\", \"userId\": \"{userId}\", \"slot\": \"{slot}\", \"count\": 100, \"paidOnly\": false}"
}
],
"acquireActions": [
{
"action": "Gs2Inventory:AcquireItemSetByUserId",
"request": "{\"categoryName\": \"category-0001\", \"inventoryModelName\": \"character\", \"itemModelName\": \"ssr-0001\", \"userId\": \"{userId}\", \"acquireCount\": 1}"
}
]
},
{
"type": "salesItem",
"salesItem":
"name": "10times",
"metadata": "10TIMES",
"consumeActions": [
{
"action": "Gs2Money:WithdrawByUserId",
"request": "Gs2Money:WithdrawByUserId:request"
}
],
"acquireActions": [
{
"action": "Gs2Inventory:AcquireItemSetByUserId",
"request": "Gs2Inventory:AcquireItemSetByUserId:request"
},
{
"action": "Gs2Inventory:AcquireItemSetByUserId",
"request": "Gs2Inventory:AcquireItemSetByUserId:request"
},
{
"action": "Gs2Inventory:AcquireItemSetByUserId",
"request": "Gs2Inventory:AcquireItemSetByUserId:request"
},
{
"action": "Gs2Inventory:AcquireItemSetByUserId",
"request": "Gs2Inventory:AcquireItemSetByUserId:request"
},
{
"action": "Gs2Inventory:AcquireItemSetByUserId",
"request": "Gs2Inventory:AcquireItemSetByUserId:request"
},
{
"action": "Gs2Inventory:AcquireItemSetByUserId",
"request": "Gs2Inventory:AcquireItemSetByUserId:request"
},
{
"action": "Gs2Inventory:AcquireItemSetByUserId",
"request": "Gs2Inventory:AcquireItemSetByUserId:request"
},
{
"action": "Gs2Inventory:AcquireItemSetByUserId",
"request": "Gs2Inventory:AcquireItemSetByUserId:request"
},
{
"action": "Gs2Inventory:AcquireItemSetByUserId",
"request": "Gs2Inventory:AcquireItemSetByUserId:request"
},
{
"action": "Gs2Inventory:AcquireItemSetByUserId",
"request": "Gs2Inventory:AcquireItemSetByUserId:request"
}
]
}
],
"metadata": "GACHA"
}
],
"randomShowcases":
}from gs2_cdk import Stack, core, showcase
class SampleStack(Stack):
def __init__(self):
super().__init__()
showcase.Namespace(
stack=self,
# 省略
).master_data(
showcases=[
showcase.Showcase(
name='gem',
display_items=[
showcase.DisplayItem(
type='salesItem',
sales_item=
showcase.SalesItem(
name='gem_3000',
metadata='GEM_3000',
consume_actions=[
showcase.ConsumeAction(
action='Gs2Money:InAppPurchase',
request='Gs2Money:InAppPurchase:request'
)
],
acquire_actions=[
showcase.AcquireAction(
action='Gs2Money:DepositByUserId',
request='Gs2Money:DepositByUserId:request'
)
]
)
),
showcase.DisplayItem(
type='salesItemGroup',
sales_period_event_id='grn:gs2:ap-northeast-1:YourOwnerId:schedule:schedule-0001:event:event-0001',
sales_item_group=
showcase.SalesItemGroup(
name='step_gem',
metadata='STEP_GEM',
sales_items=[
showcase.SalesItem(
name='step1_gem_1000',
metadata='STEP1_GEM_1000',
consume_actions=[
showcase.ConsumeAction(
action='Gs2Money:InAppPurchase',
request='Gs2Money:InAppPurchase:request'
),
showcase.ConsumeAction(
action='Gs2Limit:CountUpByUserId',
request='Gs2Limit:CountUpByUserId:request'
)
],
acquire_actions=[
showcase.AcquireAction(
action='Gs2Money:DepositByUserId',
request='Gs2Money:DepositByUserId:request'
)
]
),
showcase.SalesItem(
name='step2_gem_2000',
metadata='STEP1_GEM_2000',
consume_actions=[
showcase.ConsumeAction(
action='Gs2Money:InAppPurchase',
request='Gs2Money:InAppPurchase:request'
),
showcase.ConsumeAction(
action='Gs2Limit:CountUpByUserId',
request='Gs2Limit:CountUpByUserId:request'
)
],
acquire_actions=[
showcase.AcquireAction(
action='Gs2Money:DepositByUserId',
request='Gs2Money:DepositByUserId:request'
)
]
)
]
)
),
],
options=showcase.ShowcaseOptions(
metadata='GEM',
),
),
showcase.Showcase(
name='gacha',
display_items=[
showcase.DisplayItem(
type='salesItem',
sales_item=
showcase.SalesItem(
name='single',
metadata='SINGLE',
consume_actions=[
showcase.ConsumeAction(
action='Gs2Money:WithdrawByUserId',
request='{"moneyName": "money-0001", "userId": "{userId}", "slot": "{slot}", "count": 100, "paidOnly": false}'
)
],
acquire_actions=[
showcase.AcquireAction(
action='Gs2Inventory:AcquireItemSetByUserId',
request='{"categoryName": "category-0001", "inventoryModelName": "character", "itemModelName": "ssr-0001", "userId": "{userId}", "acquireCount": 1}'
)
]
)
),
showcase.DisplayItem(
type='salesItem',
sales_item=
showcase.SalesItem(
name='10times',
metadata='10TIMES',
consume_actions=[
showcase.ConsumeAction(
action='Gs2Money:WithdrawByUserId',
request='Gs2Money:WithdrawByUserId:request'
)
],
acquire_actions=[
showcase.AcquireAction(
action='Gs2Inventory:AcquireItemSetByUserId',
request='Gs2Inventory:AcquireItemSetByUserId:request'
),
showcase.AcquireAction(
action='Gs2Inventory:AcquireItemSetByUserId',
request='Gs2Inventory:AcquireItemSetByUserId:request'
),
showcase.AcquireAction(
action='Gs2Inventory:AcquireItemSetByUserId',
request='Gs2Inventory:AcquireItemSetByUserId:request'
),
showcase.AcquireAction(
action='Gs2Inventory:AcquireItemSetByUserId',
request='Gs2Inventory:AcquireItemSetByUserId:request'
),
showcase.AcquireAction(
action='Gs2Inventory:AcquireItemSetByUserId',
request='Gs2Inventory:AcquireItemSetByUserId:request'
),
showcase.AcquireAction(
action='Gs2Inventory:AcquireItemSetByUserId',
request='Gs2Inventory:AcquireItemSetByUserId:request'
),
showcase.AcquireAction(
action='Gs2Inventory:AcquireItemSetByUserId',
request='Gs2Inventory:AcquireItemSetByUserId:request'
),
showcase.AcquireAction(
action='Gs2Inventory:AcquireItemSetByUserId',
request='Gs2Inventory:AcquireItemSetByUserId:request'
),
showcase.AcquireAction(
action='Gs2Inventory:AcquireItemSetByUserId',
request='Gs2Inventory:AcquireItemSetByUserId:request'
),
showcase.AcquireAction(
action='Gs2Inventory:AcquireItemSetByUserId',
request='Gs2Inventory:AcquireItemSetByUserId:request'
)
]
)
),
],
options=showcase.ShowcaseOptions(
metadata='GACHA',
),
),
],
random_showcases=[
],
)
print(SampleStack().yaml()) # Generate Templateclass SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
(new \Gs2Cdk\Showcase\Model\Namespace_(
stack: $this,
// 省略
))->masterData(
[
new \Gs2Cdk\Showcase\Model\Showcase(
name:"gem",
displayItems:[
new \Gs2Cdk\Showcase\Model\DisplayItem(
type: "salesItem",
salesItem:
new \Gs2Cdk\Showcase\Model\SalesItem(
name: "gem_3000",
metadata: "GEM_3000",
consumeActions: [
new \Gs2Cdk\Core\Model\ConsumeAction(
action: "Gs2Money:InAppPurchase",
request: "Gs2Money:InAppPurchase:request"
)
],
acquireActions: [
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Money:DepositByUserId",
request: "Gs2Money:DepositByUserId:request"
)
]
)
),
new \Gs2Cdk\Showcase\Model\DisplayItem(
type: "salesItemGroup",
salesPeriodEventId: "grn:gs2:ap-northeast-1:YourOwnerId:schedule:schedule-0001:event:event-0001",
salesItemGroup:
new \Gs2Cdk\Showcase\Model\SalesItemGroup(
name: "step_gem",
metadata: "STEP_GEM",
salesItems: [
new \Gs2Cdk\Showcase\Model\SalesItem(
name: "step1_gem_1000",
metadata: "STEP1_GEM_1000",
consumeActions: [
new \Gs2Cdk\Core\Model\ConsumeAction(
action: "Gs2Money:InAppPurchase",
request: "Gs2Money:InAppPurchase:request"
),
new \Gs2Cdk\Core\Model\ConsumeAction(
action: "Gs2Limit:CountUpByUserId",
request: "Gs2Limit:CountUpByUserId:request"
)
],
acquireActions: [
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Money:DepositByUserId",
request: "Gs2Money:DepositByUserId:request"
)
]
),
new \Gs2Cdk\Showcase\Model\SalesItem(
name: "step2_gem_2000",
metadata: "STEP1_GEM_2000",
consumeActions: [
new \Gs2Cdk\Core\Model\ConsumeAction(
action: "Gs2Money:InAppPurchase",
request: "Gs2Money:InAppPurchase:request"
),
new \Gs2Cdk\Core\Model\ConsumeAction(
action: "Gs2Limit:CountUpByUserId",
request: "Gs2Limit:CountUpByUserId:request"
)
],
acquireActions: [
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Money:DepositByUserId",
request: "Gs2Money:DepositByUserId:request"
)
]
)
]
)
),
],
options: new \Gs2Cdk\Showcase\Model\Options\ShowcaseOptions(
metadata:"GEM"
)
),
new \Gs2Cdk\Showcase\Model\Showcase(
name:"gacha",
displayItems:[
new \Gs2Cdk\Showcase\Model\DisplayItem(
type: "salesItem",
salesItem:
new \Gs2Cdk\Showcase\Model\SalesItem(
name: "single",
metadata: "SINGLE",
consumeActions: [
new \Gs2Cdk\Core\Model\ConsumeAction(
action: "Gs2Money:WithdrawByUserId",
request: "{\"moneyName\": \"money-0001\", \"userId\": \"{userId}\", \"slot\": \"{slot}\", \"count\": 100, \"paidOnly\": false}"
)
],
acquireActions: [
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "{\"categoryName\": \"category-0001\", \"inventoryModelName\": \"character\", \"itemModelName\": \"ssr-0001\", \"userId\": \"{userId}\", \"acquireCount\": 1}"
)
]
)
),
new \Gs2Cdk\Showcase\Model\DisplayItem(
type: "salesItem",
salesItem:
new \Gs2Cdk\Showcase\Model\SalesItem(
name: "10times",
metadata: "10TIMES",
consumeActions: [
new \Gs2Cdk\Core\Model\ConsumeAction(
action: "Gs2Money:WithdrawByUserId",
request: "Gs2Money:WithdrawByUserId:request"
)
],
acquireActions: [
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "Gs2Inventory:AcquireItemSetByUserId:request"
),
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "Gs2Inventory:AcquireItemSetByUserId:request"
),
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "Gs2Inventory:AcquireItemSetByUserId:request"
),
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "Gs2Inventory:AcquireItemSetByUserId:request"
),
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "Gs2Inventory:AcquireItemSetByUserId:request"
),
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "Gs2Inventory:AcquireItemSetByUserId:request"
),
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "Gs2Inventory:AcquireItemSetByUserId:request"
),
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "Gs2Inventory:AcquireItemSetByUserId:request"
),
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "Gs2Inventory:AcquireItemSetByUserId:request"
),
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "Gs2Inventory:AcquireItemSetByUserId:request"
)
]
)
),
],
options: new \Gs2Cdk\Showcase\Model\Options\ShowcaseOptions(
metadata:"GACHA"
)
)
],
[
]
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.showcase.model.Namespace(
this,
// 省略
).masterData(
Arrays.asList(
new io.gs2.cdk.showcase.model.Showcase(
"gem",
Arrays.asList(
new io.gs2.cdk.showcase.model.DisplayItem(
"salesItem",
new io.gs2.cdk.showcase.model.SalesItem(
"gem_3000",
"GEM_3000",
Arrays.asList(
new io.gs2.cdk.core.consume_action(
"Gs2Money:InAppPurchase",
"Gs2Money:InAppPurchase:request"
)
)
Arrays.asList(
new io.gs2.cdk.core.acquire_action(
"Gs2Money:DepositByUserId",
"Gs2Money:DepositByUserId:request"
)
)
)
),
new io.gs2.cdk.showcase.model.DisplayItem(
"salesItemGroup",
"grn:gs2:ap-northeast-1:YourOwnerId:schedule:schedule-0001:event:event-0001",
new io.gs2.cdk.showcase.model.SalesItemGroup(
"step_gem",
"STEP_GEM",
Arrays.asList(
new io.gs2.cdk.showcase.model.SalesItem(
"step1_gem_1000",
"STEP1_GEM_1000",
Arrays.asList(
new io.gs2.cdk.core.consume_action(
"Gs2Money:InAppPurchase",
"Gs2Money:InAppPurchase:request"
),
new io.gs2.cdk.core.consume_action(
"Gs2Limit:CountUpByUserId",
"Gs2Limit:CountUpByUserId:request"
)
),
Arrays.asList(
new io.gs2.cdk.core.acquire_action(
"Gs2Money:DepositByUserId",
"Gs2Money:DepositByUserId:request"
)
)
),
new io.gs2.cdk.showcase.model.SalesItem(
"step2_gem_2000",
"STEP1_GEM_2000",
Arrays.asList(
new io.gs2.cdk.core.consume_action(
"Gs2Money:InAppPurchase",
"Gs2Money:InAppPurchase:request"
),
new io.gs2.cdk.core.consume_action(
"Gs2Limit:CountUpByUserId",
"Gs2Limit:CountUpByUserId:request"
)
),
Arrays.asList(
new io.gs2.cdk.core.acquire_action(
"Gs2Money:DepositByUserId",
"Gs2Money:DepositByUserId:request"
)
)
)
)
)
)
),
new io.gs2.cdk.showcase.model.options.ShowcaseOptions() {
{
metadata: "GEM";
}
}
),
new io.gs2.cdk.showcase.model.Showcase(
"gacha",
Arrays.asList(
new io.gs2.cdk.showcase.model.DisplayItem(
"salesItem",
new io.gs2.cdk.showcase.model.SalesItem(
"single",
"SINGLE",
Arrays.asList(
new io.gs2.cdk.core.consume_action(
"Gs2Money:WithdrawByUserId",
"{\"moneyName\": \"money-0001\", \"userId\": \"{userId}\", \"slot\": \"{slot}\", \"count\": 100, \"paidOnly\": false}"
)
)
Arrays.asList(
new io.gs2.cdk.core.acquire_action(
"Gs2Inventory:AcquireItemSetByUserId",
"{\"categoryName\": \"category-0001\", \"inventoryModelName\": \"character\", \"itemModelName\": \"ssr-0001\", \"userId\": \"{userId}\", \"acquireCount\": 1}"
)
)
)
),
new io.gs2.cdk.showcase.model.DisplayItem(
"salesItem",
new io.gs2.cdk.showcase.model.SalesItem(
"10times",
"10TIMES",
Arrays.asList(
new io.gs2.cdk.core.consume_action(
"Gs2Money:WithdrawByUserId",
"Gs2Money:WithdrawByUserId:request"
)
)
Arrays.asList(
new io.gs2.cdk.core.acquire_action(
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetByUserId:request"
),
new io.gs2.cdk.core.acquire_action(
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetByUserId:request"
),
new io.gs2.cdk.core.acquire_action(
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetByUserId:request"
),
new io.gs2.cdk.core.acquire_action(
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetByUserId:request"
),
new io.gs2.cdk.core.acquire_action(
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetByUserId:request"
),
new io.gs2.cdk.core.acquire_action(
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetByUserId:request"
),
new io.gs2.cdk.core.acquire_action(
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetByUserId:request"
),
new io.gs2.cdk.core.acquire_action(
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetByUserId:request"
),
new io.gs2.cdk.core.acquire_action(
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetByUserId:request"
),
new io.gs2.cdk.core.acquire_action(
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetByUserId:request"
)
)
)
)
),
new io.gs2.cdk.showcase.model.options.ShowcaseOptions() {
{
metadata: "GACHA";
}
}
)
),
Arrays.asList(
)
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Templateimport core from "@/gs2cdk/core";
import showcase from "@/gs2cdk/showcase";
class SampleStack extends core.Stack
{
public constructor() {
super();
new showcase.model.Namespace(
this,
// 省略
).masterData(
[
new showcase.model.Showcase(
"gem",
[
new showcase.model.DisplayItem(
"salesItem",
new showcase.model.SalesItem(
"gem_3000",
"GEM_3000",
new ConsumeAction[
new ConsumeAction(
"Gs2Money:InAppPurchase",
"Gs2Money:InAppPurchase:request"
)
],
new AcquireAction[
new AcquireAction(
"Gs2Money:DepositByUserId",
"Gs2Money:DepositByUserId:request"
)
]
)
),
new showcase.model.DisplayItem(
"salesItemGroup",
"grn:gs2:ap-northeast-1:YourOwnerId:schedule:schedule-0001:event:event-0001",
new showcase.model.SalesItemGroup(
"step_gem",
"STEP_GEM",
new SalesItem[
new showcase.model.SalesItem(
"step1_gem_1000",
"STEP1_GEM_1000",
new ConsumeAction[
new ConsumeAction(
"Gs2Money:InAppPurchase",
"Gs2Money:InAppPurchase:request"
),
new ConsumeAction(
"Gs2Limit:CountUpByUserId",
"Gs2Limit:CountUpByUserId:request"
)
],
new AcquireAction[
new AcquireAction(
"Gs2Money:DepositByUserId",
"Gs2Money:DepositByUserId:request"
)
]
),
new showcase.model.SalesItem(
"step2_gem_2000",
"STEP1_GEM_2000",
new ConsumeAction[
new ConsumeAction(
"Gs2Money:InAppPurchase",
"Gs2Money:InAppPurchase:request"
),
new ConsumeAction(
"Gs2Limit:CountUpByUserId",
"Gs2Limit:CountUpByUserId:request"
)
],
new AcquireAction[
new AcquireAction(
"Gs2Money:DepositByUserId",
"Gs2Money:DepositByUserId:request"
)
]
)
]
)
),
],
{
metadata: "GEM"
}
),
new showcase.model.Showcase(
"gacha",
[
new showcase.model.DisplayItem(
"salesItem",
new showcase.model.SalesItem(
"single",
"SINGLE",
new ConsumeAction[
new ConsumeAction(
"Gs2Money:WithdrawByUserId",
"{\"moneyName\": \"money-0001\", \"userId\": \"{userId}\", \"slot\": \"{slot}\", \"count\": 100, \"paidOnly\": false}"
)
],
new AcquireAction[
new AcquireAction(
"Gs2Inventory:AcquireItemSetByUserId",
"{\"categoryName\": \"category-0001\", \"inventoryModelName\": \"character\", \"itemModelName\": \"ssr-0001\", \"userId\": \"{userId}\", \"acquireCount\": 1}"
)
]
)
),
new showcase.model.DisplayItem(
"salesItem",
new showcase.model.SalesItem(
"10times",
"10TIMES",
new ConsumeAction[
new ConsumeAction(
"Gs2Money:WithdrawByUserId",
"Gs2Money:WithdrawByUserId:request"
)
],
new AcquireAction[
new AcquireAction(
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetByUserId:request"
),
new AcquireAction(
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetByUserId:request"
),
new AcquireAction(
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetByUserId:request"
),
new AcquireAction(
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetByUserId:request"
),
new AcquireAction(
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetByUserId:request"
),
new AcquireAction(
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetByUserId:request"
),
new AcquireAction(
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetByUserId:request"
),
new AcquireAction(
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetByUserId:request"
),
new AcquireAction(
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetByUserId:request"
),
new AcquireAction(
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetByUserId:request"
)
]
)
),
],
{
metadata: "GACHA"
}
)
],
[
]
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Showcase.Model.Namespace(
this,
// 省略
).MasterData(
new [] {
new Gs2Cdk.Gs2Showcase.Model.Showcase(
"gem",
new Gs2Cdk.Gs2Showcase.Model.DisplayItem[] {
new Gs2Cdk.Gs2Showcase.Model.DisplayItem(
type: "salesItem",
salesItem:
new Gs2Cdk.Gs2Showcase.Model.SalesItem(
name: "gem_3000",
metadata: "GEM_3000",
consumeActions: new Gs2Cdk.Core.Model.ConsumeAction[] {
new Gs2Cdk.Core.Model.ConsumeAction(
action: "Gs2Money:InAppPurchase",
request: "Gs2Money:InAppPurchase:request"
)
}
acquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Money:DepositByUserId",
request: "Gs2Money:DepositByUserId:request"
)
}
)
),
new Gs2Cdk.Gs2Showcase.Model.DisplayItem(
type: "salesItemGroup",
salesPeriodEventId: "grn:gs2:ap-northeast-1:YourOwnerId:schedule:schedule-0001:event:event-0001",
salesItemGroup:
new Gs2Cdk.Gs2Showcase.Model.SalesItemGroup(
name: "step_gem",
metadata: "STEP_GEM",
salesItems: new Gs2Cdk.Gs2Showcase.Model.SalesItem[] {
new Gs2Cdk.Gs2Showcase.Model.SalesItem(
name: "step1_gem_1000",
metadata: "STEP1_GEM_1000",
consumeActions: new Gs2Cdk.Core.Model.ConsumeAction[] {
new Gs2Cdk.Core.Model.ConsumeAction(
action: "Gs2Money:InAppPurchase",
request: "Gs2Money:InAppPurchase:request"
),
new Gs2Cdk.Core.Model.ConsumeAction(
action: "Gs2Limit:CountUpByUserId",
request: "Gs2Limit:CountUpByUserId:request"
)
},
acquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Money:DepositByUserId",
request: "Gs2Money:DepositByUserId:request"
)
}
),
new Gs2Cdk.Gs2Showcase.Model.SalesItem(
name: "step2_gem_2000",
metadata: "STEP1_GEM_2000",
consumeActions: new Gs2Cdk.Core.Model.ConsumeAction[] {
new Gs2Cdk.Core.Model.ConsumeAction(
action: "Gs2Money:InAppPurchase",
request: "Gs2Money:InAppPurchase:request"
),
new Gs2Cdk.Core.Model.ConsumeAction(
action: "Gs2Limit:CountUpByUserId",
request: "Gs2Limit:CountUpByUserId:request"
)
},
acquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Money:DepositByUserId",
request: "Gs2Money:DepositByUserId:request"
)
}
)
}
)
),
},
new Gs2Cdk.Gs2Showcase.Model.Options.ShowcaseOptions {
metadata = "GEM"
}
),
new Gs2Cdk.Gs2Showcase.Model.Showcase(
"gacha",
new Gs2Cdk.Gs2Showcase.Model.DisplayItem[] {
new Gs2Cdk.Gs2Showcase.Model.DisplayItem(
type: "salesItem",
salesItem:
new Gs2Cdk.Gs2Showcase.Model.SalesItem(
name: "single",
metadata: "SINGLE",
consumeActions: new Gs2Cdk.Core.Model.ConsumeAction[] {
new Gs2Cdk.Core.Model.ConsumeAction(
action: "Gs2Money:WithdrawByUserId",
request: "{\"moneyName\": \"money-0001\", \"userId\": \"{userId}\", \"slot\": \"{slot}\", \"count\": 100, \"paidOnly\": false}"
)
}
acquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "{\"categoryName\": \"category-0001\", \"inventoryModelName\": \"character\", \"itemModelName\": \"ssr-0001\", \"userId\": \"{userId}\", \"acquireCount\": 1}"
)
}
)
),
new Gs2Cdk.Gs2Showcase.Model.DisplayItem(
type: "salesItem",
salesItem:
new Gs2Cdk.Gs2Showcase.Model.SalesItem(
name: "10times",
metadata: "10TIMES",
consumeActions: new Gs2Cdk.Core.Model.ConsumeAction[] {
new Gs2Cdk.Core.Model.ConsumeAction(
action: "Gs2Money:WithdrawByUserId",
request: "Gs2Money:WithdrawByUserId:request"
)
}
acquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "Gs2Inventory:AcquireItemSetByUserId:request"
),
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "Gs2Inventory:AcquireItemSetByUserId:request"
),
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "Gs2Inventory:AcquireItemSetByUserId:request"
),
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "Gs2Inventory:AcquireItemSetByUserId:request"
),
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "Gs2Inventory:AcquireItemSetByUserId:request"
),
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "Gs2Inventory:AcquireItemSetByUserId:request"
),
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "Gs2Inventory:AcquireItemSetByUserId:request"
),
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "Gs2Inventory:AcquireItemSetByUserId:request"
),
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "Gs2Inventory:AcquireItemSetByUserId:request"
),
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "Gs2Inventory:AcquireItemSetByUserId:request"
)
}
)
),
},
new Gs2Cdk.Gs2Showcase.Model.Options.ShowcaseOptions {
metadata = "GACHA"
}
)
},
new [] {
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate TemplateDisplayItemMaster
陳列する商品のマスターデータ
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| displayItemId | string | ✓ | UUID | ~ 128文字 | 陳列商品ID |
| type | enum [ “salesItem”, “salesItemGroup” ] | ✓ | ~ 128文字 | 種類 | |
| salesItemName | string | {type} == “salesItem” | ~ 128文字 | 陳列する商品の名前 | |
| salesItemGroupName | string | {type} == “salesItemGroup” | ~ 128文字 | 陳列する商品グループの名前 | |
| salesPeriodEventId | string | ~ 1024文字 | 商品の販売期間を設定した GS2-Schedule のイベント | ||
| revision | long | 0 | ~ 9223372036854775805 | リビジョン |
PurchaseCount
商品の購入回数
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| name | string | ✓ | ~ 128文字 | ランダム陳列商品名 | |
| count | int | ✓ | 1 ~ 2147483646 | 購入回数 |
RandomDisplayItem
ランダム陳列棚に陳列された商品
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| showcaseName | string | ✓ | ~ 128文字 | ランダム陳列棚名 | |
| name | string | ✓ | UUID | ~ 128文字 | ランダム陳列商品ID |
| metadata | string | ~ 2048文字 | メタデータ | ||
| verifyActions | List<VerifyAction> | ~ 10 items | 検証アクションリスト | ||
| consumeActions | List<ConsumeAction> | ~ 10 items | 消費アクションリスト | ||
| acquireActions | List<AcquireAction> | ✓ | 1 ~ 100 items | 入手アクションリスト | |
| currentPurchaseCount | int | ✓ | 1 ~ 2147483646 | 現在の購入回数 | |
| maximumPurchaseCount | int | ✓ | 1 ~ 2147483646 | 最大購入回数 |
RandomDisplayItemModel
ランダム陳列棚に陳列可能な商品
weight に商品を選別する確率を設定できます。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| name | string | ✓ | UUID | ~ 128文字 | ランダム陳列商品ID |
| metadata | string | ~ 2048文字 | メタデータ | ||
| verifyActions | List<VerifyAction> | ~ 10 items | 検証アクションリスト | ||
| consumeActions | List<ConsumeAction> | ~ 10 items | 消費アクションリスト | ||
| acquireActions | List<AcquireAction> | ✓ | 1 ~ 100 items | 入手アクションリスト | |
| stock | int | ✓ | 1 ~ 2147483646 | 在庫数 | |
| weight | int | ✓ | 1 ~ 2147483646 | 排出重み |
ConsumeAction
消費アクション
VerifyAction
検証アクション
AcquireAction
入手アクション
Config
コンフィグ設定
スタンプシートの変数に適用する設定値
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| key | string | ✓ | ~ 64文字 | 名前 | |
| value | string | ~ 51200文字 | 値 |
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文字 | タグ名 |
LogSetting
ログの書き出し設定
ログデータの書き出し設定を管理します。この型は、ログデータを書き出すために使用されるログ名前空間の識別子（Namespace ID）を保持します。 ログ名前空間IDは、ログデータを集約し、保存する対象の GS2-Log の名前空間を指定します。 この設定を通じて、この名前空間以下のAPIリクエスト・レスポンスログデータが対象の GS2-Log へ出力されるようになります。 GS2-Log にはリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| loggingNamespaceId | string | ✓ | ~ 1024文字 | ネームスペースGRN |
TransactionSetting
トランザクション設定
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| enableAutoRun | bool | ✓ | false | 発行したスタンプシートをサーバーサイドで自動的に実行するか | |
| distributorNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:distributor:default” | ~ 1024文字 | スタンプシートの実行に使用する GS2-Distributor のネームスペースGRN |
| queueNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:queue:default” | ~ 1024文字 | スタンプシートの実行に使用する GS2-JobQueue のネームスペースGRN |
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 |