adjust-icon

深度链接生成器 API

使用深度链接生成器 API，您可以单独或批量创建应用定制深度链接。这些深度链接可长可短，能改善各个平台的用户体验。

操作前须知

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

可用性

  • 您需要使用 TrueLink Core 或 Enterprise 套餐才能使用深度链接生成器 API。
  • 使用深度链接生成器 API 创建的链接不会出现在 Campaign Lab中。
  • 使用深度链接生成器 API 创建的短链接的 TTL (生存时间) 为 120 天。

要求

认证

深度链接生成器 API 使用 Bearer 识别码进行认证。您必须在向深度链接生成器 API 发出的每个请求的 Authorization 标头中包含您的 Adjust API 识别码。

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

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

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

重置 Adjust API 识别码

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

重置 Adjust API 识别码：

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

参数

参数数据类型位置描述
adjust_auth_tokenString标头Adjust API 识别码
link_tokenString正文 (Body)自定义链接的链接识别码。如果您是从复合链接生成深度链接，请务必在 Campaign Lab 中使用复合自定义链接的正确链接识别码。
shorten_urlBoolean正文 (Body)链接是否会被缩短。默认情况下链接不会被缩短。默认值 - false
campaignString 或 null正文 (Body)推广活动名称
adgroupString 或 null正文 (Body)广告组名称
creativeString 或 null正文 (Body)素材名称
deep_link_pathString正文 (Body)指定用户被转至的应用内位置。适用于单一平台应用。
ios_deep_link_pathString正文 (Body)指定用户被转至的 iOS 应用内位置。适用于多平台 iOS 应用或复合链接。
android_deep_link_pathString正文 (Body)指定用户被转至的安卓应用内位置。适用于多平台安卓应用或复合链接。
fallbackString正文 (Body)非默认平台用户被转到的登陆页。在指定后备 URL 时，我们建议为 macOS 用户指定 redirect_macos。
redirect_macosString正文 (Body)重定向 URL，用于覆盖 Adjust 针对 macOS 的默认重定向。在指定 fallback 时，我们建议为 macOS 用户指定该参数。
labelString正文 (Body)向链接附加自定义数据。使用该参数，添加唯一的用户推荐 ID。用户分享来自应用的短链接时，该 ID 会自动填充。
og_titleString正文 (Body)链接在社交媒体上分享的预览标题。
og_descriptionString正文 (Body)链接社交平台分享预览的描述。
og_imageString正文 (Body)JPG 或 PNG 图片的 URL，大小至少为 200 x 200 像素，用于链接的社交分享预览。

发送 POST 请求，为单一或多平台应用生成长或短深度链接。

终端

https://automate.adjust.com/engage/deep-links

示例

单一平台应用

请求 - cURL
curl --location 'https://automate.adjust.com/engage/deep-links' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer adjustApiToken' \
--data '{
     "link_token": "1c52mluz",
     "redirect": "https://example.com/redirect",
     "fallback": "https://example.com/fallback",
     "deep_link_path": "/custom-path",
     "shorten_url": true
   }'
响应
{"url": "https://insights.go.link/fryYl"}

多平台应用

请求 - cURL
curl --location 'https://automate.adjust.com/engage/deep-links' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer adjustApiToken' \
--data '{
     "link_token": "2d41nkvy",
     "redirect": "https://example.com/redirect",
     "fallback": "https://example.com/fallback",
     "android_deep_link_path": "/custom-path",
     "redirect_macos": "https://www.example.com/redirectmacos",
     "shorten_url": true
   }'
响应
{ "url": "https://insights.go.link/jlbKj" }

复合链接

在使用深度链接生成器 API 生成深度链接之前，请务必在 Campaign Lab 中创建复合自定义链接。

请求 - cURL
curl --location 'https://automate.adjust.com/engage/deep-links' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer adjustApiToken' \
--data '{
     "link_token": "1c2n7ybx_1cjet4nl",
     "redirect": "https://example.com/redirect",
     "fallback": "https://example.com/fallback",
     "ios_deep_link_path": "/custom-path-ios",
     "android_deep_link_path": "/custom-path-android",
     "redirect_macos": "https://www.example.com/redirectmacos",
     "shorten_url": true
   }'
响应
{"url": "https://insights.go.link/6JtQx"}

发送POST 请求，为单一或多平台应用批量生成长或短深度链接。

终端

https://automate.adjust.com/engage/deep-links/bulk

示例

请求 - cURL
curl --location 'https://automate.adjust.com/engage/deep-links/bulk' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer adjustApiToken' \
--data '{
"data": [
    {
    "link_token": "1doptv0c",
    "redirect": "https://example.com/redirect",
    "fallback": "https://example.com/fallback",
    "campaign": "custom-campaign",
    "shorten_url": true
    },
    {
      "link_token": "1df3xslh_1dsykkaa",
      "redirect": "https://example.com/redirect",
      "fallback": "https://example.com/fallback",
      "ios_deep_link_path": "/custom-path-ios",
      "android_deep_link_path": "/custom-path-android",
      "shorten_url": true
    },
    {
      "link_token": "1dzwtdjt",
      "redirect": "https://example.com/redirect",
      "fallback": "https://example.com/fallback",
      "android_deep_link_path": "/custom-path",
      "shorten_url": true
    }
  ]
}'
响应
{
   "data": [
      {
         "url": "https://kapp.go.link/4IlkC"
      },
      {
         "url": "https://kapp.go.link/6KnoE"
      },
      {
         "url": "https://insights.go.link/5JmnD"
      }
   ]
}

发送 PUT 请求，将深度链接中的现有短链接识别码更新为长链接识别码。

终端

https://automate.adjust.com/engage/deep-links/{short_token}

示例

请求 - cURL
curl --location --request PUT 'https://automate.adjust.com/engage/deep-links/4IlkC' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer adjustApiToken' \
--data '{
  "link_token": "1doptv0c",
  "redirect": "https://example.com/new-redirect",
  "fallback": "https://example.com/new-fallback",
  "deep_link_path": "/new-custom-path"
}'
响应
204 No Content