GS2-Deploy/CDK Reference of GS2-AdReward
Entities
Namespace
Namespace
Namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project.
Basically, GS2 services have a layer called namespace, and different namespaces are treated as completely different data spaces, even for the same service.
Therefore, it is necessary to create a namespace before starting to use each service.
| Type | Require | Default | Limitation | Description |
---|
name | string | ✓ | | ~ 32 chars | Namespace name |
admob | AdMob | | | | AdMob settings |
unityAd | UnityAd | | | | Unity Ads settings |
description | string | | | ~ 1024 chars | description of Namespace |
changePointNotification | NotificationSetting | ✓ | | | Push notification when points change due to ad viewing |
logSetting | LogSetting | | | | Log output settings |
GetAttr
| Type | Description |
---|
Item | Namespace | Namespace created |
Implementation Example
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",
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=,
)
),
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'],
)
),
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",
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: ,
)
),
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'],
)
),
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.core.model.NotificationSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace-0001",
new io.gs2.cdk.core.model.options.NotificationSettingOptions(
,
)
),
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']
)
);
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",
new core.NotificationSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace-0001",
{
,
}
),
{
admob: new adReward.model.AdMob(
['1', '2', '3']
),
unityAd: new adReward.model.UnityAd(,
{
['key-0001', 'key-0002']
}
),
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.Core.Model.NotificationSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace-0001",
new Gs2Cdk.Core.Model.Options.NotificationSettingOptions(
EnableTransferMobileNotification = ,
Sound =
}
),
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']
}
),
logSetting = new Gs2Cdk.Core.Model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
),
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
AdMob
| Type | Require | Default | Limitation | Description |
---|
allowAdUnitIds | List<string> | ✓ | | 1 ~ 10 items | List of Allow Ad Unit Ids |
UnityAd
| Type | Require | Default | Limitation | Description |
---|
keys | List<string> | | | ~ 10 items | List of Keys |
NotificationSetting
| Type | Require | Default | Limitation | Description |
---|
gatewayNamespaceId | string | ✓ | | ~ 1024 chars | Namespace GRN |
enableTransferMobileNotification | bool? | | | | Forwarding to mobile push notification |
sound | string | | | ~ 1024 chars | Sound file name to be used for mobile push notifications |
LogSetting
| Type | Require | Default | Limitation | Description |
---|
loggingNamespaceId | string | ✓ | | ~ 1024 chars | Namespace GRN |