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

GS2-Deployのスタックの作成に使用するテンプレートのフォーマットと、CDKによる各種言語のテンプレート出力の実装例
Tags:

エンティティ

Namespace

ネームスペース

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

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

型有効化条件必須デフォルト値の制限説明
namestring
✓
~ 128文字ネームスペース名
descriptionstring~ 1024文字説明文
transactionSettingTransactionSettingトランザクション設定
admobAdMobAdMob の設定
unityAdUnityAdUnity Ads の設定
appLovinMaxesList<AppLovinMax>0 ~ 10 itemsAppLovin MAX の設定
acquirePointScriptScriptSettingポイント入手時に実行するスクリプト
consumePointScriptScriptSettingポイント消費時に実行するスクリプト
changePointNotificationNotificationSetting
✓
広告視聴によりポイントが変動した時のプッシュ通知
logSettingLogSettingログの出力設定

GetAttr

!GetAttrタグで取得可能なリソースの生成結果

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

実装例

Type: GS2::AdReward::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSetting: null
  Admob: 
    AllowAdUnitIds: 
    - 1
    - 2
    - 3
  UnityAd: 
    Keys: 
    - key-0001
    - key-0002
  AppLovinMaxes: null
  AcquirePointScript: null
  ConsumePointScript: null
  ChangePointNotification: 
    GatewayNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace-0001
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001
import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/adReward"
    "github.com/openlyinc/pointy"
)

SampleStack := core.NewStack()
adReward.NewNamespace(
    &SampleStack,
    "namespace-0001",
    adReward.NamespaceOptions{
        Admob: &adReward.AdMob{
            AllowAdUnitIds: []string{
                "1",
                "2",
                "3",
            },
        },
        UnityAd: &adReward.UnityAd{
            Keys: []string{
                "key-0001",
                "key-0002",
            },
        },
        ChangePointNotification: core.NewNotificationSetting(
            core.NotificationSettingOptions{
                GatewayNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace-0001"),
            },
        ),
        LogSetting: &core.LogSetting{
            LoggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
        },
    },
)

