GS2-Deploy/CDK Reference of GS2-AdReward

Template format used to create GS2-Deploy stacks and examples of template output implementation in various languages using CDK

Entities

Namespace

Namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project. Each GS2 service is managed per namespace. Services within different namespaces are treated as completely independent data spaces, even if they are the same service.

Therefore, it is necessary to create a namespace before starting to use each service.

	Type	Required	Value Limits	Description
name	string	✓	~ 128 chars	Namespace name This name is used to identify the namespace and is specified in alphanumeric characters.
description	string		~ 1024 chars	Description
transactionSetting	TransactionSetting			Transaction settings
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 to be executed when points are acquired
consumePointScript	ScriptSetting			Script to be executed when points are consumed
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 settings. This type holds the GS2-Log namespace information used to output log data.

GetAttr

Generation results of resources that can be obtained with 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: 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 settings

Maintains 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

Maintains a list of allowed ad unit IDs and uses it to verify AppLovin MAX’s 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 ad viewing completion callback from AppLovin MAX. 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 AppLovin MAX platform is in this list, you can accept only legitimate ad viewing events and prevent invalid requests and spam.
eventKey	string		✓		~ 128 chars	AppLovin Event Key Used to verify that the completion callback from AppLovin MAX is accessed from the appropriate source.

ScriptSetting

Script settings

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 execution result to stop the execution of the API or to tamper with the result of the API.

In contrast, asynchronous execution does not block processing until the script has finished executing. Since the script result cannot be used to stop the API execution or modify the API response, asynchronous execution does not affect the API’s response flow. For this reason, asynchronous execution 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

Script to be executed during processing

doneTriggerTargetType

String Enum
enum {
  “none”,
  “gs2_script”,
  “aws”
}

✓

“none”

~ 128 chars

Notification of Completion

Enumerator String Definition	Description
“none”	None
“gs2_script”	GS2-Script
“aws”	Amazon EventBridge

doneTriggerScriptId

string

{doneTriggerTargetType} == “gs2_script”

~ 1024 chars

Script to be executed upon completion

If doneTriggerTargetType is “gs2_script”, then enabled

doneTriggerQueueNamespaceId

string

{doneTriggerTargetType} == “gs2_script”

~ 1024 chars

Job queue namespace for executing the script upon completion

Used when you want to know the completion of the done script

If doneTriggerTargetType is “gs2_script”, then enabled

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 send additional processing to mobile push notifications when the destination device is offline. If you use mobile push notifications well, you may be able to realize a flow in which you can notify the player by using mobile push notifications even if you end the game during matchmaking and return to the game.

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

Forwarding to mobile push notification

When this notification is sent, if the destination device is offline, specify whether to forward it to 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.

If enableTransferMobileNotification is true, then enabled

enable

String Enum
enum {
“Enabled”,
“Disabled”
}

✓

“Enabled”

~ 128 chars

Whether to enable push notifications

Enumerator String Definition	Description
“Enabled”	Enabled
“Disabled”	Disabled

LogSetting

Log Export Settings

Manages log data export settings. 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, and debugging.

	Type	Condition	Required	Default	Value Limits	Description
loggingNamespaceId	string		✓		~ 1024 chars	GS2-Log namespace GRN to output logs

TransactionSetting

Transaction settings

Transaction settings control how transactions are executed, their consistency, asynchronous processing, and conflict avoidance mechanisms. Combining features like AutoRun, AtomicCommit, Distributor, batch application of script results, and asynchronous acquisition actions via 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 If enableAutoRun is true, then required
transactionUseDistributor	bool	{enableAtomicCommit} == true	✓	false		Whether to execute transactions asynchronously If enableAtomicCommit is true, then required
commitScriptResultInUseDistributor	bool	{transactionUseDistributor} == true	✓	false		Whether to execute the commit processing of the script result asynchronously If transactionUseDistributor is true, then required
acquireActionUseJobQueue	bool	{enableAtomicCommit} == true	✓	false		Whether to use GS2-JobQueue to execute the acquire action If enableAtomicCommit is true, then required
distributorNamespaceId	string		✓	“grn:gs2:{region}:{ownerId}:distributor:default”	~ 1024 chars	GS2-Distributor namespace used for transaction execution
queueNamespaceId	string		✓	“grn:gs2:{region}:{ownerId}:queue:default”	~ 1024 chars	Namespace in GS2-JobQueue used to run the transaction