配置回传

概述

当 Branch 测量 conversion(install 或其他事件)时,它确定哪个广告平台或合作伙伴负责生成操作,然后将功劳归功于适当的合作伙伴。 Branch 会通过启用回传将这些事件通知合作伙伴,当您启用任何Universal Ads 集成合作伙伴时,回传功能就会打开。

Branch 的回传系统是高度可定制的;为特定事件以及事件的小节设置回传,并按链接数据、用户数据或事件属性进行筛选。

📘

回传与 Webhooks

术语PostbacksWebhooks 都用于表示将数据发送到其他系统的相同过程。对于 Branch 来说,我们使用术语postback 指的是 Universal Ads(全域广告归因)产品, webhook 指的是 Data Feeds(数据对接)产品。尽管两者功能完全相同。

回传模板

Universal Ads 合作伙伴支持预定义的回传模板,以简化适当的回传 URL 的生成。如果他们需要任何额外信息(例如,特定于事件的目标 ID),则 Branch 显示空白字段,供您输入自动附加到回传 URL 的信息。

添加/启用

启用广告合作伙伴后,系统会针对 Install Purchase 等事件自动激活基本回传。然后,您可以添加额外的回传,例如,您想为特定于应用的自定义事件(如 Account Created)添加回传。

要添加回传,您需要:

  1. Partner Management,选择要为其添加/编辑回传的合作伙伴。
  2. 点击该合作伙伴页面上的Postback Config标签。
  3. 点击屏幕底部的Add New Postback按钮。
  4. 弹窗将与 Branch 默认事件以及设置的任何 commerce 事件(预留事件,如 PURCHASE)或自定义事件一起出现。选择一个事件,如被要求,请输入回传 URL,然后点击Save。这将是触发新回传的事件。
    1. 注意:如果 Branch 尚没有合作伙伴的回传模板,请为您的合作伙伴提供有效的 URL。

🚧

Install Event Changes Post iOS 14.5

Apple requires users to opt into sharing their device data through Apple's AppTrackingTransparency framework. When an install is attributed to paid ads, a 2nd install event will fire post user opt-in

Opt-ins will affect your install events as they will be delayed until opt-in. No data will be available for opted-out users. Our recommendation is to use a different identifier (ex. IDFV) to de-dupe install events on your partner systems.

For additional information on changes post iOS 14.5, visit our FAQ Pages

图片图片

禁用

要禁用当前为广告伙伴启用的任何回传,您需要:

  1. Partner Management,选择要为其添加/编辑回传的合作伙伴。
  2. 点击该合作伙伴页面上的Postback Config标签。
  3. 取消选中要禁用回传的Enable列中的复选框。

图片图片

📘

自动回传清理

分支机构每周运行一次作业,以禁用所有不起作用的回发。在过去7天内始终失败的任何回发-仅引发400/500错误-将被自动禁用。

删除

要删除当前为广告合作伙伴启用的任何回传,您需要:

  1. Partner Management,选择要为其添加/编辑回传的合作伙伴。
  2. 点击该合作伙伴页面上的Postback Config标签。
  3. 将鼠标悬停在回传右侧的三个点图标上,然后点击 Delete Postback
  4. 点击 Save

图片图片

📘

禁用 vs 删除

我们建议禁用回传而不是完全删除它们。但是,您可以重新添加以前删除的任何回传;您将需要重新添加最初添加的所有自定义设置。

发送所有事件

如果要发送All Events(无论是否归因于该合作伙伴),您则可以通过在每个回传上选中 All Events 框来启用此设置。

🚧

隐私权含义

由于此设置将发送All Events (包括此行所列出的名称和客户事件别名,无论是否归因于此合作伙伴),因此建议您在启用时要特别谨慎,尤其是在已启用代理商访问帐户的情况下。

🚧

All Events Changes Post iOS 14.5

There will be a 2nd install event after the user opts in to sharing their device data through Apple's AppTrackingTransparency framework when it is attributed to paid ads.

Data will be organic for users who opt out; thus, there will be a slight increase in organic installs. We recommend you to de-dupe installs.

For additional information on changes post iOS 14.5, visit our FAQ Pages

图片图片

高级配置

编辑模板

在大多数情况下,从您的选择生成的默认回传 URL 足以向有关各方提供回传通知。

但是有时您可能需要/想要编辑回传 URL 中的参数或从中删除参数,或者附加宏表达式/变量以包含额外信息。

👍

例如

您想向合作伙伴发送用户添加到购物车中的实际商品,以便他们可以基于这些商品进行优化。他们当前的Add to Cart回传模板不包含此信息。因此,您需要将“ 内容项”宏指令添加到其 URL。为此,您首先需要从合作伙伴那里获取传递数据的正确字段来传输此数据;例如cart_items 。最后,将&cart_item=${(content_items[0].$product_name)!}添加到回传模板。

希望添加额外的宏时,请参考回传宏&功能

