回传是Singular通过由广告网络选定的固有URL自动向广告媒体传递的告知。 例如,Singular每当从广告活动成功地获得安装成果时,会发送回传告知广告网络。 Singular 支持下面列出的回传宏。 应用宏
宏 | 数值 |
{APP_NAME} | 应用的发布名称 |
{LONGNAME} | 应用的Long name (捆绑 ID) |
广告活动宏
宏 | 数值 |
{CID} | 归因跟踪标签中的广告系列名称 |
{CLID} | 由 Singular(字符串)给出的点击 ID |
{cl?Network Name} | 通过网络作为 Singular 跟踪链接的 cl 参数发送的网络点击 ID(字符串)。网络名称必须指定为与 Singular 联动的名称。 |
{pcrid?Network Name} | 素材(Creative)ID - 仅当在 Click 提供时才有效 |
{pcrn?Network Name} | 素材(Creative)名称 - 仅当在 Click 提供时才有效。 |
{pshid?Network Name} | 发布为散列或匿名 ID 的应用程序的点击(字符串)。 它仅在作为点击发送时有效。 |
{psid?Network Name} | 关于源站点或点击(字符串)的应用程序 ID(字符串)。 仅包括click发送时有效。 |
{psn?Network Name} | 关于源站点或点击(字符串)的应用程序名称ID(字符串)。 仅包括click发送时有效。 |
{NETWORK=Network Name} | 如果属性网络与宏中指定的特定网络名称相同,则返回“1”。 否则,它返回“0”。 |
{IS_RE_ENG} | 如果归因于再营销广告,则返回“1”。 否则,它返回“0”。 |
{IS_VIEWTHROUGH} | 如果归因于展示链接,则返回“1”。 否则,它返回“0”。 |
设备的宏
宏 | 数值 |
{TOUCHPOINT_IP} | 归因接触点时设备的 IP |
{ATTRIBUTION_IP} | 设备在归因、安装或重新参与时的 IP |
{EVENT_IP} | 事件执行时设备的 IP |
{OS_VERSION} | 点击广告时设备的OS系统版本 |
{APP_VERSION} | 安装/事件发生时设备的应用程序版本 |
{IDFA} | 设备的未散列的 iOS 广告标识符 |
{IFA1} | 设备 iOS 广告标识符的 SHA-1 |
{IFA5} | 设备的 iOS 广告标识符的 MD5 |
{IDFV} | 该供应商(vendor)的未散列的 iOS 标识符 |
{ANDI} | 未散列的安卓 ID - 如果广告标识符 (AIFA) 在设备上无效,则该标识符有效。由于此标识符并不总是有效,我们建议使用 {AIFA} 或 {COALESCE|{AIFA},{ANDI}} 以便始终发送该值。 |
{AND1} | 安卓 ID的 SHA1 |
{AIFA} | 设备的未散列的 安卓广告标识符 |
{AIF1} | 设备的安卓广告标识符的SHA-1 |
{AIF5} | 设备的安卓广告标识符的 MD5 |
{COALESCE} | 传递一个或另一个 ID。 例如, {COALESCE|{AIFA},{ANDI}}允许发送 AIFA 或ANDI(如果AIFA无效) |
{PLATFORM} | iOS 或安卓 |
{TOUCHPOINT_COUNTRY} | 归因接触点时设备所在的国家 |
{ATTRIBUTION_COUNTRY} | 设备在归因、安装或重新使用时所在的国家 |
{EVENT_COUNTRY} | 事件发生时设备所在的国家 |
{TOUCHPOINT_CITY} | 归因接触点时设备所在的城市 |
{ATTRIBUTION_CITY} | 设备在归因、安装或重新使用时所在的城市 |
{EVENT_CITY} | 事件发生时设备所在的城市 |
{TOUCHPOINT_STATE} | 归因接触点时设备所在的州/省 |
{ATTRIBUTION_STATE} | 归因、安装或重新使用时设备所在的州/省 |
{EVENT_STATE} | 事件发生时设备所在的州/省 |
{USERID|user.key} {CUSTOM_USERID|user.key} | 自定义用户 ID。将‘user.key’替换为自定义用户 ID 键值对。例如,如果主值是 balloonjumpID=username,这个宏应该是 {USERID|user.balloonjumpID},它将被‘username’替换。 |
{DNT} | 如果启用了此不跟踪标志,则返回 1,对于所有其他条件返回 0。 |
{NODNT} | 如果启用了此不跟踪标志,则返回 0,对于所有其他条件返回 1。 |
{DEVICE_MODEL} | 设备型号 |
{DEVICE_BRAND} | 设备品牌 |
{MATCH_TYPE} | 通过指明归因是否为自然(无效值), 确定性(设备 ID 匹配或安装引用)或指纹识别方法。 |
{ATTRIBUTION_WINDOW} | 用于归因安装或重新参与的时间单位窗口。 |
{INSTALLER_SOURCE} | 仅限安卓。 导致安装的资源的包名。例如,如果它是从谷歌商店安装的,它将是‘com.android.vending’。 |
{APPSTORE_FLAG} | 仅限安卓。 根据安装程序源指示 0、1 或 Null。 如果数据无效,则该值将为 Null 。 |
{GLOBAL_PROPERTIES:propertyName} | 如果可通过 SDK (iOS, Android) 获得 , 则作为全局属性值传递。 |
{GLOBAL_PROPERTIES} | 如果可通过 SDK (iOS, Android) 获得, 传递所有全局属性(以 JSON 格式和加密 URL 格式)。 |
{USER_AGENT} | 设备的用户代理(由 SDK 确定) |
事件宏
宏 | 数值 |
{AMOUNT} | 销售事件百万。它是指以交易货币支付的金额。被拒绝的销售事件将被标记为 0。要检索原始事件名称,请使用 IAP_RECEIVED_REVENUE。 |
{CURRENCY} | 销售事件百万。根据ISO 4217,付款货币代码以三个字母显示。 |
{EVTNAME} | 事件名称。 被拒绝的事件将显示为 __iapinvalid__。要检索原始事件名称,请使用 IAP_RECEIVED_REVENUE。 |
{EVTATTR:Attribute_Name} | 从特定归因获得的值。 向 Singular 报告事件时, 广告主可以选择发送事件属性和参数 。 事件属性和参数作为 JSON 键值对传递,可以使用 {EVTATTR:Attribute_Name} 传递特定的 JSON 键值。 例如,如果事件名称‘Checkout’具有属性‘Number of Items’, 则 {EVTATTR: Number of Items} 返回从‘Checkout’事件中获得的项目数。 |
{EVTATTRS} | 当广告主向 Singular 报告事件时, 传递与事件相关的所有事件属性和参数 。 如果事件具有属性或参数 , 则此宏将填充属性的 JSON 有效负载。 例如,如果事件名称为“Checkout”并且广告主传递送付款信息, 例如,如果事件名称为 "Checkout" 并且广告主传递付款信息,则 {EVTATTRS} 将填充与 Singular 用于记录事件的方式相匹配的 有效负载。 { "number_of_items": 5, "cost":{ "sub_total": 50.99, "tax": 1.01, "total": 52.00 } |
{IAP_RECEIVED_EVENT_NAME} | 在销售活动中,原始活动名称。 如果事件有效,这部分将等于 EVTNAME。 |
{IAP_RECEIVED_REVENUE} | 在销售活动中,原始购买金额。 如果事件有效,这部分将与 AMOUNT 相同。 |
{IAP_RECEIPT_RECEIVED} | 在销售事件中,如果包含购买收据,则返回“1”,否则返回“0”。 |
{IAP_RECEIPT_VALID} | 在销售事件中,如果识别为购买,则返回“1”。 在其他情况下,它返回“0”。 |
{IS_FIRST_EVENT} | 如果事件首次发生(销售或定制),则返回“1”。 之后,出现在同一设备 ID 中的所有事件都返回为“0”。 |
时间宏
宏 | 数值 |
{DATE} | 基于GMT, 安装或事件的日期(格式为“YYYYMMDD”的字符串) |
{TIME} | 基于GMT, 安装或事件时间戳(格式为“YYYY-MM-DD_HH:MM:SS”的字符串) |
{UTC} | UNIX 格式的安装或事件时间戳(以秒为单位) |
{UTCM} | UNIX 格式的安装或事件时间戳(以毫秒为单位) |
{CLICK_UTC} | UNIX 格式的点击时间戳(以秒为单位) |
{CLICK_UTCM} | UNIX 格式的点击时间戳(以毫秒为单位) |
{CLICK_TIME} | 基于GMT, 点击时间戳(格式为“YYYY-MM-DD_HH:MM:SS”的字符串) |
{CLICK_DATE} | 基于GMT, 点击时间戳(格式为“YYYYMMDD”的字符串) |
{INSTALL_UTC} | 以秒为单位 (包括再营销) 最新UNIX 格式安装时间戳。 |
{INSTALL_UTCM} | 以毫秒为单位(包括再营销)最新 UNIX 格式安装时间戳 |
{INSTALL_TIME} | 基于GMT (包括再营销) 最新归因的安装时间戳(格式为“YYYY-MM-DD_HH:MM:SS”的字符串) |
{INSTALL_DATE} | 基于GMT (包括再营销) 最新归因的安装时间戳(格式为“YYYYMMDD”的字符串) |
STRFTIME|<constructing values>,ts (optional),round (optional)} | 可组合的时间戳。这个时间戳可以与下面定义的值和额外需要的字符组合。
例如,{STRFTIME|%Y-%m-%dT%H:%M:%S,{UTC}} 中的“round”是一个变体选项, 它将减少/绕过年、月、日、小时、或分钟。 例如,如果 {CLICK_UTC} 是 1435627795, 则: {STRFTIME|%s,{CLICK_UTC},month} -> 1433116800 {STRFTIME|%s,{CLICK_UTC},day} -> 1435622400 {STRFTIME|%s,{CLICK_UTC},hour} -> 1435626000 {STRFTIME|%s,{CLICK_UTC},minute} -> 1435627740 |
其他宏
宏 | 数值 |
{RAND} | 一个随机的 10 位整数。 |
{JSON} | 它用于使用 JSON 有效负载将请求从 GET 转换为 POST。 该宏左侧的所有内容都正常评估,而右侧部分从 URL 中删除,这部分转换为与查询字符串参数对应的 JSON 字典。对位于 {JSON} 宏左侧的 URL 执行 HTTP POST。 |
{POST} | 类似于 {JSON} 宏,但没有有效负载,传递旧的 application/x-www-form-urlencoded 作为编码。 |
{HTTP_HEADER|k,v} | 使用此宏将单个键/值对添加到标头。 使用其他宏示例添加键/值对。 ex) {HTTP_HEADER|SampleKey1,SampleValue1}{HTTP_HEADER|SampleKey2,SampleValue1}. 这个宏是用来填充标头的,传递的时候是从URL中完全去掉的,所以在添加这个宏到一个URL时,请勿添加特殊字符,例如 '&' 、'?'。ex) https://theURL.com/endpoint?{HTTP_HEADER|SampleKey1,SampleValue1}singular_cl={CLID}&andi={ANDI}{HTTP_HEADER|SampleKey2,SampleValue2} |
宏修饰符
宏 | 数值 | |
{SHA1|{Macro}} | 此修饰符将值编码为 SHA-1。例如,如果 {CLID} 宏返回 '1000',{SHA1|{CLID}} 将返回 'fb2f85c88567f3c8ce9b799c7c54642d0c7b41f6' | |
{MD5|{Macro}} | 此修饰符将值编码为 MD5。 例如,如果 {CLID} 宏返回 'ABCD',{MD5|{CLID}} 将返回 'cb08ca4a7bb5f9683c19133a84872ca7' | |
{BASE64|{Macro}} | 此修饰符以标准 Base64 对值进行编码。 例如,如果 {CLID} 宏返回 'ABCD',BASE64|{CLID}} 将返回 'QUJDRA=='。 (返回值为 URL 中的 HTTP 编码) | |
{BASE64U|{Macro}} | 此修饰符将该值编码为 url-safe Base64。 例如,如果 {CLID} 宏返回 'ABCD',{BASE64U|{CLID}} 将返回 'QUJDRA=='。 (返回值为 URL 中的 HTTP 编码) | |
{HMACSHA1|{Macro},key} | 此修饰符使用提供的密钥编码为 HMAC SHA-1。 例如,如果 {CLID} 宏返回 'ABCD',{HMACSHA1|{CLID},sample} 将返回 'f5143f3dda1b120ac280a82b2cae0ff60dc342b5'。 | |
{HMACMD5|{Macro},key} | 此修饰符使用提供的密钥在 HMAC MD5 中编码。 例如,如果 {CLID} 宏返回 'ABCD',{HMACMD5|{CLID},sample} 将返回 '43d752ccec4044f90a66a7d15762075e'。 | |
{UPPER|{Macro}} | 此修饰符将以大写形式返回给定值。 例如,如果 {CLID} 宏返回 'abcd',{UPPER|{CLID}} 将返回 'ABCD'。 | |
{LOWER|{Macro}} | 此修饰符将以小写形式返回给定值。 例如,如果 {CLID} 宏返回 'ABCD',{LOWER|{CLID}} 将返回 'abcd'。 | |
{MULTIPLY|{Macro},multiple} | 此修饰符将该数字乘以最接近宏返回值的整数。 要将以浮点形式购买的产品的价值转换为微量, 请将其乘以 {AMOUNT} macro 1e6 (1000000)。 例如,价值 $5250.23 美元的购买,将在 {MULTIPLY|5240.23,1000000} 之后导致 5250230000。 | |
{TERNARY|a,b,x,y} | 这个修饰符接受 4 个argument参数 a, b, x, y 并在 a == b 时返回 x,否则返回 y。 例如:. {TERNARY|0,1,yes,no} 将返回“否”。 |
直通参数 作为与Singular连接的过程,广告媒体可以为了其归因提交返回而进一步请求信息。我们将其称为直通参数,这些参数可以添加任何尚未使用或未包含在 Singular 跟踪链接中的参数。 例如,广告媒体可能会要求提供示例等信息以获取内部广告主 ID,示例)115873。 广告主也可以利用透传参数在对其服务器的提交返回中需接收的信息添加到跟踪链接。