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

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

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

{
  "version": "2020-04-30",
  "categoryModels": [
    {
      "category": "[int]カテゴリー",
      "rejectAccessTokenPost": "[string enum?]プレイヤーのアクセストークンを利用した投稿を拒否する"
    }
  ]
}
有効化条件必須デフォルト値の制限説明
versionstring
2020-04-30マスターデータのフォーマットバージョン
categoryModelsList<CategoryModel>~ 1000 itemsカテゴリーモデル
カテゴリーモデルは、チャットルームに投稿されるメッセージを分類するためのカテゴリーを定義します。
各カテゴリーは数値で識別され、カテゴリーごとにプレイヤーのアクセストークンを使った投稿を許可するか拒否するかを設定できます。
これにより、サーバーのみが投稿可能なシステムアナウンスカテゴリーなどのユースケースを実現できます。

モデル

CategoryModel

カテゴリーモデル

カテゴリーモデルは、チャットルームに投稿されるメッセージを分類するためのカテゴリーを定義します。
各カテゴリーは数値で識別され、カテゴリーごとにプレイヤーのアクセストークンを使った投稿を許可するか拒否するかを設定できます。
これにより、サーバーのみが投稿可能なシステムアナウンスカテゴリーなどのユースケースを実現できます。

有効化条件必須デフォルト値の制限説明
categoryModelIdstring
~ 1024文字カテゴリーモデル GRN
※ サーバーが自動で設定
categoryint
0 ~ 2147483645カテゴリー
メッセージカテゴリーの数値識別子です。このカテゴリー番号で投稿されたメッセージは、プレイヤーの投稿を許可するかなど、このモデルで定義されたルールに従います。
rejectAccessTokenPost文字列列挙型
enum {
  “Enabled”,
  “Disabled”
}
プレイヤーのアクセストークンを利用した投稿を拒否する
有効にすると、このカテゴリーではサーバーサイドの API 呼び出し(ユーザーID指定)のみがメッセージを投稿できます。プレイヤーが直接投稿すべきでないシステムアナウンスやサーバー生成メッセージに有用です。
定義説明
“Enabled”アクセストークンを利用した投稿を拒否する
“Disabled”アクセストークンを利用した投稿を許可する