> For the complete documentation index, see [llms.txt](https://docs.ggwp.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ggwp.com/jp/apidokyumento-repto/pakkji/reptoapi.md).

# レポートAPI

\[ ベース URL: `api.ggwp.com`]

`POST` /reporting/v1/report

## **説明**

このAPIエンドポイントは、GGWPのReports Serviceとの連携に使用されます。受信した各レポートについて、レポート種別、関係者、その他の文脈情報を受け取ります。GGWP Reports Serviceには、この情報をもとにレポートと報告者の信頼性を評価し、インシデントの優先順位を付け、プレイヤーの評判スコアを調整する一連のモデルがあります。 

GGWPは、厳選されたレポートカテゴリのセットを標準でサポートしています。一般的な定義は以下のとおりですが、ゲームごとに異なる場合があります:

* **AFK** - キーボードから離れ、進行中のゲームに長時間積極的に参加していないこと
* **不正行為** - 第三者ソフトウェアやスクリプトの使用など、ゲームのルールに反する無許可の方法を用いて不公平な優位を得ること。チートの例としては、エイムボット、ウォールハック、テレポートなどがあります。
* **称賛** - ゲーム中のいずれかの前向きな行動に対して、他のプレイヤーを支持または称賛すること
* **悪用** - ゲーム内の不具合、バグ、または意図されていない機能を悪用して不公平な優位を得ること
* **迷惑行為** - 個人的な楽しみのために、意図的に他のプレイヤーのゲーム体験を妨害・破壊したり、他のプレイヤーを嫌がらせしたりすること。迷惑行為の例としては、戦利品の横取り、味方の足止め、わざと負けることなどがあります。
* **ヘイトスピーチ** - 宗教、民族、国籍、人種、性別、性的指向、その他の属性に基づいて、他のプレイヤーに差別的・侮辱的な言葉や蔑称を使うこと
* **不適切なユーザー名** - 卑猥、攻撃的、または憎悪を含む表現を含むユーザー名を使用すること
* **暴言** - 他のプレイヤーに対して侮辱的、軽蔑的、または扇動的な言葉を使うこと。こうした言葉は非常に無礼であり、他のプレイヤーが不快に感じて会話から離れたくなることがあります
* **詐欺** - 他のプレイヤーをだましたり騙したりして、意図しない、かつ潜在的に有害な行動を取らせようとすること。詐欺の例としては、住所、銀行口座番号、クレジットカード番号などの個人情報を得ようとする試みや、悪意のあるリンクをクリックさせようとする試みがあります
* **スパム行為** - ゲーム内チャットで、望まれていない、または無関係なメッセージを過剰に繰り返し送信して、他のプレイヤーを妨害または困らせること
* **チームキル** - 味方を意図的に殺害または攻撃すること
* **その他**

追加のカスタムカテゴリは、オンボーディング中に追加できます。

## **パラメータ**

`ボディ`: 次のフィールドを含む辞書:

* **reporter\_id**: レポートを送信しているプレイヤーの一意の識別子
* **reportee\_id**: 報告対象のプレイヤーの一意の識別子
* （任意） **reporter\_name**: レポートを送信しているプレイヤーの名前
* （任意） **reportee\_name**: 報告対象のプレイヤーの名前
* **category**: レポートカテゴリ名。可能であれば、上記の厳選されたレポートカテゴリの一覧を使用してください。その他のカスタムカテゴリもサポートされていますが、評判への影響を反映するために追加の調整時間が必要になります 
* （任意） **session\_id**: レポートの集計と検証のための文脈上の境界として使用される、一意のセッション識別子です。
* （任意） **timestamp**: レポートが送信された時刻 *YYYY-MM-DD HH:MM:SS* をUTC形式で。指定されていない場合は、サーバー側のUTCタイムスタンプがその代わりに追加されます
* （任意） **comment**: レポート提出時にプレイヤーが入力した可能性のあるコメント。レポートの信頼性を判断するのに役立ちます。
* （任意） **message\_id**: から取得した、報告されたメッセージまたは投稿の一意の識別子 [チャットAPI](https://docs.ggwp.com/api-docs-chat/standard-package/chat-api)。ダッシュボードで問題のあるコンテンツを表示し、検証するために必要な直接的な文脈を提供します。
* サンプル呼び出し

  ```bash
  curl --request POST 'https://api.ggwp.com/reporting/v1/report' \
  --header 'x-api-key: api_key' \\
  --header 'Content-Type: application/json' \\
  --data-raw '{
      "reporter_id":"<player_id_1>",
      "reportee_id":"<player_id_2>",
      "reporter_name": "Sniper 7",
      "reportee_name": "Skuller89",
      "comment": "ggez",
      "timestamp": "2022-12-30 07:44:37",
      "category": "言葉による虐待",
      "session_id": "<unique_session_id>",
      "message_id": "<chat_message_id>"
  }'
  ```

## **出力**

* 200 - 正常な操作

  ```json
  {
      "success": true
  }
  ```
* 400
  * エラーレスポンス。レポートはシステムに挿入されませんでした。&#x20;
  * 検証
    * &#x20;`timestamp` は無効であるか、未来の日付です。
    * `message_id` は無効です（対応するチャットメッセージが見つかりません）。
    * `reportee_id` はメッセージの作成者と同じではありません（message\_id が存在する場合）。
    * `session_id` はメッセージ内のものと同じではありません（message\_id が存在する場合）。
* 403
  * 無効な API キー、または API キーがありません
* 500
  * エラーレスポンス。レポートはシステムに挿入されませんでした。リクエスト処理中にサーバー側でエラーが発生しました