Branch Events

Branch (formerly known as Branch Metrics) is a mobile software company focused on mobile deep linking and attribution. This integration allows server-side event tracking.

Key features

The Branch Events destination provides the following key features:

• Events structure: our Events reference matches Branch standard and custom events, meaning that your data is properly bridged to the expected fields in an optimized way.

• Prebuilt mappings: data mapping for event-based destinations happens automatically, which simplifies user inputs.

• Refined data: you can freely push additional information based on your specific needs (E.g. adding custom events and custom event properties).

• Smart mapping: data mapping can be readjusted using your datalayer defined fields.

• Event mapping: change standard mapping between your partners' events and yours or add new mappings.

• Support for multi-item data: information included in the item array is dispatched to Branch.

Destination setup

Before configuring this destination, you need to create a Branch Dashboard.

Configuration

Settings	Description
Branch Key	Required Branch Key of the originating app and obtained by accessing your Account Settings.
Content Schema	Category/Schema for the included content.
Custom Event Properties	Map your custom event properties by setting their field names in Branch property name and adding the field name holding the value in Your event property.
Event Mapping	Change the standard mapping (See Quick reference) between Branch's events and yours or add new mappings.

Quick reference

Commanders Act Events	Branch Events
achieve_level	ACHIEVE_LEVEL
add_payment_info	ADD_PAYMENT_INFO
add_to_cart	ADD_TO_CART
add_to_wishlist	ADD_TO_WISHLIST
begin_checkout	INITIATE_PURCHASE
click_ad	CLICK_AD
complete_stream	COMPLETE_STREAM
complete_tutorial	COMPLETE_TUTORIAL
generate_lead	COMPLETE_REGISTRATION
initiate_stream	INITIATE_STREAM
invite	INVITE
login	LOGIN
purchase	PURCHASE
rate	RATE
search	SEARCH
share	SHARE
start_trial	START_TRIAL
spend_credits	SPEND_CREDITS
subscribe	SUBSCRIBE
unlock_achievement	UNLOCK_ACHIEVEMENT
view_ad	VIEW_AD
view_cart	VIEW_CART
view_item	VIEW_ITEM
view_items	VIEW_ITEMS
[Any Event] [1]	[Any Event] [1]

1. See Event Mapping in Configuration for more details.

Field mappings

At least one of the following must be included: • developer_identity • browser_fingerprint_id • idfa OR idfv (IF os = iOS ) • aaid OR android_id (IF os = Android )

Properties can be remapped using our Smart Mapping feature.

Smart Mapping Fields	Commanders Act Default Properties	Branch Properties
-	Branch Key	branch_key
Customer Event Alias	partners.branch.event_alias	customer_event_alias
Device OS	context.device.os.name	os [1]
Device OS Version	context.device.os.version	os_version [1]
Environment	partners.branch.env	environment [1]
Device Mobile Identifier	context.device.advertising_id	idfa [1][5] aaid [1][6]
Android Hardware Id	partners.branch.hardware_id	android_id [1]
Device iOS IDFV	context.device.idfv	idfv [1]
Ad Tracking Enabled	context.device.ad_tracking_enabled	limit_ad_tracking [1][7]
Device User Agent	context.device.user_agent	user_agent [1]
Branch Browser Fingerprint Id	partners.branch.fingerprint_id	browser_fingerprint_id [1]
Page URL	context.page.url	http_origin [1]
Page Referrer URL	context.page.referrer	http_referrer [1]
User Id	user.id	developer_identity [1]
User Country	user.country	country [1]
User Language	context.page.lang	language [1]
Device IP	context.device.ip	ip [1]
Device Local IP	partners.branch.local_ip	local_ip [1]
Device Brand	context.device.manufacturer	brand [1]
Branch Device Token	partners.branch.device_token	randomized_device_token [1]
App Version	context.app.version	app_version [1]
Device Model	context.device.model	model [1]
Device DPI	context.device.screen.density	screen_dpi [1]
Device Screen Width	context.device.screen.width	screen_width [1]
Device Screen Height	context.device.screen.height	screen_height [1]
DMA EEA	partners.branch.dma_eea	dma_eea [1]
DMA Ad Personalization	partners.branch.dma_ad_pers	dma_ad_personalization [1]
DMA Ad User Data	partners.branch.dma_ad_user_data	dma_ad_user_data [1]
Transaction Id	id	transaction_id [2]
Transaction Revenue	revenue	revenue [2]
Currency	currency	currency [2]
Shipping Amount	shipping_amount	shipping [2]
Tax Amount	tax_amount	tax [2]
Transaction Coupon	coupon	coupon [2]
Transaction Type	type	affiliation [2]
Transaction Description	event_name	description [2]
Search Term	search_query	search_term [2]
-	Content Schema	$content_schema [3]
Item Title	item_title [4]	$og_title [3]
Item Image URL	product.image_url [4]	$og_image_url [3]
Item Canonical Identifier	product.canonical_identifier [4]	$canonical_identifier [3]
Item Publicly Indexable	product.publicly_indexable [4]	$publicly_indexable [3]
Item Publicly Indexable	product.locally_indexable [4]	$locally_indexable [3]
Item Price	product.price [4]	$price [3]
Item Quantity	quantity [4]	$quantity [3]
Item Id	id [4]	$sku [3]
Item Name	product.name [4]	$product_name [3]
Item Brand	product.brand [4]	$product_brand [3]
Item Category	product.category_1 [4]	$product_category [3]
Item Variant	variant [4]	$product_variant [3]
Item Rating Average	product.rating_average [4]	$rating_average [3]
Item Rating Count	product.rating_count [4]	$rating_count [3]
Item Rating Max	product.rating_max [4]	$rating_max [3]
Item Creation Timestamp	product.creation_timestamp [4]	$creation_timestamp [3]
Item Expiration Date	product.exp_date [4]	$exp_date [3]
Item Keywords	product.keywords [4]	$keywords [3]
Item Address Street	product.address_street [4]	$address_street [3]
Item Address City	product.address_city [4]	$address_city [3]
Item Address Region	product.address_region [4]	$address_region [3]
Item Address Country	product.address_country [4]	$address_country [3]
Item Address Postal Code	product.address_postal_code [4]	$address_postal_code [3]
Item Latitude	product.latitude [4]	$latitude [3]
Item Longitude	product.longitude [4]	$longitude [3]
Item Image Captions	product.image_captions [4]	$image_captions [3]
Item Condition	product.condition [4]	$condition [3]

1. Set in user_data . 2. Set in event_data . 3. Set in content_items.X . 4. Set in items.X . 5. property set when context.device.os.name is iOS (case insensitive). 6. property set when context.device.os.name is Android (case insensitive). 7. boolean opposite of context.device.ad_tracking_enabled .