Branch Event Ontology (事件本体)

Branch 的事件本体数据架构(Event Ontology Data Schema)是在所有 Branch 产品之间分享的统一格式。

包括的事件

我们将事件分为逻辑分组。现在,我们有以下不同的事件分组:

  • impression
  • click
  • web-to-app auto-redirect
  • Branch CTA view
  • sms sent
  • open
  • install
  • reinstall
  • web session start
  • pageview
  • commerce event
  • custom event
  • content event
  • user lifecycle event

🚧

iOS 14.5 发布后安装事件的变化

Apple 要求用户在 Apple 的 AppTrackingTransparency 框架下选择分享其设备 data。安装归因于付费广告时,第2次安装事件将触发用户选择加入

iOS 14.5 发布之后的变化,额外相关信息请访问我们的 常见问题页面

后四个是多个事件的分组。

  • Custom events 是您选择通过 Branch 追踪的任何超出我们标准事件列表的事件。
  • Commerce events 包括与电子商务有关的事件的简短列表,例如购买。
  • Content events 包括事件的简短列表,例如 VIEW_ITEM,这些事件涉及内容且与电子商务没有直接关系。
  • User lifecycle events 是标记用户在您的应用中前进时完成的独特动作的事件,例如 COMPLETE_REGISTRATION。

Branch 事件

Event 名称 iOS Android Web/API
添加到购物车 BranchStandardEventAddToCart BRANCH_STANDARD_EVENT.ADD_TO_CART ADD_TO_CART
加到收藏夹 BranchStandardEventAddToWishlist BRANCH_STANDARD_EVENT.ADD_TO_WISHLIST ADD_TO_WISHLIST
查看购物车 BranchStandardEventViewCart BRANCH_STANDARD_EVENT.VIEW_CART VIEW_CART
发起购买 BranchStandardEventInitiatePurchase BRANCH_STANDARD_EVENT.INITIATE_PURCHASE INITIATE_PURCHASE
添加付款信息 BranchStandardEventAddPaymentInfo BRANCH_STANDARD_EVENT.ADD_PAYMENT_INFO ADD_PAYMENT_INFO
点击广告 BranchStandardEventClickAd BRANCH_STANDARD_EVENT.CLICK_AD CLICK_AD
点击广告 BranchStandardEventClickAd BRANCH_STANDARD_EVENT.CLICK_AD CLICK_AD
购买 BranchStandardEventPurchase BRANCH_STANDARD_EVENT.PURCHASE PURCHASE
保留 BranchStandardEventReserve BRANCH_STANDARD_EVENT.RESERVE RESERVE
消费积分 BranchStandardEventSpendCredits BRANCH_STANDARD_EVENT.SPEND_CREDITS SPEND_CREDITS
查看广告 BranchStandardEventViewAd BRANCH_STANDARD_EVENT.VIEW_AD VIEW_AD
Event 名称 iOS Android Web/API
搜索 BranchStandardEventSearch BRANCH_STANDARD_EVENT.SEARCH SEARCH
查看商品 BranchStandardEventViewItem BRANCH_STANDARD_EVENT.VIEW_ITEM VIEW_ITEM
查看商品 BranchStandardEventViewItems BRANCH_STANDARD_EVENT.VIEW_ITEMS VIEW_ITEMS
频率 BranchStandardEventRate BRANCH_STANDARD_EVENT.RATE RATE
分享 BranchStandardEventShare BRANCH_STANDARD_EVENT.SHARE SHARE
启动流 BranchStandardEventInitiateStream BRANCH_STANDARD_EVENT.INITIATE_STREAM INITIATE_STREAM
Complete Stream BranchStandardEventCompleteStream BRANCH_STANDARD_EVENT.COMPLETE_STREAM COMPLETE_STREAM
Event 名称 iOS Android Web/API
完成注册 BranchStandardEventCompleteRegistration BRANCH_STANDARD_EVENT.COMPLETE_REGISTRATION COMPLETE_REGISTRATION
完成教程 BranchStandardEventCompleteTutorial BRANCH_STANDARD_EVENT.COMPLETE_TUTORIAL COMPLETE_TUTORIAL
达标级别 BranchStandardEventAchieveLevel BRANCH_STANDARD_EVENT.ACHIEVE_LEVEL ACHIEVE_LEVEL
解锁成就 BranchStandardEventUnlockAchievement BRANCH_STANDARD_EVENT.UNLOCK_ACHIEVEMENT UNLOCK_ACHIEVEMENT
邀请 BranchStandardEventInvite BRANCH_STANDARD_EVENT.INVITE INVITE
登录 BranchStandardEventLogin BRANCH_STANDARD_EVENT.LOGIN LOGIN
开始试用 BranchStandardEventStartTrial BRANCH_STANDARD_EVENT.START_TRIAL START_TRIAL
Subscribe BranchStandardEventSubscribe BRANCH_STANDARD_EVENT.SUBSCRIBE SUBSCRIBE

