Branch Event Ontology

Branch의 Event Ontology Data Schema는 모든 Branch 제품에서 동일하게 적용되는 통일된 형식입니다.

Events Included

이벤트를 논리적 그룹으로 나눕니다. 이제 다음과 같은 고유한 이벤트 그룹이 있습니다:

  • 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은 AppTrackingTransparency 프레임워크를 통해 디바이스 데이터 공유에 대한 유저 동의를 받도록 요구합니다. 설치가 유료 광고를 통해 발생되었을 때, 첫 번째 설치는 오가닉으로 기록되며, 유저 동의 후 두 번째 설치 이벤트가 기록되고 해당 유료 광고로 어트리뷰션 됩니다.

iOS 14.5 이후의 변경 사항에 대한 추가 정보는 FAQ 페이지를 참조하십시오

마지막 4개는 여러 이벤트의 그룹입니다.

  • Custom events 표준 이벤트 목록을 벗어나며 Branch로 트래킹하기로 선택한 모든 이벤트입니다.
  • Commerce events 전자 상거래와 관련된 PURCHASE와 같은 짧은 이벤트 목록을 포함합니다.
  • Content events 콘텐츠를 포함하고 전자 상거래와 직접 관련이 없는 VIEW_ITEM과 같은 짧은 이벤트 목록을 포함합니다.
  • User lifecycle events COMPLETE_REGISTRATION과 같이 앱에서 진행시 유저가 완료한 고유 액션을 나타내는 이벤트.

Branch Events

Event Name iOS Android Web/API
Add To Cart BranchStandardEventAddToCart BRANCH_STANDARD_EVENT.ADD_TO_CART ADD_TO_CART
Add To Wishlist BranchStandardEventAddToWishlist BRANCH_STANDARD_EVENT.ADD_TO_WISHLIST ADD_TO_WISHLIST
View Cart BranchStandardEventViewCart BRANCH_STANDARD_EVENT.VIEW_CART VIEW_CART
Initiate Purchase BranchStandardEventInitiatePurchase BRANCH_STANDARD_EVENT.INITIATE_PURCHASE INITIATE_PURCHASE
Add Payment Info BranchStandardEventAddPaymentInfo BRANCH_STANDARD_EVENT.ADD_PAYMENT_INFO ADD_PAYMENT_INFO
Click Ad BranchStandardEventClickAd BRANCH_STANDARD_EVENT.CLICK_AD CLICK_AD
Click Ad BranchStandardEventClickAd BRANCH_STANDARD_EVENT.CLICK_AD CLICK_AD
Purchase BranchStandardEventPurchase BRANCH_STANDARD_EVENT.PURCHASE PURCHASE
Reserve BranchStandardEventReserve BRANCH_STANDARD_EVENT.RESERVE RESERVE
Spend Credits BranchStandardEventSpendCredits BRANCH_STANDARD_EVENT.SPEND_CREDITS SPEND_CREDITS
View Ad BranchStandardEventViewAd BRANCH_STANDARD_EVENT.VIEW_AD VIEW_AD
Event Name iOS Android Web/API
Search BranchStandardEventSearch BRANCH_STANDARD_EVENT.SEARCH SEARCH
View Item BranchStandardEventViewItem BRANCH_STANDARD_EVENT.VIEW_ITEM VIEW_ITEM
View Items BranchStandardEventViewItems BRANCH_STANDARD_EVENT.VIEW_ITEMS VIEW_ITEMS
Rate BranchStandardEventRate BRANCH_STANDARD_EVENT.RATE RATE
Share BranchStandardEventShare BRANCH_STANDARD_EVENT.SHARE SHARE
Initiate Stream BranchStandardEventInitiateStream BRANCH_STANDARD_EVENT.INITIATE_STREAM INITIATE_STREAM
Complete Stream BranchStandardEventCompleteStream BRANCH_STANDARD_EVENT.COMPLETE_STREAM COMPLETE_STREAM
Event Name iOS Android Web/API
Complete Registration BranchStandardEventCompleteRegistration BRANCH_STANDARD_EVENT.COMPLETE_REGISTRATION COMPLETE_REGISTRATION
Complete Tutorial BranchStandardEventCompleteTutorial BRANCH_STANDARD_EVENT.COMPLETE_TUTORIAL COMPLETE_TUTORIAL
Achieve Level BranchStandardEventAchieveLevel BRANCH_STANDARD_EVENT.ACHIEVE_LEVEL ACHIEVE_LEVEL
Unlock Achievement BranchStandardEventUnlockAchievement BRANCH_STANDARD_EVENT.UNLOCK_ACHIEVEMENT UNLOCK_ACHIEVEMENT
Invite BranchStandardEventInvite BRANCH_STANDARD_EVENT.INVITE INVITE
Login BranchStandardEventLogin BRANCH_STANDARD_EVENT.LOGIN LOGIN
Start Trial BranchStandardEventStartTrial BRANCH_STANDARD_EVENT.START_TRIAL START_TRIAL
Subscribe BranchStandardEventSubscribe BRANCH_STANDARD_EVENT.SUBSCRIBE SUBSCRIBE

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


