メインコンテンツまでスキップ

概要

Roktのデータ削除APIは、クライアントがデータ主体の削除リクエストを当社のプラットフォームに送信して管理することを可能にします。これらのAPIは、顧客データとプライバシー規制に関するプロセスを自動化し、より自信を持ってリスクを軽減して実行します。

Roktは、Roktによってホワイトリストに登録された特定のアカウントに対するデータ削除リクエストをサポートしています。アカウントがホワイトリストに登録されていない場合でデータ削除へのアクセスが必要な際は、Roktのアカウントマネージャーにお問い合わせください。

機能​

データ削除リクエストは、現在Roktの内部システムによって処理される前に15日間キューに保持されます。リクエストのライフサイクルは以下のように説明されます：

データ削除APIサイクル

削除リクエストは次のようになります：

  • PENDING状態でAPIコールを介して作成されます。
  • 12日後（約288時間）にREADY状態に移行します。
    • READY状態になると、内部OPSチームが追加の手動レビューのために通知されます（必要な場合）。
  • 3日後（約72時間）に内部システムに渡され、最大15日間内に処理されます - 合計最大プロセス期間は30日となります。
  • PENDINGまたはREADY状態のときにのみAPIコールを介してキャンセル可能です。ステータスはCANCELLEDに変更され、以降のGETタスクコールで取得できます。

認証​

Roktのデータ削除APIは、EventおよびReporting APIに実装されているのと同じ認証メカニズムを共有しており、詳細は認証手順に記載されています。

APIにアクセスするには、AppIdと関連するAppSecretが必要です。これらは上記のドキュメントに記載されているとおり、Roktのダッシュボードで生成できます。あるいは、アカウントマネージャーに連絡して、プロセスを案内してもらうこともできます。

API構造​

データ削除APIのベースURLは、https://api.rokt.com です。

現在利用可能なエンドポイントは以下の通りです：

メソッドエンドポイント目的
POST/data/deletion-requests/emails新しいユーザーデータ削除リクエストを作成します。ユーザーは現在、生のメールアドレス（リスト）、ハッシュ化された（SHA256）メールアドレス（リスト）で識別されます。
GET/data/deletion-requests現在の（PENDING, READY）および過去の（ACTIONED, CANCELLED）データ削除リクエストのリストを返し、そのステータスを確認します。
DELETE/data/deletion-requests/:task_idAPIユーザーがREADYおよびPENDING状態のデータ削除リクエストをキャンセルできるようにします。

エンドポイント​

リクエストの作成​
エンドポイント/data/deletion-requests/emails
メソッドPOST
クエリパラメータなし
リクエストの例:​
{
  "accountId": "2456192011195196284677",
  "rawEmails": [
    "test@test.com"
  ],
  "sha256Emails": [
    "kJbnntuJYvQBhPiiHQcz6OSn0EyvzVeOBmtsG2sWkyU="
  ]
}
レスポンスの例: Http Code 202​

注:

  • 各削除リクエストには、3つのリストそれぞれに複数のエントリを含めることができます: rawEmails および sha256Emails.
  • リクエストが有効であるためには、3つのリストのうち少なくとも1つのエントリを埋める必要があります.
  • sha256Emails はbase64エンコーディングで提供する必要があります。
削除リクエストの取得​
エンドポイント/data/deletion-requests
メソッドGET
クエリパラメータなし
リクエストの例なし
レスポンスの例​
[
    {
        "taskId": "20675afe-f4e5-4ee6-bfb7-d5fddcffe16d",
        "status": "actioned",
        "deletionType": "emailsDeletion",
        "creationTime": "2022-03-01T11:00:00+11:00",
        "accountId": "3008848650853038987",
        "readyTime": null,
        "actionedTime": null,
        "cancelledTime": null
    }
]
削除リクエストのキャンセル​
エンドポイント/data/deletion-requests/:taskId
メソッドDELETE
クエリパラメータURI内 - taskId: キャンセルされる削除リクエストのID
例リクエストなし
例応答​
{
  "data": {
    "message": "taskId: 3bc2e8b0-88ee-400c-8696-44897bc95cd3のタスクは正常にキャンセルされました"
  }
}

エラーハンドリング​

すべてのAPIは最も一般的なRESTfulエラー応答コードに従います: 400, 403, 404, 500, など。

エラーは、次のJSON形式で呼び出し元に報告されます: 

{
  "error": {
    "code": 404,
    "error": "NOT_FOUND",
    "message": "task_id:... に対するタスクが見つかりません"
  }
}

現在サポートされているエラーコードは次のとおりです:

HTTPコードエラー説明
400BAD_REQUESTリクエストが不正または不完全です
500INTERNAL_SERVER_ERRORサーバー内部エラー
403AUTHENTICATION_ERRORリクエストの認証に失敗しました
403UNAUTHORIZED_ACCOUNT使用されているアカウントは現在データ削除リクエストの承認を受けていません
404NOT_FOUNDリソースが見つかりません
410DEADLINE_EXCEEDED削除リクエストは、PENDINGおよびREADY状態を過ぎているためキャンセルできません
この記事は役に立ちましたか？