SKAN v3 映射 API

映射终端会返回广告主转化值映射的相关信息。渠道合作伙伴可向终端发送 GET​ 请求，随时调取该信息。

终端

https://app.adjust.com/skadnetwork/{sk_network_token}/mapping/{app_store_id}

GET 请求

以 JSON 对象的形式返回映射信息。每个 GET 请求都必须包含以下参数。

参数数据类型In描述
sk_network_token*字符串路径 (Path)Adjust 分配的特定合作伙伴识别码。

示例：abcdefklmn
app_store_id*字符串路径 (Path)应用的 App Store ID。

示例：1125517808

响应

映射终端会返回一个 JSON 对象，其中包含应用相关元数据和一个已映射转化值数组。每个值均有单独描述。

{
   "app_store_id":"1125517808",
   "updated_at":1617234177,
   "cut_off_period":1,
   "reporting_currency":"USD",
   "conversion_values":[
      {
         "conversion_value":7,
         "events":[
            "..."
         ]
      },
      {
         "conversion_value":10,
         "events":[
            "..."
         ]
      },
      {
         "conversion_value":12,
         "events":[
            "..."
         ]
      }
   ]
}

响应元数据参数

字段数据类型描述
app_store_id字符串应用的 App Store ID。与请求中发送的 app_store_id 参数相同。
updated_at数字向发送请求的合作伙伴显示的最新映射变更 Unix 时间戳。
cut_off_period数字应用转化值时限设置。该值以 小时为单位显示。
reporting_currency字符串应用报告币种的 ISO 4217 货币代码。适用映射方案中定义的所有收入金额。

响应转化值字段

请注意:
应用分享设置和事件关联后，映射终端会返回至少含 1 个合作伙伴事件的转化值映射信息。请查看 API 行为 了解更多信息。

映射终端会返回每个已映射转化值的细分数据和相关详情。

{
   "app_store_id":"1125517808",
   "updated_at":1617234177,
   "cut_off_period":1,
   "reporting_currency":"USD",
   "conversion_values":[
      {
         "conversion_value":12,
         "events":[
            {
               "event_name": "Purchase",
               "count_min": 3,
               "count_max": 10,
               "revenue_min": 3.000,
               "revenue_max": 10.000
            },
            { "event_name": "Registration" }
         ]
      }
   ]
}

事件数量和收入范围均为可选参数。这些参数是否被返回，取决于广告主的合作伙伴访问权限配置。可以映射的详情如下：

  • 会话
  • 会话数量
  • 事件
  • 事件数量
  • 事件收入
  • IAP
  • 广告收入
  • 总收入
请注意:
要查看收入信息，广告主必须针对发出请求的合作伙伴启用收入分享。

数量和收入范围参数均为可选参数，定义如下：

参数数据类型默认值描述
count_min数字1事件或会话的记录不少于指定数量。
count_max数字无上限事件或会话被记录的次数不超过指定值。
revenue_min数字0总收入至少为指定值。金额按应用的 reporting_currency计算。
revenue_max数字无上限总收入不超过指定值。金额按应用的 reporting_currency计算。

完整响应示例

{
   "app_store_id":"1125517808",
   "updated_at":1617234177,
   "cut_off_period":1,
   "reporting_currency":"USD",
   "conversion_values":[
      {
         "conversion_value":7,
         "events":[
            {
               "event_name":"Registration"
            }
         ]
      },
      {
         "conversion_value":10,
         "events":[
            {
               "event_name":"TutorialComplete"
            }
         ]
      },
      {
         "conversion_value":12,
         "events":[
            {
               "event_name":"Purchase",
               "count_min":3,
               "count_max":10,
               "revenue_min":3.00,
               "revenue_max":10.00
            },
            {
               "event_name":"Registration"
            }
         ]
      }
   ]
}

响应错误代码

错误代码描述
400 Bad RequestStore ID 缺失或格式错误。
401 Unauthorized渠道识别码缺失或无法被识别。
403 Forbidden应用可被识别，但未能满足所请求应用的合作伙伴分享要求。
404 Not Found未找到所请求的应用，或尚未进行 SKAdNetwork 验证。
422 Unprocessable EntityAdjust 识别并验证了所请求的应用，但应用的转化值管理功能尚未激活。
429 Too Many Requests合作伙伴/应用的请求受到限制。Adjust 建议每天调取 1 次更新。