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

{
  "version": "2019-08-19",
  "rateModels": [
    {
      "name": "[string]交換レートの名前",
      "metadata": "[string?]メタデータ",
      "consumeActions": [
        {
          "action": "[string]スタンプタスクで実行するアクションの種類",
          "request": "[string]入手リクエストのJSON"
        }
      ],
      "timingType": "[string]交換の種類",
      "lockTime": "[int]交換実行から実際に報酬を受け取れるようになるまでの待ち時間(分)",
      "enableSkip": "[bool]スキップをすることができるか",
      "skipConsumeActions": [
        {
          "action": "[string]スタンプタスクで実行するアクションの種類",
          "request": "[string]入手リクエストのJSON"
        }
      ],
      "acquireActions": [
        {
          "action": "[string]スタンプシートを使用して実行するアクションの種類",
          "request": "[string]リクエストのJSON"
        }
      ]
    }
  ]
}
必須デフォルト値の制限説明
version2019-08-19マスターデータのフォーマットバージョン
rateModelsList<RateModel>

RateModel

交換レートモデル

交換レートはリソースとリソースを交換する際に使用するレートを定義するエンティティです。

直ちに交換できるレートだけでなく、現実時間で一定時間経過したのちに交換できるレートを設定できます。 現実時間での時間経過が必要な交換レートには、更に即時交換を実行するために必要なリソースを定義することが可能です。

必須デフォルト値の制限説明
rateModelIdstring~ 1024文字交換レートモデルGRN
namestring~ 128文字交換レートの名前
metadatastring~ 2048文字メタデータ
consumeActionsList<ConsumeAction>[]消費アクションリスト
timingTypeenum [‘immediate’, ‘await’]“immediate”~ 128文字交換の種類
lockTimeint{timingType} == “await”~ 525600交換実行から実際に報酬を受け取れるようになるまでの待ち時間(分)
enableSkipbool{timingType} == “await”falseスキップをすることができるか
skipConsumeActionsList<ConsumeAction>{skipConsumeActions}[]時短消費アクションリスト
acquireActionsList<AcquireAction>[]入手アクションリスト

AcquireAction

必須デフォルト値の制限説明
actionenum []~ 128文字スタンプシートを使用して実行するアクションの種類
requeststring~ 1048576文字リクエストのJSON

ConsumeAction

必須デフォルト値の制限説明
actionenum []~ 128文字スタンプタスクで実行するアクションの種類
requeststring~ 1048576文字入手リクエストのJSON