> For the complete documentation index, see [llms.txt](/llms.txt)

# GS2-AdReward Deploy/CDK リファレンス

GS2-Deployのスタックを作成する際に使用するテンプレートのフォーマットと、CDKによる各種言語のテンプレート出力の実装例




## エンティティ

Deploy処理で操作の対象となるリソース

### Namespace

ネームスペース<br>

ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。<br>
GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。<br>

そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。

#### Request

リソースの生成・更新リクエスト

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| name | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| description | string |  | |  |  ~ 1024文字 | 説明文 |
| transactionSetting | [TransactionSetting](#transactionsetting) |  | |  |  | トランザクション設定<br>広告視聴報酬の付与時に実行される分散トランザクションの実行方法を制御する設定です。自動実行、アトミックコミット、非同期処理などのオプションが含まれます。 |
| admob | [AdMob](#admob) |  | |  |  | AdMob の設定<br>AdMob に関連する広告の設定やパラメータを管理します。 |
| unityAd | [UnityAd](#unityad) |  | |  |  | Unity Ads の設定<br>Unity Ads に関連する広告の設定やパラメータを管理します。 |
| appLovinMaxes | [List&lt;AppLovinMax&gt;](#applovinmax) |  | |  | 0 ~ 10 items | AppLovin MAX の設定<br>AppLovin MAX に関連する広告の設定やパラメータを管理します。 |
| acquirePointScript | [ScriptSetting](#scriptsetting) |  | |  |  | ポイント入手時に実行するスクリプトの設定<br>Script トリガーリファレンス - [`acquirePoint`](../script/#acquirepoint) |
| consumePointScript | [ScriptSetting](#scriptsetting) |  | |  |  | ポイント消費時に実行するスクリプトの設定<br>Script トリガーリファレンス - [`consumePoint`](../script/#consumepoint) |
| changePointNotification | [NotificationSetting](#notificationsetting) |  | ✓|  |  | 広告視聴によりポイントが変動したときのプッシュ通知<br>広告視聴によるポイント変動時のプッシュ通知設定です。<br>ポイントが変動した際にゲームクライアントに通知するための設定を保持します。<br>この設定を行わなければ、獲得したポイントが即時にゲームに反映されません。 |
| logSetting | [LogSetting](#logsetting) |  | |  |  | ログの出力設定<br>ログデータの出力設定を管理します。この型は、ログデータを書き出すために使用される GS2-Log のネームスペース情報を保持します。 |

#### GetAttr

[!GetAttr](/articles/tech/deploy/#getattr)タグで取得可能なリソースの生成結果

| | 型 | 説明 |
| --- | --- | --- |
| Item | [Namespace](../sdk#namespace) | 作成したネームスペース

#### 実装例




**GS2-Deploy(YAML)**
```yaml

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-0001

```

**Go**
```go

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

```

**PHP**
```php

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

```

**Java**
```java

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

```

**C#**
```csharp

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

```

**TypeScript**
```typescript

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

```

**Python**
```python

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

```


#### TransactionSetting

トランザクション設定<br>

トランザクション設定は、トランザクションの実行方法・整合性・非同期処理・競合回避の仕組みを制御する設定です。<br>
自動実行（AutoRun）、アトミック実行（AtomicCommit）、GS2-Distributor を利用した非同期実行、スクリプト結果の一括適用、GS2-JobQueue による入手アクションの非同期化などを組み合わせ、ゲームロジックに応じた堅牢なトランザクション管理を可能にします。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| enableAutoRun | bool |  |  | false |  | 発行したトランザクションをサーバーサイドで自動的に実行するか |
| enableAtomicCommit | bool | {enableAutoRun} == true |  | false |  | トランザクションの実行をアトミックにコミットするか<br>※ enableAutoRun が true であれば 有効 |
| transactionUseDistributor | bool | {enableAtomicCommit} == true |  | false |  | トランザクションを非同期処理で実行する<br>※ enableAtomicCommit が true であれば 有効 |
| commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true |  | false |  | スクリプトの結果コミット処理を非同期処理で実行するか<br>※ transactionUseDistributor が true であれば 有効 |
| acquireActionUseJobQueue | bool | {enableAtomicCommit} == true |  | false |  | 入手アクションを実行する際に GS2-JobQueue を使用するか<br>※ 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

スクリプト設定<br>

GS2 ではマイクロサービスのイベントに関連づけて、カスタムスクリプトを実行することができます。<br>
このモデルは、スクリプトの実行をトリガーするための設定を保持します。<br>

スクリプトの実行方式は大きく2種類あり、それは「同期実行」と「非同期実行」です。<br>
同期実行は、スクリプトの実行が完了するまで処理がブロックされます。<br>
代わりに、スクリプトの実行結果を使って API の実行を止めたり、API のレスポンス内容を制御することができます。<br>

一方、非同期実行ではスクリプトの完了を待つために処理がブロックされることはありません。<br>
ただし、スクリプトの実行結果を利用して API の実行を停止したり、API の応答内容を変更することはできません。<br>
非同期実行は API の応答フローに影響を与えないため、原則として非同期実行を推奨します。<br>

非同期実行には実行方式が2種類あり、GS2-Script と Amazon EventBridge があります。<br>
Amazon EventBridge を使用することで、Lua 以外の言語で処理を記述することができます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| triggerScriptId | string |  |  |  |  ~ 1024文字 | API 実行時に同期的に実行される GS2-Script のスクリプトGRN<br>「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。 |
| doneTriggerTargetType | 文字列列挙型<br>enum {<br>&nbsp;&nbsp;"none",<br>&nbsp;&nbsp;"gs2_script",<br>&nbsp;&nbsp;"aws"<br>}<br> |  |  | "none" |  | 非同期スクリプトの実行方法<br>非同期実行で使用するスクリプトの種類を指定します。<br>「非同期実行のスクリプトを使用しない(none)」「GS2-Scriptを使用する(gs2_script)」「Amazon EventBridgeを使用する(aws)」が選択できます。"none": なし / "gs2_script": GS2-Script / "aws": Amazon EventBridge /  |
| doneTriggerScriptId | string | {doneTriggerTargetType} == "gs2_script" |  |  |  ~ 1024文字 | 非同期実行する GS2-Script スクリプトGRN<br>「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。<br>※ doneTriggerTargetType が "gs2_script" であれば 有効 |
| doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == "gs2_script" |  |  |  ~ 1024文字 | 非同期実行スクリプトを実行する GS2-JobQueue ネームスペースGRN<br>非同期実行スクリプトを直接実行するのではなく、GS2-JobQueue を経由する場合は GS2-JobQueue のネームスペースGRN を指定します。<br>GS2-JobQueue を利用する理由は多くはありませんので、特に理由がなければ指定する必要はありません。<br>※ doneTriggerTargetType が "gs2_script" であれば 有効 |

#### NotificationSetting

プッシュ通知に関する設定<br>

GS2 のマイクロサービス内で何らかのイベントが発生した際に、プッシュ通知を送信するための設定です。<br>
ここでいうプッシュ通知は GS2-Gateway の提供する WebSocket インターフェースを経由した処理であり、スマートフォンのプッシュ通知とは性質が異なります。<br>
たとえば、マッチメイキングが完了した時やフレンドリクエストが届いた時など、ゲームクライアントの操作とは関係なく状態が変化した際に GS2-Gateway を経由してプッシュ通知をすることで、ゲームクライアントは状態の変化を検知することができます。<br>

GS2-Gateway のプッシュ通知は通知先のデバイスがオフラインだった時に追加の処理としてモバイルプッシュ通知を送信できます。<br>
モバイルプッシュ通知をうまく利用すれば、マッチメイキング中にゲームを終了しても、モバイルプッシュ通知を使用してプレイヤーに通知し、ゲームに戻ってくるフローを実現できる可能性があります。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| gatewayNamespaceId | string |  |  | "grn:gs2:{region}:{ownerId}:gateway:default" |  ~ 1024文字 | プッシュ通知に使用する GS2-Gateway のネームスペース<br>「grn:gs2:」から始まる GRN 形式で GS2-Gateway のネームスペースIDを指定します。 |
| enableTransferMobileNotification | bool? |  |  | false |  | モバイルプッシュ通知へ転送するか<br>この通知を送信しようとした時、通知先のデバイスがオフラインだった場合、モバイルプッシュ通知へ転送するかどうかを指定します。 |
| sound | string | {enableTransferMobileNotification} == true |  |  |  ~ 1024文字 | モバイルプッシュ通知で使用するサウンドファイル名<br>ここで指定したサウンドファイル名は、モバイルプッシュ通知を送信する際に使用され、特別なサウンドで通知を出すことができます。<br>※ enableTransferMobileNotification が true であれば 有効 |
| enable | 文字列列挙型<br>enum {<br>&nbsp;&nbsp;"Enabled",<br>&nbsp;&nbsp;"Disabled"<br>}<br> |  |  | "Enabled" |  | プッシュ通知を有効にするか"Enabled": 有効 / "Disabled": 無効 /  |

#### LogSetting

ログの出力設定<br>

ログデータの出力設定を管理します。この型は、ログデータを書き出すために使用される GS2-Log ネームスペースの識別子（Namespace ID）を保持します。<br>
ログネームスペースID(loggingNamespaceId)には、ログデータを収集し保存する GS2-Log のネームスペースを、GRNの形式で指定します。<br>
この設定をすることで、設定されたネームスペース内で発生したAPIリクエスト・レスポンスのログデータが、対象の GS2-Log ネームスペース側へ出力されるようになります。<br>
GS2-Log ではリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| loggingNamespaceId | string |  | ✓ |  |  ~ 1024文字 | ログを出力する GS2-Log のネームスペースGRN<br>「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。 |

#### AdMob

AdMob 広告プラットフォームに関連する設定<br>

許可された広告ユニットIDのリストを保持し、これに基づいて AdMob からの視聴完了 Webhook の検証を行います。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| allowAdUnitIds | List&lt;string&gt; |  | ✓ |  | 1 ~ 10 items | 許可する広告ユニットIDリスト<br>AdMobからの広告視聴完了コールバックに含まれる広告ユニットIDを検証するために使用されます。<br>リストに含まれる広告ユニットIDは、アプリケーションまたはゲーム内での広告視聴が適切に完了したことを確認するためのものです。<br>AdMobプラットフォームから送信される広告視聴完了の通知に含まれる広告ユニットIDがこのリストにあるかどうかを確認することで、正当な広告視聴イベントのみを受け入れ、不正なリクエストやスパムを防ぐことができます。 |

#### UnityAd

Unity Ads 広告プラットフォームに関連する設定<br>

アプリケーションやゲームで使用されるUnity Ads関連の暗号鍵を保持するために使用されます。<br>
暗号鍵はUnity Adsから発行され、広告視聴の完了を検証する際に使用します。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| keys | List&lt;string&gt; |  |  |  | 0 ~ 10 items | 暗号鍵のリスト<br>Unity Adsから発行された暗号鍵のリストを保持します。<br>これらの鍵は、Unity Ads 広告プラットフォームとの通信や広告イベントの検証に使用されます。<br><br>暗号鍵は Unity Dashboard で取得することができます。<br>リストに含まれる各鍵は、広告視聴の完了を検証するために必要です。 |

#### AppLovinMax

AppLovin MAX 広告プラットフォームに関連する設定<br>

許可された広告ユニットIDを保持し、これに基づいて AppLovin MAX からの視聴完了 Webhook の検証を行います。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| allowAdUnitId | string |  | ✓ |  |  ~ 16文字 | 許可する広告ユニットID<br>AppLovin MAX から送信される広告視聴完了コールバックに含まれる ad_unit_id を検証するために使用されます。<br>この設定に登録された広告ユニットIDと、コールバックに含まれる ad_unit_id が一致する場合のみ、広告視聴が正当に完了したものとして受け付けます。<br>これにより、許可されていない広告ユニットからの通知や不正なリクエストを拒否し、不正な広告報酬の付与やスパムを防ぐことができます。 |
| eventKey | string |  | ✓ |  |  ~ 128文字 | AppLovin Event Key<br>AppLovin MAXからの広告視聴完了コールバックが適切なアクセス元からのアクセスであることを検証する際に利用します |

---