Commanders Act X
Platform XDocumentationWelcome to Success
  • Welcome !
  • Platform updates
    • Announcements
    • Documentation updates
    • Release notes
  • Getting started
    • How the platform works
      • Glossary
        • Condensed platform concepts
    • Platform interface
      • Prod and Testing environments
      • Productivity tools
        • Commander's AI
    • Integrating your data
      • GTM Tutorial
      • OneTag Tutorial
      • Migration guides to the Platform X
        • Migrate from SSv1 to SSv2
          • Send data to serverside v2
            • Purchase event example (ssv1 to ssv2)
        • Migrate from old mobile sdk
  • Features
    • Sources
      • Sources Overview
      • Sources Catalog
        • Web
          • Web container
            • User guides for browser-side platform
              • Container
                • Hosting
                • Creation and modification
                • Generation
                • Testing
                • Deployment and roll back
                • Deletion
                • Statistics
                • Modification history
                • Javascript block
                • Branches
                • Plugin Commanders Act Assistant
              • Tags
                • Add tags
                • Configure tags
                • Rules
                  • Basic actions
                  • Triggers
                  • Perimeters & constraints
              • Data layer and data types
                • External variables
                • Internal variables
                • Event variables
                • Data storage
              • Deduplication
                • Setup guide
                • Setup example
                • Deduplication reports
              • TagPerformance
                • Setup guide
                • Report analysis
                • Troubleshooting
            • Setup guides for developers
              • Web container setup
              • Datalayer setup
              • Browser-side events setup
              • AMP
              • Angular
              • AngularJS
              • React
              • SPA implementation guide
              • VueJS
              • IOT & TV Apps
            • Best Practices
              • FAQ
              • Common Container Strategies
              • Common Trigger Strategies
              • Performance Optimization
              • tC.* attributes and methods
              • APIs
                • Onsite API
              • TMS & Consent banners IDs
          • Javascript SDK
            • Next.js serverside rendering
          • Pixel Tracking API
          • Google Tag Manager (GTM)
          • Shopify
        • Mobile APP
          • Android
          • iOS
          • Flutter
          • React native
        • Advertising
          • Bing Ads (cost import)
          • Facebook Ads (cost import)
          • Criteo (cost import)
          • Realytics
        • Import CRM users
          • API users
          • Users file importer
        • Import conversions
          • API Conversions and Product catalog
          • Conversions files importer
        • Product catalog
          • Product catalog files importer (FTP)
        • Server
          • HTTP tracking API source
            • (deprecated) HTTP tracking API source 1.0
          • Node.JS
          • Python
          • PHP
      • Source Live Event Inspector
      • Source data quality
    • Destinations
      • Destinations overview
        • Automatic Audience replay
      • Destinations catalog
        • AbTasty
        • Actito
        • Adform
        • Adobe
          • Adobe Analytics
          • Adobe Campaign
        • AdRoll
        • Adition
        • Adventori
        • Affilae
        • Alphalyr Marketing Studio
        • Amazon
          • Amazon Ads Conversions API
          • Amazon S3
        • Attraqt
        • Awin
        • Batch Audience
        • Branch Events
        • Button
        • Campaign Analysis Legacy
        • Commission Junction
        • Criteo
          • Criteo - Events
          • Criteo (audiences)
          • Criteo (offline conversions)
        • Data Activation Legacy
        • Dataventure
        • Destination Logs Exporter (closed beta)
        • Dialog-Mail
        • Dynamic Yield
        • Easyence
        • Effinity
        • Eloqua
        • Emarsys
        • Email export
        • Equativ Audience
        • Experian
        • Facebook
          • Facebook Conversions API
            • Facebook CAPI through GTM
            • Performance tab (Event Match Quality)
          • Facebook Custom Audiences
          • Facebook Lead Ads
        • FTP
        • Gamned
        • Google
          • Google Analytics 4
            • Google Analytics 4 - Proxy Mode
          • Google BigQuery
          • Google Conversion Adjustments
          • Google Customer Match
          • Google Display & Video 360
          • Google Enhanced Conversions
          • Google Enhanced Conversions for Leads
          • Google Floodlight Mobile App Conversion
          • Google Search Ads 360 Enhanced Conversions
          • Google Store Sales Direct
        • IBM
        • Inxmail
        • IntelliAd
        • Jellyfish
        • Kameleoon
          • Kameleoon Audience
          • Kameleoon Events
        • Kelkoo
        • Kwanko
        • LinkedIn Conversions API
        • Liveramp
        • Magento
        • Marin Software
        • Mapp
        • Matomo
        • MediaMath
        • Microsoft Advertising Universal Event Tracking
        • Mindlytix
        • Moebel
        • Nextdoor Conversion API
        • OXID
        • Optimizely
        • Outbrain
        • Partnerize
        • Piano Analytics
          • Piano Analytics Collection API
          • Piano Analytics Enrichment API
        • Pinterest
        • Piwik PRO
        • Prediggo
        • Qlik
        • Quantcast
        • Quora Ads Conversion API
        • Rakuten
          • Rakuten Audience
          • Rakuten Events
        • Realytics
        • Reddit Conversions API
        • Responsys
        • RhythmOne
        • Rich Relevance
        • RTB House Audience
        • Salesforce
          • Salesforce Audience Studio
          • Salesforce Marketing Cloud
          • Salesforce Commerce Cloud
        • SAP Commerce Cloud
        • Selligent
        • Skai
        • Smart Adserver
        • SmartFocus
        • Snapchat Conversions API
        • Splio
        • Syte
        • Tableau Online
        • Taboola
          • Taboola Audience
          • Taboola Events
        • Target2sell
        • Temelio
        • Teradata
        • The Trade Desk
          • The Trade Desk Conversions API
          • The Trade Desk Audience
        • TikTok
          • TikTok Events API
          • TikTok Offline Events
        • TimeOne
        • Tradedoubler
        • TradeTracker
        • X (Twitter) Conversion API
        • Xandr
        • Webhook
        • Webtrends
        • ZBO Media
        • Zeta
      • Destination builder
        • Javascript destination builder
          • Tutorial - How to build a server destination with the JS sandbox
          • Serverside javascript helpers
      • Destination filters
      • Mapping and Properties transformation
      • Event delivery
      • Destination event inspector
      • Dry mode (lab)
    • Enrichments
      • Augmented User Attributes
        • Business case
      • Events enrichment
      • Storage Settings
    • Data Quality
      • Event Specification
      • Sources data quality
      • Data cleansing
        • Supported transformation functions - Data cleansing
          • Format a date
    • Identity resolution
      • Migrate from Fuse v1 to Fuse v2
    • Customers
      • Segment
        • Segment overlap
        • Segment stats
    • Explore
      • Campaign analysis
        • Attribution
        • Control Group (Closed Beta )
      • User analysis
        • Dashboards
      • Consent Analysis
    • Consent management
      • Responsability of actors
      • Setup Guides
        • Tag Manager
          • Commanders Act TMS
          • Google Tag Manager (GTM)
          • Google Tag Manager (GTM) - Consent Mode
          • Google Consent Mode in Commanders Act CMP
          • Adobe Launch
        • Websites (Hardcoded)
        • FR : Suppression des cookies lors du retrait du consentement
        • Mobile apps
          • iOS
            • ATT - App Tracking Transparency (iOS 14.5+)
          • Android
      • User Guides
        • Categories & Tags
          • Manage Categories
          • Manage Vendors
          • Assign Categories
        • Privacy Banners
          • Banner Templates
            • Accessibility Template
          • Manage Banner
          • Deploy Banner
          • Copy Banner
        • Consent Analysis
        • Exports
        • Settings
      • Extensions
        • Cookie Scanner
        • Piggybacking
        • Tag Firewall
      • Marketing Preferences Center (additional module)
      • Knowledge Base
        • Consent Object
        • Consent cookies exemption
          • Implementation guide for exempted consent statistics FR market
        • Consent Cookie
        • IAB TCF V2.2 Release details
          • IAB TCF v2.2 CMP requirements
          • IAB TCF v2.2 Migration guide Web
          • IAB TCF v2.2 Migration guide App
        • IAB TCF V2.2 Consent
        • IAB TCF V2.2 and Google FAQ
        • Google ACM requires IAB TCF
        • CCPA & Global Privacy control
      • Rest Data API
        • GET/PUT Consents / preferences
      • OnSite API
        • Getting Started
        • consent.get
        • consent.update
        • consent.revoke
        • consent.onUpdate
        • consent.onReady
        • consentBanner.show
        • consentBanner.hide
        • consentCenter.show
        • consentCenter.hide
      • Platform API
        • Get statistics
  • Use cases
    • Data activation
      • Engage new customers
        • Welcome banner for new customers
        • Real-time promotion for hesitant customers
        • Discount banner for installing the application
        • Personalized ads
        • Engage similar audience (lookalike)
      • Increase loyalty
        • Drive to favourite store
        • Increase Customer Lifetime Value with a loyalty program
        • Notification about order delay
      • Increase revenue
        • Abandoned cart
        • Products recommendations
        • Complementary product offer
      • Retain customers
        • Identify a churn risk with RFM segmentation
        • Identify customers’ preferred channel
        • Contact with the customer support
      • Advocacy
        • Incentive to share customers' experience and rating
        • Sponsorship Program
        • Social Media Hashtag
    • Website performance
    • Consent banners A/B testing
    • Customer analysis
    • Campaigns performance analysis
  • Developers
    • Tracking & Integrations
      • Tracking
        • About events
          • E-commerce/retail events
          • Web event specificity
          • Mobile App event specificity
        • Events reference
          • Common events
          • E-commerce events
          • Video events
          • Campaign Tracking events
        • Properties reference
          • Global properties
          • Video properties
          • Permanent properties
        • Data API
          • HTTP API
          • Segment API
          • User API
          • Product catalog and conversion API
      • Server IP Whitelisting
    • Config API
    • Changelogs
      • Measure.js changelog
      • Web container generator
    • Content Security Policy
  • CONFIGURE
    • Data Management
      • Events collection
      • Data retention duration
      • Data Governance
    • Administration
      • User management
      • Domain Management
        • WAF Proxy (CloudFlare,...)
        • A record
        • CNAME record
        • On-Premise Proxy
        • Cookie CAID
        • First party hosting
      • Single Sign-On
      • Two-factor authentication (2FA)
      • Copy Management
    • Cookies
      • Cookie 1st
      • Cookie sync partners
      • First domain tracking (Phoenix)
    • Disclaimer
