GS2-AdReward Deploy/CDK Reference
Entities
Resources targeted by the Deploy operation
Namespace
Namespace
A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space.
Therefore, you must create a namespace before you can start using each service.
Request
Resource creation and update requests
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| name | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| description | string | ~ 1024 chars | Description | |||
| transactionSetting | TransactionSetting | Transaction Setting | ||||
| admob | AdMob | AdMob settings Manages settings and parameters related to ads. | ||||
| unityAd | UnityAd | Unity Ads settings Manages settings and parameters related to ads. | ||||
| appLovinMaxes | List<AppLovinMax> | 0 ~ 10 items | AppLovin MAX settings Manages settings and parameters related to ads. | |||
| acquirePointScript | ScriptSetting | Script setting to be executed when points are acquired Script Trigger Reference - acquirePoint | ||||
| consumePointScript | ScriptSetting | Script setting to be executed when points are consumed Script Trigger Reference - consumePoint | ||||
| changePointNotification | NotificationSetting | ✓ | Push notification when point changes This is a push notification setting when the point changes. This setting holds the information necessary to notify the game client when the point changes. If you do not make this setting, the points you earn will not be reflected in the game immediately. | |||
| logSetting | LogSetting | Log Output Settings Manages log output setting. This type holds the GS2-Log namespace information used to output log data. |
GetAttr
Resource creation results that can be retrieved using the !GetAttr tag
| Type | Description | |
|---|---|---|
| Item | Namespace | Namespace created |
Implementation Example
Type: GS2::AdReward::Namespace
Properties:
Name: namespace-0001
Description: null
TransactionSetting: null
Admob:
AllowAdUnitIds:
- 1
- 2
- 3
UnityAd:
Keys:
- key-0001
- key-0002
AppLovinMaxes: []
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-0001import (
"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 Templatepublic 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 Templateimport 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 TemplateTransactionSetting
Transaction Setting
Transaction Setting controls how transactions are executed, including their consistency, asynchronous processing, and conflict avoidance mechanisms. Combining features like AutoRun, AtomicCommit, asynchronous execution using GS2-Distributor, batch application of script results, and asynchronous Acquire Actions via GS2-JobQueue enables robust transaction management tailored to game logic.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| enableAutoRun | bool | false | Whether to automatically execute issued transactions on the server side | |||
| enableAtomicCommit | bool | {enableAutoRun} == true | false | Whether to commit the execution of transactions atomically * Applicable only if enableAutoRun is true | ||
| transactionUseDistributor | bool | {enableAtomicCommit} == true | false | Whether to execute transactions asynchronously * Applicable only if enableAtomicCommit is true | ||
| commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true | false | Whether to execute the commit processing of the script result asynchronously * Applicable only if transactionUseDistributor is true | ||
| acquireActionUseJobQueue | bool | {enableAtomicCommit} == true | false | Whether to use GS2-JobQueue to execute the acquire action * Applicable only if enableAtomicCommit is true | ||
| distributorNamespaceId | string | “grn:gs2:{region}:{ownerId}:distributor:default” | ~ 1024 chars | GS2-Distributor Namespace GRN used to execute transactions | ||
| queueNamespaceId | string | “grn:gs2:{region}:{ownerId}:queue:default” | ~ 1024 chars | GS2-JobQueue Namespace GRN used to execute transactions |
ScriptSetting
Script Setting
In GS2, you can associate custom scripts with microservice events and execute them. This model holds the settings for triggering script execution.
There are two main ways to execute a script: synchronous execution and asynchronous execution. Synchronous execution blocks processing until the script has finished executing. Instead, you can use the script’s execution results to halt API execution or control the API’s response content.
In contrast, asynchronous execution does not block processing until the script has finished executing. However, because the script result cannot be used to stop the API execution or modify the API response, asynchronous execution does not affect the API response flow and is generally recommended.
There are two types of asynchronous execution methods: GS2-Script and Amazon EventBridge. By using Amazon EventBridge, you can write processing in languages other than Lua.
| Type | Condition | Required | Default | Value Limits | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| triggerScriptId | string | ~ 1024 chars | GS2-Script script GRN
executed synchronously when the API is executed Must be specified in GRN format starting with “grn:gs2:”. | |||||||||||
| doneTriggerTargetType | String Enum enum { “none”, “gs2_script”, “aws” } | “none” | How to execute asynchronous scripts Specifies the type of script to use for asynchronous execution. You can choose from “Do not use asynchronous execution (none)”, “Use GS2-Script (gs2_script)”, and “Use Amazon EventBridge (aws)”.
| |||||||||||
| doneTriggerScriptId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024 chars | GS2-Script script GRN
for asynchronous execution Must be specified in GRN format starting with “grn:gs2:”. * Applicable only if doneTriggerTargetType is “gs2_script” | ||||||||||
| doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024 chars | GS2-JobQueue namespace GRN
to execute asynchronous execution scripts If you want to execute asynchronous execution scripts via GS2-JobQueue instead of executing them directly, specify the GS2-JobQueue namespace GRN. There are not many cases where GS2-JobQueue is required, so you generally do not need to specify it unless you have a specific reason. * Applicable only if doneTriggerTargetType is “gs2_script” |
NotificationSetting
Push Notification Settings
This is a setting for sending push notifications when an event occurs in a GS2 microservice. The push notification here refers to the processing via the WebSocket interface provided by GS2-Gateway, and is different from the push notification of a smartphone. For example, when a matchmaking is completed or a friend request is received, the GS2-Gateway can send a push notification via the WebSocket interface, and the game client can detect the change of the state.
GS2-Gateway’s push notifications can be used to forward notifications to mobile push notification services when the destination device is offline. By properly utilizing mobile push notifications, you can implement a flow in which players are notified even if they exit the game during matchmaking and later return to it.
| Type | Condition | Required | Default | Value Limits | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| gatewayNamespaceId | string | “grn:gs2:{region}:{ownerId}:gateway:default” | ~ 1024 chars | GS2-Gateway namespace to use for push notifications Specify the GS2-Gateway namespace ID in GRN format starting with “grn:gs2:”. | ||||||||
| enableTransferMobileNotification | bool? | false | Whether to forward the notification as a mobile push notification When this notification is sent and the destination device is offline, specify whether to forward it as a mobile push notification. | |||||||||
| sound | string | {enableTransferMobileNotification} == true | ~ 1024 chars | Sound file name to be used for mobile push notifications The sound file name specified here is used when sending mobile push notifications, and you can send notifications with a special sound. * Applicable only if enableTransferMobileNotification is true | ||||||||
| enable | String Enum enum { “Enabled”, “Disabled” } | “Enabled” | Whether to enable push notifications
|
LogSetting
Log Output Setting
Log Output Setting defines how log data is exported. This type holds the GS2-Log namespace identifier (Namespace ID) used to export log data. Specify the GS2-Log namespace where log data is collected and stored in the GRN format for the Log Namespace ID (loggingNamespaceId). Configuring this setting ensures that log data for API requests and responses occurring within the specified namespace is output to the target GS2-Log namespace. GS2-Log provides real-time logs that can be used for system monitoring, analysis, debugging, and other operational purposes.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| loggingNamespaceId | string | ✓ | ~ 1024 chars | GS2-Log namespace GRN
to output logs Must be specified in GRN format starting with “grn:gs2:”. |
AdMob
AdMob settings
Stores a list of allowed ad unit IDs and uses it to verify AdMob’s viewing completion Webhook.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| allowAdUnitIds | List<string> | ✓ | 1 ~ 10 items | List of allowed ad unit IDs Used to verify the ad unit ID included in the ad viewing completion callback from AdMob. The ad unit IDs included in this list are used to verify that the ad viewing was completed properly in the application or game. By checking whether the ad unit ID included in the notification of ad viewing completion sent from the AdMob platform is in this list, you can accept only legitimate ad viewing events and prevent invalid requests and spam. |
UnityAd
Unity Ads settings
Used to store the Unity Ads-related cryptographic keys used by the application or game. The cryptographic keys are issued by Unity Ads and are used to verify the completion of ad viewing.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| keys | List<string> | 0 ~ 10 items | List of cryptographic keys Stores a list of cryptographic keys issued by Unity Ads. These keys are used to communicate with the Unity Ads ad platform and to verify ad events. Encryption keys can be obtained from the Unity Dashboard. Each key in the list is required to verify the completion of ad viewing. |
AppLovinMax
AppLovin MAX settings
Stores an allowed ad unit ID and uses it to verify the AppLovin MAX viewing completion Webhook.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| allowAdUnitId | string | ✓ | ~ 16 chars | Allowed Ad Unit ID Used to verify the ad_unit_id included in the AppLovin MAX ad viewing completion callback. The ad viewing event is accepted only when the ad_unit_id in the callback matches the configured ad unit ID. This prevents unauthorized callbacks, invalid requests, and fraudulent reward claims from unregistered ad units. | ||
| eventKey | string | ✓ | ~ 128 chars | AppLovin Event Key Used to verify that the completion callback from AppLovin MAX is accessed from the appropriate source. |