获取SKAN转化信息API参考(Singular合作伙伴的SKadNetwork API)

如果您是Singular合作的媒体渠道您可以使用转化模型API以获取广告主配置的当前转化模型的详细信息。注意:这是一个受限功能。要访问此API,请联系Singular合作伙伴经理或者我们的Singular支持。

更多有关信息,请参阅Singular SKAdNetwork集成:合作伙伴常见问题

如果您是Singular客户, 请参阅模型配置常见问题

 

获取SKAN转化信息端点

获取 https://api.singular.net/api/skadnetwork/conversion_info

使用方法

SKAdNetwork回传可以包含一个转化值,它是一个介于063之间的数字。Singular提供了多种不同的转化值模型的选择,以将尽可能多的信息映射到转化值。广告主可以在转化模型面板中即时调整转化模型的设置或者切换不同的转化模型。

如果您想要解析转化值,请查询转化模型端点,以获取当前为应用程序启用的转化模型的详细信息。

如果满足以下要求,此API将为给定应用程序返回已配置的转化模型:

查询示例

https://api.singular.net/api/skadnetwork/conversion_info?api_key=[api_key]&app_id=14
41750662&org_type=partner

查询参数

参数 是否需要
描述 例子
api_key Yes

Singular为SKAdNetwork集成提供的Singular SKAN API密钥。可以是URL的一部分,也可以是 授权HTTP。

6aed7434-737f-4cae-9fd4-ff
1a0f17b0d1
app_id Yes Apple应用ID。 1441750662
bundle_id Yes 应用程序的bundle ID(应用程序还未在App Store发布时需要)。 com.my.app
org_type org_type 输入“合作伙伴”。 partner
app_response_type No 默认是“bundle_id”。确定API响应是否应由应用程序的bundle ID或Apple应用程序ID键入。请注意, app_response_type=app_id只会返回应用商店中已上线的应用。app_response_type=bundle_id包括尚未在应用商店中发布的应用。 app_id
bundle_id

响应样本

{
      "com.my.app": {
          "currency": ​"USD"​, 
          "keepalive_interval": ​24​, 
          "measurement_period": ​168​, 
          "start_ts": ​1601856000​, 
          "update_ts": ​1601856000​, 
          "version": ​5​, 
          "previous_version": ​4​, 
          "conversion_model": {
              "0": [ 
                  {
                      "conversion_name": ​"purchase",​ 
                      "conversion_type": ​"conversion_events"​, 
                      "partner_conversion_name": ​"Partner Purchase"​, 
                      "value": ​0
                  }, 
                  {
                      "conversion_name": ​"Add To Cart",​ 
                      "conversion_type": ​"conversion_events"​, 
                      "partner_conversion_name": ​"Partner Add to Cart"​, 
                      "value": ​0
                  }, 
                  {
                      "conversion_name": ​"retention"​, 
                      "conversion_type": ​"retention"​, 
                      "partner_conversion_name": ​"Partner App Open"​, 
                      "value": {"min": ​0​,"max": ​24}
                  } 
              ],
              "1": [ 
                  {
                      "conversion_name": ​"purchase",​ 
                      "conversion_type": ​"conversion_events"​, 
                      "partner_conversion_name": ​"Partner Purchase"​, 
                      "value": ​0
                  },
                  {
                      "conversion_name": ​"Add To Cart",​ 
                      "conversion_type": ​"conversion_events"​, 
                      "partner_conversion_name": ​"Partner Add to Cart"​, 
                      "value": ​1
                  }, 
                  {
                      "conversion_name": ​"retention"​, 
                      "conversion_type": ​"retention"​, 
                      "partner_conversion_name": ​"Partner App Open"​, 
                      "value": {"min": ​0​,"max": ​24 }
                  }
              ],
              "2": [ 
                  {
                      "conversion_name": ​"purchase",​ 
                      "conversion_type": ​"conversion_events"​, 
                      "partner_conversion_name": ​"Partner Purchase"​, 
                      "value": ​1
                  }, 
                  {
                      "conversion_name": ​"Add To Cart",​ 
                      "conversion_type": ​"conversion_events"​, 
                      "partner_conversion_name": ​"Partner Add to Cart"​, 
                      "value": ​1
                  }, 
                  {
                      "conversion_name": ​"retention"​, 
                      "conversion_type": ​"retention"​, 
                      "partner_conversion_name": ​"Partner App Open"​, 
                      "value": {"min": ​0​, "max": ​24 }
                  } 
              ]
          }
      }
  }

