筛选项

Branch Event Ontology (事件本体)

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

包括的事件

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

  • impression
  • click
  • Branch CTA view
  • open
  • install
  • reinstall
  • web session start
  • pageview
  • commerce event
  • custom event
  • content event
  • user lifecycle event

🚧

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

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

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

  • Custom events are any events you choose to track with Branch that fall outside our list of standard events.
  • Commerce events include a short list of events such as PURCHASE that involve e-commerce.
  • Content events include a short list of events such as VIEW_ITEM that involve content and are not directly related to e-commerce.
  • User lifecycle events are events marking a distinct action completed by a user as they progress through your app, such as COMPLETE_REGISTRATION.

Branch 事件

商业活动

Event 名称iOSAndroidWeb/API
添加到购物车BranchStandardEventAddToCartBRANCH_STANDARD_EVENT.ADD_TO_CARTADD_TO_CART
加到收藏夹BranchStandardEventAddToWishlistBRANCH_STANDARD_EVENT.ADD_TO_WISHLISTADD_TO_WISHLIST
查看购物车BranchStandardEventViewCartBRANCH_STANDARD_EVENT.VIEW_CARTVIEW_CART
发起购买BranchStandardEventInitiatePurchaseBRANCH_STANDARD_EVENT.INITIATE_PURCHASEINITIATE_PURCHASE
添加付款信息BranchStandardEventAddPaymentInfoBRANCH_STANDARD_EVENT.ADD_PAYMENT_INFOADD_PAYMENT_INFO
点击广告BranchStandardEventClickAdBRANCH_STANDARD_EVENT.CLICK_ADCLICK_AD
购买BranchStandardEventPurchaseBRANCH_STANDARD_EVENT.PURCHASEPURCHASE
保留BranchStandardEventReserveBRANCH_STANDARD_EVENT.RESERVERESERVE
消费积分BranchStandardEventSpendCreditsBRANCH_STANDARD_EVENT.SPEND_CREDITSSPEND_CREDITS
查看广告BranchStandardEventViewAdBRANCH_STANDARD_EVENT.VIEW_ADVIEW_AD

Content Event

Event 名称iOSAndroidWeb/API
搜索BranchStandardEventSearchBRANCH_STANDARD_EVENT.SEARCHSEARCH
查看商品BranchStandardEventViewItemBRANCH_STANDARD_EVENT.VIEW_ITEMVIEW_ITEM
查看商品BranchStandardEventViewItemsBRANCH_STANDARD_EVENT.VIEW_ITEMSVIEW_ITEMS
频率BranchStandardEventRateBRANCH_STANDARD_EVENT.RATERATE
分享BranchStandardEventShareBRANCH_STANDARD_EVENT.SHARESHARE
启动流BranchStandardEventInitiateStreamBRANCH_STANDARD_EVENT.INITIATE_STREAMINITIATE_STREAM
Complete StreamBranchStandardEventCompleteStreamBRANCH_STANDARD_EVENT.COMPLETE_STREAMCOMPLETE_STREAM

Lifecycle Event

Event 名称iOSAndroidWeb/API
完成注册BranchStandardEventCompleteRegistrationBRANCH_STANDARD_EVENT.COMPLETE_REGISTRATIONCOMPLETE_REGISTRATION
完成教程BranchStandardEventCompleteTutorialBRANCH_STANDARD_EVENT.COMPLETE_TUTORIALCOMPLETE_TUTORIAL
达标级别BranchStandardEventAchieveLevelBRANCH_STANDARD_EVENT.ACHIEVE_LEVELACHIEVE_LEVEL
解锁成就BranchStandardEventUnlockAchievementBRANCH_STANDARD_EVENT.UNLOCK_ACHIEVEMENTUNLOCK_ACHIEVEMENT
邀请BranchStandardEventInviteBRANCH_STANDARD_EVENT.INVITEINVITE
登录BranchStandardEventLoginBRANCH_STANDARD_EVENT.LOGINLOGIN
开始试用BranchStandardEventStartTrialBRANCH_STANDARD_EVENT.START_TRIALSTART_TRIAL
SubscribeBranchStandardEventSubscribeBRANCH_STANDARD_EVENT.SUBSCRIBESUBSCRIBE

自订活动

Custom Events can be tracked if the event does not fall within one of the categories above.

包括的字段

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

Field类型描述
idStringA unique id for the event
名称StringThe name of the event, such as CLICK, INSTALL, PURCHASE, or custom event names like "signup".
timestampLongUnix timestamp in milliseconds for the event
user_data_opted_inBooleanWill always be false on first install. Will only be true on first app session after users opts in to Apple's App Tracking Transparency framework from paid ads
days_from_install_to_opt_in整数number of days between when the first install (user_data_opted_in= false) and when this event occurred
request_idStringA Branch generated identifier used to track the request through our pipeline.
days_from_last_attributed_touch_to_event整数Number of days between when the last touch occurred and when this event subsequently occurred.
last_attributed_touch_typeenum { CLICK, IMPRESSION }Whether the last attributed touch was an impression or a click
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_timestampLongUnix timestamp in milliseconds for the last attributed touch.
last_attributed_touch_dataObjectIf an impression, click, or branch CTA view, this field contains the link data directly associated with the event. For all other events, this is the data associated with the last qualifying touch (click, impression, etc) to occur before this event. Subject to attribution windows, within which the last click trumps a more recent impression.
days_from_last_cta_view_to_event整数Number of days between when the last Branch CTA view occurred and when this event subsequently occurred (see datasource definition of CTA view).
last_cta_view_timestampLongUnix timestamp in milliseconds for the last Branch CTA view.
last_cta_view_dataObjectThis is the data associated with the last qualifying Branch CTA View to occur before this event. Subject to attribution windows, within which the last click trumps a more recent impression.
first_event_for_userBooleanIf this is the first time for this persona that this event has been triggered.
user_dataObjectData associated with the user who triggered the event.
event_dataObjectData associated with commerce or content events, but not specific to any one item.
content_itemsArray of Object内容项数组。内容项目是任何不同的项目,无论是产品,内容,饭店,服务,航班,酒店还是任何媒体(文本,视觉,音频)。
custom_dataObjectPartner-specified custom key-value pairs associated with an event, excluding Touches, Branch CTA view .

完整字段列表

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:

Field类型描述
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