当您需要支持终端用户获取个人数据电子拷贝,以满足GDPR要求时,您可以在其开发的应用中提供获取个人数据电子拷贝按钮,当终端用户点击此按钮时,您的应用服务器可以调用此接口导出其采集上报到Analytics Kit服务端的该用户个人数据电子拷贝。
应用服务器在调用该接口后,Analytics Kit服务端异步导出数据,您的应用服务器需要定时查询导出任务状态,并及时下载导出数据提供给终端用户。
承载协议 | HTTP POST |
|---|---|
接口方向 | 开发者回调接口服务器->分析服务服务器 |
接口URL | {rootUrl}/analytics/gdpr/user_data_export_requests/v2 说明: {rootUrl}:请参见接口访问路径获取。 |
数据格式 | 请求消息:Content-Type: application/json 响应消息:Content-Type: application/json |
Request Header
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
x-product-id | 是 | String | 用户在AppGallery Connect上的Product ID。 |
x-app-id | 是 | String | 用户在AppGallery Connect上的App ID。 |
Authorization | 是 | String | 鉴权信息。请参见基于OAuth 2.0开放鉴权。 说明: Bearer后面拼接空格,再拼接获取的access_token。 |
Request Body
POST /analytics/gdpr/user_data_export_requests/v2 HTTP/1.1 Content-Type: application/json; charset=UTF-8 Content-Length: xxxx Accept: application/json Authorization: Bearer *** x-product-id: sample-productid x-app-id: sample-appid { "aaid":"sample-aaid" }
状态码为200时:
Response Header
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
Content-Type | 是 | application/json | 响应消息的数据格式。 |
Response Body
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
result_code | 是 | String | 响应码,请参见错误码。 |
result_msg | 是 | String | 响应描述。 |
状态码为200时:
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 | 请求已经接收。 | - |
400 | 10020 | 非法参数。 | 请修改填写错误的参数值。 |
400 | 10021 | Client ID不等于APP ID。 | 请使用该应用对应的Client ID和Client Secret获取鉴权信息。 |
400 | 10030 | 用户已申请删除个人数据,无法导出。 | 请提示用户数据已经删除。 |
400 | 10031 | 用户申请数据已导出,上次请求距离当前请求不足两个月。 | 请提示用户需要距上次导出请求两个月后,才可以再次请求导出个人数据。 |
400 | 10008 | 请求过于频繁。 | 请提示用户请求导出数据过于频繁,稍后再试。 |
400 | 19910 |
| 请稍后重试。 |