响应字段

字段 描述
bundle_id object 如果请求成功,则返回其中一个或多个。每个bundle ID都包含为相应应用配置的转换模型的详细信息。
status

如果有错误则返回整数:

  • 1 - HTTP 400,请求中的应用程序ID无效
  • 2 - HTTP 400,未为此应用配置合作伙伴。广告主在其Singular控制面板中为合作伙伴配置合作伙伴配置
  • 3 - HTTP 200,Singular SKAdNetwork未为此应用启用。广告主需要通过Singular启用SKAdNetwork测量
message

状态对应的描述信息

  • status=1 - “无效的应用程序ID”
  • status=2 - “没有为此应用程序配置[合作伙伴]”
  • status=3 - “Singular SKAN没有为该应用程序启用”

Bundle_id对象字段

字段 描述 例子
start_ts 激活此模型的时间戳(Unix 格式) 1601856000
update_ts 此模型上次更新时间的时间戳 1601856000
version 转化模型的版本号 2
previous_version 转化模型以前的版本号 1
measurement_period 转化模型用于跟踪安装后事件的最长时间周期(以小时为单位)。 Singular最多支持7天(168 小时)。 168
keepalive_interval 转化模型用于实施“保持活跃”以进行转化值跟踪的时间间隔(以小时为单位)。Singular当前支持24小时间隔。 24
currency 为广告主的Singular帐户设置的货币。响应中显示的任何收入详细信息都基于此货币。 USD
conversion_model

包含可能的转化值列表的对象。 每个值都包含一个详细对象数组,这些对象共同描述了转化值的含义。请注意,该列表不一定包含从0到63的每个数字,因为转化模型可能未使用某些值。

  • conversion_type: “收入”、“留存”、“互动”、“转化事件”或“漏斗”。 将此字段与valueconversion_name字段一起使用,将给定的转化值(0-63)转化为数据指标/KPI。更多信息,请参阅下面的转化类型和值。
  • value: 应该根据转化类型解释的数字/对象。请参阅下面的转化类型和值。
  • conversion_name: 广告主提供的事件名称,例如“My IAP”。
  • partner_conversion_name: 广告主提供的事件名称(如果支持),例如“IAP”。 如果广告主未将事件映射给合作伙伴,则此字段为空或包含空字符串。
 

转化类型和值

转化类型 值的样本 描述
收入
{
  "min": 0,
  "max": 5
}
如果您看到这种转化类型,则意味着广告主已选择关注在测量周期内从终端用户那里获得的收入。由于转化值的限制,收入不是作为一个确切的数字而是作为收入的一个类别或“桶(区间)”给出的。 在这个例子当中,来自终端用户的收入介于0-5之间(为帐户定义的货币 - 请参阅 bundle_id.currency)。
留存
{
  "min": 0,
  "max": 24
}
此转化类型意味着广告主已选择跟踪安装后此转化事件发生的大致时间。 时间作为客户自定义的几个“桶”之一给出,具有下限(“min”)和上限(“max”),以小时为单位。
互动
{
  "min": 2,
  "max": 2
}
此转化类型意味着广告主已选择跟踪在测量周期内发生了多少事件的实例(事件由conversion_name和partner_conversion_name表示)。
转化事件 1 此转化类型意味着广告主已选择跟踪事件是否在测量周期内至少发生过一次。 0表示事件未发生,1表示已发生(事件由conversion_name和partner_conversion_name表示)。
漏斗 1 此转化类型意味着广告主已选择跟踪事件是否在测量周期内至少发生过一次。0表示事件未发生,1表示已发生(事件由conversion_name和partner_conversion_name表示)。