Adjust 自动化 API

使用 Adjust 自动化 API，以程序化的方式大规模创建、更新和管理应用。借助该 API，您可以复制模板应用设置，自动设置应用，无需进行重复的手动配置就能轻松管理多个应用。

操作前须知

以下是您在操作前需要了解的内容。

可用性

• 已启用 Adjust 自动化 API 功能的账户可使用该功能。请联系您的技术客户经理，获取访问权限。
• 使用此 API 前，您需要在账户中配置 模板应用 。您的技术客户经理可以协助进行设置。

要求

1. Adjust 中的管理员或编辑员权限。
2. 有效的 Adjust API 识别码。请参阅认证指南了解详情。
3. 您账户中配置的模版应用识别码。作为模板，该应用的设置可以被复制到现有的和新的应用。

Base URL

所有 API 请求应发送至：

https://automate.adjust.com/app-automation

认证

要访问 Adjust 自动化 API，您需要通过 Authorization 标头 (Bearer token) 提供 Adjust API 识别码。

如果您的组织启用了单点登录 (SSO)，请联系您的 Adjust 代表，或发送电子邮件至 support@adjust.com，我们将帮您查找 API 识别码。

非单点登录账户的 API 识别码位于用户 个人档案 中。要找到该识别码，请按照下列步骤操作。

1. 选择账户 (用户) 图标。
2. 选择 账户设置 。
3. 选择 个人档案 标签页。
4. 您的 API 识别码 会显示在 用户详细信息 中。选择复制按钮来将识别码复制到您的系统剪贴板。

重置 Adjust API 识别码

您可以随时重置 Adjust API 识别码。重置后，旧的识别码将失效。请务必在所有使用识别码的位置进行替换。使用无效识别码发送的请求会被 Adjust 拒绝。

重置 Adjust API 识别码：

1. 选择账户 (用户) 图标。
2. 选择 账户设置 。
3. 选择 个人档案 标签页。
4. 您的 API 识别码 会显示在 用户详情 中。
5. 选择 重置 API 识别码 。
6. 在窗口中输入账户密码并选择 重置 来重置您的 API 识别码。屏幕右上角会显示确认信息。
7. 选择 API 识别码 旁的复制按钮来将识别码复制到您的系统剪贴板。

使用案例

如果您需要管理大量应用，那么 Adjust 自动化 API 非常实用。手动设置每个新应用会产生大量成本。而该 API 能为您带来下列优势：

1. 大规模创建应用 ：复制模板应用的设置，使用单个 API 请求创建多个新应用。所有合作伙伴集成、事件、归因设置和其他配置都会被自动复制。
2. 更新现有应用 ：通过更新模板应用并触发迁移，将设置更改应用于多个应用。
3. 以程序化方式管理事件 ：无需使用控制面板，即可在单个或多个应用中创建和更新事件。
4. 配置 SDK 签名 ：自动为 Android 应用设置证书指纹并管理签名的执行。
5. 跟踪作业状态 ：监控处理设置迁移的后台作业进度。

工作原理

应Adjust 自动化 API 使用 模板应用 ：

1. 设置模板应用 ：请与您的技术客户经理合作，在账户中配置模板应用。此应用应当包含您希望应用于其他应用的所有设置。

2. 创建或更新应用 ：向 /app 终端发送带有应用详情的 POST 请求。该 API 将进行下列操作：

   • 创建新应用 (如不存在)
   • 将复制模板应用设置的后台作业加入队列
   • 返回工单识别码，用于跟踪作业状态

3. 跟踪进度 ：使用工单识别码，通过 /status 终端查看设置迁移的状态。

4. 覆盖设置 ：在 override_settings 或 channel_setup 中传递应用特定值，在沿用模板大部分设置的情况下定制单个应用设置。

可用终端

哪些应用被返回？ 应用终端的按识别码获取、按商店 ID 获取和列出应用等操作仅返回 通过 API 创建或更新 的应用。应用设置终端 (和 GET 设置/csv) 会返回您账户中的 任意应用 。

应用部分

在创建或更新应用时，您可以指定要从模板应用中迁移的设置部分。如果未指定部分，则默认迁移所有部分。

快速入门

创建您的第一个应用

发送 POST 请求，根据您的模板创建新应用：

curl --location 'https://automate.adjust.com/app-automation/app' \
--header 'Authorization: Bearer {your-adjust-api-token}' \
--header 'Content-Type: application/json' \
--data '{
    "name": "My New App",
    "bundle_id": "com.example.myapp",
    "store_id": "com.example.myapp",
    "platform": "android"
}'

{
   "adjust_app_token": "abc123xyz",
   "name": "My New App",
   "bundle_id": "com.example.myapp",
   "store_id": "com.example.myapp",
   "ticket_token": "e5b07bb3-b5f3-40a8-8a2d-197d30b6beff",
   "sk_app_id": null
}

2. 查看迁移状态

使用响应中的 ticket_token 查看状态

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"], "failures": [] },
      "partners": { "successes": ["facebook", "google"], "failures": [] }
   }
}

3. 调取应用详情

迁移完成后，请调取应用详情：

curl --location 'https://automate.adjust.com/app-automation/app/abc123xyz' \
--header 'Authorization: Bearer {your-adjust-api-token}'

{
   "name": "My New App",
   "store_id": "com.example.myapp",
   "platform": "android",
   "adjust_app_token": "abc123xyz",
   "additional_info": { "overrides": {} },
   "channel_setup": {
      "facebook": { "app_id": "123456789" }
   }
}

错误处理

API 会返回标准 HTTP 状态代码和 JSON 错误响应：

{
   "error_code": "validation_error",
   "error_desc": "Human-readable error description",
   "error_desc_details": [
      { "loc": ["body", "platform"], "msg": "field required" }
   ]
}

错误代码