如果事件不属于上述类别之一,则可以追踪自定义事件


包括的字段

对于每个事件,我们都提供大量信息。下表提供了概述。下面的几个字段是对象,它们本身具有很多字段。

字段format定义
idstring事件的 unique ID
namestring该事件的名称,如 CLICKINSTALLPURCHASE ,或自定义事件的名称,如"注册" 。
timestamplong事件的 Unix 时间戳(以毫秒为单位)
user_data_opted_inboolean首次安装时将始终为 false。用户从付费广告中选择加入 Apple 的 App Tracking Transparency 框架 在第一次应用程序会话上只会true
days_from_install_to_opt_inint从首次安装 (user_data_opted_in= false) 到此事件发生之间的天数
request_idstringA Branch generated identifer used to track the request through our pipeline.
days_from_last_attributed_touch_to_eventint从最后一次触点到此事件发生之间的天数。
last_attributed_touch_typeenum {CLICK,WEB_TO_APP_AUTO_REDIRECT,IMPRESSION}上一次归因的触点是展示,点击还是从网页到应用的自动重定向。
last_attributed_touch_data_tilde_idlongid for the last attributed touch (Quick Links only). set automatically server side.
last_attributed_touch_data_tilde_keyword_match_typestringHow the keyword the user searched got matched to the ad, e.g. Broad, Exact, Phrase, Search Match.
last_attributed_touch_timestamplong上一次归因于触点的 Unix 时间戳(以毫秒为单位)。
last_attributed_touch_dataobject如果有展示,点击,Web 到应用的自动重定向,Branchcta 视图或发送的短信,则此字段包含与事件直接相关的链接数据。对于所有其他事件,这是与该事件之前发生的最后一次合格的触点(点击,展示等)相关的数据。取决于归因窗口,在该窗口中,最后一次点击或从 Web 到应用的自动重定向将获得最近的展示。
days_from_last_cta_view_to_eventint从上一个 Branch CTA 视图发生到此事件随后发生之间的天数(请参阅 cta 视图的数据源定义)。
last_cta_view_timestamplong上一个 Branch CTA 视图的 Unix 时间戳(以毫秒为单位)。
last_cta_view_dataobject这是与在此事件之前发生的最后一个合格 Branch CTA 视图相关的数据。取决于归因窗口,在该窗口中,最后一次点击或从 Web 到应用的自动重定向将获得最近的展示。
first_event_for_userboolean如果这是此角色的第一次触发此事件。
deep_linkedboolean如果当前应用或 Web 会话导致用户被深度链接,则为 true。
user_dataobject与触发事件的用户相关联的数据。
event_dataobject与商务或内容事件相关联的数据,但并非特定于任何一项。
content_itemsarray of object内容项数组。内容项目是任何不同的项目,无论是产品,内容,饭店,服务,航班,酒店还是任何媒体(文本,视觉,音频)。
custom_dataobject与事件关联的合作伙伴指定的自定义 key-values pairs,但不包括触点,Branch CTA 视图和发送的短信。

完整字段列表

If you are building an integration with Branch or simply wish to learn more about the fields we offer, please download the CSV file below. It provides a comprehensive list of events and fields, definitions, and data types, along with which fields are available for which event types.

Full Event Ontology for Webhooks, Data Integrations, and Exports

Additionally, the Daily Export API CSVs will contain the following fields:

字段format定义
timestamp_isostring时间戳记为 YYYY-MM-DD HH:MM:SS+0000
last_attributed_touch_timestamp_isostringlast_attributed_touch_timestamp as YYYY-MM-DD HH:MM:SS+0000
last_cta_view_timestamp_isostringlast_cta_view_timestamp as YYYY-MM-DD HH:MM:SS+0000
hash_versionstring某些敏感字段是 hashed 还是 unhashed

3个月前更新


Branch Event Ontology (事件本体)


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

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