SKAN v4 映射 API

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

重要提示:
如果目标应用未进行 SKAdNetwork v4 配置，那么该终端就会转而使用 v3 映射方案。请参阅 SKAN v3 映射终端文档。

终端

https://app.adjust.com/skadnetwork/v4/{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

响应

映射终端会返回一个数组，该数组由 3 个 JSON 对象组成。这些对象分别与 SKAdNetwork v4 发送的三个回调对应。每个 JSON 对象都有相应的 conversion_window。

终端只会在第 1 次回调时同时返回粗粒度​ 和 细粒度​ 映射信息。第 2 和第 3 次回调只包含 粗粒度​ 映射信息。

[
   {
      "data": {
         "fine": [{}],
         "coarse": [{}],
         "settings": {},
      },
      "conversion_window": 1
   },
   {
      "data": {
         "coarse": [{}],
         "settings": {},
      },
      "conversion_window": 2
   }
   {
      "data": {
         "coarse": [{}],
         "settings": {},
      },
      "conversion_window": 3
   }
]

细粒度转化值字段

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

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

[
   {
      "data": {
         "fine": [
            {
               "conversion_value":12,
               "events":[
                  {
                     "event_name":"Purchase",
                     "count_min":3,
                     "count_max":10,
                     "revenue_min":3.00,
                     "revenue_max":10.00
                  },
                  {
                     "event_name":"Registration"
                  }
               ]
            }
         ],
      }
   }
]

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

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

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

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

粗粒度转化值字段

如果转化量未达到隐私阈值标准，无法发送细粒度转化值，那么系统就会使用粗粒度转化值。粗粒度转化值分为低、中、高三个等级，是预定义转化值的聚合范围。

[
   {
      "data": {
         "coarse": [
            {
               "coarse_conversion_value": "low",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 0,
                     "revenue_max": 0.5
                  }
               ]
            },
            {
               "coarse_conversion_value": "medium",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 0.5,
                     "revenue_max": 1.0
                  }
               ]
            },
            {
               "coarse_conversion_value": "high",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 1.0,
                     "revenue_max": 50
                  }
               ]
            }
         ]
      }
   }
]
参数数据类型默认值描述
coarse_conversion_value字符串未定义粗粒度转化值等级。可以是以下之一：
  • "low"
  • "medium"
  • "high"
event_name字符串null已映射事件的名称。
count_min数字1事件被记录的次数不少于指定值。
count_max数字无上限事件被记录的次数不超过指定值。
revenue_min数字0已记录的事件总收入至少为指定值。金额以应用的 reporting_currency计算。
revenue_max数字无上限事件记录的总收入不超过指定值。金额以应用的 reporting_currency计算。

响应设置字段

[
   {
      "data": {
         "settings": {
            "lock_window": {
               "time_in_hours": 24
            },
            "app_store_id":"1125517808",
            "updated_at":1617234177,
            "reporting_currency":"USD",
         }
      }
   }
]
字段数据类型描述
app_store_id字符串应用的 App Store ID。与请求中发送的 app_store_id 参数相同。
updated_at数字向发送请求的合作伙伴显示的最新映射变更 Unix 时间戳。
lock_window对象 lockWindow相关设置。
time_in_hours数字lockWindow 时长 (以小时计)。
reporting_currency字符串应用报告币种的 ISO 4217 货币代码。应用于映射方案中定义的所有收入金额。

完整响应示例

[
   {
      "data": {
         "fine": [
            {
               "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"
                  }
               ]
            }
         ],
         "coarse": [
            {
               "coarse_conversion_value": "low",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 0,
                     "revenue_max": 0.5
                  }
               ]
            },
            {
               "coarse_conversion_value": "medium",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 0.5,
                     "revenue_max": 1.0
                  }
               ]
            },
            {
               "coarse_conversion_value": "high",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 1.0,
                     "revenue_max": 50
                  }
               ]
            }
         ],
         "settings": {
            "lock_window": {
               "time_in_hours": 24
            },
            "app_store_id":"1125517808",
            "updated_at":1617234177,
            "reporting_currency":"USD",
         }
      },
      "conversion_window": 1
   },
   {
      "data": {
         "coarse": [
            {
               "coarse_conversion_value": "low",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 0,
                     "revenue_max": 0.5
                  }
               ]
            },
            {
               "coarse_conversion_value": "medium",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 0.5,
                     "revenue_max": 1.0
                  }
               ]
            },
            {
               "coarse_conversion_value": "high",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 1.0,
                     "revenue_max": 50
                  }
               ]
            }
         ],
         "settings": {
            "app_store_id":"1125517808",
            "updated_at":1617234177,
            "reporting_currency":"USD",
         }
      },
      "conversion_window": 2
   },
   {
      "data": {
         "coarse": [
            {
               "coarse_conversion_value": "low",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 0,
                     "revenue_max": 0.5
                  }
               ]
            },
            {
               "coarse_conversion_value": "medium",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 0.5,
                     "revenue_max": 1.0
                  }
               ]
            },
            {
               "coarse_conversion_value": "high",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 1.0,
                     "revenue_max": 50
                  }
               ]
            }
         ],
         "settings": {
            "app_store_id":"1125517808",
            "updated_at":1617234177,
            "reporting_currency":"USD",
         }
      },
      "conversion_window": 3
   }
]

响应错误代码

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