要编辑回传模板,您需要:

  • 方法1
  1. Partner Management,选择要为其添加/编辑回传的合作伙伴。
  2. 点击该合作伙伴页面上的Postback Config标签。
  3. Postback URL 字段中,添加/编辑/删除必要的键值对。
    个在附加每个键值对之前,您必须添加&
  4. 点击 Save
  • 方法2
  1. Partner Management,选择要为其添加/编辑回传的合作伙伴。
  2. 将鼠标悬停在回传右侧的三个点图标上,然后点击 Advanced Edit
  3. Send a Webhook to 字段中,添加/编辑/删除必要的键值对。
    个在附加每个键值对之前,您必须添加&
  4. 点击 Save

添加筛选器

注意:虽然 Branch 保留所有捕获的数据字段值的原始大小写,并且通过导出保留大小写,但是当评估 Webhook/postback 筛选项时,将取消大小写区分。例如,如果您在 user_data.os 上创建了筛选项,则 iOSiosIOS 是等效的。

默认情况下,所有回传都包括以下两个筛选器:

  • Operating System = ROBOT
    • 此筛选器可确保 Branch 仅根据实际流量发送回传。
  • 最后归因触点数据 $3p = 当前选择的广告合作伙伴
    • 此筛选器可确保 Branch 仅发送归因于当前所选广告合作伙伴的事件回传。
    • 注意:删除此筛选器会导致 Branch 不考虑所归因广告合作伙伴而发送所有事件。这相当于选中 All Events 框。

👍

例如

您的合作伙伴需要分别针对 Android purchase 事件和 iOS purchase 事件进行回传。为此,您需要为以下添加两个 Purchase 回传和一个筛选器:Operating System - user_data.os - equals - Android 至一个,以及Operating System - user_data.os - equals - iOS 至另一个。

要创建筛选器,您需要:

  1. Partner Management,选择要为其添加/编辑回传的合作伙伴。
  2. 点击该合作伙伴页面上的Postback Config标签。
  3. 将鼠标悬停在回传右侧的三个点图标上,然后点击 Advanced Edit
  4. 点击 Add Filter
  5. 选择您要筛选的 metadata。请参阅下面的基本筛选器列表。
    1. 从下一个下拉列表中选择equalsdoes not equal
  6. 最后,设置您要筛选的 key 值。
  7. 点击 Save

图片图片

基本筛选器

编辑回传时,可以使用以下筛选器:

  • Campaign
  • Channel
  • Country
  • Custom —有关更多信息,请参见高级筛选器
  • Feature
  • Tags
  • Last Attributed Touch ID
  • Last Attributed Touch Type
  • Operating System
  • Environment
  • Platform
  • Agency ID
  • Re-engagement Activity
  • Attributed
  • Customer Event Alias
  • First Event for User

高级筛选器

除了上述基本筛选器之外,您还可以创建自定义筛选器,以利用链接数据、用户数据和事件数据等各种数据点。

在尝试设置高级筛选器之前,请确保已查看数据格式。

要创建筛选器,您需要:

  1. Partner Management,选择要为其添加/编辑回传的合作伙伴。
  2. 点击该合作伙伴页面上的Postback Config标签。
  3. 将鼠标悬停在回传右侧的三个点图标上,然后点击 Advanced Edit
  4. 点击 Add Filter 键。
  5. 选择您想要筛选的 metadata。要进行高级筛选,请选择 "Custom"
  6. 输入您要筛选的 key。要查找您要筛选的 key,请参考我们对基于用户的归因模式之数据格式的简单介绍,以找出可能嵌套 key 的位置。查找 key 的另一种简便方法是在设置筛选器之前完整查看数据。您可以通过 CSV 导出API 导出或发送带有 POST 主体的单个回传来实现,并在该 POST 主体中找到您的 key。
  7. 除非您的 key 是顶层数据的一部分(例如timestampid),否则它很可能嵌套在一层深处。大多数 key 的格式为object_name.key。例如,如果要筛选叫做 "product_deeplink_id" 的深度链接数据中的自定义 key,则格式应为last_attributed_touch_data.product_deeplink_id

假设您有兴趣使用特定优惠券为每个Purchase事件接收回传。在您的应用或网站中设置 Purchase 事件时,您"coupon"添加了特定的 metadata。在 Event Ontology Schema 中,您看到“优惠券”位于 “event_data” 内部。要将筛选器配置为仅在coupon等于HOLIDAYS时才触发回传,您将:

  1. 从筛选器 key 下拉列表中选择 "Custom"
  2. 将 key 设为 event_data.coupon
  3. 在等效下拉列表中选择 "equals"
  4. 输入值 HOLIDAYS

图片图片

使用 POST HTTP 方法

默认情况下,Branch 通过 GET HTTP 方法发送回传。但是,您可以选择通过 POST HTTP 方法发送回传。

要将 HTTP 方法更改为 POST,您需要:

  1. Partner Management,选择要为其添加/编辑回传的合作伙伴。
  2. 点击该合作伙伴页面上的Postback Config标签。
  3. 将鼠标悬停在回传右侧的三个点图标上,然后点击 Advanced Edit
  4. GET下拉菜单更改为POST
  5. 默认情况下,Branch 的 POST header 设置包括:
    1. Content-Type : application/json
      1. 额外的 Content-Type 值包括 application/x-www-formurlencoded

