配置回发

概述

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

Branch的回发系统是高度可定制的;为特定事件以及事件的特定子部分设置回发,并按链接数据,用户数据或事件属性进行过滤。

📘

回发与Webhooks

术语PostbacksWebhooks 都用于表示将数据发送到其他系统的相同过程。在分公司的情况下,我们使用术语postback 指的是通用广告产品,并在webhook 指的是数据饲料产品时;尽管功能完全相同。

回发模板

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

添加/启用

启用广告合作伙伴后,系统会针对诸如安装购买类的事件自动激活基本回发。然后,您可以添加其他回发,例如,如果您想为应用程序特定的自定义事件添加回发,例如 Account Created

要添加回发:

  1. Partner Management ,选择要为其添加/编辑其回发的伙伴。
  2. 点击该合作伙伴页面上的Postback Config 标签。
  3. 点击屏幕底部的Add New Postback 按钮。
  4. 模态会出现分公司违约事件,以及任何商业(预留的事件,如购买) ,你或自定义事件'已经成立。选择一个事件,如果要求'输入回发URL,然后点击Save 。这将是触发新回发的事件。
    1. 注意:如果Branch尚没有合作伙伴的回发模板,请为您的合作伙伴提供有效的URL。

图像图像

禁用

要禁用当前为广告伙伴启用的任何回发:

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

图像图像

📘

自动回发清理

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

删除中

删除当前为广告伙伴启用的任何回发:

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

图像图像

📘

禁用与删除

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

发送所有事件

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

🚧

隐私隐含

由于此设置将发送All Events 无论此属性是否归因于此合作伙伴,此名称都会在此行中列出,名称和客户事件别名-我们建议在启用时/启用时谨慎使用,尤其是在已启用代理机构访问帐户的情况下。

图像图像

进阶设定

编辑模板

在大多数情况下,从您的选择中生成的默认回发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

添加过滤器

NOTE: While Branch preserves the original case of all captured data field values and case is retained through export, when webhook/postback filters are evaluated, case-sensitivity is removed. For example, if you created a filter on user_data.os, iOS, ios, and IOS are equivalent.

默认情况下,所有回发都包括以下两个过滤器:

  • 操作系统= ROBOT
    • 此筛选器可确保Branch仅根据实际流量发送回发。
  • 最后归属的触点数据$ 3p =当前选择的广告合作伙伴
    • 此过滤器可确保Branch仅发送归因于当前所选广告伙伴的事件的回发。
    • 注意:删除此过滤器将导致Branch发送所有事件,而不管所归属的广告伙伴如何。这等效于选中All Events 框。

👍

您的合作伙伴需要分别针对Android购买事件和iOS购买事件进行回发。为了实现这一点,则需要添加两个购买回发和添加过滤器为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. 选择您想要过滤的元数据' 。请参阅下面的基本过滤器列表。
    1. 从下一个下拉列表中选择equalsdoes not equal
  6. 最后,设置' d想要过滤的键的值。
  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. 选择您想要过滤的元数据。要进行高级过滤,请选择 "Custom"
  6. 输入您要筛选的'键。为了找到问题的关键,您' d喜欢上过滤器,参考我们简要介绍了人以诚为本归属' s的数据格式找出在您的钥匙可能嵌套。查找密钥的另一种简单方法是在设置过滤器之前完整查看数据。您可以做一个这样做 CSV出口 API出口或发送一个回传与后机身,并找到在该职位的身体您的关键。
  7. 除非您的密钥是顶层数据的一部分(例如timestampid ),否则它很可能嵌套在一层深处。大多数键的格式为object_name.key 。例如,如果要过滤名为"product_deeplink_id"深度链接接数据中的自定义键,则格式为last_attributed_touch_data.product_deeplink_id

假设您有兴趣使用特定优惠券在每Purchase事件中收到回发。在您的应用或网站中设置购买事件时,您"coupon"添加了特定的元数据 。在事件本体架构中,您看到“优惠券”位于“ event_data”内部。要将过滤器配置为仅在coupon等于HOLIDAYS时才触发回发,您将:

  1. 从过滤键下拉列表中选择"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标头设置包括:
    1. Content-Type : application/json
      1. 其他Content-Type值包括application/x-www-form & urlencoded

图像图像

测试回发

启用和/或配置新的回发后,可以使用Branch仪表板中的Liveview功能测试它们是否正常工作。

要在Liveview中测试回发/ webhooks:

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

图像图像

如何查找合作伙伴的Webhook Key

为了按伙伴过滤Webhook记录以验证回发是否正确触发,您需要找到伙伴的Webhook Key。

查找合作伙伴的Webhook Key:

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

图像图像

验证时的注意事项

  • 检查是否填充了预期的宏以及response code。最重要的是,您需要验证是否已填充IDFA / AAID和Click ID。
  • 我们建议即使响应代码为200(成功),也要与广告合作伙伴验证事件。为此,向他们发送事件名称,webhook 请求URL,设备ID,时间戳,webhook reponsce code 和 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

附录

回发宏&函数

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

事件本体数据格式

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

使用Freemarker表达式

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

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

标签

参量

描述

< @json >

JSON将内容编码为字符串。

输入:

<@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编码内容

< @循环>

< @休息>

< @ <月>

data = foo(必填)

val = " bar " (必填)

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

输入:

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

输出:

sha1 = d0b486885d4f2270ee6b4217ae95ee737b7b8975

< @jsonmap >

data = foo(必填)

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>"

7 天前更新


配置回发


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

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