GS2-Account Deploy/CDK リファレンス

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

エンティティ

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

Namespace

ネームスペース

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

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

Request

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

型有効化条件必須デフォルト値の制限説明
namestring
✓
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
descriptionstring~ 1024文字説明文
transactionSettingV2TransactionSettingV2トランザクション設定(V2)
このネームスペースが発行するトランザクションをどのように実行するかを決める設定です。設定する項目は、実行に使用する GS2-Distributor のネームスペースと、トランザクションに含まれるアクションを 1 件ずつ実行して先に実行されたアクションの結果を後続のアクションから使えるようにするか、まとめて同時に実行してレスポンスタイムを短くするか、の 2 つだけです。
新しく作成するネームスペースではこちらを設定してください。これに置き換えられて非推奨となった transactionSetting は、こちらが設定されていない間だけ使用されます。
changePasswordIfTakeOverboolfalseアカウント引き継ぎ時にパスワードを変更するか
アカウント引き継ぎ時にパスワードを変更するかどうかを指定します。
この設定により、アカウント引き継ぎを実行した後に引き継ぎ前のデバイスからのログインを制限することができます。
differentUserIdForLoginAndDataRetentionboolfalseログインに使用するユーザーIDとデータの保持に使用するユーザーIDを異なるものにする
ログイン用ユーザーIDとデータ保持用ユーザーIDを分けるかどうかを指定します。
この設定により、プラットフォーマーが規定する個人情報保護の要件を少ない工数で満たせる可能性があります。

※このパラメータは、ネームスペースの作成時にのみ設定が可能です。
createAccountScriptScriptSettingアカウント新規作成したときに実行するスクリプトの設定
アカウント作成のカスタムロジックを実装するのに使用されます。
Script トリガーリファレンス - createAccount
authenticationScriptScriptSetting認証したときに実行するスクリプトの設定
認証プロセスのカスタマイズに役立ちます。
Script トリガーリファレンス - authentication
createTakeOverScriptScriptSetting引き継ぎ情報登録したときに実行するスクリプトの設定
引き継ぎ情報を初めて登録した時に報酬を与えるために、GS2-Mission のカウンターを上昇するなどのカスタムロジックを追加するのに使用されます。
Script トリガーリファレンス - createTakeOver
doTakeOverScriptScriptSetting引き継ぎ実行したときに実行するスクリプトの設定
引き継ぎ処理の追加ロジックを実装するのに役立ちます。
Script トリガーリファレンス - doTakeOver
banScriptScriptSettingアカウントBANステータスを追加したときに実行するスクリプトの設定
Script トリガーリファレンス - ban
unBanScriptScriptSettingアカウントBANステータスを解除したときに実行するスクリプトの設定
Script トリガーリファレンス - unBan
accountDeletionSettingAccountDeletionSettingアカウント削除設定
猶予期間の長さ、猶予期間中にログインしたときの動作、削除するユーザーデータの範囲など、猶予期間を設けてゲームプレイヤーアカウントを削除するための設定です。
設定されていない場合、猶予期間つきのアカウント削除の申請はエラーになります。
requestDeletionScriptScriptSettingアカウントの削除を申請したときに実行するスクリプトの設定
Script トリガーリファレンス - requestDeletion
cancelDeletionScriptScriptSettingアカウントの削除の申請を取り消したときに実行するスクリプトの設定
Script トリガーリファレンス - cancelDeletion
executeDeletionScriptScriptSetting猶予期間が過ぎてアカウントを削除するときに実行するスクリプトの設定
削除が途中で失敗すると後で再試行するため、同じアカウントに対してスクリプトが複数回実行されることがあります。スクリプトは冪等にしてください。
削除が 13 回失敗すると、以降はスクリプトを実行せずに削除を進めます。

Script トリガーリファレンス - executeDeletion
logSettingLogSettingログの出力設定
ログデータの出力設定を管理します。この型は、ログデータを書き出すために使用される GS2-Log のネームスペース情報を保持します。

GetAttr

!GetAttrタグで取得可能なリソースの生成結果

型説明
ItemNamespace作成したネームスペース

実装例

