Ticketing System

自動的に生成され、事前に割り当てられたメール アドレスとパブリック Web API キーを使用して、製品のサポートを提供します。

4 分で読めます

Epic Online Services (EOS) は、自動的に生成され、事前に割り当てられたメール アドレスとパブリック Web API キーを使用して、一元化された場所から製品をサポートする チケット システム です。チケット システムは以下をサポートします。

  • 未処理 (open)、処理中 (in-progress)、完了 (closed) のチケットを追跡する
  • 関係するチケットの合併
  • チケットを送信したエンドユーザーに応答し、応答を受信する

操作を開始する

チケット システムを使用するには、Developer Portal を使ってチケット システムを製品と統合する必要があります。

  1. Developer Portal の左側のサイドバーの [Your Products (使用する製品)] で製品を選択します。Developer Portal に製品を追加していない場合、[Create Product (製品を作成する)] オプションを使って最初に製品の設定をしてください。
  2. サイドバーから [Game Services] > [Player Ticketing]、またはメイン ウィンドウから [Player Ticketing] タイトルを選択して [Player Ticketing] ページに移ります。
  3. これは、新しい製品のみに必要なステップです:次のステップに移る前に、[Integrate APIs (API を統合)] ボタンをクリックして統合します。
  4. [Show API Key] ボタンをクリックして、製品のパブリック Web API キーを表示します。API を実装するためにこのキーが必要です。各製品には独自のパブリック Web API キーがありますが、システムはすべての製品に同じメールアドレスを使用します。

API を使用する

チケット システムでは、エンドユーザーからのメールを専用のメールボックスに送信します。このプロセスをトリガーするには、HTTP 認証フィールドに製品の API キーを入力し、報告したい情報とともに、https://dev.epicgames.com/portal/api/v1/services/tickets/submit/ に POST リクエストを送信します。次のフィールドがサポートされています。

フィールド名必須フィールド説明
subject以下のいずれかです。 * open-question * technical-support
messageエンドユーザーによって書かれたメールのテキスト
sender_emailエンドユーザーのメール アドレス
sender_name×エンドユーザーの名前
guid×エンドユーザーのゲームの一意の識別子 (productUserId など) :すべてのタイプの一意の識別子が使えます。ギルドに関して実行される制約はありません。
error_code×テクニカル サポート メールのエラー コード
system_os×エンドユーザーのオペレーティング システム
system_antimalware×エンドユーザーのマルウェア対策システム
system_other×エンドユーザーのシステムに関するその他の情報

リクエストする

CURL によってチケットを生成するには、リクエストを以下の形式にします。

curl -X POST \
https://dev.epicgames.com/portal/api/v1/services/tickets/submit/ \
-H 'Authorization:Token your_product_api_key_here' \
-H 'Content-Type: application/json' \
-d '{
"subject": "technical-support",
"message":"Example message.",
"sender_email": "example.user@example.domain",
"sender_name":"Example User",
"guid": "example_user_guid",
"error_code": "example error code",
"system_os": "example OS",
"system_antimalware": "example antimalware",
"system_other": "example system other"
}'

システムにリクエストが受け入れられると、次のような応答を受け取ります。

{
"data": {
"prod_name": "example_game",
"prod_slug": "example_game_slug",
"guid": "example_user_guid",
"sender_name":"Example User",
"sender_email": "example.user@example.domain",
"subject":"Technical Support",
"message":"Example message.",
"error_code": "example error code",
"system_os": "example OS",
"system_antimalware": "example antimalware",
"system_other": "example system other",
"timestamp":"2019-03-07T14:20:10.933689Z",
}
}

その後、システムで新しいチケットが作成されます。新しいチケットはチケット システムに移動すると確認できます。

ユーザー データをエクスポートする

たとえば、GDPR リクエストを実行するためにユーザーのデータをエクスポートするには、HTTP 認証フィールドに製品の API キー、そして URL パスにデータをエクスポートしたいユーザーのメールアドレスを入力して、GET リクエストを https://dev.epicgames.com/portal/api/v1/services/tickets/datarights/{email} に送信します。

CURL を介してユーザー データをエクスポートするには、リクエストを以下の形式にします。

curl --location --request GET \
https://dev.epicgames.com/portal/api/v1/services/tickets/datarights/example@example.com \
-H 'Authorization:Token your_product_api_key_here' \
-H 'Content-Type: application/json'

システムにリクエストが受け入れられると、次のような HTTP ステータス コード 200 の応答を受け取ります。

{
"data": [
{
"guid": "example_guid",
"subject": "technical-support: example game",
"message":"Example ticket message",
"sender_name":"Example User",
"sender_email": "example@example.com",
"timestamp":"2019-04-11T12:49:21.349000Z",
"messages": [
{
"ticket_id":1,
"message":"Example reply 2",
"sender_name":"Example User",
"sender_email": "example@example.com",
"timestamp":"2019-04-11T12:54:21.463000Z"
},
{
"ticket_id":1,
"message":"Example reply 1",
"sender_name":"Example Org Support",
"sender_email": "example_org@eos-external-support.mail.on.epicgames.com",
"timestamp":"2019-04-11T12:52:02.514000Z"
}
]
}
]
}

ユーザー データを削除する

たとえば、GDPR リクエストを削除するためにユーザーのデータをエクスポートするには、HTTP 認証フィールドに製品の API キー、そして URL パスにデータを削除したいユーザーのメールアドレスを入力して、DELETE リクエストを https://dev.epicgames.com/portal/api/v1/services/tickets/datarights/{email} に送信します。

CURL を介してユーザー データを削除するには、リクエストを以下の形式にします。

curl --location --request DELETE \
https://dev.epicgames.com/portal/api/v1/services/tickets/datarights/example@example.com \
-H 'Authorization:Token your_product_api_key_here'

システムにリクエストが受け入れられると、次のような HTTP ステータス コード 204 の応答を受け取ります。

使用パターン、制約、制限

このシステムでリクエストを行う際は、ユーザーは次の制限を順守する必要があります。

  • リクエストは Web サイトまたはゲーム クライアントから送信する必要があります。
  • すべてのリクエストには、エンドユーザーの書面の資料が含まれている必要があります
  • 1 日に作成されるリクエストの数は 10,000 件以下、すなわち、Daily Active Users (1 日あたりのアクティブ ユーザー) 100 ユーザーあたり 5 件以下である必要があります。
  • このシステムのユーザー データは、上述されているようにエンドポイントでのユーザー データのエクスポートとユーザー データの削除を介して、他の EOS サービス とは別にエクスポート/削除する必要があります。