概述
您可以在 Journey (站到端引流),Universal Ads(全域广告归因)链接,Quick Links(快速链接)和 Universal Email中使用深度链接。在本指南中,我们将帮助您逐步了解如何设置默认和自定义链接行为,以及如何创建短链接和长链接。
默认链接行为
您尚未安装应用
-
用户
clicks
Branch 深度链接 -
设备
navigates
到fallback (例如,app store 或网站)- 支持的 App Stores:
- 苹果应用商店
- Google Play
- 华为 App Store
- Vivo App Store
- Oppo App Store
- 百度移动助手
- 支持的 App Stores:
-
用户
installs
且opens
您的应用 -
Branch 将深度链接
data
传递到您的应用中
已安装您的应用
-
用户
clicks
Branch 深度链接 -
设备
opens
您的应用或导航到预期的链接行为 -
Branch 将深度链接
data
传递到您的应用中
预期的链接行为
移动
-
预期链接行为取决于您的应用是否支持深度链接
-
*Able to force app open
使用$uri_redirect_mode
或启用Deepview
平台 | iOS | Android |
---|---|---|
Facebook Newsfeed | Fallback; 能够通过 Facebook App Links 进行深度链接 | 应用 |
Facebook浏览器 | 应用 | 应用 |
Facebook Messenger | Fallback; 能够通过 Facebook App Links 进行深度链接 | 应用 |
Facebook Messenger 浏览器 | 应用 | 应用 |
Instagram 个人资料 | Fallback; 能够强制通过以下方式打开应用 | 应用 |
Instagram浏览器 | 应用 | 应用 |
Instagram Stories | Fallback; 能够强制打开应用 | 应用 |
Twitter的Feed | 倒退;能够强制打开应用。具有 | 应用 |
Twitter浏览器 | 应用 | 应用 |
Snap Messages | 应用 | 应用 |
Snap Stories | 应用 | |
Fallback; 需要在链接中使用 | Fallback | |
Fallback | Fallback | |
Pinterest浏览器 | 应用 | 应用 |
Google+ | Fallback; App Store 重定向将不起作用 | Fallback |
Chrome浏览器 | 应用 | 应用 |
Chrome地址栏 | Fallback | Fallback; 深度链接数据不会传递到应用中 |
Safari浏览器 | 应用 | 不适用 |
Safari地址栏 | 倒退; 被Apple封锁 | 不适用 |
Firefox浏览器 | Fallback | 应用 |
Firefox地址栏 | Fallback | 应用 |
UC浏览器 | 不适用 | 应用 |
Naver浏览器 | 不适用 | 应用 |
Kakao浏览器 | 不适用 | 应用 |
Opera浏览器 | 应用 | 应用 |
幽灵浏览器 | 应用 | Fallback; 需对请求参数(Query String)进行编码 ($=%24) |
Google Hangouts | Fallback; 能够强制打开应用 | 应用 |
三星短信 | 不适用 | 应用 |
三星短信浏览器 | 不适用 | 应用 |
苹果iMessage | 应用 | 不适用 |
苹果商务聊天 | 应用 | 不适用 |
Slack | App;必须将 Slack 设置为能打开 Safari 链接 | 应用 |
倒退;自定义微信后备网址 | 倒退;自定义微信后备网址 | |
App; | App; | |
LINE | Fallback; 能够强制打开应用 | 应用 |
Discord | 应用 | 应用 |
苹果邮件 | 应用 | 不适用 |
Gmail | 应用 | 应用 |
雅虎邮箱 | Fallback; 能够强制打开应用 | 应用 |
TikTok | 宣传应用的广告会将用户带到 App Store | 宣传应用的广告会将用户带到 App Store |
TikTok | 将用户带到非应用商店登录页面的广告将在应用内浏览器中打开。 | 将用户带到非应用商店登录页面的广告将在应用内浏览器中打开。 |
桌面
-
预期链接行为取决于您的应用是否支持深度链接
-
默认情况下,我们尝试通过 URI 方案启动应用,并在后台加载桌面重新定向后备
-
*Only launches background desktop web fallbacks
使用$afterclick_desktop_url
平台 | 苹果电脑 | Windows |
---|---|---|
Safari | 应用;支持通用链接 | 应用 |
Firefox | 应用* | 应用* |
Chrome | 应用* | 应用* |
Edge | 应用 | 应用 |
IE 浏览器 | 不适用 | 应用* |
Slack | 应用;支持通用链接 | 应用 |
自定义链接行为
将数据从链接传递到应用
-
将链接数据添加到每个深度链接接
-
将 key-values 对组添加到您的 Quick Links(快速链接)上
-
附加请求参数(Query String)
https://example.app.link/fzmLEhobLD?$custom_data=123&hello=world
返回到特定网址
-
根据以下情况确定深度链接将前往的位置
-
您尚未安装应用
-
[或] 另一个应用阻止其他应用进行深度链接
-
-
Fallback 将取代(按优先级排序)
- 添加请求参数(Query String)
https://example.app.link?$ios_url=https://example.com
- 添加链接数据
$ios_url = 'https://example.com'
( 文档 ) - 为深层视图添加链接数据
$ios_deepview = 'deepviewId'
( 文档 ) - 在Branch Dashboard上全面启用Deep View
- 添加链接数据
$fallback_url = 'https://example.com'
( 文档 ) - 在Branch Dashboard上添加
iOS/Android Custom URL
- 在Branch Dashboard上添加Default URL (
$fallback_url
)
- 添加请求参数(Query String)
打开网页不是应用
- 您尚未安装应用
- 设备
navigates
到 fallback(例如,app store 或网站)
- 设备
- 已安装您的应用
- iOS: 需要取代
Universal Links
- Android:需要取代
App Links
- 取消选中
Enable App Links
,然后在 Branch Dashboard 上选Save
- 添加重定向
$android_url = 'https://google.com'
( 文档 ) - 添加带有
$android_deeplink_path = 'random'
( docs )的损坏的URI Scheme
- 取消选中
- iOS: 需要取代
- 在链接域内添加
-web
,比如:branch.app.link
->branch-web.app.link
- 与自定义别名一起使用时,不适用于自定义链接域。
社交链接行为
- 使用 OG标签将内容显示为Facebook,Twitter,Pinterest,iMessage等中的预览卡。
- 基本项为
$og_title
,$og_description
以及$og_image_url
- 基本项为
- 使用深度视图将内容显示为网站
UTM 行为
默认启用
要取消此功能,请前往 Link Settings -> Advance Settings -> Analytics mapping with UTM。
- 重定向到网页网址时,Branch 会自动将链接分析标记中的值作为 UTM 参数进行传递:
~campaign
->utm_campaign
~channel
->utm_source
~feature
->utm_medium
- 这一点适用于通过以下几点定义网页网址
$fallback_url
,$ios_url
,$android_url
,$desktop_url
,$original_url
,和$canonical_url
。 - 如果在重定向到的 URL 上已经检测到这些 UTM 参数,这些 URL 则不会被取代。
- 有关UTM参数的更多信息,请阅读Google Analytic ' s 自定义广告系列文章。
创建深度链接接
短链接
- 短链接是最常见的深度链接接
- 您可以自定义
example.app.link
的子域,或更改为自己的个人域(links.yoursite.com
) - 您可以在创建过程中自定义短代码
alias
- 别名(Aliases)可以是短字符,例如
https://example.app.link/october-sale
- 或者可以是完整的链接路径,例如
https://example.app.link/product/id1234
- 别名(Aliases)可以是短字符,例如
- 短链接在链接创建时将链接数据封装在其中
- 例如现有链接
https://example.app.link/fzmLEhobLD
- 例如现有链接
- 短链接可以附加其他数据
- 例如动态链接
https://example.app.link/fzmLEhobLD?content_id=123
- 例如动态链接
- 创建短链接的方法
- 使用 Quick Links(快速链接)进行快速创建并轻松追踪链接
- 使用我们的 App SDK 在您的应用内创建和分享链接
- 使用我们的 Web SDK 来创建有助于将您的网页用户转化为应用用户的链接
- 使用我们的 HTTP API 从您的服务器通过编程方式创建链接
- 使用我们的 Chrome扩展程序从您的浏览器生成链接
长链接
- 无需网络调用 Branch 服务即可创建长链接
- 长链接需要将链接数据添加为Quey String请求参数。确保对链接中的所有url进行URI编码。
- 例如现有链接
https://example.app.link/fzmLEhobLD?foo=bar&baz=456&$fallback_url=https%3A%2F%2Fbranch.io%2F
- 例如动态链接
https://example.app.link/?foo=bar&baz=456&$fallback_url=https%3A%2F%2Fbranch.io%2F
- 例如现有链接
- 长链接需要使用
/a/
和Branch Key(如果使用custom link domain
- 例如现有链接
https://link.example.com/5NPh/p4M09KRLrD?foo=bar&baz=456&$fallback_url=https%3A%2F%2Fbranch.io%2F
- 例如动态链接
https://link.example.com/a/key_live_kaFuWw8WvY7yn1d9yYiP8gokwqjV0Swt?foo=bar&baz=456&$fallback_url=https%3A%2F%2Fbranch.io%2F
- 例如现有链接
- 长链接需要使用
/a/
和Branch Key(如果使用bnc.lt
- 例如现有链接
https://bnc.lt/5NPh/p4M09KRLrD?foo=bar&baz=456&$fallback_url=https%3A%2F%2Fbranch.io%2F
- 例如动态链接
https://bnc.lt/a/key_live_kaFuWw8WvY7yn1d9yYiP8gokwqjV0Swt?foo=bar&baz=456&$fallback_url=https%3A%2F%2Fbranch.io%2F
- 例如现有链接
- 将
tags
添加到动态链接后,请分别输入每个标签
设置深度链接
您可以选择将您的 key-value 参数添加到 Branch Link 上。Branch SDK 会将这些参数传递到您的应用(部分 key 存在特殊情况)。
保留的前缀
- Branch将其他属性添加到您的深度链接接数据中以解释链接
字首 | 用途 |
---|---|
$ | Branch保留关键字 |
~ | Branch分析数据 |
+ | Branch其他保留字 |
分析标签
- 您可以通过这些标签对深度链接进行筛选和分組
Key | 默认 | 用途 |
---|---|---|
~channel | 您可以使用渠道来标记链接到达用户的路径。例如,带有'Facebook' 或'LinkedIn' 标记的链接可分别追踪点击和安装 | |
~feature | 这是与您链接相关联应用的一个功能。例如,如果您有推荐程序,则可以使用'推荐功能'标记链接。 | |
~campaign | 使用此字段按实际 Campaign(营销活动)生成链接。例如,当您启动了一项新功能或产品,并希望围绕该功能设立 Campaign 时,可以使用此功能。 | |
~campaign_id | 使用此字段可以按实际的 campaign ID 来组织链接。例如,如果您启动了新功能或产品,并希望围绕该功能或产品建立 campaign | |
~customer_campaign | 最后一次归因触点指定的客户 campaign。可以由客户在链接上指定。 | |
~stage | 生成链接时,可使用此选项对用户的进度或类别进行分类。例如,如果您的邀请系统可以在1级,3级和5级上访问,则您可以使用此参数来区分在不同级别上生成的链接 | |
~tags | 这是一个包含无限值的自由格式的条目 ['string'] 。您可以用它来组织标签不在上述范围内的链接数据。 | |
~secondary_publisher | 最后一次归因触点指定的子发行商。由广告平台传递。 | |
~customer_secondary_publisher | 为上一次归因的触点指定的子发行商的ID。可以由客户端在链接上指定。 | |
~creative_name | 最后一次归因触点指定的名称。 | |
~creative_id | 最后一次归因的触点指定的 ID。 | |
~ad_set_name | 最后一次归因触点指定的广告合集名称。 | |
~ad_set_id | 为最后一次归因的触点指定的广告集合 ID。 | |
~customer_ad_set_name | 最后一次归因触点指定的客户广告集合名称。可以由客户端在链接上指定。 | |
~ad_name | 最后一次归因触点指定的广告名称。 | |
~ad_id | 最后一次归因触点指定的广告 ID。 | |
~customer_ad_name | 上一次归因触点指定的客户广告名称。可以由客户端在链接上指定。 | |
~keyword | 最后一次归属触点指定的关键字。 | |
~keyword_id | 最后一次触点关键字的唯一 ID | |
~customer_keyword | 最后一次触点的客户关键字。可以由客户端在链接上指定。 | |
~placement | 上次触点的位置,由 Analytics 标签标记。实际显示 campaigns 的应用或网站。 | |
~placement_id | 上次触点的位置 ID,由 Analytics 标签设置。实际显示 campaigns 的应用或网站。 | |
~customer_placement | 客户指定了最后的触点位置,并通过分析标签进行了设置。实际显示 campaigns 的应用或网站。可以由客户端在链接上指定。 | |
~sub_site_name | 引用显示广告的网站。 | |
~customer_sub_site_name | 客户对广告展示网站的引用。可以由客户端在链接上指定。 |
- 这些标签可让您自定义单个链接的归因窗口
Key | 默认 | 用途 |
---|---|---|
$click_install_window_days | 7 | 从点击或网络到应用自动重定向到安装或重新安装之间的时间。 (即 https://branchster.app.link/hpNVE52gxE?$click_install_window_days=3 ) |
$click_session_start_window_days | 1 | 从点击或网络到应用自动重定向到开始打开或网络会话之间的时间。 (即 https://branchster.app.link/hpNVE52gxE?$click_session_start_window_days=7 ) |
$click_conversion_window_days | 30 | 从点击或网络到应用自动重定向到转化事件之间的时间。转化事件包括商务事件(例如购买,添加到购物车),所有自定义事件以及所有视图事件,例如综合浏览量&内容视图。 (即 https://branchster.app.link/hpNVE52gxE?$click_session_start_window_days=30 ) |
$impression_install_window_days | 1 | 从广告展示到安装或重新安装之间的时间。 (即 https://branchster.app.link/hpNVE52gxE?$impression_install_window_days=3 ) |
$impression_session_start_window_days | 1 | 从广告展示到开始公开会话或网络会话之间的时间。 (即 https://branchster.app.link/hpNVE52gxE?$impression_session_start_window_days=1 ) |
$impression_conversion_window_days | 7 | 从广告展示到转化事件之间的时间。转化事件包括商务事件(例如购买,添加到购物车),所有自定义事件以及所有视图事件,例如综合浏览量&内容视图。 (即 https://branchster.app.link/hpNVE52gxE?$impression_session_start_window_days=7 ) |
自订数据
- 传递自定义数据以在您的应用内部读取
Key | 值 | 用途 |
---|---|---|
random | 123 | key-values 对组 |
custom_data | true | key-values 对组 |
any_value | { 'random': 'dictionary' } | key-values 对组 |
look_at | [1,2,3,4,5,6] | key-values 对组 |
nav_here | content/123 | key-values 对组 |
重新导向
- 根据设备信息前往其他位置
- 导航网址必须是网站,而不是深度链接接
Key | 默认 | 用途 |
---|---|---|
$fallback_url | 更改所有平台的重定向端点 — 因此您不需逐平台启用它。需要注意的是 Branch 会将 robots 导向这个 URL,因此会在链接中 overrides any OG tags。系统范围的默认 URL(在“ Settings 中设置) | |
$fallback_url_xx | 根据小写的 Alpha-2 国家代码更改所有平台的重定向端点。例如,$fallback_url_de="..." 将重定向德国深度链接点击。除了特定于国家/地区的重定向,还应该设置$fallback_url 作为全球重定向。注意:设置了平台特定的重定向(例如$ios_url 或$ desktop_url),它们将取代国家/地区特定的重定向。因此,建议仅将 $fallback_url_xx 用于特定国家/地区的重定向,而 $fallback_url 用于获取其他用户。 | |
$desktop_url | 更改桌面上 Text-Me-The-App 页面的重定向终结点(在 Link Settings 中设置) | |
$ios_url | 更改您应用的 iOS App Store 页面的重定向终结点(在 Link Settings 中设置) | |
$ios_url_xx | 根据小写的 Alpha-2 国家代码更改 iOS 的重新定向端点。例如, $ios_url_de="..." 将重新定向德国深层链接点击。除了特定于国家/地区的重定向,还应该设置$ios_url 作为全局重新定向。 | |
$ipad_url | 更改 iPad $ios_url 的重定向端点 | |
$android_url | 更改您应用的 Android Play 商店页面的重定向端点(在 Link Settings 中设置) | |
$android_url_xx | 根据小写的 Alpha-2 国家/地区代码更改 Android 的重新定向端点。例如, $android_url_de="..." 将重新定向德国深层链接点击。除了特定于国家/地区的重定向,还应该设置$android_url 作为全局重新定向。 | |
$samsung_url | 重定向到 Samsung 设备上的 Samsung Galaxy Store。仅存在链接级别控制。格式应为 http://www.samsungapps.com/appquery/appDetail.as?appId=YOUR.PACKAGE.NAME | |
$windows_phone_url | 更改 Windows 操作系统和手机的默认 URL 重定向终结点(在 Link Setting 中设置) | |
$blackberry_url | 更改 Blackberry OS BlackBerry 默认URL的重定向终结点(在 Link Setting 中设置) | |
$fire_url | 更改 Amazon Fire OS Fire 默认 URL 的重定向终端节点(在 Link Setting 中设置) | |
$ios_wechat_url | 更改 iOS 设备上微信的重定向终结点 $ios_url 值 | |
$android_wechat_url | 更改 Android 设备上微信的重定向终结点$android_url 值 | |
$web_only | false | 强制打开 $fallback_url 并非应用 |
$desktop_web_only | false | Force to open the $windows_desktop_url , $mac_desktop_url , $desktop_url , or $fallback_url in this order of precedence instead of the app |
$mobile_web_only | false | Force to open the$ios_url , $android_url , or $fallback_url in this order of precedence instead of the app |
$after_click_url | false | 当用户转到应用后返回浏览器时,将其带到该 URL。仅限 iOS; Android 版即将面世 |
$afterclick_desktop_url | false | 当桌面上的用户转到桌面应用后返回桌面浏览器时,将其带到该 URL。 |
强制重定向
- 点击 Branch 深度链接时,防止其他应用发出错误消息
Key | 值 | 用途 |
---|---|---|
$uri_redirect_mode | 0 | 这是产生标准行为的默认值,在该行为下,如果用户看到错误信息,我们将不尝试打开应用。 |
$uri_redirect_mode | 1 | 智能重定向模式。在用户通过 Branch Persona (同人用户)数据安装应用前,行为会等同于0。在这种情况下,您可以强制使用 URI Schemes 打开应用。 |
$uri_redirect_mode | 2 | 强制重定向模式。始终尝试强制打开应用,即使未安装应用时可能会显示错误消息 。 |
-
可以通过使用参数
$ios_uri_redirect_mode
和$android_uri_redirect_mode
来启用 OS 级重定向模式。 -
支持的应用
- Facebook Newsfeed iOS
- Instagram iOS
- Twitter iOS
- Safari iOS
- Firefox iOS & Android
深度链接
- 根据设备信息前往其他位置
Key | 默认 | 用途 |
---|---|---|
$deeplink_path | open?link_click_id=1234 | 为所有平台设置深度链接接路径。当 Branch SDK 收到带有此参数集的链接时,将自动加载包含在其中的自定义 URI 路径 |
$android_deeplink_path | 设置 Android 应用的深度链接接路径。当 Branch SDK 收到带有此参数集的链接时,将自动加载其中包含的自定义 Android URI 路径 | |
$ios_deeplink_path | 设置 iOS 应用的深度链接接路径。当 Branch SDK 收到带有此参数集的链接时,将自动加载其中包含的自定义 iOS URI 路径 | |
$desktop_deeplink_path | 设置桌面应用的深度链接路径。您将必须获取此参数并相应地路由用户 | |
$match_duration | 7200 | 可让您控制快照匹配超时(点击等待应用打开匹配的时间),也称为归因窗口,以秒为单位 |
$always_deeplink | true | 设置为false 可使链接始终回退到您的移动网站。不适用于 Universal Links 或 Android App Links。 |
$ios_redirect_timeout | 750 | 控制客户端 JS 在尝试打开应用后重定向到 App Store 之前的等待超时,以毫秒为单位 |
$android_redirect_timeout | 750 | 控制客户端JS在尝试打开应用后重定向到Play商店之前等待的超时。以毫秒为单位 |
$custom_sms_text | 发送给SMS链接的文本,供桌面点击此链接。 “设置”中的应用页面必须包含{{ link }} “ Text me me”值 | |
$marketing_title | 设置深度链接的营销标题。 | |
$deeplink_no_attribution | 设置为true 的链接仅支持深度链接接,而对该链接没有任何归属。 |
Content
- 处理内容属性
Key | 默认 | 用途 |
---|---|---|
$publicly_indexable | 1 | 无法在此处修改。需要由 Branch Universal Object 设置 |
~keyword | 应该为其寻找内容的关键字 | |
$canonical_identifier | 这是内容的标识符,可帮助 Branch 在同一事物的许多实例之间进行重复数据删除。合适的选项:具有路径的网站或具有实体标识符的数据库 | |
$content_type | 这是存在的内容类型的标签。 Apple 建议您按照此处所述使用统一类型的标识符 | |
$do_not_process | false | 这将阻止点击追踪和链接分析的存储。从点击链接到打开应用,深度链接接数据仍将流入应用。 |
Deepview
- 启用/控制活动的Deepview 属性
Key | 默认 | 用途 |
---|---|---|
$ios_deepview | branch_default | 用于 iOS 的 Deepview 模板的名称 |
$android_deepview | branch_default | 用于 Android 的 Deepview 模板的名称 |
$desktop_deepview | branch_default | 用于桌面的 Deepview 模板的名称 |
- 控制被动式Deepview 模板
Key | 值 | 默认 |
---|---|---|
$ios_passive_deepview | 用于 iOS 的模板名称。 | branch_default |
$android_passive_deepview | 用于 Android 的模板名称。 | branch_default |
链接外观
- 自定义您的短链接的外观
Key | 默认 | 用途 |
---|---|---|
alias | none | 指定一个链接别名来取代标准编码的短URL(例如https://example.app.link/aQXXDHaxKF - > https://example.app.link/october-campaign 或https://example.app.link/product/id1234 )。每个应用的链接别名必须唯一(如果您创建已使用的别名,则别名为409 error )。另外请注意,我们不'吨当前域(后支持单字符路径段/a/ , /b/ , /c/ ,等等)。 |
Open Graph
- 处理Facebook属性
Key | 默认 | 用途 |
---|---|---|
$og_title | 在仪表板上设置 | 设置链接的标题,以使其在社交媒体显示中看到 |
$og_description | 在仪表板上设置 | 设置链接的描述,以便在社交媒体显示中看到 |
$og_image_url | 在仪表板上设置 | 设置链接的图像,使其在社交媒体显示中看到 |
$og_image_width | 为社交媒体显示设置图像的' s宽度(以像素为单位) | |
$og_image_height | 设置图像' s的高度(以像素为单位)以用于社交媒体显示 | |
$og_video | 设置视频,使其在社交媒体显示中看到 | |
$og_url | 设置链接的 base URL,因为它将在社交媒体显示中看到 | |
$og_type | 设置自定义卡格式链接的类型,因为它将在社交媒体显示中看到。在Facebook上分享深度链接接时,不要设置此属性 | |
$og_redirect | (高级,不建议使用)设置自定义 URL,我们将社交媒体 robot 重定向到该 URL,以便获得所有适当的标签 | |
$og_app_id | 在仪表板上设置 | (很少使用)设置应用ID标签 |
Twitter
- 处理Twitter属性
Key | 默认 | 用途 |
---|---|---|
$twitter_card | 设置链接的Twitter卡类型(例如player )(您必须使用 Twitter Card Validator 将深度链接接白名单 | |
$twitter_title | 在仪表板上设置 | 设置 Twitter 卡的标题 |
$twitter_description | 在仪表板上设置 | 设置 Twitter 卡的描述 |
$twitter_image_url | 在仪表板上设置 | 设置 Twitter 卡的图片网址 |
$twitter_site | 设置 Twitter 网站 | |
$twitter_app_country | 设置应用卡的应用国家/地区 | |
$twitter_player | 设置视频播放器'的URL。默认值为$og_video 。 | |
$twitter_player_width | 设置播放器'的宽度(以像素为单位) | |
$twitter_player_height | 设置播放器'的高度(以像素为单位) |
其他保留键
Key | 用途 |
---|---|
access_token or AccessToken | Branch 用来确定深度链接是否为有效的 Branch Link 。 |
auth_token or AuthToken | Branch 用来确定深度链接是否为有效的 Branch Link 。 |
data | 由Branch使用,以包含顶级链接信息。如果通过附加查询参数将此参数添加到“Branch”链接,则它将被删除。通过仪表板手动创建链接时,可以安全地使用它。 |
自定义标签
- 处理自定义元标记
Key | 值 |
---|---|
$custom_meta_tags | 标签的键和值的有效字符串化JSON字典 |
- 有效的字典示例:“ {"twitter:player:stream": "https://branch.io\"} ” 。这将导致以下元标记:
<meta property="twitter:player:stream" content="https://branch.io" />
- 如果您通过仪表板创建链接,则不必担心将字典字符串化。它将自动完成。
- apple_touch_icon是词典中的特殊键。如果您进行了设置,我们将在抓取的HTML页面上添加一个
<link rel="apple-touch-icon" href="<url>" />
标签。这将允许您在iMessage,Safari书签,Slack等中显示用于预览的自定义图标。
Universal Object
- 应用集成中的 Branch Universal Object
Key | 默认 | 用途 | 链接属性 |
---|---|---|---|
canonicalIdentifier | (必需) 这是内容的标识符,将帮助 Branch 在同一事物的许多实例之间进行重复数据删除。合适的选项:具有路径的网站或具有实体标识符的数据库 | $canonical_identifier | |
canonicalUrl | 规范网址,用于SEO | $canonical_url | |
title | 内容的名称 | $og_title | |
contentDescription | 内容说明 | $og_description | |
contentImageUrl | 内容的图片网址。必须是绝对路径 | $og_image_url | |
price | 商品价格 | $amount | |
currency | 表示价格的货币,采用ISO 4217货币代码 | $currency | |
contentIndexingMode | "public" | 可以设置为"public" 或"private" 。公开表示您'希望此内容被其他应用发现。 | $publicly_indexable |
contentMetadata | 任何自定义键值数据,例如 { "custom": "data" } |
BUO最佳实践
- 要
- 跨应用实例将
canonicalIdentifier
设置为唯一的重复数据消除值 - 确保
title
,contentDescription
和imageUrl
适当地表示对象 - 初始化 Branch Universal Object,并在页面加载时使用
VIEW_ITEM
事件调用logEvent - 当用户执行需要链接的操作时,请在生命周期的后期调用showShareSheet和createShortLink。
- 当采取相应的用户操作时,调用其他对象事件(购买,分享完成等)
- 跨应用实例将
- 不要
- 设置相同的
title
,contentDescription
和imageUrl
在所有对象 - 等待初始化对象并注册视图,直到用户分享
- 等待初始化对象,直到方便地需要链接为止
- 一次创建多个对象,并在
for
循环中注册视图。
- 设置相同的
阅读深度链接接
- 深度链接数据从链接发送到应用集成
数据结构
- 示例深度链接接数据结构
{
"identity_id": "427469360685348303",
"link": "https://example.app.link?%24identity_id=427469360685348303",
"session_id": "429691081177874743",
"data": {
"$canonical_identifier": "item/1503684554354.28",
"$canonical_url": "https://example.com/home?utm_campaign=test&deeplink=value",
"$desktop_url": "http://example.com/home",
"$identity_id": "427469360685348303",
"$og_description": "My Content Description",
"$og_image_url": "http://lorempixel.com/200/200/",
"$og_title": "46D6D28E-0390-40E4-A856-BD74F34D24C8",
"$publicly_indexable": 1,
"+click_timestamp": 1503684563,
"+clicked_branch_link": true,
"+is_first_session": false,
"+match_guaranteed": true,
"custom": "blue",
"random": "FE848A5B-78F7-42EC-A253-9F795FE91692",
"added": "1503684554354.33",
"~campaign": "new launch",
"~channel": "facebook",
"~creation_source": 3,
"~feature": "sharing",
"~id": 429691043152332059,
"~referring_link": "https://example.app.link/X7OsnWv9TF",
"~stage": "new person",
"~tags": [
"one",
"two"
]
}
}
回调值
- 其他属性从您的应用中的
initSession
和网站集成中读取
Key | 用途 |
---|---|
| 自动生成驱动安装/打开的链接的18位ID号(如果存在)(对于动态和3P链接为0) |
| 驱动安装/打开的引荐链接(如果有) |
| 创建链接的位置( |
| 如果以100%的准确度进行匹配 |
| 点击链接的推荐人来源网址(如果已点击链接) |
|
默认值为 |
| 用户是否点击触发此会话的 Branch Link。 默认值为 |
| 应用是通过非 Branch Link(第三方,无效的 Branch 深度链接或 Branch key 不匹配)打开的。 |
13 天前更新
下一步
对深度链接常见问题进行问题排查 |