图片图片

测试回传

启用和/或配置新的回传后,您可以通过 Branch 操作后台 (Dashboard)的 Liveview 功能测试它们是否正常工作。

要在 Liveview 中测试回传/webhooks,您需要:

  1. 在左侧导航栏中,在 Setup & Testing 项下点击Liveview
  2. 点击 Webhooks Record 选项卡以加载 Webhook / Postbacks 对象。
  3. 点击 Add Filter 按钮,然后从下拉列表中选择 Webhook Partner Key,然后为合作伙伴插入相关值。
  4. 点击列(columns)按钮以将 Webhook Response CodeWebhook Response Body 都添加为列。
  5. 点击 Update Session 查看筛选结果。

图片图片

如何查找合作伙伴的 Webhook Key

为了按照合作伙伴筛选 Webhook 记录以验证回传是否正确触发,您需要找到合作伙伴的 Webhook key。

要查找合作伙伴的 Webhook Key,您需要:

  1. 在合作伙伴管理项下,选择要为其添加/编辑回传的合作伙伴。
  2. 在帐户设置标签的合作伙伴广告帐户信息项下,复制并粘贴合作伙伴标识符($3p 值)。

图片图片

验证时注意事项

  • 检查是否填充了预期的宏以及响应代码。最重要的是,您需要验证是否填充了 IDFA / AAID 和 Click ID。
  • 我们建议即使响应代码为200 (successful),也要与广告合作伙伴验证事件。为此,请向他们发送事件名称,webhook 请求 URL,设备 ID,时间戳,webhook 响应代码和 webhook 响应体。
  • 如果找不到所需的 Webhook,建议您再测试几次广告链接以触发后续的 Webhook/回传。

白名单回传服务器 IP 地址

  • 如果出于安全考虑需要将回传服务器 IP 地址列入白名单,则它们将在下面列出:
    • 52.9.159.121/32
    • 52.9.176.205/32
    • 52.9.188.221/32
    • 52.9.188.236/32

附录

回传宏&功能

请参阅我们的回传宏& Function 文档,以获取可用回传宏和 Function 的完整列表。

事件本体数据格式

请参阅我们的 Event Ontology Data Schema 文档,详细了解 Branch 的数据格式和可用字段的完整列表。

使用 Freemarker 表达式

您还可以通过将 Freemarker 应用于 Branch 的事件本体数据模式来添加更多高级筛选器。

除上述链接中提到的表达式外,Branch 还创建了可使用的特定于 Branch 的 freemarker 表达式。

标签

参数

描述

例如

<@json>

JSON 将内容编码为 string。

输入:

<@json>And then they said, "Hello, ${name}"/@json

输出:

“然后他们说,“你好,德米特里””

<@sha1>

SHA1 对内容进行编码

输入:

sha1=<@sha1>${user_data.idfv}/@sha1

输出:

sha1=d0b486885d4f2270ee6b4217ae95ee737b7b8975

<@sha256>

SHA256 对内容进行编码

输入:

sha256=<@sha256>${user_data.idfv}/@sha256

输出:
sha1=1bb12f133f50a6a63a02c8f0ce33c5f0a61f7cbecc667acc82d3efa4c2965c26

<@md5>

MD5 对内容进行编码

输入:

sha1=<@sha1>${user_data.idfv}/@sha1

输出:
sha1=d0b486885d4f2270ee6b4217ae95ee737b7b8975

<@base64>

Base64 对内容进行编码

<@loop>

<@break>

<@sep>

data=foo (required)

val="bar" (required)

在数据中指定的变量周围循环,将每个连续循环分配给 val 中指定的名称。确保不要在数据两边加上引号。

输入:

sha1=<@sha1>${user_data.idfv}/@sha1

输出:

sha1=d0b486885d4f2270ee6b4217ae95ee737b7b8975

<@jsonmap>

data=foo (required)

JSON 以任何方式对数据进行编码(请确保不要引用)。

输入:

sha1=<@sha1>${user_data.idfv}/@sha1

输出:

sha1=d0b486885d4f2270ee6b4217ae95ee737b7b8975

<@urlencode>

URL 对内容进行编码。

输入:

sha1=<@sha1>${user_data.idfv}/@sha1

输出:

sha1=d0b486885d4f2270ee6b4217ae95ee737b7b8975

由于安全限制,Branch 不支持以下 Freemarker 表达式:

  • "<#import>"
  • "<#visit>"
  • "<#include>"
  • "?eval"
  • "<#recurse>"
  • "<#setting>"
  • "<#macro>"
  • "<#function>"
  • "<#nested>"
  • "<#return>"
  • "<#list>"

19 天前更新


配置回传


建议的编辑仅限于 API 参考页

您只能建议对 Markdown 正文内容进行修改,而不能建议对 API 说明进行修改。