API 端点
https://api.epicgames.dev/player-reports/v1/report
发送新玩家报告
策略
使用的客户端策略必须具有以下任一权限：
playerreports:sendReportForAnyUser：客户端有代表玩家发送报告的权限。通常为报告来自游戏服务器的情况。
授权
此调用要求使用从连接接口获取的 EOS 客户端身份验证访问令牌来进行 Bearer 令牌授权。
请求
| HTTP请求 | POST /player-reports/v1/report | ||
| HTTP标头 | |||
| 名称 | 值 | ||
内容类型 | application/json | ||
| 请求正文 | |||
| 名称 | 类型 | 说明 | 是否必填 |
reportingPlayerId | 字符串 | 用于制作报告的EOS productUserId | 是 |
reportedPlayerId | 字符串 | 已报告的EOS productUserId。它必须不同于reportingPlayerId。 | 是 |
时间 | 字符串 | 是 | |
reasonId | 整型 | 报告原因ID。它必须是有效ID。参阅 | 是 |
消息 | 字符串 | 最大长度为1024个字符的报告消息 | 否 |
上下文 | 字符串 | 所有有效的Json。适用于所有对开发人员有用的相关信息。最大长度为4096个 字符 | 否 |
请求示例
响应
| HTTP响应201 - 已创建：成功。 |
查找玩家报告
策略
使用的客户端策略必须具有以下任一权限：
playerreports:findReportsForAnyUser: 客户端具有获取玩家报告的权限。
授权
此调用要求使用从连接接口获取的 EOS 客户端身份验证访问令牌来进行 Bearer 令牌授权。
请求
| HTTP请求 | GET /player-reports/v1/report/{deploymentId} | ||
| 请求参数 | |||
| 名称 | 类型 | 说明 | 是否必填 |
deploymentId | 字符串 | EOS deploymentId。它必须与访问令牌生成的deploymentId匹配 | 是 |
reportingPlayerId | 字符串 | 制作报告的EOS productUserId。reportingPlayerId和reported PlayerId不能同时为空 | 否 |
reportedPlayerId | 字符串 | 已报告的EOS productUserId。reportingPlayerId和reportedPlayerId不能同时为空 | 否 |
reasonId | 整型 | 报告原因ID。它必须是有效ID。参阅 /player-reports/v1/report/reason/definitionapi端点了解更多信息 | 否 |
startTime | 字符串 | 在startTime之后发出的返回报告。以ISO 8601和 RFC3339格式显示的报告发布时间。 示例： 2021-01-01T00:00:00.000Z | 否 |
endTime | 字符串 | 返回在endTime之前发布的报告。以ISO
8601
和RFC3339格式显示的报告发布时间。
示例： | 否 |
分页 | 布尔值 | 启用/禁用分页响应。默认值：false | 否 |
偏移 | 整型 | 分页偏移默认值：0 | 否 |
限制 | 整型 | 每次调用返回的报告计数默认值：50 | 否 |
| 顺序 | 字符串 | 返回报告遵循的顺序如下：可能的值：
Default value: time:desc | 否 |
请求示例
响应
| HTTP响应200 - OK：成功。 | ||
| HTTP标头 | ||
| 名称 | 值 | |
内容类型 | application/json | |
| JSON负载 | ||
| 名称 | 类型 | 说明 |
| 元素 | Array<Report> | 报告列表 |
分页 | Object<Paging> | 分页信息 |
Paging
| 分页 | ||
| 名称 | 类型 | 描述 |
偏移 | 整型 | 分页偏移 |
限制 | 整型 | 每次调用返回的报告计数 |
总计 | 整型 | 报告总数 |
报告
| 报告 | ||
| 名称 | 类型 | 描述 |
productId | 字符串 | 游戏EOS productId |
sandboxId | 字符串 | 游戏EOS sandboxId |
deploymentId | 字符串 | 游戏EOS deploymentId |
时间 | 字符串 | |
reportingPlayerId | 字符串 | 制作报告的EOS productUserId |
reportedPlayerId | 字符串 | 已报告的EOS productUserId |
reasonId | 整型 | 报告reasonId |
消息 | 字符串 | 报告内容 |
示例响应
获取报告原因定义
策略
调用该报告定义 api 无需特殊的客户端权限
授权
此调用要求使用从连接接口获取的 EOS 客户端身份验证访问令牌来进行 Bearer 令牌授权。
请求
| HTTP请求 | GET /player-reports/v1/report/reason/definition | |
请求示例
响应
| HTTP响应200 - OK：成功。 | ||
| HTTP标头 | ||
| 名称 | 值 | |
内容类型 | application/json | |
| JSON负载 | ||
| 名称 | 类型 | 说明 |
元素 | Array<ReportReason> | 报告理由列表 |
报告理由
| 报告理由 | ||
| 名称 | 类型 | 描述 |
reasonId | 整型 | 报告原因ID |
reasonString | 字符串 | 描述reasonId的字符串 |