adjust-icon

推广活动 API

使用推广活动 API 获得链接、子链接和合作伙伴信息。创建新链接和使用新的合作伙伴信息更新已有链接。

认证

推广活动 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 识别码 旁的复制按钮来将识别码复制到您的系统剪贴板。

调取合作伙伴

终端
GET https://api.adjust.com/public/v1/partners

使用此终端获取合作伙伴列表和关联数据。 返回的数据为一个合作伙伴对象数组。

参数

您可以将下列参数作为 查询参数 传递：

after (String)

请求起始游标位置。

before (String)

请求结束的游标位置。

limit (Integer)

响应中包含的最大结果数，该值必须为正整数。默认设置为 50。

分页

来自此终端的结果会通过游标进行分页。每页返回previous和next的位置。您可以将这些信息包含在调用中来返回指定页。

每个结果页都包含一个paging对象，其中包含游标位置。您可以使用这些游标位置来在不同页间程序化移动。例如，首页可能包含以下paging对象：

分页示例
"paging": {
   "page_size": "50",
   "collection_size": "49",
   "total": "199",
   "cursors": {
      "after": "g2wAAAACYhW1_gxkAANuaWxq",
      "before": null
   },
   "next": "https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers?after=g2wAAAACYhW1_gxkAANuaWxq&limit=50",
   "previous": null
}

要访问第二页，在下一个请求中的after参数中添加after值。例如：

cURL
$ curl "https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers?after=g2wAAAACYhW1_gxkAANuaWxq"

响应格式

{
   "data": {
      "api_version": "string",
      "request_id": "string",
      "timestamp": "datetime",
      "paging": {
         "page_size": "string",
         "collection_size": "string",
         "total": "string",
         "next": "string",
         "previous": "string",
         "cursors": {
            "after": "string",
            "before": "string"
         }
      },
      "items": [
         {
            "id": 100,
            "display_name": "string",
            "supports_cost_data": true
         }
      ]
   }
}

示例

cURL
$ curl \
--header 'Authorization: Token token={API_TOKEN}' \
-L -X GET 'https://api.adjust.com/public/v1/partners?limit=1'
成功响应
{
   "data": {
      "api_version": "1",
      "request_id": "FcK55-tdJUDOWQIAABsB",
      "timestamp": "2019-09-09T09:07:06Z",
      "paging": {
         "page_size": "1",
         "collection_size": "1",
         "total": "199",
         "next": "https://api.adjust.com/public/v1/partners?after=g2wAAAACYhW1_gxkAANuaWxq&limit=1",
         "previous": null,
         "cursors": {
            "after": "g2wAAAACYhW1_gxkAANuaWxq",
            "before": null
         }
      },
      "items": [
         {
            "id": 174,
            "display_name": "Adcolony",
            "supports_cost_data": true
         }
      ]
   }
}

使用此终端调取与应用关联的渠道层级链接。

所有链接均按以下格式作为项目返回：

成功响应
{
   "name": "String",
   "token": "String",
   "label": "String",
   "level": 1,
   "archived": false,
   "has_subtrackers": false,
   "partner_id": 3,
   "cost_data_enabled": false,
   "url": "String",
   "click_url": "String",
   "impression_url": "String"
}

使用此终端，为指定的应用获得子链接。

{
   "name": "String",
   "token": "String",
   "label": "String",
   "level": 2,
   "archived": false,
   "has_subtrackers": false,
   "partner_id": null,
   "cost_data_enabled": false,
   "url": "String",
   "click_url": "String",
   "impression_url": "String"
}
终端
POST https://api.adjust.com/public/v1/apps/{app_token}/trackers

使用此终端来为应用创建链接和子链接。

您必须在请求 路径 中传递以下参数：

app_token (String)

用于标识应用的字母数字识别码。长度必须为 12 个字符。

您必须在请求 数据 中传递以下参数：

name (String)

新链接的名称。

您可以在请求 数据 中传递以下参数：

parent_token (String)

子链接所在 父级链接 的链接识别码。只有在创建子链接时需要。

{
   "name": "String",
   "token": "String",
   "label": "String",
   "level": 1,
   "archived": false,
   "has_subtrackers": false,
   "partner_id": 3,
   "cost_data_enabled": false,
   "url": "String",
   "click_url": "String",
   "impression_url": "String"
}

可用的level值如下：

  • 1: 渠道层级
  • 2: 推广活动层级
  • 3: 广告组层级
  • 4: 素材层级

以下示例展示了如何创建 链接 和 子链接 。

