プレイヤー レポート ウェブ API

Player Reports Web API を使用して、RESTful サービスで Player Reports インターフェイス機能を使用します。

API エンドポイント

https://api.epicgames.dev/player-reports/v1/report

新規プレイヤー レポートを送信する

ポリシー

使用するクライアントポリシーでは、次のいずれかが必要です。

  • playerreports:sendReportForAnyUser:クライアントが任意のプレイヤーの代わりにレポートを送信するための許可がある場合。通常、レポートがゲーム サーバーからくる場合。

認証

この呼び出しには、Connect インターフェス から取得した EOS クライアント認証アクセス トークンを使用した Bearer トークン認証が必要です。

リクエスト

HTTP Request

POST /player-reports/v1/report

HTTP Headers

Name

Value

Content-Type

application/json

Request Body

Name

Type

Description

Required

reportingPlayerId

String

The EOS productUserId making the report

Yes

reportedPlayerId

String

The reported EOS productUserId.It must be different from the "reportingPlayerId".

Yes

time

String

ISO 8601RFC3339 で定義されたとおりにレポートが発行された時間。

example:2021-01-01T00:00:00.000Z

Yes

reasonId

Integer

The report reason Id.It must be a valid id.Refer to

/player-reports/v1/report/reason/definition

api endpoint for more information

Yes

message

String

The report message with a maximum length of 1024 characters

No

context

String

Any valid Json.For any relevant information deemed useful for the developers.It has a maximum length of 4096 characters

No

リクエストの例

curl --location --request POST 'https://api.epicgames.dev/player-reports/v1/report' \
--header 'Content-Type: text/plain' \
--data-raw '{
"time":"2020-04-02T00:00:00.000Z",
"reportingPlayerId": "player_1",
"reportedPlayerId": "player_2",
"reasonId":1,
"message":"This player is cheating",
"context" : "{\"key\": \"value\"}"
}'

レスポンス

HTTP Response 201 - CREATED:Success.

https://api.epicgames.dev/player-reports/v1/report/<deploymentId>

Find Player Reports

ポリシー

使用するクライアントポリシーでは、次のいずれかが必要です。

  • playerreports:findReportsForAnyUser:クライアントが任意のプレイヤーのレポートを取得するための許可がある場合。

認証

この呼び出しには、Connect インターフェス から取得した EOS クライアント認証アクセス トークンを使用した Bearer トークン認証が必要です。

リクエスト

HTTP Request

GET /player-reports/v1/report/<deploymentId>

Request Parameters

Name

Type

Description

Required

deploymentId

String

The EOS deploymentId.It has to match the deploymentId generated by the access token

Yes

reportingPlayerId

String

The EOS productUserId making the report. "reportingPlayerId" and "reported PlayerId" cannot be both empty

No

reportedPlayerId

String

The reported EOS productUserId. "reportingPlayerId" and "reported PlayerId" cannot be both empty

No

reasonId

Integer

The report reason Id.It must be a valid id.Refer to

/player-reports/v1/report/reason/definition

api endpoint for more information

No

startTime

String

Return reports issued after startTime.

ISO 8601RFC3339 で定義されたとおりにレポートが発行された時間。

example:2021-01-01T00:00:00.000Z

No

endTime

String

Return reports issued before endTime.

ISO 8601RFC3339 で定義されたとおりにレポートが発行された時間。

example:2021-01-01T00:00:00.000Z

No

pagination

Boolean

Enable/Disable pagination response.

Default value : false

No

offset

Integer

The pagination offset

Default value:0

No

limit

Integer

The reports count returned per call

Default value:50

No

order

String

The order followed by returned reports:

Possible values:

  • time:desc

  • time:asc

  • reasonId:asc

  • reasonId:desc

Default value: time:desc

No

リクエストの例

curl --location --request GET 'https://api.epicgames.dev/player-reports/v1/report/deployment_0?reportingPlayerId=player_1&reportingPlayerId=player_2&reportingPlayerId=player_3&reasonId=1&reasonId=2&pagination=true&offset=0&limit=10&startTime=2018-05-01T00:00:00.000&endTime=2020-06-01T00:00:00.000Z&order=time:asc'

レスポンス

HTTP Response 200 - OK:Success.

HTTP Headers

Name

Value

Content-Type

application/json

JSON Payload

Name

Type

Description

elements

Array<Report>

List of reports

paging

Object<Paging>

Pagination information

Paging

offset

Integer

The pagination offset

limit

Integer

The reports count returned per call

total

Integer

The total reports count

Report

productId

String

The game EOS productId

sandboxId

String

The game EOS sandboxId

deploymentId

String

The game EOS deploymentId

time

String

ISO 8601RFC3339 で定義されたとおりにレポートが発行された時間。

example:2021-01-01T00:00:00.000Z

reportingPlayerId

String

The EOS productUserId making the report

reportedPlayerId

String

The reported EOS productUserId

reasonId

Integer

The report reasonId

message

String

The report content

レスポンスの例

{
  "paging": {
    "offset":0,
    "limit":1,
    "total":1
  },
  "elements": [
    {
      "productId": "product_0",
      "sandboxId": "sandbox_0",
      "deploymentId": "deployment_0",
      "time":"2019-04-01T00:00:00.000Z",
      "reportingPlayerId": "player_1",
      "reportedPlayerId": "player_2",
      "reasonId":1,
      "message":"This player is cheating"
    }
  ]
}

https://api.epicgames.dev/player-reports/v1/report/reason/definition

レポート取得理由の定義

ポリシー

レポート定義 API を呼び出すために特別なクライアント権限は必要ありません

認証

この呼び出しには、Connect インターフェス から取得した EOS クライアント認証アクセス トークンを使用した Bearer トークン認証が必要です。

リクエスト

HTTP Request

GET /player-reports/v1/report/reason/definition

リクエストの例

curl --location --request GET 'https://api.epicgames.dev/player-reports/v1/report/reason/definition'

レスポンス

HTTP Response 200 - OK:Success.

HTTP Headers

Name

Value

Content-Type

application/json

JSON Payload

Name

Type

Description

elements

Array<ReportReason>

List of report reasons

ReportReason

reasonId

Integer

The report reason Id

reasonString

String

A String describing the reasonId

レスポンスの例

{
    "elements": [
        {
            "reasonId":1,
            "reasonString":"Cheating"
        },
        {
            "reasonId":2,
            "reasonString":"Exploiting"
        },
        {
            "reasonId":3,
            "reasonString":"Offensive profile"
        },
        {
            "reasonId":4,
            "reasonString":"Verbal abuse"
        },
        {
            "reasonId":5,
            "reasonString":"Scamming"
        },
        {
            "reasonId":6,
            "reasonString":"Spamming"
        },
        {
            "reasonId":7,
            "reasonString":"Other negative behavior"
        }
    ]
}