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.

TypeRequireDefaultLimitationDescription
namestring~ 128 charsNamespace name
admobAdMobAdMob settings
unityAdUnityAdUnity Ads settings
appLovinMaxesAppLovinMax[]~ 10 itemsAppLovin MAX settings
descriptionstring~ 1024 charsDescription
acquirePointScriptScriptSettingScript to be executed when points are acquired
consumePointScriptScriptSettingScript to be executed when points are consumed
changePointNotificationNotificationSettingPush notification when point changes
logSettingLogSettingLog output settings

GetAttr

TypeDescription
ItemNamespaceNamespace created

Implementation Example

Type: GS2::AdReward::Namespace
Properties:
  Name: namespace1
  Admob: 
    AllowAdUnitIds: 
    - 1
    - 2
    - 3
  UnityAd: 
    Keys: 
    - key-0001
    - key-0002
  AppLovinMaxes: null
  Description: null
  AcquirePointScript: null
  ConsumePointScript: 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(
                        allowAdUnitIds = ['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(){
                        {
                            gatewayNamespaceId = "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(
                        loggingNamespaceId = "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(
                    AllowAdUnitIds = ['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(
                    new Gs2Cdk.Core.Model.Options.NotificationSettingOptions {
                        gatewayNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace-0001"
                    },
                    new Gs2Cdk.Core.Model.Options.NotificationSettingOptions(
                        EnableTransferMobileNotification = ,
                        Sound = 
                    }
                ),
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    LoggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template

AdMob

AdMob settings

Maintains a list of allowed ad unit IDs and uses it to verify Ad Mob’s viewing completion WebHook.

TypeRequireDefaultLimitationDescription
allowAdUnitIdsList<string>1 ~ 10 itemsList of allowed ad unit IDs

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.

TypeRequireDefaultLimitationDescription
keysList<string>~ 10 itemsList of cryptographic keys

AppLovinMax

AppLovin MAX settings

Maintains a list of allowed ad unit IDs and uses it to verify Ad Mob’s viewing completion WebHook.

TypeRequireDefaultLimitationDescription
allowAdUnitIdstring~ 16 charsAllowed ad unit ID
eventKeystring~ 128 charsAppLovin Event Key

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.

On the other hand, asynchronous execution does not block 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. However, asynchronous execution does not block processing until the script has finished executing, so it is generally recommended to use asynchronous execution.

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.

TypeRequireDefaultLimitationDescription
triggerScriptIdstring~ 1024 charsScript GRN
doneTriggerTargetTypeenum {
    “none”,
    “gs2_script”,
    “aws”
}
“none”~ 128 charsNotification of Completion
doneTriggerScriptIdstring{doneTriggerTargetType} == “gs2_script”~ 1024 charsScript GRN
doneTriggerQueueNamespaceIdstring{doneTriggerTargetType} == “gs2_script”~ 1024 charsNamespace GRN

Enumeration type definition to specify as doneTriggerTargetType

Enumerator String DefinitionDescription
noneNone
gs2_scriptGS2-Script
awsAmazon EventBridge

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.

TypeRequireDefaultLimitationDescription
gatewayNamespaceIdstring“grn:gs2:{region}:{ownerId}:gateway:default”~ 1024 charsGS2-Gateway namespace to use for push notifications
enableTransferMobileNotificationbool?falseForwarding to mobile push notification
soundstring{enableTransferMobileNotification} == true~ 1024 charsSound file name to be used for mobile push notifications

LogSetting

Log setting

This type manages log output settings. This type holds the identifier of the log namespace used to output log data. The log namespace ID specifies the GS2-Log namespace to aggregate and store the log data. Through this setting, API request and response log data under this namespace will be output to the target GS2-Log. GS2-Log provides logs in real time, which can be used for system monitoring, analysis, debugging, etc.

TypeRequireDefaultLimitationDescription
loggingNamespaceIdstring~ 1024 charsNamespace GRN