GS2-Mission GS2-Deploy/CDK リファレンス
エンティティ
Namespace
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。 GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
name | string | ✓ | ~ 32文字 | ネームスペース名 | |
description | string | ~ 1024文字 | 説明文 | ||
transactionSetting | TransactionSetting | ✓ | トランザクション設定 | ||
missionCompleteScript | ScriptSetting | ミッションを達成したときに実行するスクリプト | |||
counterIncrementScript | ScriptSetting | カウンターを上昇したときに実行するスクリプト | |||
receiveRewardsScript | ScriptSetting | 報酬を受け取ったときに実行するスクリプト | |||
completeNotification | NotificationSetting | ミッションのタスクを達成したときのプッシュ通知 | |||
logSetting | LogSetting | ログの出力設定 |
GetAttr
型 | 説明 | |
---|---|---|
Item | Namespace | 作成したネームスペース |
実装例
Type: GS2::Mission::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
MissionCompleteScript: null
CounterIncrementScript: null
ReceiveRewardsScript: null
CompleteNotification: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
from gs2_cdk import Stack, core, mission
class SampleStack(Stack):
def __init__(self):
super().__init__()
mission.Namespace(
stack=self,
name="namespace-0001",
transaction_setting=core.TransactionSetting(
enable_auto_run=False,
queue_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001',
options=core.TransactionSettingOptions(
distributor_namespace_id=,
key_id='grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001',
)
),
options=mission.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\Mission\Model\Namespace_(
stack: $this,
name: "namespace-0001",
transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
enableAutoRun: False,
queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
options: new \Gs2Cdk\Core\Model\Options\TransactionSettingOptions(
distributorNamespaceId: ,
keyId: "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
)
),
options: new \Gs2Cdk\Mission\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.mission.model.Namespace(
this,
"namespace-0001",
new io.gs2.cdk.core.model.TransactionSetting(
false,
"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"
)
),
new io.gs2.cdk.mission.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 mission from "@/gs2cdk/mission";
class SampleStack extends core.Stack
{
public constructor() {
super();
new mission.model.Namespace(
this,
"namespace-0001",
new core.TransactionSetting(
false,
"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"
)
}
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Mission.Model.Namespace(
this,
"namespace-0001",
new Gs2Cdk.Core.Model.TransactionSetting(
false,
"grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
new Gs2Cdk.Core.Model.Options.TransactionSettingOptions(
DistributorNamespaceId = ,
KeyId = "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
}
),
new Gs2Cdk.Gs2Mission.Model.Options.NamespaceOptions {
logSetting = new Gs2Cdk.Core.Model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
),
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
CurrentMissionMaster
現在有効なマスターデータ
GS2ではマスターデータの管理にJSON形式のファイルを使用します。 ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
JSONファイルの形式についてはドキュメントを参照ください。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | |
settings | string | ✓ | ~ 5242880文字 | マスターデータ |
GetAttr
型 | 説明 | |
---|---|---|
Item | CurrentMissionMaster | 更新した現在有効なミッションマスター |
実装例
Type: GS2::Mission::CurrentMissionMaster
Properties:
NamespaceName: namespace1
Settings: {
"version": "2019-05-28",
"groups": [
{
"name": "daily",
"metadata": "DAILY",
"tasks": [
{
"name": "quest_x10",
"metadata": "QUEST_X10",
"counterName": "quest_complete",
"targetValue": 10,
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": "{\\"experienceName\\": \\"basic\\", \\"userId\\": \\"#{userId}\\", \\"experienceModelName\\": \\"player\\", \\"propertyId\\": \\"player\\", \\"experienceValue\\": 10}"
}
]
},
{
"name": "quest_x20",
"metadata": "QUEST_X20",
"counterName": "quest_complete",
"premiseMissionTaskName": "quest_x10",
"targetValue": 20,
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": "{\\"experienceName\\": \\"basic\\", \\"userId\\": \\"#{userId}\\", \\"experienceModelName\\": \\"player\\", \\"propertyId\\": \\"player\\", \\"experienceValue\\": 20}"
}
]
},
{
"name": "gacha",
"metadata": "GACHA",
"counterName": "lot_gacha",
"targetValue": 1,
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": "{\\"experienceName\\": \\"basic\\", \\"userId\\": \\"#{userId}\\", \\"experienceModelName\\": \\"player\\", \\"propertyId\\": \\"player\\", \\"experienceValue\\": 30}"
}
]
}
],
"resetType": "daily",
"resetHour": 10
},
{
"name": "weekly",
"metadata": "WEEKLY",
"tasks": [
{
"name": "quest_x100",
"metadata": "QUEST_X100",
"counterName": "quest_complete",
"targetValue": 100,
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": "{\\"experienceName\\": \\"basic\\", \\"userId\\": \\"#{userId}\\", \\"experienceModelName\\": \\"player\\", \\"propertyId\\": \\"player\\", \\"experienceValue\\": 40}"
}
]
},
{
"name": "quest_x1000",
"metadata": "QUEST_X1000",
"counterName": "quest_complete",
"premiseMissionTaskName": "quest_x100",
"targetValue": 1000,
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": "{\\"experienceName\\": \\"basic\\", \\"userId\\": \\"#{userId}\\", \\"experienceModelName\\": \\"player\\", \\"propertyId\\": \\"player\\", \\"experienceValue\\": 50}"
}
]
}
],
"resetType": "weekly",
"resetDayOfWeek": "monday",
"resetHour": 10
},
{
"name": "story",
"metadata": "STORY",
"tasks": [
{
"name": "quest_1-1",
"metadata": "QUEST_1-1",
"counterName": "quest1",
"targetValue": 1
},
{
"name": "quest_1-2",
"metadata": "QUEST_1-2",
"counterName": "quest1",
"premiseMissionTaskName": "quest_1-1",
"targetValue": 1
},
{
"name": "quest_1-3",
"metadata": "QUEST_1-3",
"counterName": "quest1",
"premiseMissionTaskName": "quest_1-2",
"targetValue": 1
},
{
"name": "quest_1-4",
"metadata": "QUEST_1-4",
"counterName": "quest1",
"premiseMissionTaskName": "quest_1-3",
"targetValue": 1
},
{
"name": "quest_2-1",
"metadata": "QUEST_2-1",
"counterName": "quest2",
"premiseMissionTaskName": "quest_1-4",
"targetValue": 1
}
],
"resetType": "notReset"
}
],
"counters": [
{
"name": "quest_complete",
"metadata": "QUEST_COMPLETE",
"scopes": [
{
"resetType": "daily",
"resetHour": 5
},
{
"resetType": "weekly",
"resetDayOfWeek": "monday",
"resetHour": 5
}
]
},
{
"name": "lot_gacha",
"metadata": "LOT_GACHA",
"scopes": [
{
"resetType": "daily",
"resetHour": 5
}
]
},
{
"name": "quest1",
"metadata": "QUEST1",
"scopes": [
{
"resetType": "notReset"
}
]
},
{
"name": "quest2",
"metadata": "QUEST2",
"scopes": [
{
"resetType": "notReset"
}
]
}
]
}
from gs2_cdk import Stack, core, mission
class SampleStack(Stack):
def __init__(self):
super().__init__()
mission.Namespace(
stack=self,
# 省略
).master_data(
[
],
[
],
)
print(SampleStack().yaml()) # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
(new \Gs2Cdk\Mission\Model\Namespace_(
stack: $this,
// 省略
))->masterData(
[
],
[
],
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.mission.model.Namespace(
this,
// 省略
).masterData(
Arrays.asList(
),
Arrays.asList(
)
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
import core from "@/gs2cdk/core";
import mission from "@/gs2cdk/mission";
class SampleStack extends core.Stack
{
public constructor() {
super();
new mission.model.Namespace(
this,
// 省略
).masterData(
[
],
[
]
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Mission.Model.Namespace(
this,
// 省略
).MasterData(
new [] {
},
new [] {
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
NotificationSetting
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
gatewayNamespaceId | string | ✓ | ~ 1024文字 | ネームスペースGRN | |
enableTransferMobileNotification | bool? | モバイルプッシュ通知へ転送するか | |||
sound | string | ~ 1024文字 | モバイルプッシュ通知で使用するサウンドファイル名 |
CounterScopeModel
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
resetType | enum [’notReset’, ‘daily’, ‘weekly’, ‘monthly’] | ✓ | ~ 128文字 | リセットタイミング | |
resetDayOfMonth | int | {resetType} == “monthly” | 1 ~ 31 | リセットをする日にち | |
resetDayOfWeek | enum [‘sunday’, ‘monday’, ’tuesday’, ‘wednesday’, ’thursday’, ‘friday’, ‘saturday’] | {resetType} == “weekly” | ~ 128文字 | リセットする曜日 | |
resetHour | int | {resetType} in [“monthly”, “weekly”, “daily”] | ~ 23 | リセット時刻 |
ScopedValue
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
resetType | enum [’notReset’, ‘daily’, ‘weekly’, ‘monthly’] | ✓ | ~ 128文字 | リセットタイミング | |
value | long | ✓ | 0 | ~ 9223372036854775806 | カウント |
nextResetAt | long | 次回リセットタイミング | |||
updatedAt | long | ✓ | 最終更新日時 |
AcquireAction
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
action | enum [] | ✓ | ~ 128文字 | スタンプシートを使用して実行するアクションの種類 | |
request | string | ✓ | ~ 1048576文字 | リクエストのJSON |
Config
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
key | string | ~ 64文字 | 名前 | ||
value | string | ~ 51200文字 | 値 |
LogSetting
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
loggingNamespaceId | string | ✓ | ~ 1024文字 | ネームスペースGRN |
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 |
TransactionSetting
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
enableAutoRun | bool | ✓ | false | 発行したスタンプシートをサーバーサイドで自動的に実行するか | |
distributorNamespaceId | string | {enableAutoRun} | ~ 1024文字 | スタンプシートの実行に使用する GS2-Distributor ネームスペース | |
keyId | string | !{enableAutoRun} | ~ 1024文字 | スタンプシートの署名に使用する GS2-Key の暗号鍵 | |
queueNamespaceId | string | ✓ | ~ 1024文字 | スタンプシートの実行に使用する GS2-JobQueue のネームスペース |