Powered by GitBook
On this page
  • Key features
  • Destination setup
  • Configuration
  • Quick reference
  • Field Mappings

Was this helpful?

Edit on GitHub
Export as PDF
  1. Features
  2. Destinations
  3. Destinations catalog

Branch Events

PreviousBatch AudienceNextButton

Last updated 9 months ago

Was this helpful?

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

Key features

The Branch Events destination provides the following key features:

  • Events structure: our matches Branch and , 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 array is dispatched to Branch.

Destination setup

Before configuring this destination, you need to create a .

Configuration

Settings
Description

Branch Key

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

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]

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 )

Most properties can be remapped using our "Smart Mapping" feature.

Commanders Act Properties
Branch Properties

Branch Key

branch_key

partners.branch.event_alias

customer_event_alias

context.device.os.name

os [1]

context.device.os.version

os_version [1]

partners.branch.env

environment [1]

context.device.advertising_id

idfa [1][5]

aaid [1][6]

partners.branch.hardware_id

android_id [1]

context.device.idfv

idfv [1]

context.device.ad_tracking_enabled

limit_ad_tracking [1][7]

context.device.user_agent

user_agent [1]

partners.branch.fingerprint_id

browser_fingerprint_id [1]

context.page.url

http_origin [1]

context.page.referrer