println(SampleStack.Yaml())  // Generate Template

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        new \Gs2Cdk\AdReward\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\AdReward\Model\Options\NamespaceOptions(
                admob: new \Gs2Cdk\AdReward\Model\AdMob(
                    allowAdUnitIds: [
                        "1",
                        "2",
                        "3",
                    ]
                ),
                unityAd: new \Gs2Cdk\AdReward\Model\UnityAd(
                    options: new \Gs2Cdk\AdReward\Model\Options\UnityAdOptions(
                        keys: [
                            "key-0001",
                            "key-0002",
                        ]
                    )
                ),
                changePointNotification: new \Gs2Cdk\Core\Model\NotificationSetting(
                    new \Gs2Cdk\Core\Model\NotificationSettingOptions(
                        gatewayNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace-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.adReward.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.adReward.model.options.NamespaceOptions()
                        .withAdmob(new io.gs2.cdk.adReward.model.AdMob(
                            Arrays.asList(
                                "1",
                                "2",
                                "3"
                            )
                        ))
                        .withUnityAd(new io.gs2.cdk.adReward.model.UnityAd(
                            new io.gs2.cdk.adReward.model.options.UnityAdOptions()
                                .withKeys(
                                    Arrays.asList(
                                        "key-0001",
                                        "key-0002"
                                    )
                                )
                        ))
                        .withChangePointNotification(new io.gs2.cdk.core.model.NotificationSetting(
                            new io.gs2.cdk.core.model.options.NotificationSettingOptions()
                                .withGatewayNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace-0001")
                        ))
                        .withLogSetting(new io.gs2.cdk.core.model.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.Gs2AdReward.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: new Gs2Cdk.Gs2AdReward.Model.Options.NamespaceOptions
            {
                admob = new Gs2Cdk.Gs2AdReward.Model.AdMob(
                    allowAdUnitIds: new string[]
                    {
                        "1",
                        "2",
                        "3"
                    }
                ),
                unityAd = new Gs2Cdk.Gs2AdReward.Model.UnityAd(
                    options: new Gs2Cdk.Gs2AdReward.Model.Options.UnityAdOptions
                    {
                        keys = new string[]
                        {
                            "key-0001",
                            "key-0002"
                        }
                    }
                ),
                changePointNotification = new Gs2Cdk.Core.Model.NotificationSetting(
                    options: new Gs2Cdk.Core.Model.NotificationSettingOptions
                    {
                        gatewayNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace-0001"
                    }
                ),
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template
import core from "@/gs2cdk/core";
import adReward from "@/gs2cdk/adReward";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new adReward.model.Namespace(
            this,
            "namespace-0001",
            {
                admob: new adReward.model.AdMob(
                    [
                        "1",
                        "2",
                        "3",
                    ]
                ),
                unityAd: new adReward.model.UnityAd(
                    {
                        keys:
                        [
                            "key-0001",
                            "key-0002",
                        ]
                    }
                ),
                changePointNotification: new core.NotificationSetting(
                    {
                        gatewayNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace-0001"
                    }
                ),
                logSetting: new core.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

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

from gs2_cdk import Stack, core, ad_reward

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        ad_reward.Namespace(
            stack=self,
            name='namespace-0001',
            options=ad_reward.NamespaceOptions(
                admob=ad_reward.AdMob(
                    allow_ad_unit_ids=[
                        '1',
                        '2',
                        '3',
                    ],
                ),
                unity_ad=ad_reward.UnityAd(
                    options=ad_reward.UnityAdOptions(
                        keys=[
                            'key-0001',
                            'key-0002',
                        ],
                    )
                ),
                change_point_notification=core.NotificationSetting(
                    options=core.NotificationSettingOptions(
                        gateway_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace-0001',
                    )
                ),
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

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

AdMob

AdMob 広告プラットフォームに関連する設定

許可された広告ユニットIDのリストを保持し、これに基づいて Ad Mob からの視聴完了 WebHook の検証を行います。

型有効化条件必須デフォルト値の制限説明
allowAdUnitIdsList<string>
✓
1 ~ 10 items許可する広告ユニットIDリスト

UnityAd

Unity Ads 広告プラットフォームに関連する設定

アプリケーションやゲームで使用されるUnity Ads関連の暗号鍵を保持するために使用されます。
暗号鍵はUnity Adsから発行され、広告視聴の完了を検証する際に使用します。

型有効化条件必須デフォルト値の制限説明
keysList<string>0 ~ 10 items暗号鍵のリスト

AppLovinMax

AppLovin MAX 広告プラットフォームに関連する設定

許可された広告ユニットIDのリストを保持し、これに基づいて AppLovin MAX からの視聴完了 WebHook の検証を行います。

型有効化条件必須デフォルト値の制限説明
allowAdUnitIdstring
✓
~ 16文字許可する広告ユニットID
eventKeystring
✓
~ 128文字AppLovin Event Key

ScriptSetting

スクリプト設定

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

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

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

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

型有効化条件必須デフォルト値の制限説明
triggerScriptIdstring~ 1024文字処理時に実行するスクリプト
doneTriggerTargetType文字列列挙型
enum {
  “none”,
  “gs2_script”,
  “aws”
}
✓
“none”~ 128文字完了通知の通知先
定義説明
“none”なし
“gs2_script”GS2-Script
“aws”Amazon EventBridge
doneTriggerScriptIdstring{doneTriggerTargetType} == “gs2_script”~ 1024文字完了時に実行するスクリプト
doneTriggerTargetType が “gs2_script” であれば有効
doneTriggerQueueNamespaceIdstring{doneTriggerTargetType} == “gs2_script”~ 1024文字完了時のスクリプトを実行するためのジョブキューのネームスペース
doneTriggerTargetType が “gs2_script” であれば有効

NotificationSetting

プッシュ通知に関する設定

GS2 のマイクロサービス内で何らかのイベントが発生した際に、プッシュ通知を送信するための設定です。
ここでいうプッシュ通知は GS2-Gateway の提供する WebSocket インターフェースを経由した処理であり、スマートフォンのプッシュ通知とは性質が異なります。
たとえば、マッチメイキングが完了した時やフレンドリクエストが届いた時など、ゲームクライアントの操作とは関係なく状態が変化した際に GS2-Gateway を経由してプッシュ通知をすることで、ゲームクライアントは状態の変化を検知することができます。

GS2-Gateway のプッシュ通知は通知先のデバイスがオフラインだった時に追加の処理としてモバイルプッシュ通知を送信できます。
モバイルプッシュ通知をうまく利用すれば、マッチメイキング中にゲームを終了しても、モバイルプッシュ通知を使用してプレイヤーに通知し、ゲームに戻ってくるフローを実現できる可能性があります。

型有効化条件必須デフォルト値の制限説明
gatewayNamespaceIdstring
✓
“grn:gs2:{region}:{ownerId}:gateway:default”~ 1024文字プッシュ通知に使用する GS2-Gateway のネームスペース
enableTransferMobileNotificationbool?falseモバイルプッシュ通知へ転送するか
soundstring{enableTransferMobileNotification} == true~ 1024文字モバイルプッシュ通知で使用するサウンドファイル名
enableTransferMobileNotification が true であれば有効
enable文字列列挙型
enum {
  “Enabled”,
  “Disabled”
}
✓
“Enabled”~ 128文字プッシュ通知を有効にするか
定義説明
“Enabled”有効
“Disabled”無効

LogSetting

ログの書き出し設定

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

型有効化条件必須デフォルト値の制限説明
loggingNamespaceIdstring
✓
~ 1024文字ログを出力する GS2-Log のネームスペースGRN

TransactionSetting

トランザクション設定

型有効化条件必須デフォルト値の制限説明
enableAutoRunbool
✓
false発行したトランザクションをサーバーサイドで自動的に実行するか
enableAtomicCommitbool{enableAutoRun} == true
✓
falseトランザクションの実行をアトミックにコミットするか
enableAutoRun が true であれば必須
transactionUseDistributorbool{enableAtomicCommit} == true
✓
falseトランザクションを非同期処理で実行する
enableAtomicCommit が true であれば必須
commitScriptResultInUseDistributorbool{transactionUseDistributor} == true
✓
falseスクリプトの結果コミット処理を非同期処理で実行するか
transactionUseDistributor が true であれば必須
acquireActionUseJobQueuebool{enableAtomicCommit} == true
✓
false入手アクションを実行する際に GS2-JobQueue を使用するか
enableAtomicCommit が true であれば必須
distributorNamespaceIdstring
✓
“grn:gs2:{region}:{ownerId}:distributor:default”~ 1024文字トランザクションの実行に使用する GS2-Distributor ネームスペース
queueNamespaceIdstring
✓
“grn:gs2:{region}:{ownerId}:queue:default”~ 1024文字トランザクションの実行に使用する GS2-JobQueue のネームスペース