GS2-AdReward GS2-Deploy/CDK リファレンス
エンティティ
Namespace
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。 GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
name | string | ✓ | ~ 32文字 | ネームスペース名 | |
admob | AdMob | AdMob の設定 | |||
unityAd | UnityAd | Unity Ads の設定 | |||
description | string | ~ 1024文字 | 説明文 | ||
changePointNotification | NotificationSetting | ✓ | 広告視聴によりポイントが変動した時のプッシュ通知 | ||
logSetting | LogSetting | ログの出力設定 |
GetAttr
型 | 説明 | |
---|---|---|
Item | Namespace | 作成したネームスペース |
実装例
Type: GS2::AdReward::Namespace
Properties:
Name: namespace1
Admob:
AllowAdUnitIds:
- 1
- 2
- 3
UnityAd:
Keys:
- key-0001
- key-0002
Description: null
ChangePointNotification:
GatewayNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace1
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
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(
gateway_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace-0001',
options=core.NotificationSettingOptions(
enable_transfer_mobile_notification=,
sound=,
)
),
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\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(
gatewayNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace-0001",
options: new \Gs2Cdk\Core\Model\Options\NotificationSettingOptions(
enableTransferMobileNotification: ,
sound: ,
)
),
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() {
{
admob = new io.gs2.cdk.adReward.model.AdMob(
['1', '2', '3']
);
unityAd = new io.gs2.cdk.adReward.model.UnityAd(,
new io.gs2.cdk.adReward.model.options.UnityAdOptions(
['key-0001', 'key-0002']
)
);
changePointNotification = new io.gs2.cdk.core.model.NotificationSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace-0001",
new io.gs2.cdk.core.model.options.NotificationSettingOptions(
,
)
);
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 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(,
{
['key-0001', 'key-0002']
}
),
changePointNotification: new core.NotificationSetting(
"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
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2AdReward.Model.Namespace(
this,
"namespace-0001",
new Gs2Cdk.Gs2AdReward.Model.Options.NamespaceOptions {
admob = new Gs2Cdk.Gs2AdReward.Model.AdMob(
['1', '2', '3']
),
unityAd = new Gs2Cdk.Gs2AdReward.Model.UnityAd(,
new Gs2Cdk.Gs2AdReward.Model.Options.UnityAdOptions {
Keys = ['key-0001', 'key-0002']
}
),
changePointNotification = new Gs2Cdk.Core.Model.NotificationSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace-0001",
new Gs2Cdk.Core.Model.Options.NotificationSettingOptions(
EnableTransferMobileNotification = ,
Sound =
}
),
logSetting = new Gs2Cdk.Core.Model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
),
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
AdMob
AdMob 広告プラットフォームに関連する設定
許可された広告ユニットIDのリストを保持し、これに基づいて Ad Mob からの視聴完了 WebHook の検証を行います。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
allowAdUnitIds | List<string> | ✓ | 1 ~ 10 items | 許可する広告ユニットIDリスト |
UnityAd
Unity Ads 広告プラットフォームに関連する設定
アプリケーションやゲームで使用されるUnity Ads関連の暗号鍵を保持するために使用されます。 暗号鍵はUnity Adsから発行され、広告視聴の完了を検証する際に使用します。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
keys | List<string> | ~ 10 items | 暗号鍵のリスト |
NotificationSetting
プッシュ通知に関する設定
GS2 のマイクロサービス内で何らかのイベントが発生した際に、プッシュ通知を送信するための設定です。 ここでいうプッシュ通知は GS2-Gateway の提供する WebSocket インターフェースを経由した処理であり、スマートフォンのプッシュ通知とは性質が異なります。 たとえば、マッチメイキングが完了した時やフレンドリクエストが届いた時など、ゲームクライアントの操作とは関係なく状態が変化した際に GS2-Gateway を経由してプッシュ通知をすることで、ゲームクライアントは状態の変化を検知することができます。
GS2-Gateway のプッシュ通知は通知先のデバイスがオフラインだった時に追加の処理としてモバイルプッシュ通知を送信できます。 モバイルプッシュ通知をうまく利用すれば、マッチメイキング中にゲームを終了しても、モバイルプッシュ通知を使用してプレイヤーに通知し、ゲームに戻ってくるフローを実現できる可能性があります。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
gatewayNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:gateway:default” | ~ 1024文字 | プッシュ通知に使用する GS2-Gateway のネームスペース |
enableTransferMobileNotification | bool? | false | モバイルプッシュ通知へ転送するか | ||
sound | string | {enableTransferMobileNotification} == true | ~ 1024文字 | モバイルプッシュ通知で使用するサウンドファイル名 |
LogSetting
ログの書き出し設定
ログデータの書き出し設定を管理します。この型は、ログデータを書き出すために使用されるログ名前空間の識別子(Namespace ID)を保持します。 ログ名前空間IDは、ログデータを集約し、保存する対象の GS2-Log の名前空間を指定します。 この設定を通じて、この名前空間以下のAPIリクエスト・レスポンスログデータが対象の GS2-Log へ出力されるようになります。 GS2-Log にはリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
loggingNamespaceId | string | ✓ | ~ 1024文字 | ネームスペースGRN |