GS2-AdReward Deploy/CDK 레퍼런스
GS2-Deploy의 스택을 생성할 때 사용하는 템플릿 포맷과, CDK를 이용한 각종 언어의 템플릿 출력 구현 예제
엔티티
Deploy 처리에서 조작 대상이 되는 리소스
Namespace
네임스페이스
네임스페이스는 하나의 프로젝트 내에서 동일한 서비스를 서로 다른 용도로 여러 개 이용하기 위한 엔티티입니다.
GS2의 각 서비스는 네임스페이스 단위로 관리됩니다. 네임스페이스가 다르면 동일한 서비스라도 완전히 독립된 데이터 공간으로 취급됩니다.
따라서 각 서비스의 이용을 시작하려면 먼저 네임스페이스를 생성해야 합니다.
Request
리소스 생성·갱신 요청
| 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 | |
|---|---|---|---|---|---|---|
| name | string | ✓ | ~ 128자 | 네임스페이스 이름 네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. | ||
| description | string | ~ 1024자 | 설명문 | |||
| transactionSetting | TransactionSetting | 트랜잭션 설정 광고 시청 보상 부여 시 실행되는 분산 트랜잭션의 실행 방법을 제어하는 설정입니다. 자동 실행, 아토믹 커밋, 비동기 처리 등의 옵션이 포함됩니다. | ||||
| admob | AdMob | AdMob 설정 AdMob에 관련된 광고 설정 및 파라미터를 관리합니다. | ||||
| unityAd | UnityAd | Unity Ads 설정 Unity Ads에 관련된 광고 설정 및 파라미터를 관리합니다. | ||||
| appLovinMaxes | List<AppLovinMax> | 0 ~ 10 items | AppLovin MAX 설정 AppLovin MAX에 관련된 광고 설정 및 파라미터를 관리합니다. | |||
| acquirePointScript | ScriptSetting | 포인트 획득 시 실행할 스크립트 설정 Script 트리거 레퍼런스 - acquirePoint | ||||
| consumePointScript | ScriptSetting | 포인트 소비 시 실행할 스크립트 설정 Script 트리거 레퍼런스 - consumePoint | ||||
| changePointNotification | NotificationSetting | ✓ | 광고 시청으로 포인트가 변동되었을 때의 푸시 알림 광고 시청에 의한 포인트 변동 시의 푸시 알림 설정입니다. 포인트가 변동되었을 때 게임 클라이언트에 알리기 위한 설정을 보유합니다. 이 설정을 하지 않으면, 획득한 포인트가 즉시 게임에 반영되지 않습니다. | |||
| logSetting | LogSetting | 로그 출력 설정 로그 출력 설정을 관리합니다. 이 타입은 로그 데이터를 출력하는 데 사용되는 GS2-Log의 네임스페이스 정보를 보유합니다. |
GetAttr
!GetAttr 태그로 취득 가능한 리소스 생성 결과
| 타입 | 설명 | |
|---|---|---|
| Item | Namespace | 생성한 네임스페이스 |
구현 예제
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 Templateclass 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
트랜잭션 설정
트랜잭션 설정은 트랜잭션의 실행 방법·정합성·비동기 처리·충돌 회피 메커니즘을 제어하는 설정입니다.
자동 실행(AutoRun), 원자적 실행(AtomicCommit), GS2-Distributor를 이용한 비동기 실행, 스크립트 결과의 일괄 적용, GS2-JobQueue를 통한 입수 액션의 비동기화 등을 조합하여 게임 로직에 맞는 견고한 트랜잭션 관리를 가능하게 합니다.
| 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 | |
|---|---|---|---|---|---|---|
| enableAutoRun | bool | false | 발행한 트랜잭션을 서버 사이드에서 자동으로 실행할지 여부 | |||
| enableAtomicCommit | bool | {enableAutoRun} == true | false | 트랜잭션의 실행을 원자적으로 커밋할지 여부 ※ enableAutoRun이(가) true 이면 활성화 | ||
| transactionUseDistributor | bool | {enableAtomicCommit} == true | false | 트랜잭션을 비동기 처리로 실행할지 여부 ※ enableAtomicCommit이(가) true 이면 활성화 | ||
| commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true | false | 스크립트의 결과 커밋 처리를 비동기 처리로 실행할지 여부 ※ transactionUseDistributor이(가) true 이면 활성화 | ||
| acquireActionUseJobQueue | bool | {enableAtomicCommit} == true | false | 입수 액션을 실행할 때 GS2-JobQueue를 사용할지 여부 ※ enableAtomicCommit이(가) true 이면 활성화 | ||
| distributorNamespaceId | string | “grn:gs2:{region}:{ownerId}:distributor:default” | ~ 1024자 | 트랜잭션 실행에 사용하는 GS2-Distributor 네임스페이스 GRN | ||
| queueNamespaceId | string | “grn:gs2:{region}:{ownerId}:queue:default” | ~ 1024자 | 트랜잭션 실행에 사용하는 GS2-JobQueue의 네임스페이스 GRN |
ScriptSetting
스크립트 설정
GS2에서는 마이크로서비스의 이벤트에 연결하여 커스텀 스크립트를 실행할 수 있습니다.
이 모델은 스크립트 실행을 트리거하기 위한 설정을 보유합니다.
스크립트 실행 방식은 크게 두 가지로, 바로 “동기 실행"과 “비동기 실행"입니다.
동기 실행은 스크립트 실행이 완료될 때까지 처리가 블록됩니다.
대신 스크립트 실행 결과를 이용하여 API 실행을 중단시키거나 API 응답 내용을 제어할 수 있습니다.
한편, 비동기 실행에서는 스크립트 완료를 기다리기 위해 처리가 블록되는 일이 없습니다.
다만 스크립트 실행 결과를 이용하여 API 실행을 중단하거나 API 응답 내용을 변경할 수는 없습니다.
비동기 실행은 API의 응답 흐름에 영향을 주지 않으므로 원칙적으로 비동기 실행을 권장합니다.
비동기 실행에는 실행 방식이 두 가지 있으며, GS2-Script와 Amazon EventBridge가 있습니다.
Amazon EventBridge를 사용함으로써 Lua 이외의 언어로 처리를 작성할 수 있습니다.
| 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| triggerScriptId | string | ~ 1024자 | API 실행 시 동기적으로 실행되는 GS2-Script의 스크립트
GRN
“grn:gs2:“로 시작하는 GRN 형식의 ID로 지정해야 합니다. | |||||||||||
| doneTriggerTargetType | 문자열 열거형 enum { “none”, “gs2_script”, “aws” } | “none” | 비동기 스크립트의 실행 방법 비동기 실행에서 사용할 스크립트의 종류를 지정합니다. “비동기 실행의 스크립트를 사용하지 않음(none)”, “GS2-Script를 사용함(gs2_script)”, “Amazon EventBridge를 사용함(aws)” 중에서 선택할 수 있습니다.
| |||||||||||
| doneTriggerScriptId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024자 | 비동기 실행할 GS2-Script 스크립트
GRN
“grn:gs2:“로 시작하는 GRN 형식의 ID로 지정해야 합니다. ※ doneTriggerTargetType이(가) “gs2_script” 이면 활성화 | ||||||||||
| doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024자 | 비동기 실행 스크립트를 실행하는 GS2-JobQueue 네임스페이스
GRN
비동기 실행 스크립트를 직접 실행하지 않고 GS2-JobQueue를 경유하는 경우 GS2-JobQueue의 네임스페이스GRN을 지정합니다. GS2-JobQueue를 이용해야 할 이유는 많지 않으므로, 특별한 이유가 없다면 지정할 필요는 없습니다. ※ doneTriggerTargetType이(가) “gs2_script” 이면 활성화 |
NotificationSetting
푸시 통지에 관한 설정
GS2의 마이크로서비스 내에서 어떠한 이벤트가 발생했을 때, 푸시 통지를 전송하기 위한 설정입니다.
여기서 말하는 푸시 통지란 GS2-Gateway가 제공하는 WebSocket 인터페이스를 경유하는 처리이며, 스마트폰의 푸시 통지와는 성질이 다릅니다.
예를 들어 매치메이킹이 완료되었을 때나 친구 요청이 도착했을 때 등, 게임 클라이언트의 조작과는 관계없이 상태가 변화했을 때 GS2-Gateway를 경유하여 푸시 통지를 함으로써, 게임 클라이언트는 상태 변화를 감지할 수 있습니다.
GS2-Gateway의 푸시 통지는 통지 대상 디바이스가 오프라인이었을 때 추가 처리로 모바일 푸시 통지를 전송할 수 있습니다.
모바일 푸시 통지를 잘 활용하면, 매치메이킹 중에 게임을 종료하더라도 모바일 푸시 통지를 사용하여 플레이어에게 알리고, 게임으로 복귀하도록 하는 흐름을 구현할 수 있을 가능성이 있습니다.
| 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| gatewayNamespaceId | string | “grn:gs2:{region}:{ownerId}:gateway:default” | ~ 1024자 | 푸시 통지에 사용할 GS2-Gateway의 네임스페이스 “grn:gs2:“로 시작하는 GRN 형식으로 GS2-Gateway의 네임스페이스 ID를 지정합니다. | ||||||||
| enableTransferMobileNotification | bool? | false | 모바일 푸시 통지로 전달할지 여부 이 통지를 전송하려 할 때, 통지 대상 디바이스가 오프라인일 경우 모바일 푸시 통지로 전달할지 여부를 지정합니다. | |||||||||
| sound | string | {enableTransferMobileNotification} == true | ~ 1024자 | 모바일 푸시 통지에서 사용할 사운드 파일명 여기서 지정한 사운드 파일명은 모바일 푸시 통지를 전송할 때 사용되며, 특별한 사운드로 통지를 출력할 수 있습니다. ※ enableTransferMobileNotification이(가) true 이면 활성화 | ||||||||
| enable | 문자열 열거형 enum { “Enabled”, “Disabled” } | “Enabled” | 푸시 통지를 활성화할지 여부
|
LogSetting
로그 출력 설정
로그 데이터의 출력 설정을 관리합니다. 이 타입은 로그 데이터를 기록하는 데 사용되는 GS2-Log 네임스페이스의 식별자(Namespace ID)를 보유합니다.
로그 네임스페이스ID(loggingNamespaceId)에는 로그 데이터를 수집하여 저장하는 GS2-Log의 네임스페이스를 GRN 형식으로 지정합니다.
이 설정을 하면 설정된 네임스페이스 내에서 발생한 API 요청·응답의 로그 데이터가 대상 GS2-Log 네임스페이스 쪽으로 출력됩니다.
GS2-Log에서는 실시간으로 로그가 제공되어 시스템 모니터링, 분석, 디버깅 등에 이용할 수 있습니다.
| 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 | |
|---|---|---|---|---|---|---|
| loggingNamespaceId | string | ✓ | ~ 1024자 | 로그를 출력할 GS2-Log의 네임스페이스
GRN
“grn:gs2:“로 시작하는 GRN 형식의 ID로 지정해야 합니다. |
AdMob
AdMob 광고 플랫폼에 관련된 설정
허용된 광고 유닛 ID 목록을 보유하며, 이를 기반으로 AdMob으로부터의 시청 완료 Webhook을 검증합니다.
| 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 | |
|---|---|---|---|---|---|---|
| allowAdUnitIds | List<string> | ✓ | 1 ~ 10 items | 허용할 광고 유닛 ID 목록 AdMob으로부터의 광고 시청 완료 콜백에 포함된 광고 유닛 ID를 검증하기 위해 사용됩니다. 목록에 포함된 광고 유닛 ID는 애플리케이션 또는 게임 내에서 광고 시청이 적절하게 완료되었음을 확인하기 위한 것입니다. AdMob 플랫폼에서 전송되는 광고 시청 완료 알림에 포함된 광고 유닛 ID가 이 목록에 있는지 확인함으로써, 정당한 광고 시청 이벤트만을 수용하고 부정한 요청과 스팸을 방지할 수 있습니다. |
UnityAd
Unity Ads 광고 플랫폼에 관련된 설정
애플리케이션이나 게임에서 사용되는 Unity Ads 관련 암호 키를 보유하기 위해 사용됩니다.
암호 키는 Unity Ads에서 발급되며, 광고 시청 완료를 검증할 때 사용합니다.
| 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 | |
|---|---|---|---|---|---|---|
| keys | List<string> | 0 ~ 10 items | 암호 키 목록 Unity Ads에서 발급된 암호 키 목록을 보유합니다. 이 키들은 Unity Ads 광고 플랫폼과의 통신 및 광고 이벤트 검증에 사용됩니다. 암호 키는 Unity Dashboard에서 취득할 수 있습니다. 목록에 포함된 각 키는 광고 시청 완료를 검증하기 위해 필요합니다. |
AppLovinMax
AppLovin MAX 광고 플랫폼에 관련된 설정
허용된 광고 유닛 ID를 보유하며, 이를 기반으로 AppLovin MAX로부터의 시청 완료 Webhook을 검증합니다.
| 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 | |
|---|---|---|---|---|---|---|
| allowAdUnitId | string | ✓ | ~ 16자 | 허용할 광고 유닛 ID AppLovin MAX에서 전송되는 광고 시청 완료 콜백에 포함된 ad_unit_id를 검증하기 위해 사용됩니다. 이 설정에 등록된 광고 유닛 ID와 콜백에 포함된 ad_unit_id가 일치하는 경우에만 광고 시청이 정상적으로 완료된 것으로 간주하여 승인합니다. 이를 통해 허용되지 않은 광고 유닛으로부터의 알림이나 부정한 요청을 거부하고, 부정한 광고 보상 지급이나 스팸을 방지할 수 있습니다. | ||
| eventKey | string | ✓ | ~ 128자 | AppLovin Event Key AppLovin MAX로부터의 광고 시청 완료 콜백이 적절한 접근 경로에서 전송되었는지 검증할 때 사용합니다 |