Type: GS2::Account::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSettingV2: null
  ChangePasswordIfTakeOver: false
  DifferentUserIdForLoginAndDataRetention: null
  CreateAccountScript: null
  AuthenticationScript: null
  CreateTakeOverScript: null
  DoTakeOverScript: null
  BanScript: null
  UnBanScript: null
  AccountDeletionSetting: null
  RequestDeletionScript: null
  CancelDeletionScript: null
  ExecuteDeletionScript: null
  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/account"
)


SampleStack := core.NewStack()
account.NewNamespace(
    &SampleStack,
    "namespace-0001",
    account.NamespaceOptions{
        ChangePasswordIfTakeOver: false,
        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\Account\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\Account\Model\Options\NamespaceOptions(
                changePasswordIfTakeOver: false,
                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.account.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.account.model.options.NamespaceOptions()
                        .withChangePasswordIfTakeOver(false)
                        .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.Gs2Account.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: new Gs2Cdk.Gs2Account.Model.Options.NamespaceOptions
            {
                changePasswordIfTakeOver = false,
                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 account from "@/gs2cdk/account";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new account.model.Namespace(
            this,
            "namespace-0001",
            {
                changePasswordIfTakeOver: false,
                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, account

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        account.Namespace(
            stack=self,
            name='namespace-0001',
            options=account.NamespaceOptions(
                change_password_if_take_over=False,
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

print(SampleStack().yaml())  # Generate Template

TransactionSettingV2

トランザクション設定(V2)

トランザクション設定(V2)は、ネームスペースが発行するトランザクションをどのように実行するかを決める設定です。

設定する項目は次の 2 つだけです。

  • distributorNamespaceId: トランザクションの実行に使用する GS2-Distributor のネームスペース
  • enableParallelExecution: トランザクションに含まれるアクションを 1 件ずつ実行するか、まとめて同時に実行するか

どちらを選んでも、トランザクションは発行された時点でサーバーが実行し、成否はトランザクション全体でひとつになります。あるアクションが失敗した場合は、それまでに実行されたアクションもろとも取り消され、1 つも反映されません。トランザクションの実行方法に関するそれ以外の項目は推奨構成に固定されているため、設定する必要はありません。

1 件ずつ実行する場合(既定 / enableParallelExecution が false)、各アクションは先に実行されたアクションの書き込みを踏まえて動作します。アクションは verify・consume・acquire の順に実行され、次のことができます。

  • 1 つのトランザクションの中で、同じ行を複数のアクションから更新する(まとめて同時に実行する場合は失敗します)
  • 先に実行されたアクションの書き込みを読む。List や Query の結果でも、入れ子になったトランザクションの内側でも読めます
  • %{Gs2Xxx:ActionName.path[0].field} を使って、先に実行された verify や consume アクションの結果を、後続の verify・consume・acquire アクションの引数として渡す

代わりに、レスポンスタイムは各アクションの実行時間の合計になり、1 つのトランザクションに含められるアクションは最大 20 件になります。また、各フェーズの中での実行順はアクション名、次に対象リソースの順で決まるため、リクエストに並べた順序で実行順を指定することはできません。実行は最初に失敗したアクションで停止します。

まとめて同時に実行する場合(enableParallelExecution が true)、アクションは同一のデータスナップショットに対して並列に実行されるため、レスポンスタイムは最も遅いアクション 1 件分で済み、アクション数の上限もありません。

代わりに、あるアクションから他のアクションの書き込みを読むことはできず、同じ行を 2 つのアクションが書き換えるとトランザクションは database:transaction:same.resource(400)で失敗します。同一トランザクション内で同じデータを 2 つ以上のアクションが書き換えないことを保証できる場合にだけ選択してください。%{...} は先行するフェーズ(verify → consume → acquire の順)の結果だけを参照でき、同じフェーズ内のアクションへの参照は解決されずにそのまま残ります。%{...} を含むフェーズは先行するフェーズの完了を待ってから実行されるため、その分だけレスポンスタイムが伸びます。

トランザクション設定は、トランザクション設定(V2)に置き換えられた非推奨の設定で、トランザクション設定(V2)が存在しなかった頃に作成されたネームスペースのために残されています。トランザクション設定(V2)が設定されていない間だけ適用され、トランザクション設定(V2)を設定するとそちらが優先されます。トランザクション設定で可能だった、トランザクションをクライアント実行のスタンプシートとして実行する・GS2-Distributor による AutoRun の非同期実行を行う・入手アクションを GS2-JobQueue に畳み込む、という 3 つの挙動は、こちらではあえて提供していません。

型有効化条件必須デフォルト値の制限説明
distributorNamespaceIdstring“grn:gs2:{region}:{ownerId}:distributor:default”~ 1024文字トランザクションの実行に使用する GS2-Distributor ネームスペース GRN
enableParallelExecutionboolfalseアクションを直列ではなく並列に実行するか

ScriptSetting

スクリプト設定

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

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

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

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

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

LogSetting

ログの出力設定

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

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

TransactionSetting

トランザクション設定

トランザクション設定は非推奨です。トランザクション設定(V2)がこれに置き換わります。トランザクション設定(V2)が存在しなかった頃に作成されたネームスペースのために残されており、トランザクション設定(V2)が設定されていない間だけ適用されます。新しく作成するネームスペースでは使用しないでください。

この設定は、トランザクションの実行に関わる要素――自動実行(AutoRun)、アトミック実行(AtomicCommit)、GS2-Distributor を利用した非同期実行、スクリプト結果の一括適用、GS2-JobQueue による入手アクションの非同期化、直列実行――をそれぞれ個別の項目として公開しているため、推奨構成以外の組み合わせも作れます。その推奨構成を 1 つの設定としてまとめたものがトランザクション設定(V2)です。トランザクション設定を使い続けるのは、トランザクション設定(V2)が提供しない挙動――トランザクションをクライアント実行のスタンプシートとして実行する、GS2-Distributor による AutoRun の非同期実行を行う、入手アクションを GS2-JobQueue に畳み込む――にすでに依存しているネームスペースに限ってください。

型有効化条件必須デフォルト値の制限説明
enableAutoRunboolfalse発行したトランザクションをサーバーサイドで自動的に実行するか
enableAtomicCommitbool{enableAutoRun} == truefalseトランザクションの実行をアトミックにコミットするか
※ enableAutoRun が true であれば 有効
transactionUseDistributorbool{enableAtomicCommit} == truefalseトランザクションを非同期処理で実行する
※ enableAtomicCommit が true であれば 有効
commitScriptResultInUseDistributorbool{transactionUseDistributor} == truefalseスクリプトの結果コミット処理を非同期処理で実行するか
※ transactionUseDistributor が true であれば 有効
acquireActionUseJobQueuebool{enableAtomicCommit} == truefalse入手アクションを実行する際に GS2-JobQueue を使用するか
※ enableAtomicCommit が true であれば 有効
enableSequentialExecutionbool{enableAtomicCommit} == truefalseアトミックコミットのアクションを直列に実行し、同じ行を複数のアクションで更新できるようにするか
※ enableAtomicCommit が true であれば 有効
distributorNamespaceIdstring“grn:gs2:{region}:{ownerId}:distributor:default”~ 1024文字トランザクションの実行に使用する GS2-Distributor ネームスペース GRN
queueNamespaceIdstring“grn:gs2:{region}:{ownerId}:queue:default”~ 1024文字トランザクションの実行に使用する GS2-JobQueue のネームスペース GRN

AccountDeletionSetting

アカウント削除設定

猶予期間を設けてゲームプレイヤーアカウントを削除するための設定です。
ゲームプレイヤーが削除を申請すると、アカウントはすぐには削除されず、猶予期間が過ぎた後に削除される予定となります。
猶予期間中は申請を取り消すことができ、猶予期間が過ぎるとアカウントと関連するユーザーデータが削除されます。

この設定がされていない場合、このネームスペースでは猶予期間つきのアカウント削除を申請できません。

型有効化条件必須デフォルト値の制限説明
gracePeriodMinutesint432000 ~ 131400猶予期間(分)
削除を申請してから実際にアカウントが削除されるまでの時間を分単位で指定します。
この期間中は申請を取り消すことができます。既定値は 43200 分(30 日)で、最大 131400 分(約 3 か月)まで指定できます。
0 を指定した場合、申請後の次回の削除処理でアカウントが削除されます。
loginDuringGracePeriod文字列列挙型
enum {
  “reject”,
  “cancel”
}
“reject”猶予期間中にログインしたときの動作
アカウントが削除予定となっている間にゲームプレイヤーが認証したときの動作を指定します。
「ログインを拒否する(reject)」では署名を発行せずにアカウントを返すため、ゲームプレイヤーはログインできません。
「削除を取り消してログインする(cancel)」では削除の申請を取り消したうえで、通常どおり認証を続けます。
定義説明
rejectログインを拒否する
cancel削除を取り消してログインする
cleanUserDataScope文字列列挙型
enum {
  “account”,
  “project”,
  “projectExceptMoney”
}
“account”削除するユーザーデータの範囲
猶予期間が過ぎたときに削除するユーザーデータの範囲を指定します。
「GS2-Account のみ(account)」では GS2-Account が管理するデータだけを削除します。
「プロジェクト内の全サービス(project)」ではユーザーデータの完全削除機能と同様に、プロジェクト内の全サービスのユーザーデータを削除します。
「課金を除くプロジェクト内の全サービス(projectExceptMoney)」では GS2-Money と GS2-Money2 を除く、プロジェクト内の全サービスのユーザーデータを削除します。
定義説明
accountGS2-Account のみ
projectプロジェクト内の全サービス
projectExceptMoney課金を除くプロジェクト内の全サービス

CurrentModelMaster

現在アクティブな引き継ぎ情報タイプモデルのマスターデータ

現在ネームスペース内で有効な引き継ぎ情報タイプモデルの定義を記述したマスターデータです。
GS2ではマスターデータの管理にJSON形式のファイルを使用します。
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。

JSONファイルを作成する方法として、マネージメントコンソール内にマスターデータエディタを提供しています。
また、よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。

Request

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

型有効化条件必須デフォルト値の制限説明
namespaceNamestring
✓
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
mode文字列列挙型
enum {
  “direct”,
  “preUpload”
}
“direct”更新モード
定義説明
directマスターデータを直接更新
preUploadマスターデータをアップロードしてから更新
settingsstring{mode} == “direct”
✓※
~ 5242880 バイト (5MB)マスターデータ
※ mode が “direct” であれば必須
uploadTokenstring{mode} == “preUpload”
✓※
~ 1024文字事前アップロードで取得したトークン
アップロードしたマスターデータを適用するために使用されます。
※ mode が “preUpload” であれば必須

GetAttr

!GetAttrタグで取得可能なリソースの生成結果

型説明
ItemCurrentModelMaster更新された現在アクティブな引き継ぎ情報タイプモデルのマスターデータ

実装例

Type: GS2::Account::CurrentModelMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  Settings: {
    "version": "2024-07-30",
    "takeOverTypeModels": [
      {
        "type": 0,
        "metadata": "Google",
        "openIdConnectSetting":
          {
            "configurationPath": "https://accounts.google.com/.well-known/openid-configuration",
            "clientId": "695893071400-qelt0dsu8tkotl13psnq5d1ko7kki4sl.apps.googleusercontent.com",
            "clientSecret": "secret"
          }
      },
      {
        "type": 1,
        "metadata": "Apple",
        "openIdConnectSetting":
          {
            "configurationPath": "https://appleid.apple.com/.well-known/openid-configuration",
            "clientId": "io.gs2.sample.auth",
            "appleTeamId": "9LX9LA85H8",
            "appleKeyId": "P937MLY6Z7",
            "applePrivateKeyPem": "-----BEGIN PRIVATE KEY-----\nAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\n-----END PRIVATE KEY-----"
          }
      }
    ]
  }
  UploadToken: null
import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/account"
    "github.com/openlyinc/pointy"
)


SampleStack := core.NewStack()
account.NewNamespace(
    &SampleStack,
    "namespace-0001",
    account.NamespaceOptions{},
).MasterData(
    []account.TakeOverTypeModel{
        account.NewTakeOverTypeModel(
            0,
            account.TakeOverTypeModelTakeOverMethodOpenIdConnect,
            account.TakeOverTypeModelOptions{
                Metadata: pointy.String("Google"),
                OpenIdConnectSetting: &account.OpenIdConnectSetting{
                    ConfigurationPath: "https://accounts.google.com/.well-known/openid-configuration",
                    ClientId: "695893071400-qelt0dsu8tkotl13psnq5d1ko7kki4sl.apps.googleusercontent.com",
                    ClientSecret: pointy.String("secret"),
                },
            },
        ),
        account.NewTakeOverTypeModel(
            1,
            account.TakeOverTypeModelTakeOverMethodOpenIdConnect,
            account.TakeOverTypeModelOptions{
                Metadata: pointy.String("Apple"),
                OpenIdConnectSetting: &account.OpenIdConnectSetting{
                    ConfigurationPath: "https://appleid.apple.com/.well-known/openid-configuration",
                    ClientId: "io.gs2.sample.auth",
                    AppleTeamId: pointy.String("9LX9LA85H8"),
                    AppleKeyId: pointy.String("P937MLY6Z7"),
                    ApplePrivateKeyPem: pointy.String("-----BEGIN PRIVATE KEY-----\\nAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\n-----END PRIVATE KEY-----"),
                },
            },
        ),
    },
)

println(SampleStack.Yaml())  // Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Account\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\Account\Model\TakeOverTypeModel(
                    type:0,
                    takeOverMethod: \Gs2Cdk\Account\Model\Enums\TakeOverTypeModelTakeOverMethod::OPEN_ID_CONNECT,
                    options: new \Gs2Cdk\Account\Model\Options\TakeOverTypeModelOptions(
                        metadata:"Google",
                        openIdConnectSetting:new \Gs2Cdk\Account\Model\OpenIdConnectSetting(
                            configurationPath: "https://accounts.google.com/.well-known/openid-configuration",
                            clientId: "695893071400-qelt0dsu8tkotl13psnq5d1ko7kki4sl.apps.googleusercontent.com",
                            options: new \Gs2Cdk\Account\Model\Options\OpenIdConnectSettingOptions(
                                clientSecret: "secret",
                            ),
                        )
                    )
                ),
                new \Gs2Cdk\Account\Model\TakeOverTypeModel(
                    type:1,
                    takeOverMethod: \Gs2Cdk\Account\Model\Enums\TakeOverTypeModelTakeOverMethod::OPEN_ID_CONNECT,
                    options: new \Gs2Cdk\Account\Model\Options\TakeOverTypeModelOptions(
                        metadata:"Apple",
                        openIdConnectSetting:new \Gs2Cdk\Account\Model\OpenIdConnectSetting(
                            configurationPath: "https://appleid.apple.com/.well-known/openid-configuration",
                            clientId: "io.gs2.sample.auth",
                            options: new \Gs2Cdk\Account\Model\Options\OpenIdConnectSettingOptions(
                                appleTeamId: "9LX9LA85H8",
                                appleKeyId: "P937MLY6Z7",
                                applePrivateKeyPem: "-----BEGIN PRIVATE KEY-----\\nAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\n-----END PRIVATE KEY-----",
                            ),
                        )
                    )
                )
            ]
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.account.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.account.model.TakeOverTypeModel(
                    0,
                    io.gs2.cdk.account.model.enums.TakeOverTypeModelTakeOverMethod.OPEN_ID_CONNECT,
                    new io.gs2.cdk.account.model.options.TakeOverTypeModelOptions()
                        .withMetadata("Google")
                        .withOpenIdConnectSetting(new io.gs2.cdk.account.model.OpenIdConnectSetting(
                            "https://accounts.google.com/.well-known/openid-configuration",
                            "695893071400-qelt0dsu8tkotl13psnq5d1ko7kki4sl.apps.googleusercontent.com",
                            new io.gs2.cdk.account.model.options.OpenIdConnectSettingOptions()
                                .withClientSecret("secret")
                        ))
                ),
                new io.gs2.cdk.account.model.TakeOverTypeModel(
                    1,
                    io.gs2.cdk.account.model.enums.TakeOverTypeModelTakeOverMethod.OPEN_ID_CONNECT,
                    new io.gs2.cdk.account.model.options.TakeOverTypeModelOptions()
                        .withMetadata("Apple")
                        .withOpenIdConnectSetting(new io.gs2.cdk.account.model.OpenIdConnectSetting(
                            "https://appleid.apple.com/.well-known/openid-configuration",
                            "io.gs2.sample.auth",
                            new io.gs2.cdk.account.model.options.OpenIdConnectSettingOptions()
                                .withAppleTeamId("9LX9LA85H8")
                                .withAppleKeyId("P937MLY6Z7")
                                .withApplePrivateKeyPem("-----BEGIN PRIVATE KEY-----\\nAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\n-----END PRIVATE KEY-----")
                        ))
                )
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Account.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2Account.Model.TakeOverTypeModel[] {
                new Gs2Cdk.Gs2Account.Model.TakeOverTypeModel(
                    type: 0,
                    takeOverMethod: Gs2Cdk.Gs2Account.Model.Enums.TakeOverTypeModelTakeOverMethod.OpenIdConnect,
                    options: new Gs2Cdk.Gs2Account.Model.Options.TakeOverTypeModelOptions
                    {
                        metadata = "Google",
                        openIdConnectSetting = new Gs2Cdk.Gs2Account.Model.OpenIdConnectSetting(
                            configurationPath: "https://accounts.google.com/.well-known/openid-configuration",
                            clientId: "695893071400-qelt0dsu8tkotl13psnq5d1ko7kki4sl.apps.googleusercontent.com",
                            options: new Gs2Cdk.Gs2Account.Model.Options.OpenIdConnectSettingOptions
                            {
                                clientSecret = "secret"
                            }
                        )
                    }
                ),
                new Gs2Cdk.Gs2Account.Model.TakeOverTypeModel(
                    type: 1,
                    takeOverMethod: Gs2Cdk.Gs2Account.Model.Enums.TakeOverTypeModelTakeOverMethod.OpenIdConnect,
                    options: new Gs2Cdk.Gs2Account.Model.Options.TakeOverTypeModelOptions
                    {
                        metadata = "Apple",
                        openIdConnectSetting = new Gs2Cdk.Gs2Account.Model.OpenIdConnectSetting(
                            configurationPath: "https://appleid.apple.com/.well-known/openid-configuration",
                            clientId: "io.gs2.sample.auth",
                            options: new Gs2Cdk.Gs2Account.Model.Options.OpenIdConnectSettingOptions
                            {
                                appleTeamId = "9LX9LA85H8",
                                appleKeyId = "P937MLY6Z7",
                                applePrivateKeyPem = "-----BEGIN PRIVATE KEY-----\\nAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\n-----END PRIVATE KEY-----"
                            }
                        )
                    }
                )
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template
import core from "@/gs2cdk/core";
import account from "@/gs2cdk/account";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new account.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new account.model.TakeOverTypeModel(
                    0,
                    account.model.TakeOverTypeModelTakeOverMethod.OPENIDCONNECT,
                    {
                        metadata: "Google",
                        openIdConnectSetting: new account.model.OpenIdConnectSetting(
                            "https://accounts.google.com/.well-known/openid-configuration",
                            "695893071400-qelt0dsu8tkotl13psnq5d1ko7kki4sl.apps.googleusercontent.com",
                            {
                                clientSecret: "secret"
                            }
                        )
                    }
                ),
                new account.model.TakeOverTypeModel(
                    1,
                    account.model.TakeOverTypeModelTakeOverMethod.OPENIDCONNECT,
                    {
                        metadata: "Apple",
                        openIdConnectSetting: new account.model.OpenIdConnectSetting(
                            "https://appleid.apple.com/.well-known/openid-configuration",
                            "io.gs2.sample.auth",
                            {
                                appleTeamId: "9LX9LA85H8",
                                appleKeyId: "P937MLY6Z7",
                                applePrivateKeyPem: "-----BEGIN PRIVATE KEY-----\\nAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\n-----END PRIVATE KEY-----"
                            }
                        )
                    }
                )
            ]
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template
from gs2_cdk import Stack, core, account

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        account.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            take_over_type_models=[
                account.TakeOverTypeModel(
                    type=0,
                    take_over_method=account.TakeOverTypeModelTakeOverMethod.OPEN_ID_CONNECT,
                    options=account.TakeOverTypeModelOptions(
                        metadata = 'Google',
                        open_id_connect_setting = account.OpenIdConnectSetting(
                            configuration_path='https://accounts.google.com/.well-known/openid-configuration',
                            client_id='695893071400-qelt0dsu8tkotl13psnq5d1ko7kki4sl.apps.googleusercontent.com',
                            options=account.OpenIdConnectSettingOptions(
                                client_secret='secret',
                            ),
                        )
                    ),
                ),
                account.TakeOverTypeModel(
                    type=1,
                    take_over_method=account.TakeOverTypeModelTakeOverMethod.OPEN_ID_CONNECT,
                    options=account.TakeOverTypeModelOptions(
                        metadata = 'Apple',
                        open_id_connect_setting = account.OpenIdConnectSetting(
                            configuration_path='https://appleid.apple.com/.well-known/openid-configuration',
                            client_id='io.gs2.sample.auth',
                            options=account.OpenIdConnectSettingOptions(
                                apple_team_id='9LX9LA85H8',
                                apple_key_id='P937MLY6Z7',
                                apple_private_key_pem='-----BEGIN PRIVATE KEY-----\\nAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\n-----END PRIVATE KEY-----',
                            ),
                        )
                    ),
                ),
            ],
        )

print(SampleStack().yaml())  # Generate Template

TakeOverTypeModel

引き継ぎ情報タイプモデル

引き継ぎ情報を定義するモデルです。

引き継ぎ情報とは、デバイスの機種変更やプラットフォーム間のアカウントの移動・共有時に使用する情報です。
個人を識別するユニークな文字列とパスワードで構成され、その適切な組み合わせを入力することで、Account(匿名アカウント)を取得することができます。

1つの Account に対して複数の引き継ぎ情報を設定できます。
複数の引き継ぎ情報を設定するにはそれぞれ異なるスロットを指定する必要があります。
スロットには0~1024を指定できますので、最大1025種類の引き継ぎ情報を設定可能です。

具体的な用例としては 0 には Sign in with Apple のアカウント情報を、1 には Google のアカウント情報を保存するようにする、というような使い方が想定されています。
あくまでこの引き継ぎ情報はデータホルダーであり、ソーシャルアカウントとの認証の仕組みは別途用意する必要があります。

型有効化条件必須デフォルト値の制限説明
takeOverTypeModelIdstring
※
~ 1024文字引き継ぎ情報タイプモデル GRN
※ サーバーが自動で設定
typeint
✓
0 ~ 1024スロット番号
0から1024までの範囲で指定され、異なる引き継ぎ情報を区別します。
metadatastring~ 2048文字メタデータ
メタデータには任意の値を設定できます。
これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。
takeOverMethod文字列列挙型
enum {
  “openIdConnect”,
  “issuedCode”
}
“openIdConnect”引き継ぎの方式
このスロットの引き継ぎ情報をどのように登録し、照合するかです。
openIdConnect は、OpenID Connect 準拠の Identity Provider (IdP) が発行した ID トークンで引き継ぎます。
issuedCode は、GS2 が発行したユーザーIDとパスワード(IssueTakeOverCode)で引き継ぎます。
定義説明
openIdConnectOpenID Connect
issuedCode発行したコード
openIdConnectSettingOpenIdConnectSetting{takeOverMethod} == “openIdConnect”
✓※
OpenID Connect の設定
OpenID Connect 準拠の Identity Provider (IdP) と連携するための設定です。ディスカバリURL、クライアント認証情報、Apple Sign In パラメータなどのプラットフォーム固有の設定が含まれます。
※ takeOverMethod が “openIdConnect” であれば 必須
issuedCodeSettingIssuedCodeSetting{takeOverMethod} == “issuedCode”
✓※
発行する引き継ぎコードの設定
IssueTakeOverCode で発行するコードの有効期間、失効するまでに許す失敗の回数、使用したら失効させるかの設定です。
※ takeOverMethod が “issuedCode” であれば 必須

OpenIdConnectSetting

OpenID Connect の設定

OpenID Connect 準拠の IdP の設定を登録することで、アカウントの引き継ぎ情報として IdP 連携を利用できるようになります。

型有効化条件必須デフォルト値の制限説明
configurationPathstring
✓
~ 1024文字OpenID Connect 設定 URL
OpenID Connect プロバイダーのディスカバリエンドポイント URL です。well-known 形式(例:https://example.com/.well-known/openid-configuration)に従う必要があります。
clientIdstring
✓
~ 1024文字クライアントID
IdP に登録されたアプリケーションのクライアントIDです。
clientSecretstring{configurationPath} != “https://appleid.apple.com/.well-known/openid-configuration”
✓※
~ 1024文字クライアントシークレット
※ configurationPath が “https://appleid.apple.com/.well-known/openid-configuration” 以外の、その他の IdP 連携であれば 必須
appleTeamIdstring{configurationPath} == “https://appleid.apple.com/.well-known/openid-configuration”
✓※
~ 1024文字Apple Developer チームID
Apple Developer アカウントのチームIDです。Sign in with Apple 認証に必要です。
※ configurationPath が “https://appleid.apple.com/.well-known/openid-configuration” であれば 必須
appleKeyIdstring{configurationPath} == “https://appleid.apple.com/.well-known/openid-configuration”
✓※
~ 1024文字Apple に登録済みのキーID
Sign in with Apple 用に Apple Developer アカウントに登録されたキーIDです。
※ configurationPath が “https://appleid.apple.com/.well-known/openid-configuration” であれば 必須
applePrivateKeyPemstring{configurationPath} == “https://appleid.apple.com/.well-known/openid-configuration”
✓※
~ 10240文字Apple から受け取った秘密鍵
Apple Developer ポータルからダウンロードした PEM 形式の秘密鍵です。Sign in with Apple 認証に必要です。
※ configurationPath が “https://appleid.apple.com/.well-known/openid-configuration” であれば 必須
doneEndpointUrlstring~ 1024文字認証完了時に遷移するURL
未指定の場合 /authorization/done に遷移します。
Query String に id_token が付与されます。
additionalScopeValuesList<ScopeValue>[]0 ~ 10 itemsOpenID Connect で取得する追加のスコープ
デフォルトの OpenID Connect スコープに加えて IdP にリクエストする追加の OAuth スコープです。認証時に追加のユーザー情報を取得することができます。
additionalReturnValuesList<string>[]0 ~ 10 itemsOpenID Connect で取得する追加の返却値
ID トークンまたは UserInfo レスポンスから返却値に含める追加のクレーム名です。指定されたクレームが抽出され、標準の認証結果とともに返却されます。

IssuedCodeSetting

発行する引き継ぎコードの設定

引き継ぎ用のユーザーIDとパスワードを、プレイヤーが決めるのではなく GS2 が発行する引き継ぎ情報の設定です。
発行したコードは指定した日数で失効します。使用したときや、パスワードを規定の回数間違えたときに失効させることもできます。

型有効化条件必須デフォルト値の制限説明
expiresDaysint
✓
1 ~ 365有効期間(日)
コードを発行してから失効するまでの日数です。
失効したコードでは引き継ぎを実行できません。
maxFailedAttemptsint1 ~ 100失敗の上限回数
パスワードをこの回数間違えると、発行したコードは失効します。
コードでの引き継ぎに成功すると回数は 0 に戻ります。
省略した場合は、何回間違えても失効しません。
deleteOnUsebooltrue使用したらコードを失効させるか
有効にすると、発行したコードは引き継ぎに一度成功した時点で失効します。
無効にすると、有効期間が切れるまで何度でも使用できます。

ScopeValue

スコープ値

OpenID Connect 認証時に取得される追加の OAuth スコープ値を表すキーと値のペアです。標準の OpenID Connect クレーム以外に IdP から取得した追加データの保存に使用されます。

型有効化条件必須デフォルト値の制限説明
keystring
✓
~ 64文字名前
認証時に IdP に対してリクエストしたスコープ名です。
valuestring~ 51200文字値
対応するスコープに対して IdP から返却された値です。