Profanity
概要
指定されたテキストに不適切な言葉が含まれるかチェックします。
ユーザがテキストを投稿する機能を有する箇所には必ず適用してください。ProfanityAPIで不適切と判断された投稿はアプリケーション上に表示しないでください。
 | Textdata API と違い、機械的に不適切な言葉が含まれるかチェックします。Profanity API の利用は自社で監視を行う際には必須です。 また、Textdata API には Profanity API の機械的に不適切な言葉が含まれていないかチェックする機能が含まれていますので、Textdata API を利用する場合は、Profanity API を利用する必要はありません。 |
APIリクエスト
エンドポイント URL
Sandbox 環境
https://sb-app.mobage.jp/social/api/restful/v2/profanity
本番環境
https://app.mobage.jp/social/api/restful/v2/profanity
HTTP メソッド
- Authorization Code Grant
- GET - 入力テキストのチェック
- Client Credentials Grant
- GET - 入力テキストのチェック
リクエストヘッダー
- Authorization ヘッダーは必須になります。
URL クエリパラメータ
パラメータ名 |
型 |
説明 |
必須 |
|---|---|---|---|
text |
文字列 |
ユーザから投稿された自由文テキスト |
Yes |
format |
文字列 |
"json" を指定して下さい |
No |
リクエスト本文
なし
レスポンスコード
リクエスト HTTP メソッド |
レスポンスコード |
レスポンスメッセージ |
説明 |
|---|---|---|---|
GET |
200 |
OK |
データの取得が成功した場合 |
GET |
400 |
Bad Request |
クライアント側のリクエストデータが不正です |
GET |
401 |
Unauthorized |
認証エラーです |
GET |
403 |
Forbidden |
リソースは存在するが認証エラー以外の理由でアクセス出来ない場合です |
GET |
500 |
Internal Server Error |
API サーバー側のエラーです |
GET |
503 |
Service Unavailable |
一時的に API が利用不可となっている場合です |
レスポンス本文
- 入力テキストに不適切な言葉が含まれていれば false、そうでなければ true。
- Content-Type: application/json; charset=utf-8
実例
 | 下記入力テキストは「殺す」のような不適切な言葉です。リクエストに含まれるため URLEncode されています。 |
Base String
HTTP リクエスト
HTTP レスポンス