GS2-Enhance GS2-Deploy/CDK リファレンス
エンティティ
Namespace
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。
GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
name | string | ✓ | ~ 128文字 | ネームスペース名 | |
description | string | ~ 1024文字 | 説明文 | ||
transactionSetting | TransactionSetting | ✓ | トランザクション設定 | ||
enhanceScript | ScriptSetting | 強化時に実行するスクリプト | |||
logSetting | LogSetting | ログの出力設定 |
GetAttr
型 | 説明 | |
---|---|---|
Item | Namespace | 作成したネームスペース |
実装例
Type: GS2::Enhance::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
EnhanceScript: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
from gs2_cdk import Stack, core, enhance
class SampleStack(Stack):
def __init__(self):
super().__init__()
enhance.Namespace(
stack=self,
name="namespace-0001",
options=enhance.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\Enhance\Model\Namespace_(
stack: $this,
name: "namespace-0001",
options: new \Gs2Cdk\Enhance\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.enhance.model.Namespace(
this,
"namespace-0001",
new io.gs2.cdk.enhance.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 enhance from "@/gs2cdk/enhance";
class SampleStack extends core.Stack
{
public constructor() {
super();
new enhance.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.Gs2Enhance.Model.Namespace(
this,
"namespace-0001",
new Gs2Cdk.Gs2Enhance.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
CurrentRateMaster
現在有効な強化レートマスター
GS2ではマスターデータの管理にJSON形式のファイルを使用します。
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが
よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
Note
JSONファイルの形式については GS2-Enhance マスターデータリファレンス をご参照ください。型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 | |
settings | string | ✓ | ~ 5242880文字 | マスターデータ |
GetAttr
型 | 説明 | |
---|---|---|
Item | CurrentRateMaster | 更新した現在有効な強化レート設定 |
実装例
Type: GS2::Enhance::CurrentRateMaster
Properties:
NamespaceName: namespace1
Settings: {
"version": "2020-08-22",
"rateModels": [
{
"name": "character-friendly",
"targetInventoryModelId": "grn:inventory:character",
"acquireExperienceSuffix": ":friendly",
"materialInventoryModelId": "grn:inventory:sweet",
"experienceModelId": "grn:experience:friendly",
"metadata": "CHARACTER_FRIENDLY",
"acquireExperienceHierarchy": [
"taste"
],
"bonusRates": [
{
"rate": 1,
"weight": 90
}
]
},
{
"name": "character-level",
"targetInventoryModelId": "grn:inventory:character",
"acquireExperienceSuffix": ":level",
"materialInventoryModelId": "grn:inventory:material",
"experienceModelId": "grn:experience:level",
"metadata": "CHARACTER_LEVEL",
"acquireExperienceHierarchy": [
"experience"
],
"bonusRates": [
{
"rate": 1,
"weight": 90
},
{
"rate": 1.5,
"weight": 9
},
{
"rate": 2,
"weight": 1
}
]
}
],
"unleashRateModels": [
]
}
from gs2_cdk import Stack, core, enhance
class SampleStack(Stack):
def __init__(self):
super().__init__()
enhance.Namespace(
stack=self,
# 省略
).master_data(
rate_models=[
enhance.RateModel(
name='character-friendly',
target_inventory_model_id='grn:inventory:character',
acquire_experience_suffix=':friendly',
material_inventory_model_id='grn:inventory:sweet',
experience_model_id='grn:experience:friendly',
options=enhance.RateModelOptions(
metadata='CHARACTER_FRIENDLY',
acquire_experience_hierarchy=[
'taste',
],
bonus_rates=[
enhance.BonusRate(
rate=1,
weight=90
),
],
),
),
enhance.RateModel(
name='character-level',
target_inventory_model_id='grn:inventory:character',
acquire_experience_suffix=':level',
material_inventory_model_id='grn:inventory:material',
experience_model_id='grn:experience:level',
options=enhance.RateModelOptions(
metadata='CHARACTER_LEVEL',
acquire_experience_hierarchy=[
'experience',
],
bonus_rates=[
enhance.BonusRate(
rate=1,
weight=90
),
enhance.BonusRate(
rate=1.5,
weight=9
),
enhance.BonusRate(
rate=2,
weight=1
),
],
),
),
],
unleash_rate_models=[
],
)
print(SampleStack().yaml()) # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
(new \Gs2Cdk\Enhance\Model\Namespace_(
stack: $this,
// 省略
))->masterData(
[
new \Gs2Cdk\Enhance\Model\RateModel(
name:"character-friendly",
targetInventoryModelId:"grn:inventory:character",
acquireExperienceSuffix:":friendly",
materialInventoryModelId:"grn:inventory:sweet",
experienceModelId:"grn:experience:friendly",
options: new \Gs2Cdk\Enhance\Model\Options\RateModelOptions(
metadata:"CHARACTER_FRIENDLY",
acquireExperienceHierarchy:[
"taste",
],
bonusRates:[
new \Gs2Cdk\Enhance\Model\BonusRate(
rate: 1,
weight: 90
),
]
)
),
new \Gs2Cdk\Enhance\Model\RateModel(
name:"character-level",
targetInventoryModelId:"grn:inventory:character",
acquireExperienceSuffix:":level",
materialInventoryModelId:"grn:inventory:material",
experienceModelId:"grn:experience:level",
options: new \Gs2Cdk\Enhance\Model\Options\RateModelOptions(
metadata:"CHARACTER_LEVEL",
acquireExperienceHierarchy:[
"experience",
],
bonusRates:[
new \Gs2Cdk\Enhance\Model\BonusRate(
rate: 1,
weight: 90
),
new \Gs2Cdk\Enhance\Model\BonusRate(
rate: 1.5,
weight: 9
),
new \Gs2Cdk\Enhance\Model\BonusRate(
rate: 2,
weight: 1
),
]
)
)
],
[
]
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.enhance.model.Namespace(
this,
// 省略
).masterData(
Arrays.asList(
new io.gs2.cdk.enhance.model.RateModel(
"character-friendly",
"grn:inventory:character",
":friendly",
"grn:inventory:sweet",
"grn:experience:friendly",
new io.gs2.cdk.enhance.model.options.RateModelOptions() {
{
metadata: "CHARACTER_FRIENDLY";
acquireExperienceHierarchy: Arrays.asList(
"taste"
);
bonusRates: Arrays.asList(
new io.gs2.cdk.enhance.model.BonusRate(
1f,
90
)
);
}
}
),
new io.gs2.cdk.enhance.model.RateModel(
"character-level",
"grn:inventory:character",
":level",
"grn:inventory:material",
"grn:experience:level",
new io.gs2.cdk.enhance.model.options.RateModelOptions() {
{
metadata: "CHARACTER_LEVEL";
acquireExperienceHierarchy: Arrays.asList(
"experience"
);
bonusRates: Arrays.asList(
new io.gs2.cdk.enhance.model.BonusRate(
1f,
90
),
new io.gs2.cdk.enhance.model.BonusRate(
1.5f,
9
),
new io.gs2.cdk.enhance.model.BonusRate(
2f,
1
)
);
}
}
)
),
Arrays.asList(
)
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
import core from "@/gs2cdk/core";
import enhance from "@/gs2cdk/enhance";
class SampleStack extends core.Stack
{
public constructor() {
super();
new enhance.model.Namespace(
this,
// 省略
).masterData(
[
new enhance.model.RateModel(
"character-friendly",
"grn:inventory:character",
":friendly",
"grn:inventory:sweet",
"grn:experience:friendly",
{
metadata: "CHARACTER_FRIENDLY",
acquireExperienceHierarchy: [
"taste",
],
bonusRates: [
new enhance.model.BonusRate(
1,
90
),
]
}
),
new enhance.model.RateModel(
"character-level",
"grn:inventory:character",
":level",
"grn:inventory:material",
"grn:experience:level",
{
metadata: "CHARACTER_LEVEL",
acquireExperienceHierarchy: [
"experience",
],
bonusRates: [
new enhance.model.BonusRate(
1,
90
),
new enhance.model.BonusRate(
1.5,
9
),
new enhance.model.BonusRate(
2,
1
),
]
}
)
],
[
]
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Enhance.Model.Namespace(
this,
// 省略
).MasterData(
new [] {
new Gs2Cdk.Gs2Enhance.Model.RateModel(
"character-friendly",
"grn:inventory:character",
":friendly",
"grn:inventory:sweet",
"grn:experience:friendly",
new Gs2Cdk.Gs2Enhance.Model.Options.RateModelOptions {
metadata = "CHARACTER_FRIENDLY",
acquireExperienceHierarchy = new string[] {
"taste",
},
bonusRates = new Gs2Cdk.Gs2Enhance.Model.BonusRate[] {
new Gs2Cdk.Gs2Enhance.Model.BonusRate(
rate: 1f,
weight: 90
),
}
}
),
new Gs2Cdk.Gs2Enhance.Model.RateModel(
"character-level",
"grn:inventory:character",
":level",
"grn:inventory:material",
"grn:experience:level",
new Gs2Cdk.Gs2Enhance.Model.Options.RateModelOptions {
metadata = "CHARACTER_LEVEL",
acquireExperienceHierarchy = new string[] {
"experience",
},
bonusRates = new Gs2Cdk.Gs2Enhance.Model.BonusRate[] {
new Gs2Cdk.Gs2Enhance.Model.BonusRate(
rate: 1f,
weight: 90
),
new Gs2Cdk.Gs2Enhance.Model.BonusRate(
rate: 1.5f,
weight: 9
),
new Gs2Cdk.Gs2Enhance.Model.BonusRate(
rate: 2f,
weight: 1
),
}
}
)
},
new [] {
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
BonusRate
経験値獲得量ボーナス
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
rate | float | ✓ | 1.0 | ~ 10000 | 経験値ボーナスの倍率(1.0=ボーナスなし) |
weight | int | ✓ | 1 | ~ 2147483645 | 抽選重み |
Material
強化素材
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
materialItemSetId | string | ✓ | ~ 1024文字 | 有効期限ごとのアイテム所持数量GRN | |
count | int | ✓ | 1 | ~ 2147483645 | 消費数量 |
UnleashRateEntryModel
限界突破レートエントリモデル
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
gradeValue | long | ✓ | 1 ~ 1000 | 対象グレード | |
needCount | int | ✓ | 1 ~ 1000 | 同種のアイテムを何個消費するか |
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文字 | タグ名 |
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 |
TransactionSetting
トランザクション設定
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
enableAutoRun | bool | ✓ | false | 発行したトランザクションをサーバーサイドで自動的に実行するか | |
distributorNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:distributor:default” | ~ 1024文字 | トランザクションの実行に使用する GS2-Distributor ネームスペース |
queueNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:queue:default” | ~ 1024文字 | トランザクションの実行に使用する GS2-JobQueue のネームスペース |