포함된 필드

At each event, we provide a considerable amount of information. The following table has an overview. Several of the fields below are objects which themselves have many fields.

필드format정의
idstringa unique id for the event
namestringCLICK, INSTALL, PURCHASE과 같은 이벤트 이름 또는 "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_inintnumber of days between when the first install (user_data_opted_in= false) and when this event occurred
request_idstringA Branch generated identifer used to track the request through our pipeline.
days_from_last_attributed_touch_to_eventintnumber of days between when the last touch occurred and when this event subsequently occurred.
last_attributed_touch_typeenum { CLICK, WEB_TO_APP_AUTO_REDIRECT, IMPRESSION }whether the last attributed touch was an impression, a click, or a web to app auto redirect.
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_dataobjectimpression, click, web to app auto redirect, branch cta view, 혹은 sms sent의 경우 이 필드에는 이벤트와 직접 연관된 링크 데이터가 포함됩니다. 기타 모든 이벤트의 경우 이 이벤트 이전에 발생할 마지막 유효한 터치 (클릭, 임프레션 등)와 연관된 데이터입니다. 어트리뷰션 윈도우에 따라 마지막 클릭 또는 웹 투 앱 자동 리디렉션이 최근 임프레션보다 우선합니다.
days_from_last_cta_view_to_eventintnumber 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_timestamplong마지막 Branch CTA 보기에 대한 밀리 초 unix 타임스탬프입니다.
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 or web to app auto redirect trumps a more recent impression.
first_event_for_userbooleanif this is the first time for this persona that this event has been triggered.
deep_linkedboolean현재 앱 또는 웹 세션으로 인해 유저가 딥링크(Deep Link)된 경우 true입니다.
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 objectArray of content items. A content item is any distinct item, whether a product, piece of content, restaurant, service, flight, hotel, or any kind of media (text, visual, audio.)
custom_dataobject이벤트와 관련된 파트너 지정 커스텀 key-value 페어 (Touch, Branch CTA view 및 SMS sent 제외).

전체 필드 목록

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: (YYYY-MM-DD HH:MM:SS+0000형식으로 표시 )
last_cta_view_timestamp_isostringlast_cta_view_timestamp: (YYYY-MM-DD HH:MM:SS+0000형식으로 표시 )
hash_versionstring특정 민감한 필드가 해시되었는지 또는 언해시되었는지 여부

Updated 6 months ago


Branch Event Ontology


제안된 편집은 API 참조 페이지에서 제한됩니다.

Markdown 본문 콘텐츠에 대한 편집만 제안할 수 있지만 API 사양에는 제안할 수 없습니다.


필터