http_referrer [1]

user.id

developer_identity [1]

user.country

country [1]

context.page.lang

language [1]

context.device.ip

ip [1]

partners.branch.local_ip

local_ip [1]

context.device.manufacturer

brand [1]

partners.branch.device_token

randomized_device_token [1]

context.app.version

app_version [1]

context.device.model

model [1]

context.device.screen.density

screen_dpi [1]

context.device.screen.width

screen_width [1]

context.device.screen.height

screen_height [1]

partners.branch.dma_eea

dma_eea [1]

partners.branch.dma_ad_pers

dma_ad_personalization [1]

partners.branch.dma_ad_user_data

dma_ad_user_data [1]

id

transaction_id [2]

revenue

revenue [2]

currency

currency [2]

shipping_amount

shipping [2]

tax_amount

tax [2]

coupon

coupon [2]

type

affiliation [2]

event_name

description [2]

search_query

search_term [2]

Content Schema

$content_schema [3]

item_title [4]

$og_title [3]

product.image_url [4]

$og_image_url [3]

product.canonical_identifier [4]

$canonical_identifier [3]

product.publicly_indexable [4]

$publicly_indexable [3]

product.locally_indexable [4]

$locally_indexable [3]

product.price [4]

$price [3]

quantity [4]

$quantity [3]

id [4]

$sku [3]

product.name [4]

$product_name [3]

product.brand [4]

$product_brand [3]

product.category_1 [4]

$product_category [3]

variant [4]

$product_variant [3]

product.rating_average [4]

$rating_average [3]

product.rating_count [4]

$rating_count [3]

product.rating_max [4]

$rating_max [3]

product.creation_timestamp [4]

$creation_timestamp [3]

product.exp_date [4]

$exp_date [3]

product.keywords [4]

$keywords [3]

product.address_street [4]

$address_street [3]

product.address_city [4]

$address_city [3]

product.address_region [4]

$address_region [3]

product.address_country [4]

$address_country [3]

product.address_postal_code [4]

$address_postal_code [3]

product.latitude [4]

$latitude [3]

product.longitude [4]

$longitude [3]

product.image_captions [4]

$image_captions [3]

product.condition [4]

$condition [3]

[1] in user_data . [2] in event_data . [3] in content_items.X . [4] 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 .

Required Branch Key of the originating app and obtained by accessing your .

Change the standard mapping (See ) between Branch's events and yours or add new mappings.

[1] See Event Mapping in for more details.

Branch
server-side event tracking
Events reference
standard
custom events
item
Branch Dashboard
Configuration
Account Settings
Quick reference