削除ユーザー登録API¶

削除ユーザー登録APIを使うと、Reproのデータベースからユーザー情報を削除することができます。

注釈

リクエスト受付日の約6日後から削除処理が始まり、キャンペーン対象から除外されます。削除処理を開始した翌月の7日に削除処理が完了します。リクエスト受付日によっては完了が翌々月の7日になることもあります。
削除ユーザー登録APIを実行してから、削除されるまでの間に同じユーザー情報が送られた場合、その情報も合わせて削除されます。

警告

削除ユーザー登録APIはキャンセルできません。ご注意の上ご利用ください。

はじめに¶

削除ユーザー登録APIを使うには、Repro API トークンを利用する必要があります。

Repro API トークンの取得¶

設定 > プロジェクト設定 に行き、 認証情報 > Repro API トークン を確認します。

警告

「APIトークンの再発行」をすると既存のAPIトークンを利用できなくなり、あとから復元することはできません。

削除したいユーザーを登録する¶

削除ユーザー登録APIはHTTPの POST メソッドを受けつけるエンドポイントと紐付いています。

POST https://api.reproio.com/v3/user_data_deletions

認証¶

取得した Repro API トークンをHTTPヘッダーの X-Repro-Token フィールドに設定してください。

単位時間あたりのアクセス上限¶

削除ユーザー登録APIには、単位時間当たりのアクセス制限があります。

アクセス上限設定値は、APIトークンごとに1分あたり1000件です。
リクエストが正常に完了すると、レスポンスの X-RateLimit-Limit ヘッダーに単位時間あたりのリクエスト上限回数が記載されます。
リクエスト数がアクセス上限数を超えると、 HTTP Status 429 (Too Many Requests) が返ります。

レスポンスヘッダーの詳細は削除ユーザー登録APIのレスポンスをご覧ください。

警告

アクセス上限設定値は予告なく変動する場合があります。
アクセス上限設定値は、機能単位でのAPIトークンごととなります。

例えば、プッシュAPIとユーザープロフィールAPIは同じAPIトークンを利用していますが、別機能のため同時にリクエストしたとしても、それぞれ１件づつのカウントとなります。

APIフォーマット¶

メッセージをHTTP bodyにJSONフォーマットでセットします。

identity_type: user_id 固定です。
identity_value: アプリやWebサイト内でユーザーID APIを使って登録されたユーザーのIDを指定します。
- 登録されていないユーザーの場合は、 HTTP Status 400 (Bad Request) が返ります。詳細は削除ユーザー登録APIのレスポンスをご覧ください。

削除ユーザー登録APIのペイロード例¶

削除したいユーザーを登録する¶

{
  "identity_type": "user_id",
  "identity_value": "user-123"
}

削除ユーザー登録APIのリクエスト¶

リクエストヘッダー

リクエストのヘッダーには、以下の値を設定します。

ヘッダー	説明	必須
Content-Type	application/jsonを指定します。	必須
X-Repro-Token	Repro API トークンの取得で取得したトークンを指定します。	必須

リクエストボディ

メッセージをJSONフォーマットで設定します。

削除ユーザー登録APIのレスポンス¶

レスポンスヘッダー

レスポンスのヘッダーには、以下の値が含まれます。

ステータス	ヘッダー	説明
正常	`X-RateLimit-Limit`	単位時間あたりのアクセス上限
正常	`X-RateLimit-Remaining`	アクセスできる残り回数
正常	`X-RateLimit-Reset`	アクセス数がリセットされる時刻(unixtime)
リクエスト制限	`Retry-After`	再実行可能になるまでの秒数

レスポンスボディ

削除ユーザー登録APIをコールした際の、レスポンスに含まれるステータスコードとエラーメッセージの一覧は下記になります。

202 Accepted¶

リクエストが成功しました。

レスポンスボディ:

{
  "status": "accepted"
}

400 Bad Request¶

リクエストにエラーがあります。タイプミスなどがないかご確認ください。

レスポンスボディ:

{
  "error": {
    "messages": ["error message"]
  }
}

401 Unauthorized¶

Repro API トークンが指定されていません。

レスポンスボディ:

{
  "status": "unauthorized",
  "error": {
    "messages": [
      "Please include your Repro API Token as \"X-Repro-Token\" HTTP header."
    ]
  }
}

403 Forbidden¶

指定した Repro API トークンが間違っています。

レスポンスボディ:

{
  "status": "forbidden",
  "error": {
    "messages": [
      "Please check your Repro API Token as \"X-Repro-Token\" HTTP header."
    ]
  }
}

404 Not Found¶

エンドポイントが存在しません。

レスポンスボディ:

{
  "status": "not_found",
  "error": {
    "messages": [
      "Not found."
    ]
  }
}

415 Unsupported Media Type¶

受理できないフォーマットのデータが含まれています。リクエストヘッダの Content-Type やエンドポイントに誤りがないか確認してください。

レスポンスボディ:

{
  "error": {
    "messages": ["The provided content-type '指定されたMime Type' is not supported."]
  }
}

429 Too Many Requests¶

リクエスト数が多すぎます。 Retry-After ヘッダーに記載された秒数待った後、リクエストを再開してください。

レスポンスボディ:

{
  "status": "too_many_requests",
  "error": {
      "messages": [
          "Too many requests hit the API too quickly."
      ]
  }
}

削除が完了した時にメールを受信する¶

ユーザーの削除が完了すると、下記メールを受信します。

注釈

指定したユーザーの削除工程がすべて完了した時に受信します。