GS2-Chat マスターデータリファレンス
マスターデータのフォーマットと インポートする各種モデルのリファレンス
マスターデータのフォーマット
{
"version": "2020-04-30",
"categoryModels": [
{
"category": "[int]カテゴリー",
"rejectAccessTokenPost": "[string enum?]プレイヤーのアクセストークンを利用した投稿を拒否する"
}
]
}| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| version | string | ✓ | 2020-04-30 | マスターデータのフォーマットバージョン | ||
| categoryModels | List<CategoryModel> | ~ 1000 items | カテゴリーモデル カテゴリーモデルは、チャットルームに投稿されるメッセージを分類するためのカテゴリーを定義します。 各カテゴリーは数値で識別され、カテゴリーごとにプレイヤーのアクセストークンを使った投稿を許可するか拒否するかを設定できます。 これにより、サーバーのみが投稿可能なシステムアナウンスカテゴリーなどのユースケースを実現できます。 |
モデル
CategoryModel
カテゴリーモデル
カテゴリーモデルは、チャットルームに投稿されるメッセージを分類するためのカテゴリーを定義します。
各カテゴリーは数値で識別され、カテゴリーごとにプレイヤーのアクセストークンを使った投稿を許可するか拒否するかを設定できます。
これにより、サーバーのみが投稿可能なシステムアナウンスカテゴリーなどのユースケースを実現できます。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| categoryModelId | string | ※ | ~ 1024文字 | カテゴリーモデル
GRN ※ サーバーが自動で設定 | ||||||||
| category | int | ✓ | 0 ~ 2147483645 | カテゴリー メッセージカテゴリーの数値識別子です。このカテゴリー番号で投稿されたメッセージは、プレイヤーの投稿を許可するかなど、このモデルで定義されたルールに従います。 | ||||||||
| rejectAccessTokenPost | 文字列列挙型 enum { “Enabled”, “Disabled” } | プレイヤーのアクセストークンを利用した投稿を拒否する 有効にすると、このカテゴリーではサーバーサイドの API 呼び出し(ユーザーID指定)のみがメッセージを投稿できます。プレイヤーが直接投稿すべきでないシステムアナウンスやサーバー生成メッセージに有用です。
|