cURL
$ curl --location --request POST 'https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/trackers' \
--header 'Authorization: Token token={API_TOKEN}' \
--header 'Content-Type: application/json' \
--data-raw '{"name": "Adroll"}'
成功响应
{
   "data": {
      "api_version": "1",
      "request_id": "FcK55-tdJUDOWQIAABsB",
      "timestamp": "2019-09-09T09:07:06Z",
      "items": [
         {
            "name": "Adroll",
            "token": "abc123",
            "label": "Adroll",
            "level": 1,
            "archived": false,
            "has_subtrackers": false,
            "partner_id": 3,
            "cost_data_enabled": false,
            "url": "https://app.adjust.com/abc123",
            "click_url": "https://app.adjust.com/abc123?campaign={campaign_name}&idfa={idfa}&deeplink=http%3A%2F%2Fa.b%2Fc%3Fd%3D1%26e%3D%%MACROS%%",
            "impression_url": "https://s2s.adjust.com/impression/abc123?campaign={campaign_name}&idfa={idfa}&s2s=1"
         }
      ]
   }
}
cURL
$ curl --location --request POST 'https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/trackers' \
--header 'Authorization: Token token={API_TOKEN}' \
--header 'Content-Type: application/json' \
--data-raw '{"parent_token": "abc123", "name": "SpringCampaign"}'
成功响应
{
   "data": {
      "api_version": "1",
      "request_id": "FcK55-tdJUDOWQIAABsB",
      "timestamp": "2019-09-09T09:07:06Z",
      "items": [
         {
            "name": "Adroll::SpringCampaign",
            "token": "xyz456",
            "label": "SpringCampaign",
            "level": 2,
            "archived": false,
            "has_subtrackers": false,
            "partner_id": 3,
            "cost_data_enabled": false,
            "url": "https://app.adjust.com/xyz456",
            "click_url": "https://app.adjust.com/xyz456?campaign={campaign_name}&idfa={idfa}&deeplink=http%3A%2F%2Fa.b%2Fc%3Fd%3D1%26e%3D%%MACROS%%",
            "impression_url": "https://s2s.adjust.com/impression/xyz456?campaign={campaign_name}&idfa={idfa}&s2s=1"
         }
      ]
   }
}
终端
PATCH https://api.adjust.com/public/v1/apps/{app_token}/trackers/{link_token}

使用此终端来更新应用的已有链接和子链接。您可以向跟踪链接添加新的合作伙伴或控制成本数据是否开启。

您必须在请求 路径 中传递以下参数：

app_token (String)

用于标识应用的字母数字识别码。长度必须为 12 个字符。

tracker_token (String)

要更新的链接的跟踪码。

您可以在请求 数据 中传递以下参数：

partner_id (Integer)

要附加至链接的合作伙伴的 ID。请参阅上文的调取合作伙伴部分，查看合作伙伴及其 ID 的列表。

cost_data_enabled (Boolean)

是否为链接启用广告支出数据。

响应参数

{
   "name": "String",
   "token": "String",
   "label": "String",
   "level": 1,
   "archived": false,
   "has_subtrackers": false,
   "partner_id": 3,
   "cost_data_enabled": false,
   "url": "String",
   "click_url": "String",
   "impression_url": "String"
}

可用的level值如下：

  • 1: 渠道层级
  • 2: 推广活动层级
  • 3: 广告组层级
  • 4: 素材层级
cURL
$ curl \
--header 'Authorization: Token token={API_TOKEN}' \
--header 'Content-Type: application/json' \
--location --request PATCH 'https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/trackers/klm789' \
--data-raw '{"partner_id": 174, "cost_data_enabled": false}'
成功响应
{
   "data": {
      "api_version": "1",
      "request_id": "FcK55-tdJUDOWQIAABsB",
      "timestamp": "2019-09-09T09:07:06Z",
      "items": [
         {
            "name": "Adcolony",
            "token": "klm789",
            "label": "Adcolony",
            "level": 1,
            "archived": false,
            "has_subtrackers": false,
            "partner_id": 174,
            "cost_data_enabled": true,
            "url": "https://app.adjust.com/klm789",
            "impression_url": "https://s2s.adjust.com/impression/klm789?s2s=1&idfa=[IDFA]&gps_adid=[GOOGLE_AD_ID]&ip_address=  [IP_ADDRESS]&adcolony_click_id=[CLICK_ID]&android_id_upper_sha1=[SHA1_ANDROID_ID]&cost_id=[CLICK_ID]&cost_type=[BID_TYPE]&cost_amount=[BID]&cost_currency=USD",
            "click_url": "https://s2s.app.adjust.com/klm789?s2s=1&idfa=[IDFA]&gps_adid=[GOOGLE_AD_ID]&ip_address=[IP_ADDRESS]&adcolony_click_id=[CLICK_ID]&android_id_upper_sha1=[SHA1_ANDROID_ID]&cost_id=[CLICK_ID]&cost_type=[BID_TYPE]&cost_amount=[BID]&cost_currency=USD"
         }
      ]
   }
}