API エンドポイント
https://api.epicgames.dev/player-reports/v1/report
新規プレイヤー レポートを送信する
ポリシー
使用するクライアントポリシーでは、次のいずれかが必要です。
playerreports:sendReportForAnyUser:クライアントが任意のプレイヤーの代わりにレポートを送信するための許可がある場合。通常、レポートがゲーム サーバーからくる場合。
認証
この呼び出しには、Connect インターフェス から取得した EOS クライアント認証アクセス トークンを使用した Bearer トークン認証が必要です。
リクエスト
| HTTP リクエスト | POST /player-reports/v1/report | ||
| HTTP ヘッダ | |||
| 名前 | 値 | ||
Content-Type | application/json | ||
| リクエスト ボディ | |||
| 名前 | 型 | 説明 | 必須 |
reportingPlayerId | 文字列 | レポートを作成する EOS productUserId | 必須 |
reportedPlayerId | 文字列 | レポートされた EOS productUserId。reportingPlayerId とは異なる必要があります | 必須 |
time | 文字列 | ISO 8601 と
RFC3339 で定義されたとおりにレポートが発行された時間。例:
| 必須 |
reasonId | 整数 | レポート理由 ID。有効なIDである必要があります。詳細については | 必須 |
message | 文字列 | 最大1024文字までのレポートメッセージ | 任意 |
context | 文字列 | 任意の有効な Json。 開発者にとって役立つと思われる関連情報。 最大4096文字 | 任意 |
リクエストの例
レスポンス
| HTTP Response 201 - CREATED: Success. |
プレーヤーレポートを探す
ポリシー
使用するクライアントポリシーでは、次のいずれかが必要です。
playerreports:findReportsForAnyUser:クライアントが任意のプレイヤーのレポートを取得するための許可がある場合。
認証
この呼び出しには、Connect インターフェス から取得した EOS クライアント認証アクセス トークンを使用した Bearer トークン認証が必要です。
リクエスト
| HTTP リクエスト | GET /player-reports/v1/report/{deploymentId} | ||
| リクエスト パラメータ | |||
| 名前 | 型 | 説明 | 必須 |
deploymentId | 文字列 | EOSdeploymentId。アクセストークンによって生成された deploymentId と一致する必要があります | 必須 |
reportingPlayerId | 文字列 | レポートを作成する EOS productUserId。reportingPlayerId と reportedPlayerId の両方を空にすることはできません | 任意 |
reportedPlayerId | 文字列 | レポートされた EOS productUserId。 reportingPlayerId と reportedPlayerId の両方を空にすることはできません | 任意 |
reasonId | 整数 | レポート理由 ID。有効なIDである必要があります。詳細については /player-reports/v1/report/reason/definitionAPI エンドポイントを参照してください | 任意 |
startTime | 文字列 |
| 任意 |
endTime | 文字列 |
| 任意 |
pagination | ブーリアン | ページネーション応答を有効/無効にします デフォルト値 : false | 任意 |
offset | 整数 | ページネーション オフセット デフォルト値: 0 | 任意 |
limit | 整数 | 1回の呼び出しで返されるレポート数 デフォルト値: 50 | 任意 |
| order | 文字列 | レポートが返される順序。 可能な値:
デフォルト値: time:desc | 任意 |
リクエストの例
レスポンス
| HTTP Response 200 - OK: Success. | ||
| HTTP ヘッダ | ||
| 名前 | 値 | |
Content-Type | application/json | |
| JSON ペイロード | ||
| 名前 | 型 | 説明 |
elements | Array<Report> | レポートのリスト |
paging | Object<Paging> | ページネーション情報 |
ページング
| Paging | ||
| 名前 | 型 | 説明 |
offset | 整数 | ページネーション オフセット |
limit | 整数 | 1回の呼び出しで返されるレポート数 |
total | 整数 | レポートの総数 |
レポート
| Report | ||
| 名前 | 型 | 説明 |
productId | 文字列 | ゲーム EOS productId |
sandboxId | 文字列 | ゲーム EOS sandboxId |
deploymentId | 文字列 | ゲーム EOS deploymentId |
time | 文字列 | ISO 8601 と
RFC3339 で定義されたとおりにレポートが発行された時間。 例:
|
reportingPlayerId | 文字列 | レポートを作成する EOS productUserId |
reportedPlayerId | 文字列 | レポートされた EOS productUserId |
reasonId | 整数 | レポート理由ID |
message | 文字列 | レポートの内容 |
レスポンスの例
レポート取得理由の定義
ポリシー
レポート定義 API を呼び出すために特別なクライアント権限は必要ありません
認証
この呼び出しには、Connect インターフェス から取得した EOS クライアント認証アクセス トークンを使用した Bearer トークン認証が必要です。
リクエスト
| HTTP リクエスト | GET /player-reports/v1/report/reason/definition | |
リクエストの例
レスポンス
| HTTP Response 200 - OK: Success. | ||
| HTTP ヘッダ | ||
| 名前 | 値 | |
Content-Type | application/json | |
| JSON ペイロード | ||
| 名前 | 型 | 説明 |
elements | Array<ReportReason> | レポート理由のリスト |
レポート理由
| ReportReason | ||
| 名前 | 型 | 説明 |
reasonId | 整数 | レポート理由 ID |
reasonString | 文字列 | reasonId を記述する文字列 |