目录

查询导出任务状态

功能介绍

应用服务端通过该接口查询导出请求任务在分析平台的执行进展,如果平台处理完毕,应用服务器需要在指定时间内(当前是6个小时)将数据下载后提供给终端用户。

场景描述

应用服务器在调用导出个人数据接口后,Analytics Kit服务端异步导出数据,您的应用服务器需要定时查询导出任务的状态,并及时下载导出数据提供给终端用户。

使用约束

接口原型

承载协议

HTTP POST

接口方向

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

接口URL

{rootUrl}/analytics/gdpr/user_data_export_tasks/v2

说明:

{rootUrl}:请参见接口访问路径获取。

数据格式

响应消息: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

参数

是否必选

参数类型

描述

aaid

是

String

通过HMS Core端侧接口获取。

请求示例

POST /analytics/gdpr/user_data_export_tasks/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

响应描述。

task_list

是

List<UserDataExportInfo>

任务列表。

UserDataExportInfo数据结构说明

参数

是否必选

参数类型

描述

request_id

是

String

请求ID。

request_time

是

DateTime

请求时间。

status

是

String

任务状态:

  • EXPORTING:导出中

  • PENDING:等待导出

  • EXPORTED:成功导出

  • NO_DATA:没有该用户数据

  • QUERY_FAILED:查询失败

  • DATAPUSH_FAILED:导出失败

file_path

否

String

电子拷贝下载路径,该字段只有在任务状态是“EXPORTED”才会有值。

status_time

否

DateTime

状态最后更新时间。

响应示例

状态码为200时:

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Connection:  Close
Content-Length: xxxx                       
 
{
  "result_code":"0",
  "result_msg":"success",
  "task_list":[{
    "request_id":"12345678",
    "request_time":"datetime",
    "status":"EXPORTED",
    "status_time":"datetime",
    "file_path":"https://xxx/xxx.xx"
  }]
}

错误码

状态码

错误码

描述

解决方法

200

0

请求成功。

-

400

10020

非法参数。

请修改填写错误的参数值。

400

10008

请求过于频繁。

请修改代码,降低查询导出任务状态的频率。

Postman调试

您可以使用Postman在线调试此接口。