Epic Online Services (EOS) は、自動的に生成され、事前に割り当てられたメール アドレスとパブリック Web API キーを使用して、一元化された場所から製品をサポートする チケット システム です。チケット システムは以下をサポートします。
- 未処理 (open)、処理中 (in-progress)、完了 (closed) のチケットを追跡する
- 関係するチケットの合併
- チケットを送信したエンドユーザーに応答し、応答を受信する
操作を開始する
チケット システムを使用するには、Developer Portal を使ってチケット システムを製品と統合する必要があります。
- Developer Portal の左側のサイドバーの [Your Products (使用する製品)] で製品を選択します。Developer Portal に製品を追加していない場合、[Create Product (製品を作成する)] オプションを使って最初に製品の設定をしてください。
- サイドバーから [Game Services] > [Player Ticketing]、またはメイン ウィンドウから [Player Ticketing] タイトルを選択して [Player Ticketing] ページに移ります。
- これは、新しい製品のみに必要なステップです:次のステップに移る前に、[Integrate APIs (API を統合)] ボタンをクリックして統合します。
- [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 によってチケットを生成するには、リクエストを以下の形式にします。
システムにリクエストが受け入れられると、次のような応答を受け取ります。
その後、システムで新しいチケットが作成されます。新しいチケットはチケット システムに移動すると確認できます。
ユーザー データをエクスポートする
たとえば、GDPR リクエストを実行するためにユーザーのデータをエクスポートするには、HTTP 認証フィールドに製品の API キー、そして URL パスにデータをエクスポートしたいユーザーのメールアドレスを入力して、GET リクエストを https://dev.epicgames.com/portal/api/v1/services/tickets/datarights/{email} に送信します。
CURL を介してユーザー データをエクスポートするには、リクエストを以下の形式にします。
システムにリクエストが受け入れられると、次のような HTTP ステータス コード 200 の応答を受け取ります。
ユーザー データを削除する
たとえば、GDPR リクエストを削除するためにユーザーのデータをエクスポートするには、HTTP 認証フィールドに製品の API キー、そして URL パスにデータを削除したいユーザーのメールアドレスを入力して、DELETE リクエストを https://dev.epicgames.com/portal/api/v1/services/tickets/datarights/{email} に送信します。
CURL を介してユーザー データを削除するには、リクエストを以下の形式にします。
システムにリクエストが受け入れられると、次のような HTTP ステータス コード 204 の応答を受け取ります。
使用パターン、制約、制限
このシステムでリクエストを行う際は、ユーザーは次の制限を順守する必要があります。
- リクエストは Web サイトまたはゲーム クライアントから送信する必要があります。
- すべてのリクエストには、エンドユーザーの書面の資料が含まれている必要があります
- 1 日に作成されるリクエストの数は 10,000 件以下、すなわち、Daily Active Users (1 日あたりのアクティブ ユーザー) 100 ユーザーあたり 5 件以下である必要があります。
- このシステムのユーザー データは、上述されているようにエンドポイントでのユーザー データのエクスポートとユーザー データの削除を介して、他の EOS サービス とは別にエクスポート/削除する必要があります。