终端用户在应用客户端发起个人数据删除请求,应用服务端调用此接口能够协助用户删除在分析服务平台的数据。
当开发者需要支持终端用户删除个人数据,以满足GDPR要求时,开发者可以在其开发的应用中提供删除个人数据按钮,当终端用户点击此按钮时,开发者的应用服务器可以调用此接口删除其采集上报到Analytics Kit服务端的该用户的数据。
用户已请求导出数据,导出未完成前,不支持删除。
数据已经被删除的用户,不支持再次删除。
调用频率不超过1条/秒。
| 承载协议 | HTTP POST |
|---|---|
| 接口方向 | 分析服务服务器→开发者回调接口服务器 |
| 接口URL | POST https://<URI>/analytics/gdpr/user_deletion_requests/v2 |
| 数据格式 | 请求消息:Content-Type: application/json 响应消息:Content-Type: application/json |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
aaid | 是 | string | 用户设备标识,可以在端侧通过getAAID接口获取。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
result_code | 是 | String | 响应码,详见错误码。 |
result_msg | 是 | String | 响应描述。 |
- HTTP/1.1 200 OK
- Content-Type: application/json; charset=UTF-8
- Connection: Close
- Content-Length: xxxx
- {
- "result_code":"0",
- "result_msg":"success"
- }
| 状态码 | 错误码 | 响应代码 | 描述 | 处理建议 |
|---|---|---|---|---|
200 | 0 | Success | 请求成功。 | - |
400 | 10020 | invalidParameter | 非法参数。 | 开发者修改填写错误的参数值。 |
400 | 10032 | dataExportError | 数据导出中,无法删除。 | 开发者提示其用户,正在导出该用户的个人数据,需要待导出完成后,重新申请删除数据。 |
400 | 10033 | dataDeleted | 数据已删除。 | 开发者提示其用户数据已经删除。 |
400 | 10008 | tooFrequentRequest | 接口请求过于频繁。 | 开发者提示其用户请求导出数据过于频繁,稍后再试。 |
- POST /analytics/gdpr/user_deletion_requests/v2 HTTP/1.1
- Content-Type: application/json; charset=UTF-8
- Content-Length: xxxx
- Accept: application/json
- Authorization: Bearer 78C2395236BBF4262CAE4F1172E327C2929AD63EAA0395961A49DEBC3B6F8339
- x-product-id: sample-productid
- x-app-id: sample-appid
- {
- "aaid":”sample-aaid”
- }