功能介绍

终端用户在应用客户端发起个人数据导出请求,应用服务端调用此接口能够协助用户导出在分析服务平台数据的电子拷贝。

场景描述

当开发者需要支持终端用户获取个人数据电子拷贝,以满足GDPR要求时,开发者可以在其开发的应用中提供获取个人数据电子拷贝按钮,当终端用户点击此按钮时,开发者的应用服务器可以调用此接口导出其采集上报到Analytics Kit服务端的该用户个人数据电子拷贝。

使用约束

接口原型

承载协议

HTTP POST

接口方向

分析服务服务器→开发者回调接口服务器

接口URL

POST https://<URI>/analytics/gdpr/user_data_export_requests/v2

数据格式

请求消息:Content-Type: application/json

响应消息:Content-Type: application/json

请求参数

表1 请求Body参数
参数是否必选参数类型描述

aaid

是

string

用户设备标识,可以在端侧通过getAAID接口获取。

响应参数

表2 响应Body参数
参数
是否必选参数类型描述

result_code

是

String

响应码,详见错误码。

result_msg

是

String

响应描述。

响应示例

  1. HTTP/1.1 200 OK
  2. Content-Type: application/json; charset=UTF-8
  3. Connection:  Close
  4. Content-Length: xxxx
  5. {
  6.  "result_code":"0",
  7.  "result_msg":"success"
  8. }

错误码

状态码错误码响应代码描述处理建议

200

0

Success

请求已经接收。

-

400

10020

invalidParameter

非法参数。

开发者修改填写错误的参数值。

400

10030

userInstanceIdDeleted

用户已申请删除个人数据,无法导出。

开发者提示其用户数据已经删除。

400

10031

userDataExporting

用户申请数据已导出,上次请求距离当前请求两个月内。

开发者提示其用户需要距上次导出请求两个月后,才可以再次请求导出个人数据。

400

10008

tooFrequentRequest

请求过于频繁。

开发者提示其用户请求导出数据过于频繁,稍后再试。

调用示例

  1. POST /analytics/gdpr/user_data_export_requests/v2 HTTP/1.1
  2. Content-Type: application/json; charset=UTF-8
  3. Content-Length: xxxx
  4. Accept: application/json
  5. Authorization: Bearer 78C2395236BBF4262CAE4F1172E327C2929AD63EAA0395961A49DEBC3B6F8339  
  6. x-product-id: sample-productid
  7. x-app-id: sample-appid
  8. {
  9.           "aaid":”sample-aaid”
  10. }