跳到主要内容

NGWord

概要​

ゲーム上での投稿における運営ポリシーに反するテキストが含まれるかどうかを確認する為の API です。 

注意

アプリケーション内ニックネームにはTextDataAPIを適用しなくても構いませんが、NGWordAPIは必ず適用し、APIで不適切と判断された投稿はアプリ上に表示しないでください(ユーザに投稿されたニックネームの審査はNGWordAPIを利用するだけではなく、別途パートナー様による監視と対応が必要です)


NGWord オブジェクトフィールド​

値説明型名前空間補足
dataテキストデータxs:stringhttp://ns.dena.jp/mbga/gameapi/v1–
validNG ワードチェックに通っているかどうかxs:booleanhttp://ns.dena.jp/mbga/gameapi/v1–

valid 値が true ならば問題無く投稿出来るテキストデータです。


API リクエスト​

HTTP メソッド​

Proxy モデル

  • POST (オーバーロード POST)
    • 入力テキストの検証

Trusted モデル

  • POST (オーバーロード POST)
    • 入力テキストの検証

オーバーロード POST とは RESTful API の統一インターフェース (GET, POST, PUT, DELETE) の操作から外れたメソッドに対するアクセスを明示する為に POST メソッドを用い、クエリパラメータ等でそのメソッドを明示することです。

本 API ではオーバーロード POST で実行するメソッドの指定に _method クエリパラメータを用います。

エンドポイント URL​

  • Sandbox 環境

    http://sb.sp.app.mbga.jp/api/restful/v1/ngword
  • 本番環境

    http://sp.app.mbga.jp/api/restful/v1/ngword

URI Template パラメータ​

特にありません


クエリパラメータ​

下記のクエリパラメータを指定する事が出来ます。

format​

レスポンス形式を指定する事が出来ます。

値説明備考
json"application/json; charset=utf8"任意、デフォルト値

_method​

オーバーロード POST によって実行するメソッド名を指定します。

値説明備考
check送信されたデータに NG ワードが含まれるかどうかをチェックするメソッドです必須

API レスポンス​

レスポンスコード​

API のレスポンスコードは以下のいずれかになります。

リクエスト HTTP メソッドレスポンスコードレスポンスメッセージ説明
GET200OK正常にデータの送信及び NG ワードの検証が完了しました。
GET400Bad Requestリクエストデータが不正です
GET401UnauthorizedOAuth による認可が失敗しています
GET500Internal Server ErrorAPI 側の問題による失敗です

注意事項​

特にありません。

サンプル​

NGWord の check​

任意のテキスト文に NG ワードが含まれているかどうかを検証する例です。

リクエスト形式​

POST /api/restful/v1/ngword?_method=check&format=json
Content-Type: application/json; charset=utf8

{
"data": "掲示板等で「殺す」などと言うと投稿が運営側によって削除される場合があります"
}

レスポンス形式​

200 OK

{
"totalResults": 1,
"itemsPerPage" : 1,
"ngword": {
"valid": false
},
"startIndex": 1
}

参考資料​

XML Schema Part 2: Datatypes Second Edition
URI Template draft-gregorio-uritemplate-03

更新履歴​

  • 2013/03/01
    • ドキュメント移行