使用 /status 终端跟踪后台作业的进度。创建或更新应用时,设置迁移会在后台运行。API 会返回一个 ticket_token 值,供您查看作业状态。
获取工单状态
使用工单识别码,调取后台作业的当前状态。
API 协议
终端: https://automate.adjust.com/app-automation/status/{ticket_token}
方法: GET
响应: 工单状态响应
参数
| 参数 | 数据类型 | 位置 | 必要参数 | 描述 |
|---|---|---|---|---|
ticket_token | String | Path | 是 | 之前 API 作业 (如应用创建或更新) 返回的工单识别码。 |
示例
curl --location 'https://automate.adjust.com/app-automation/status/e5b07bb3-b5f3-40a8-8a2d-197d30b6beff' \--header 'Authorization: Bearer {your-adjust-api-token}'{ "status": "completed", "kind": "migration", "result": { "events": { "successes": ["purchase", "registration", "level_complete"], "failures": [] }, "partners": { "successes": ["facebook", "google", "applovin"], "failures": [] }, "trackers": { "successes": ["facebook_installs", "google_installs"], "failures": [] } }}{ "status": "opened", "kind": "migration", "result": { "events": { "successes": ["purchase"], "failures": [] } }}{ "status": "failed", "kind": "migration", "result": { "events": { "successes": ["purchase"], "failures": [] }, "partners": { "section": "partners", "detail": "Could not be started because events section has failed" } }}状态值
| 状态 | 描述 |
|---|---|
new | 任务已创建,但尚未开始处理。 |
opened | 任务正在处理中。 |
completed | 作业成功完成。查看 result 字段了解详情。 |
failed | 作业失败。请查看 result 字段了解错误详情。 |
作业类型
kind 字段说明的是工单正在跟踪的作业类型:
| Kind | 描述 |
|---|---|
migration | 模板应用迁移 (将模板应用的设置复制到目标应用) |
update_app | 应用设置更新 (名称、sotre ID、Bundle ID 变更) |
create_signature | SDK 签名生成 |
event_partial_update | 事件创建或更新 |
partner_partial_update | 合作伙伴设置更新 |
tracker_partial_update | 跟踪链接设置更新 |
callback_partial_update | 回传 URL 更新 |
解读结果
result 对象包含作业期间成功和失败的相关信息。结构视作业类型而定。
迁移结果
migration 作业的结果中包括已处理的每个应用部分的状态。
{ "result": { "events": { "successes": ["event_name_1", "event_name_2"], "failures": [] }, "partners": { "successes": ["facebook", "google"], "failures": ["snapchat"] }, "trackers": { "successes": [], "failures": [], "skipped": "Partner facebook not configured in target app" } }}部分更新结果
对于部分更新作业,结果中会包含更新成功和失败的项目。
{ "result": { "successes": [{ "app_token": "abc123", "name": "purchase" }], "failures": [ { "app_token": "xyz789", "name": "invalid_event", "detail": "Event not found" } ] }}轮询状态
在等待作业完成期间,我们建议您以合理的时间间隔轮询状态终端:
- 收到工单识别码后,请等待 2 - 3 秒,然后再进行首次状态检查。
- 每 5 - 10 秒轮询一次,直至状态变为
completed或failed。 - 设置最长超时限制 (例如 5 分钟),以避免无限轮询。
数据模型
工单状态响应
| 参数 | 数据类型 | 描述 |
|---|---|---|
status* | String | 作业当前状态。状态可以是下列任一:new、opened、completed、failed。 |
kind* | String | 作业类型。可以是以下各项之一:migration、update_app、create_signature、event_partial_update、partner_partial_update、tracker_partial_update、callback_partial_update。 |
result* | Object | 作业成功和失败的相关信息。结构视作业类型而定。 |