Skip to main content

Profanity

概要​

指定されたテキストに不適切な言葉が含まれるかチェックします。
ユーザがテキストを投稿する機能を有する箇所には必ず適用してください。ProfanityAPIで不適切と判断された投稿はアプリケーション上に表示しないでください。

warning

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 メソッドレスポンスコードレスポンスメッセージ説明
GET200OKデータの取得が成功した場合
GET400Bad Requestクライアント側のリクエストデータが不正です
GET401Unauthorized認証エラーです
GET403Forbiddenリソースは存在するが認証エラー以外の理由でアクセス出来ない場合です
GET500Internal Server ErrorAPI サーバー側のエラーです
GET503Service Unavailable一時的に API が利用不可となっている場合です

レスポンス本文​

  • 入力テキストに不適切な言葉が含まれていれば false、そうでなければ true。
  • Content-Type: application/json; charset=utf-8

実例​

info

下記入力テキストは「殺す」のような不適切な言葉です。リクエストに含まれるため URLEncode されています。

Base String

GET&http%3A%2F%2Fsb.sp.mbga-platform.jp%2Fsocial%2Fapi%2Frestful%2Fv2%2Fprofanity&oauth_consumer_key%3Dc8bb6e04c60b9f6c0063%26oauth_nonce%3D0db64ddcb4c16ed78d1fd73e5dbbfa8e%26oauth_signature_method%3DHMAC-SHA1%26oauth_timestamp%3D1381219850%26oauth_token%3Dsp_client_id%253A8a714e962e6620b830ac66ba628f890f%26oauth_version%3D2.0%26text%3D%25E6%25AE%25BA%25E3%2581%2599%25E3%2581%25AE%25E3%2582%2588%25E3%2581%2586%25E3%2581%25AA%25E3%2582%258F%25E3%2582%258B%25E3%2581%2584%25E8%25A8%2580%25E8%2591%2589

HTTP リクエスト

GET /social/api/restful/v2/profanity?text=%E6%AE%BA%E3%81%99%E3%81%AE%E3%82%88%E3%81%86%E3%81%AA%E3%82%8F%E3%82%8B%E3%81%84%E8%A8%80%E8%91%89 HTTP/1.1
Host: sb.sp.mbga-platform.jp
Accept: */*
Accept-Encoding: gzip
Authorization: OAuth oauth_version="2.0",oauth_nonce="0db64ddcb4c16ed78d1fd73e5dbbfa8e",oauth_timestamp="1381219850",oauth_consumer_key="c8bb6e04c60b9f6c0063",oauth_token="sp_client_id%3A8a714e962e6620b830ac66ba628f890f",oauth_signature_method="HMAC-SHA1",oauth_signature="ROYaykoQYlV2SBdMBPUbxKIcYaU%3D"

HTTP レスポンス

HTTP/1.0 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 15
Connection: close
Date: Tue, 08 Oct 2013 08:10:51 GMT
Server: Unknown

{"valid":false}
  • 概要
  • APIリクエスト
    • エンドポイント URL
    • HTTP メソッド
    • リクエストヘッダー
    • URL クエリパラメータ
    • リクエスト本文
    • レスポンスコード
    • レスポンス本文
    • 実例