分支事件本体

Branch '的事件本体数据架构是在所有Branch产品之间共享的统一格式。

包括的活动

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

  • 印象
  • 请点击
  • 网络到应用自动重定向
  • Branch机构CTA视图
  • 短信已发送
  • 打开
  • 安装
  • 重新安装
  • 网络会话开始
  • 页面预览
  • 商业活动
  • 自订活动
  • 内容事件
  • 用户生命周期事件

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

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

Branch标准活动

活动名称活动类别iOS安卓网络和API
Add To Cart商业活动BranchStandardEventAddToCartBRANCH_STANDARD_EVENT.ADD_TO_CARTADD_TO_CART
Add To Wishlist商业活动BranchStandardEventAddToWishlistBRANCH_STANDARD_EVENT.ADD_TO_WISHLISTADD_TO_WISHLIST
View Cart商业活动BranchStandardEventViewCartBRANCH_STANDARD_EVENT.VIEW_CARTVIEW_CART
Initiate Purchase商业活动BranchStandardEventInitiatePurchaseBRANCH_STANDARD_EVENT.INITIATE_PURCHASEINITIATE_PURCHASE
Add Payment Info商业活动BranchStandardEventAddPaymentInfoBRANCH_STANDARD_EVENT.ADD_PAYMENT_INFOADD_PAYMENT_INFO
Click Ad商业活动BranchStandardEventClickAdBRANCH_STANDARD_EVENT.CLICK_ADCLICK_AD
Purchase商业活动BranchStandardEventPurchaseBRANCH_STANDARD_EVENT.PURCHASEPURCHASE
Reserve商业活动BranchStandardEventReserveBRANCH_STANDARD_EVENT.RESERVERESERVE
Spend Credits商业活动BranchStandardEventSpendCreditsBRANCH_STANDARD_EVENT.SPEND_CREDITSSPEND_CREDITS
View Ad商业活动BranchStandardEventViewAdBRANCH_STANDARD_EVENT.VIEW_ADVIEW_AD
View Cart商业活动BranchStandardEventViewCartBRANCH_STANDARD_EVENT.VIEW_CARTVIEW_CART
Search内容事件BranchStandardEventSearchBRANCH_STANDARD_EVENT.SEARCHSEARCH
View Item内容事件BranchStandardEventViewItemBRANCH_STANDARD_EVENT.VIEW_ITEMVIEW_ITEM
View Items内容事件BranchStandardEventViewItemsBRANCH_STANDARD_EVENT.VIEW_ITEMSVIEW_ITEMS
Rate内容事件BranchStandardEventRateBRANCH_STANDARD_EVENT.RATERATE
Share内容事件BranchStandardEventShareBRANCH_STANDARD_EVENT.SHARESHARE
Initiate Stream内容事件BranchStandardEventInitiateStreamBRANCH_STANDARD_EVENT.INITIATE_STREAMINITIATE_STREAM
Complete Stream内容事件BranchStandardEventCompleteStreamBRANCH_STANDARD_EVENT.COMPLETE_STREAMCOMPLETE_STREAM
Complete Registration生命周期事件BranchStandardEventCompleteRegistrationBRANCH_STANDARD_EVENT.COMPLETE_REGISTRATIONCOMPLETE_REGISTRATION
Complete Tutorial生命周期事件BranchStandardEventCompleteTutorialBRANCH_STANDARD_EVENT.COMPLETE_TUTORIALCOMPLETE_TUTORIAL
Achieve Level生命周期事件BranchStandardEventAchieveLevelBRANCH_STANDARD_EVENT.ACHIEVE_LEVELACHIEVE_LEVEL
Unlock Achievement生命周期事件BranchStandardEventUnlockAchievementBRANCH_STANDARD_EVENT.UNLOCK_ACHIEVEMENTUNLOCK_ACHIEVEMENT
Invite生命周期事件BranchStandardEventInviteBRANCH_STANDARD_EVENT.INVITEINVITE
Login生命周期事件BranchStandardEventLoginBRANCH_STANDARD_EVENT.LOGINLOGIN
Start Trial生命周期事件BranchStandardEventStartTrialBRANCH_STANDARD_EVENT.START_TRIALSTART_TRIAL
Subscribe生命周期事件BranchStandardEventSubscribeBRANCH_STANDARD_EVENT.SUBSCRIBESUBSCRIBE

包括的领域

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

领域格式定义
idstring活动的唯一ID
namestring该事件的名称,如CLICKINSTALLPURCHASE ,或自定义事件的名称,如"注册" 。
timestamplong事件的Unix时间戳(以毫秒为单位)
days_from_last_attributed_touch_to_eventint从最后一次触点到此事件随后发生之间的天数。
last_attributed_touch_typeenum {CLICK,WEB_TO_APP_AUTO_REDIRECT,IMPRESSION}上一次归因的触点是展示,点击还是从网络到应用的自动重定向。
last_attributed_touch_timestamplong上一次归因于触点的Unix时间戳(以毫秒为单位)。
last_attributed_touch_dataobject如果有展示,点击,Web到应用的自动重定向,Branchcta视图或发送的短信,则此字段包含与事件直接相关的链接数据。对于所有其他事件,这是与该事件之前发生的最后一次合格触点(点击,展示等)相关的数据。取决于归因窗口,在该窗口中,最后一次点击或从Web到应用的自动重定向将获得最近的展示。
days_from_last_cta_view_to_eventint从上一个BranchCTA视图发生到此事件随后发生之间的天数(请参阅cta视图的数据源定义)。
last_cta_view_timestamplong上一个BranchCTA视图的Unix时间戳(以毫秒为单位)。
last_cta_view_dataobject这是与在此事件之前发生的最后一个合格BranchCTA视图相关的数据。取决于归因窗口,在该窗口中,最后一次点击或从Web到应用的自动重定向将获得最近的展示。
first_event_for_userboolean如果这是此角色的第一次触发此事件。
deep_linkedboolean如果当前应用或Web会话导致用户被深链接,则为true。
user_dataobject与触发事件的用户相关联的数据。
event_dataobject与商务或内容事件相关联的数据,但并非特定于任何一项。
content_itemsarray of object内容项数组。内容项目是任何不同的项目,无论是产品,内容,饭店,服务,航班,酒店还是任何媒体(文本,视觉,音频)。
custom_dataobject与事件关联的合作伙伴指定的自定义键值对,但不包括触点,BranchCTA视图和发送的SMS。

完整字段列表

如果您要与Branch建立集成,或者只是想了解有关我们提供的字段的更多信息,请下载下面的CSV文件。它提供了事件和字段,定义和数据类型的完整列表,以及哪些字段可用于哪些事件类型。

Webhooks,数据集成和导出的完整事件本体

此外,每日导出API CSV将包含以下字段:

领域格式定义
timestamp_isostring<s/span>时间戳记为YYYY-MM-DD HH:MM:SS + 0000
last_attributed_touch_timestamp_isostringlast_attributed_touch_timestamp为YYYY-MM-DD HH:MM:SS + 0000
last_cta_view_timestamp_isostringlast_cta_view_timestamp为YYYY-MM-DD HH:MM:SS + 0000
hash_versionstring某些敏感字段是散列还是未散列

9 天前更新


分支事件本体


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

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