GS2-Account マスターデータリファレンス

マスターデータのフォーマットと インポートする各種モデルのリファレンス

マスターデータのフォーマット

{
  "version": "2024-07-30",
  "takeOverTypeModels": [
    {
      "type": "[int]スロット番号",
      "metadata": "[string?]メタデータ",
      "openIdConnectSetting": {
        "configurationPath": "[string]OpenID Connect 設定 URL",
        "clientId": "[string]クライアントID",
        "clientSecret": "[string]クライアントシークレット",
        "appleTeamId": "[string]Apple Developer チームID",
        "appleKeyId": "[string]Apple に登録済みのキーID",
        "applePrivateKeyPem": "[string]Apple から受け取った秘密鍵",
        "doneEndpointUrl": "[string?]認証完了時に遷移するURL",
        "additionalScopeValues": [
          {
            "key": "[string]名前",
            "value": "[string?]値"
          }
        ],
        "additionalReturnValues": [
          "[string]OpenID Connect で取得する追加の返却値"
        ]
      }
    }
  ]
}
有効化条件必須デフォルト値の制限説明
versionstring
2024-07-30マスターデータのフォーマットバージョン
takeOverTypeModelsList<TakeOverTypeModel>~ 1000 items引き継ぎ情報タイプモデル
引き継ぎ情報を定義するモデルです。

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

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

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

モデル

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 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。
openIdConnectSettingOpenIdConnectSetting
OpenID Connect の設定
OpenID Connect 準拠の Identity Provider (IdP) と連携するための設定です。ディスカバリURL、クライアント認証情報、Apple Sign In パラメータなどのプラットフォーム固有の設定が含まれます。

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です。Apple Sign In 認証に必要です。
※ 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 形式の秘密鍵です。Apple Sign In 認証に必要です。
※ 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 レスポンスから返却値に含める追加のクレーム名です。指定されたクレームが抽出され、標準の認証結果とともに返却されます。

ScopeValue

スコープ値

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

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