iOS Branch接入
参考网址:https://shimo.im/docs/jdPXKHgkKYr9jRGX/read
*注:以shimo开头网址,请复制链接后用石墨文档App或小程序打开。
请注意
有SDK的包上线之后, Branch才能够收集到数据并归因
对接流程图
请操考此对接流程图和下方文档分步骤完成对接
image.png-
帐号注册
-
SDK对接基础(参考下方文档 3.SDK对接) /同时联系商务功能开通
-
事件上报(参考下方文档 4.事件上报相关)
-
广告渠道对接(参考下方文档 5.广告渠道对接)
-
帐号注册
1.1. 请通过下方链接查看开通帐号时常见问题:
-
Branch后台注册链接: <u>https://dashboard.branch.io</u> (建议全程开启VPN),注册完成后建议浏览器星标/收藏已登录的Branch后台,方便以后日常登录(免去每次输入密码)
-
《开通帐号时常见问题》请参考FAQ:https://shimo.im/docs/qYhPyQwHgyt9jjy3
1.2如何邀请新团队成员
- 执行路径:Account Settings -> Team -> Add App Team Member
- 如邀请用户进"Team"时出现错误, 请稍等再尝试. 可能因为短时间对单一IP, 请求服务器限制造成. 请稍等30-60分钟后重试
- 新App功能开通
2.1. 请提前通知与您接洽的Branch商务对接工作人员,并在后台授予Branch商务对接人和Jeff(jliu@branch.io)Admin权限
2.2. *注:正式签订合约后可以申请简易开通,使流程更加精简
2.3 简易开通 (签合同之后)
如果未来需要添加多个App, 请联系商务创建Org. 好处:1)新App直接默认具备广告追踪等功能;2)避免每次添加新app后签署补充协议
2.4 如何在Org下创建新app直接具备广告追踪等功能
https://shimo.im/docs/TKkKW3PjWRRrHgHG/ 《(详细步骤)如何在org下创建新的app》,可复制链接后用石墨文档 App 或小程序打开
- SDK 对接
3.1. 通过链接: 链接: https://pan.baidu.com/s/1_DCa7KNOK9JONyHxZXfLlg 提取码: dcpb 链接进入百度网盘查看并下载对接文档,其中包含2个主要文件.
-
文件1****:****Branch对接****大全 此文档回答了对接过程中常见疑问的回答(简单中文翻译,请以英文官方文档为准 https://help.branch.io/ )
-
文件2:Branch对接检查文档 - 对接完成后,请按照该文档进行检查,确保对接完毕。
3.2. 请技术同学点击链接进入https://dashboard.branch.io/ 并用邮箱进行后台注册,此时请参考文件1:Branch对接文档开始进行SDK配置,出现问题欢迎随时沟通!
3.3. *注:因后台面板更新, 烦请注意以下链接中内容:
-
https://shimo.im/docs/vxYw83wGDVJHkWRg《新版仪表盘[Dashboard]注意事项》
-
https://shimo.im/docs/kqvycyHvdqHVCV6p/ 《后台操作相关(包含看数据)》
3.4. 必要时,请参考以下内容:
3.4.1. 如需在SDK生成链接用于分享:
-
https://help.branch.io/developers-hub/docs/android-advanced-features#create-deep-link
-
https://help.branch.io/developers-hub/docs/ios-advanced-features#create-deep-link
3.4.2. 如需将用户ID和设备关连:
-
https://help.branch.io/developers-hub/docs/android-advanced-features#track-users
-
https://help.branch.io/developers-hub/docs/ios-basic-integration#track-users
3.4.3. 如需归因推送(push notification):
3.4.4. 必要时,请参考以下链接中SDK对接常见问题:
-
https://shimo.im/docs/amDzsN1YrzkQpdmj/ 《Android常见问题》
-
https://shimo.im/docs/FIlZHwRDVvAjx2PI/ 《iOS对接常见问题和答疑》
3.4.5 Web SDK
Web SDK基础对接一行代码 请参考
https://shimo.im/docs/cVRTTQRjJjq8Crhc/ 《☆ Branch Web SDK对接指导 ☆》,可复制链接后用石墨文档 App 或小程序打开
3.5. 对接验证
https://shimo.im/docs/yJpgK3drpDdrt8pd/ 《验证 SDK对接》
3.6 Test Device
https://shimo.im/docs/kcDWwydC89rggtTw/ 《如何使用测试设备 Test Device》
3.7 SDK归因数据获取最佳实践
https://shimo.im/docs/C38hGCQpVqTqHWwr
3.8 其他
-
Flutter https://github.com/RodrigoSMarques/flutter_branch_sdk 目前没有官方支持版本,请参考此第三方版本。
-
Unity https://shimo.im/docs/gkdJqGYhYtdTgGtq/ 《Unity 对接注意事项》,可复制链接后用石墨文档 App 或小程序打开
-
https://shimo.im/docs/YWDHtv686cT9YDQp/ 《[Apple审核用] Branch SDK目前收集的信息》
-
桌面版(Desktop)SDK
-
请见此链结 https://help.branch.io/developers-hub MacOS, Windows等
- 事件上报相关
*注:****上报事件即时性:
Liveview数据: 延迟5分钟内. 关于Liveview操作请参考 "7. Liveview相关"
Dashboard其他部分: 延迟60分钟内
*注:除Open,Install,Reinstall等事件, 其他in-app用户行为事件需要埋点报上
4.1. 如需上报事件, 请参考以下链接中内容:
注意事项:
-
只需照下方文档格式上报事件. 在归因后, Branch将转化对应格式上报给对应渠道
-
除Purchase事件, 其他事件均没有必须上报属性, 请照需求上报.
-
除Purchase事件, 其他事件Branch会
-
归因
-
统计发生次数
-
不会对上报数据有任何逻辑处理
-
https://shimo.im/dcs/qq11/ 《事件列表 + 埋点上报事件代码释义》
-
https://shimo.im/docs/uCuIG0rt78UUkSmJ/ 《商业上报事件(购买Purchase)范例》
-
https://shimo.im/docs/xVhatw4vzY0uH52F/ 《如何使用S2S上报事件》
-
https://shimo.im/docs/wGrthhxGJ9YHQXWy/ 《如何测试事件上报成功》
注:埋点上报事件包含商业上报事件,因90%的客户需要在商业上报事件中上报purchase和revenue,故作单独说明一篇*。
- 广告渠道对接
*注 请先确认带Branch SDK的包上线(更新到Google Play)后再做渠道对接
在对接Facebook, Google, Snap, Tiktok, Unity等已经存在对接渠道时, 请勿点击 Add Custom Partner
image.png
5.1. Google,请参考以下链接内对接文&档:
- https://shimo.im/docs/YvGKqRtdHrYW3YwW/ 《(全)Google AdWords广告主追踪设置》
5.2. Facebook,请参考以下链接内对接文档:
-
https://shimo.im/docs/GTQpxcDWYCGWjcR3/ 《(全)Facebook广告追踪配置》
-
https://shimo.im/docs/54xpCzc94Yo9KFmC/ 《Facebook web广告追踪配置》
-
https://shimo.im/docs/vGVgT6cPTgxwyCQg/ 《Branch <> Facebook 事件映射设置
-
*注:请确认签署过以下文件:https://www.facebook.com/ads/manage/advanced_mobile_measurement/app_based_tos
5.3. Facebook&Google,请参考以下链接内对接注意事项与常见问题:
-
https://shimo.im/docs/Tghkc6Pj6q6KgR9r 《Google& Facebook对接注意事项》
-
https://shimo.im/docs/h9dqptKC3h9WQ9jq/ 《【持续更新】Facebook FAQs常见问题》
注:
-
如需要添加新广告帐号(Google/Facebook), 请照文档重新关连
-
重新关连后不会对现有数据有影响
-
https://shimo.im/docs/YYRCkdvqHvjgCDcw/ 《Facebook, Google对接自查步骤》
5.4. 其他广告平台(非自归因平台)
- https://shimo.im/docs/KxQ6RKkprCPvtxrX/ 《(全 )如何给渠道配置Branch追踪链接》
5.5. Tiktok, 请参考以下链接内对接文档:
5.6. Snap, 请参考以下链接内对接文档:
5.7 Twitter,
5.8. 如有Google web campaigns需要配置tracking template,请参考以下链接:
- https://shimo.im/docs/f257184d712f48c9/ 《Google Keyword/Search 配置流程 - Tracking Template》
5.9. 其他渠道相关问题 https://shimo.im/docs/Y6
G6DqVjrHtkQwgx/ 《常见渠道配置笔记》,可复制链接后用石墨文档 App 或小程序打开
5.10 ASA Apple Search Ads
https://shimo.im/docs/RXj9RQkrCVy6tcJK
5.11 Criteo
https://help.branch.io/zh/using-branch/page/criteo
5.12 RTB House
https://help.branch.io/zh/using-branch/page/rtb-house
附录:
其他归因平台切换到Branch流程
https://shimo.im/docs/aWEnse5Ubccd9b0a
- 代理相关
*注:在执行对接前,****请优先阅读此文档
代理商帮助文档 (不定期更新)
https://shimo.im/docs/rRcxycPKVD8K3Wdp
广告平台帮助文档 (不定期更新)
https://shimo.im/docs/yWt669hCh3TjtVpD
更多文档请移步China BD Wiki: https://shimo.im/docs/ctWwXw6GXYG3ycQQ#anchor-74vy
6.1. 新代理商/网盟/广告平台申请,请参考此链接:
6.2. 「Agency FAQ」,请参考此链接:
6.4 客户已经发Agency Dashboard邀请,但是Agency 对接人没有收到邀请怎么办?
-
查看Agency user list: https://docs.google.com/spreadsheets/d/123eAKI5dOsjBtbepr02AaVwtQNa2jZIgI5PDs4LTmBA/edit#gid=894280744
-
如果agency对接人不在列表中,TA需要找在列表中的同事邀请他进入Agency后台
- Liveview相关/测试相关
*注:****Liveview 一般提供开发人员使用, 为Session机制****,****不保存历史数据****。
7.1. 请按照以下链接中步骤操作:
- https://shimo.im/docs/tQh93jvh9HJwW3tw/ 《测试发送事件(埋点)》
7.2. 如何测试非自归因渠道是否已经可以成功追踪:
https://shimo.im/docs/Fu5VQQVwyG8xwl6N/ 《(全 )如何测试渠道的追踪链接是否正常工作》,可复制链接后用石墨文档 App 或小程序打开
7.3. 如需获取历史数据, 请按照如下过程操作:
- 后台面板 ->Daily Export 下载数据
*注:
1. 请勿点击"Export All" 因数据量导致导出时间变长
2. 该数据仅在过去7天内可检索(Branch需要hash(加密)7天前的设备ID讯息)
- 数据对接 - 导出原始数据/实时数据回传
8.1. 请优先阅读此文档进行数据对接:
-
https://shimo.im/docs/W6WprJk9xkVy6HTk 《数据对接最佳实践》
-
https://shimo.im/docs /ydQtKj9qQKJvDtwk/ 《(全)如何在dashboard上导出原始数据?(含custom export)》
-
https://shimo.im/docs/rC9KqV6gyxqcgkjj/ 《如何使用custom Export导出数据》
8.2. 如有更多疑问,请参考以下链接中文档:
-
https://shimo.im/docs/gv1IbIEUGjks9t9t/ 《数据对接相关文档》
-
https://shimo.im/sheets/zUVlMiWXoFQua60K/GE86u 《Branch导出数据字段说明》
8.3. 对接第三方注意事项
如您需要对接Amplitude, 等第三方数据平台, 请注意以下
因SAN(自归因平台)的数据分享限制, Branch在将归因数据发给第三方时
-
Google: 会分享给第三方
-
Facebook:** 如果第三方为FMP(Facebook Market Partner), Branch可以在申请内部配置后发送数据给第三方.**
-
可以从 https://www.facebook.com/business/partner-directory/search?solution_type=campaign_management 查看第三方是不是FMP
-
SNAP: 不会分享给第三方 https://help.branch.io/using-branch/docs/snap#exporting-snap-data
- 后台相关
*注:如您刚开始使用Branch, 请和Branch商务联系安排 "后台使用演示/教学"
后台操作相关信息:
- https://shimo.im/docs/kqvycyHvdqHVCV6p/ 《后台操作/配置相关(包含 查看数据)》
- 从SDK获取自归因平台归因数据
*注:****请先联系您Branch商务负责人开通 LATD(SAN Deferred Ad Data)功能
- 参考此文档: https://shimo.im/docs/GvHRKTHRCP6V9yTq/ 「Branch SAN Deferred Ad Data [Beta]」
- Quick Link相关
如果您需要:
-
链结放H5页面上
-
链结使用到短信(sms)
-
链结放到较小众渠道
参考:
https://shimo.im/docs/KtPcrGY6vjKRqkK9/ 《(全)如何生成Branch Quick Link》,可复制链接后用石墨文档 App 或小程序打开
如有特殊需求, 需要将已经安装app用户引导到网址
https://shimo.im/docs/x3YPvJVKCkqKJ3DW/ 《已安装用户跳转到网址(Web Only)》,可复制链接后用石墨文档 App 或小程序打开
- 预安装、三方应用市场
https://shimo.im/docs/dwcC9Q6kk6fWWrQxQ/ 《如何设置预装或者其他三方应用市场渠道?》,可复制链接后用石墨文档 App 或小程序打开
- 已安装用户识别
-
嵌入Branch SDK时间越久,Branch慢慢就可以识别老用户
-
第2种方法,需要导入设备IDs,这个操作大概1-2周,需要技术同学按照Branch模板导入,建议在进入正式商务合同后操作 https://shimo.im/docs/VychxCqtRjqJhgK6/ 《导入初始数据步骤》
- 贷超渠道
如果要在APK包里写死渠道号,请参照以下步骤:
如需要投放到贷超等渠道, 建议方式如下:
-
按照如下命名规范命名渠道号:a_ 开投加渠道拼音 例:渠道名称 -> cashclub,渠道号 -> a_cashclub
-
照上方13. 预安装 文档使用渠道代码并打包
-
将此版本安装包, 发送给贷超进行投放
-
只要用户安装此版本安装包, Branch将归因到对应的贷超渠道
注: 如使用此方式, 不需要使用Branch link
贷超渠道需要申请账号查看数据
-
确认渠道名称按照命名规范 a_渠道名称
-
联系BD新建渠道profile,并开通渠道账号
-
广告主按照渠道授权方式给渠道账号授权查看该渠道数据
Q:****贷超****什么时候需要对接渠道?
贷超是否需要访问Branch后台权限
-
是 - 对接渠道
-
否 - 不需要对接渠道
两个qualification question
1. 是否能用链接?(否则不用问2了)
2. 是否需要数据回传,生成单独的广告链接,同时在Branch dashboard Ads 部分查看数据?
1 是 2 是 -> 推荐接渠道
1 是 2 否 -> quick link,不需要对接渠道
1 否 -> APK,不需要对接渠道
- Dashboard 数据相关
1)后台数据更新时间
image.png备注:
-
Non-San(非自归因渠道)数据即时收集到branch 数据库, 从branch数据库校验处理有1.5小时刷新时间
-
SAN(自归因渠道) 每两小时和渠道拉取数据
2) SAN后台和Branch后台数据差异
给大家系统解释下,app事件(比如安装、购买事件)的数据对比,是肯定不会一致的,差异在20%-40%不等。导致这种差异的因素有哪些呢?
-
广告平台后台和Branch后台时区的不同
-
广告平台后台和Branch后台归因窗口的不同
-
比较最后点击的范围不同:
以FB为例,adwords/snap同理 ,
-
Branch是对比所有渠道(FB,adwords, snap, etc, journey, quick link, email )之间的最后点击,而 FB只对比FB范围内的。
-
比如客户点了FB广告,又点了snap广告, 完成安装, Branch把安装归给FB, 但是FB和snap都会归给自己。
- branch是每次事件归因,将本次事件归给最后一个点击的campaign. 而SAN以及其他友商是把事件归给带来install的那个campaign。
- 比如小明周一点击FB,下载了app. 周三点击了tiktok完成了购买,branch将该事件归给TT,而FB归给自己
- 事件发生时间 VS 点击事件,
- 比如用户周一点击,周三安装,FB算成周一的安装,branch算成周三的安装
- 安装定义不同
- 比如谷歌的安装定义是点击应用市场下载的按钮; Branch的定义是安装后首次打开
- Google在2020年初时正式宣布iOS应用广告安装的搜索库存仅在Google Ads上呈现 (不会出现在任何AAP的面板上),因此,iOS应用安装广告系列会导致不一致的数据汇报。
小贴士:在查看谷歌数据时,将搜索类与视频、展示类广告进行区分
注意:数据的对比,建议基数大一些,至少三位数。个位数或者两位数的转化不易做比较
3)自定义 domain
-
可以自定义域名,可以自定义子域名。大多数客户会选择使用自定义子域名。
-
自定义域名建议在集成好 sdk 上线前完成。否则后边可能面临旧 domain 不好用的问题。
-
需要客户有较懂域名、DNS 等网络配置的技术运营人员,参考 https://help.branch.io/using-branch/docs/advanced-settings-configuration#section-domain-change-warning 进行配置。
- Journeys相关
https://shimo.im/docs/Mlk86CCKcwITLFKb/ 《Journeys 接入(手把手) 》,可复制链接后用石墨文档 App 或小程序打开
- iOS14和SKADNetwork
https://shimo.im/docs/hV8qwgV88PWJYGww/ 《iOS 14 和SKADNetwork答疑》,可复制链接后用石墨文档 App 或小程序打开
iOS 14.5 影响及应对指南 https://shimo.im/docs/KV1mRFcBLAA5SP2E/
Branch iOS 14.5 常见问题答疑 https://shimo.im/docs/jKW3WGkjVCrgJdjR
- 其他场景
游戏客户桌面版预注册场景
https://shimo.im/docs/vXgdHHYtPjRTWyD3/ 《游戏客户桌面版预注册场景》,可复制链接后用石墨文档 App 或小程序打开
如何实现推荐(Referral)
https://shimo.im/docs/xgxQHCQJGvtg9TWg/ 《如何实现推荐(Referral)》,可复制链接后用石墨文档 App 或小程序打开
20.面板基本操作介绍视频(中文字幕)
Branch Deep Linking 深度链接基础介绍
Dashboard - Agency Permissions 如何为代理授权
Dashboard - Analytics Analytics面板使用介绍
Dashboard - Overview 面板使用总览
Dashboard - Quick Link Creation 如何创建短链接 quick link
Dashboard - User Permissions 如何为新用户授权
Data Feeds - Enable a Data Integration
Data Feeds - Overview 原始数据总览
Journeys - Analytics 网页端智能横幅报表界面介绍
Journeys - Campaign Creation 如何创建新的智能横幅
Universal Ads - Adding and Editing Postbacks 为广告平台/渠道创建或修改回传
Universal Ads - Creating Ad Links 创建广告链接
Universal Ads - Enable an Integration 对接新的广告渠道
Universal Ads - Overview 广告归因面板总览
Universal Email - Overview 邮件总览
- UE邮件对接相关
https://shimo.im/docs/teHcrfPdz1UqoUUs/ 《UE对接范例&Checklist》,可复制链接后用石墨文档 App 或小程序打开
[附】相关录屏演示
-
如何使用Liveview测试Event (安卓) https://www.bilibili.com/video/BV1W4411Y7WF
-
[Facebook] 如何确认ads account权限授权正确 https://www.bilibili.com/video/BV18A411b7jE
-
在Google Ads后台 import Branch conversions https://www.bilibili.com/video/BV1JJ411T73C
-
如何关连Google帐号 https://www.bilibili.com/video/BV1ZT4y1u74Y
-
如何检查Google Conversion和新增 https://www.bilibili.com/video/BV1oZ4y1p7wS
-
其他 https://space.bilibili.com/6869081/channel/detail?cid=67312
-
Branch Partner 对接指南 https://v.qq.com/x/page/l3208bjbw7g.html
-
Branch Agency 账号 vs 广告主 账号 https://v.qq.com/x/page/r3208xsojct.html
-
Branch 代理 vs 渠道 授权 https://v.qq.com/x/page/n3208w0grw9.html
-
Branch agency 账号授权常见问题 https://v.qq.com/x/page/t3208420by7.html
-
Branch 监测链接参数与宏替换详解 https://v.qq.com/x/page/l3208sb4my8.html
-
Branch 测试广告链接常见报错原因 https://v.qq.com/x/page/q32080wk4mf.html
-
Branch 合作伙伴如何获取帮助 https://v.qq.com/x/page/x3208qh431s.html