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

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

TakeOverTypeModel

引き継ぎ情報モデル

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

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

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

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

有効化条件必須デフォルト値の制限説明
takeOverTypeModelIdstring~ 1024文字引き継ぎ情報モデルGRN
typeint~ 1024スロット番号
metadatastring~ 2048文字メタデータ
openIdConnectSettingOpenIdConnectSettingOpenID Connect の設定

OpenIdConnectSetting

OpenID Connect の設定

有効化条件必須デフォルト値の制限説明
configurationPathstring~ 1024文字Open ID Connect 設定 URL
clientIdstring~ 1024文字クライアントID
clientSecretstring{configurationPath} != “https://appleid.apple.com/.well-known/openid-configuration”~ 1024文字クライアントシークレット
appleTeamIdstring{configurationPath} == “https://appleid.apple.com/.well-known/openid-configuration”~ 1024文字Apple Developer チームID
appleKeyIdstring{configurationPath} == “https://appleid.apple.com/.well-known/openid-configuration”~ 1024文字Apple に登録済みのキーID
applePrivateKeyPemstring{configurationPath} == “https://appleid.apple.com/.well-known/openid-configuration”~ 10240文字Apple から受け取った秘密鍵
doneEndpointUrlstring~ 1024文字認証完了時に遷移するURL

PlatformUser

各種プラットフォームにおけるユーザー情報

有効化条件必須デフォルト値の制限説明
typeint~ 1024スロット番号
userIdentifierstring~ 1024文字各種プラットフォームにおけるユーザーID
userIdstring~ 128文字ユーザーID