以下のような状況下では、チケットまたはエンドユーザーに関する情報を削除する必要がある場合があります。
- エンドユーザーが、エージェントへのメッセージに、意図せず機密データを送信してしまいました。
- エンドユーザーが、機密データを含むファイルをチケットに添付またはアップロードしました。
- エンドユーザーがGDPRの第17条、「忘れられる権利」を発動しました。
以下の種類の情報は、削除リクエストによって削除できます。
- ユーザー名
- メール
- エージェントまたはエンドユーザーから送信されたメッセージのコンテンツ
- CSAT(顧客満足度)フィードバック
- 添付ファイル
- カスタムチケットフィールド
- キャンペーン関連データ（ユーザー属性）
- Helpshift 分析のタイトルとユーザー識別子
当社のチケット削除プロセスに関して、以下にご留意ください。
- アーカイブされたチケットは、未解決および解決済みのチケットとともに削除されます。
- チケットまたはユーザーデータが修正された後、修正されたすべてのチケットはダッシュボードで次のようになります。
チケットが削除された後、エンドユーザーにどのように表示されるかを確認するには、「チケットが削除された後、エンドユーザーにはどのように表示されますか？」を参照してください。
削除リクエストは、下記の方法でご提出ください。この方法により、プロセスが効率化され、多数のリクエストに最適で、迅速な完了が保証されます。
REST APIを使用した完全な削除リクエスト
Helpshiftは、GDPR要件に基づいて個人サポートデータを削除するための削除リクエストを自動的に作成するために使用できるREST APIセットを提供します。修正は週単位で処理されます。
これらの削除リクエストは、「ユーザー」、「メッセージ」、「添付ファイル」、または「チケット」のいずれかであり、システムから削除するコンテンツのタイプを示します（詳細については、以下の表を参照）。その後、貴社はREST /redaction API を使用し、処理のためにHelpshiftに一連のリクエストを提供します。作成されると、Helpshiftは、その情報の実際の削除を実行する定期的なバッチプロセスを自動的にスケジュールします。貴社は、/redaction APIを定期的に使用して、現在の削除リクエストのステータスを監視できます。
柔軟性を提供するために、ユーザーによる削除は、以下の表で定義されているように、さまざまな方法で識別できます。
| タイプ | 何が墨消しされますか？ | 情報はどのように特定されますか？ | 墨消しリクエストの作成 |
|---|---|---|---|
| ユーザー | ユーザー削除は、特定のHSユーザーオブジェクトをHelpshiftから、そのユーザーのすべての個人データ、およびそのユーザーに関連付けられているすべてのチケットとともに削除します。 | HSユーザーオブジェクトは、/usersエンドポイントの下、または特定のチケットの「reporter」プロパティから見つけることができます。 | ユーザー削除は、「redaction_type」が「user」であることを示し、次のいずれかのIDを提供することによって作成されます。 |
| Issue | チケット削除は、特定のチケットから個人データを削除し、ユーザーオブジェクトとの関連付けも削除します。ただし、ユーザーオブジェクトおよびその他の関連するチケットはHelpshiftに残ります。 | これは、Helpshift チケット IDを介して識別されます。 | チケット削除は、「redaction_type」が「issue」であることを示し、チケットのIDを提供することによって作成されます。 |
| メッセージ | メッセージ削除は、指定されたメッセージIDのメッセージコンテンツを削除します。 | これは、HelpshiftメッセージIDを介して識別されます。 | メッセージ削除は、「redaction_type」が「message」であることを示し、メッセージのIDを提供することによって作成されます。 |
| 添付ファイル | 添付ファイル削除は、指定されたメッセージ内のすべての添付ファイルを削除します。 | 添付ファイルは、HelpshiftメッセージIDを介して識別されます。 | 添付ファイル削除は、「redaction_type」が「attachment」であることを示し、添付ファイルを含むメッセージのIDを提供することによって作成されます。 |
組織に、削除対象として特定されたユーザーまたはチケットのセットがある場合、REST APIを使用して、これらの削除リクエストを作成および監視できます。（REST APIの使用方法の詳細については、開発者向けドキュメントの「はじめに」をご覧ください）。
パート 1: 削除リクエストの作成 (POST /redaction)
API: POST /redaction
POST /redaction APIは、一連の削除リクエストを送信するために使用できます。「requests」パラメーターで、JSON形式のリクエストの配列として指定できます。以下に例を示します。
リクエスト：[ {
redaction_type (string) = [‘issue’, ‘user’],
property (string) = [’email’, ‘issue_id’, ‘hs_user_id’, ‘external_user_id’],
価値 (文字列)
app_publish_id (文字列)
external_redaction_id (文字列、オプション) } ]
APIコールごとに最大25件の削除リクエストが可能です。リクエストオブジェクトには、以下のプロパティが含まれています。
| プロパティ | タイプ | 必須ですか？ | 説明 |
|---|---|---|---|
| redaction_type | String | はい | 削除のタイプを示す "user" または "issue" |
| property | String | はい | 提供されるIDを示す "user_id" OR "hs_user_id" OR "issue_id" OR "email" |
| value | String | はい | 削除ン対象を特定するために使用される実際のID (ユーザーID、HSユーザーID、Issue ID、またはメールアドレス) |
| app_publish_id | String | はい | 削除が行われるアプリ - これはユーザーまたはチケットのアプリと一致する必要があります |
| external_redaction_id | String | いいえ | 削除リクエストの作成時に設定できるオプションの外部トラッキングID |
例：
サンプル CURL リクエスト:
curl -u <api-key>: -H ‘Accept:application/json’ ‘https://api.helpshift.com/v1/<domain>/redactions’ –data-urlencode ‘requests=[{“redaction_type”: “issue”, “property”:”issue_id”,”value”:”6001″, “app_publish_id”: “99”,”external_redaction_id”:”KB-tracker”}]’
応答：
以下は、POSTリクエストから返されるものです。
| パラメータ | タイプ | 説明 |
|---|---|---|
| redaction_id | ID | 削除リクエストを追跡するために使用される一意のID |
| success | T/F | 削除リクエストの作成が成功したかどうかの表示 |
| external_redaction_id | ID | 追跡のためにリクエストで指定された外部ID |
| eta | 日付 | ジョブが完了する推定日 |
| reason | 文字列 | リクエストの作成に失敗した場合、そのリクエストが失敗した理由 – ユーザーID / チケットIDが無効 / すでに削除済み / 既存の削除リクエストがある / 既存のユーザー削除リクエストの一部である |
回答例：
パート2：削除ステータスの確認
API: GET /redaction/status
GET /redaction/status APIは、既存の削除リクエストのセットと、各リクエストの現在のステータスを返します。
フィルター:
GET /redaction/status APIは、特定の削除リクエストを識別するために使用されます。以下のフィルターのうち、少なくとも1つが必要です。
| フィルター | 用途 |
|---|---|
| /redactions/status?external_redaction_id=value | 外部削除IDを使用して、削除リクエストをフィルタリングします |
| /redactions/status?redaction_id=value | 削除IDに基づいて特定の削除リクエストを検索します |
| /redactions/status?issue_id=value | チケットIDに基づいて削除リクエストを検索します |
| /redactions/status?email=value | 特定のメールアドレスに対して作成された削除リクエストを検索します |
| /redactions/status?external_user_id=value | 外部ユーザーIDに基づいて作成された削除リクエストを検索します |
| /redactions/status?hs_user_id=value | HelpshiftユーザーIDに基づいて作成された削除リクエストを検索します |
追加パラメーター：
- ページ（オプション）
- = 大量のリストを処理する際に、特定のページを返します
応答:
GETリクエストは、次の形式で削除リクエストオブジェクトのセットを含むJSONレスポンスを返します。
{
“redaction_id”: “文字列”,
"ステータス": "作成済み",
“eta”: “文字列”,
"reason": "文字列",
「リクエスト」：{
“redaction_type”: “チケット”,
「property」：「email」
"value": "文字列",
“app_publish_id”: “文字列”,
“external_redaction_id”: “文字列”
}
}
リクエストオブジェクトの詳細：
| プロパティ | タイプ | 説明 |
|---|---|---|
| redaction_id | String | HSから返された、削除リクエストのID |
| eta | String | 削除の予想日付 |
| status | String | 作成済み: エクスポートまたは削除ジョブが開始されました 完了：エクスポートまたは削除ジョブが完了しました not_found: 指定されたジョブ ID のエクスポートまたは削除ジョブはありません。 実行中: エクスポートまたは削除ジョブが進行中です waiting: エクスポートまたは削除ジョブは開始されていません |
| reason | String | リクエストの処理に失敗した理由 |
| request | Object | POST で渡された元の削除リクエストオブジェクト |
例：
GET /redactions/status?(filter) を使用して、削除のリストを表示します
CURL:
curl -u <api-key>: ‘https://api.helpshift.com/v1/<domain>/redactions/status?external_redaction_id=KB-tracker&page=1
回答例：
