Back

This article describes how to set up the Branch Events connector in your Universal Data Hub (UDH) account.

Table of Contents Placeholder

Connector Actions

Action Name AudienceStream EventStream
Log Commerce Event
Log Content Event
Log Lifecycle Event
Log Custom Event

Configure Settings

Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector.

After adding the connector, configure the following settings:

  • Branch Key
    This value is found on the Profile page of the Branch Account Manager.

Action Settings - Parameters and Options

Click Next or go to the Actions tab. This is where you configure connector actions.

This section describes how to set up parameters and options for each action.

Action - Log Commerce Event

Parameters

Parameter Description
Event Type
  • Required.
  • Select a type of commerce event.
OS Type
  • Required.
  • Select a type of operating system on the mobile device.
Device ID
  • Required.
  • Specify one or two device IDs.
  • Different IDs can be selected depending on the OS type.
User Data
  • Optional.
  • Specify as many device-identifying parameters as desired:
    • OS Version
      • Number.
      • Version of the operating system.
      • Specific to Android and iOS.
    • Environment
      • String.
      • Usually "FULL_APP".
    • User Agent
      • String.
      • User agent of the browser or app where the event occurred.
    • HTTP Origin
      • String.
      • Current page URL where Web SDK logged web session start.
    • HTTP Referrer
      • String.
      • Referral URL that led to the current page where the Web SDK logged web session started.
    • Local IP
      • String.
      • Local IP of the device (Android only).
    • Country
      • String.
      • Country code of the user, usually based on device settings or user agent string.
    • Language
      • String.
      • Language code of the user, usually based on device settings or user agent string.
    • Brand
      • String.
      • Brand of the device.
    • Model
      • String.
      • Model of the device.
    • App Version
      • String.
      • App version downloaded by the user.
    • Screen DPI
      • Number.
      • Screen DPI.
    • Screen Height
      • Number.
      • Height of the screen.
    • Screen Width
      • Number.
      • Width of the screen.
    • Developer Identity
      • String.
      • Developer-specified identity for a user.
    • Device Fingerprint ID
      • Branch internal-only field for tracking devices.
    • Browser Fingerprint ID
      • Branch internal-only field for tracking browsers.
    • Limit Ad Tracking
      • Value is True if the partner has opted to not be tracked by advertiser.
Event Data
  • Optional.
  • Data specific for the event.
    • Transaction ID
      • String.
      • Partner-specified transaction ID for the partner's internal use.
    • Currency
      • String.
      • Currency that revenue, price, shipping, and tax were originally reported in by the partner.
    • Revenue
      • Number.
      • Partner-specified reported revenue for the event.
    • Shipping
      • Number.
      • Shipping cost associated with the transaction.
    • Tax
      • Number.
      • Total tax associated with the transaction.
    • Coupon
      • String
      • Transaction coupon redeemed with the transaction.
      • Example: "SPRING2017".
    • Affiliation
      • String.
      • Store or affiliation from which this transaction occurred.
      • Example: "Google Store".
    • Description
      • String.
      • Description associated with the event, not necessarily specific to an individual content item.
Custom Data
  • Optional.
  • Specify additional data with arbitrary property names and values.
Content Items
  • Optional.
  • Specify properties for content items either as array-type values of equal lengths, or as a single value, which will apply to all items.
    • Content Schema
    • Category or schema for a piece of content, may be used in the future for analytics.
    • One of:
      • COMMERCE_AUCTION
      • COMMERCE_BUSINESS
      • COMMERCE_OTHER
      • COMMERCE_PRODUCT
      • COMMERCE_RESTAURANT
      • COMMERCE_SERVICE
      • COMMERCE_TRAVEL_FLIGHT
      • COMMERCE_TRAVEL_HOTEL
      • COMMERCE_TRAVEL_OTHER
      • GAME_STATE
      • MEDIA_IMAGE
      • MEDIA_MIXED
      • MEDIA_MUSIC
      • MEDIA_OTHER
      • MEDIA_VIDEO
      • OTHER
      • TEXT_ARTICLE
      • TEXT_BLOG
      • TEXT_OTHER
      • TEXT_RECIPE
      • TEXT_REVIEW
      • TEXT_SEARCH_RESULTS
      • TEXT_STORY
      • TEXT_TECHNICAL_DOC
    • Title
      • Title for the individual content item.
    • Description
      • Description of the individual content item.
    • Image URL
      • Image URL for the individual content item.
    • Canonical Identifier
      • Used to allow Branch to unify content/messages for Content Analytics.
    • Publicly Indexable
      • If value is true, content can be viewed by anyone.
      • If value is false, cannot index for public use.
    • Locally Indexable
      • If value is true, content can be indexed for local (device) use.
      • If value is false, cannot index for local use.
    • Price
      • Price for the product/content.
    • Quantity
      • Quantity of the item to be ordered.
      • Example: for PURCHASE, ADD_TO_CART
    • SKU
      • Product SKU or product ID.
    • Product Name
      • Name of the product.
    • Product Brand
      • Brand of the product.
    • Product Category
      • Category of a product. if applicable.
      • One of:
        • ANIMALS_AND_PET_SUPPLIES
        • APPAREL_AND_ACCESSORIES
        • ARTS_AND_ENTERTAINMENT
        • BABY_AND_TODDLER
        • BUSINESS_AND_INDUSTRIAL
        • CAMERAS_AND_OPTICS
        • ELECTRONICS
        • FOOD_BEVERAGES_AND_TOBACCO
        • FURNITURE
        • HARDWARE
        • HEALTH_AND_BEAUTY
        • HOME_AND_GARDEN
        • LUGGAGE_AND_BAGS
        • MATURE
        • MEDIA
        • OFFICE_SUPPLIES
        • RELIGIOUS_AND_CEREMONIAL
        • SOFTWARE
        • SPORTING_GOODS
        • TOYS_AND_GAMES
        • VEHICLES_AND_PARTS
    • Product Variant
      • Variant of the product.
      • Example: red
    • Rating Average
      • Average rating of the item.
    • Rating Count
      • Number of ratings for the item.
    • Rating Max
      • Maximum possible rating for the item.
      • Example: 5.0 if 5 stars is highest possible rating.
    • Creation Timestamp
      • Time the content was created.
    • Exp Date
      • The last time after which this content is no longer valid.
      • Null / 0 mean no limit.
      • Should rarely be set.
    • Condition
      • For auctions, whether the item is new, good, acceptable, etc.
      • One of:
        • OTHER
        • NEW
        • EXCELLENT
        • GOOD
        • FAIR
        • POOR
        • USED
        • REFURBISHED
    • Keywords
      • Keyword.
    • Image Captions
      • String with comma-separated values.
      • Captions associated with the image.
    • Latitude
      • Latitude for a restaurant, business, room (hotel), etc.
    • Longitude
      • Longitude for a restaurant, business, room (hotel), etc.
    • Postal Code
      • Postal/zip code for a restaurant, business, room (hotel), etc.
    • Country
      • Country code for a restaurant, business, room (hotel), etc.
    • Region
      • State or region for a restaurant, business, room (hotel), etc.
    • City
      • City for a restaurant, business, room (hotel), etc.
    • Street
      • Street address for a restaurant, business, room (hotel), etc.
    • Custom Fields
      • Key-value pairs that the app developer would like attached to the content item.

Action - Log Content Event

Parameters

Parameter Description
Event Type
  • Required.
  • Select a type of commerce event.
OS Type
  • Required.
  • Select a type of operating system on the mobile device.
Device ID
  • Required.
  • Specify one or two device IDs.
  • Different IDs can be selected depending on the OS type.
User Data
  • Optional.
  • Specify as many device-identifying parameters as desired:
    • OS Version
      • Number.
      • Version of the operating system.
      • Specific to Android and iOS.
    • Environment
      • String.
      • Usually "FULL_APP".
    • User Agent
      • String.
      • User agent of the browser or app where the event occurred.
    • HTTP Origin
      • String.
      • Current page URL where Web SDK logged web session start.
    • HTTP Referrer
      • String.
      • Referral URL that led to the current page where the Web SDK logged web session started.
    • Local IP
      • String.
      • Local IP of the device (Android only).
    • Country
      • String.
      • Country code of the user, usually based on device settings or user agent string.
    • Language
      • String.
      • Language code of the user, usually based on device settings or user agent string.
    • Brand
      • String.
      • Brand of the device.
    • Model
      • String.
      • Model of the device.
    • App Version
      • String.
      • App version downloaded by the user.
    • Screen DPI
      • Number.
      • Screen DPI.
    • Screen Height
      • Number,
      • Height of the screen.
    • Screen Width
      • Number.
      • Width of the screen.
    • Developer Identity
      • String.
      • Developer-specified identity for a user.
    • Device Fingerprint ID
      • Branch internal-only field for tracking devices.
    • Browser Fingerprint ID
      • Branch internal-only field for tracking browsers.
    • Limit Ad Tracking
      • Value is True if the partner has opted to not be tracked by advertiser.
Event Data
  • Optional.
  • Data specific for the event.
    • Search Query
      • String.
      • Search query associated with the event.
    • Description
      • String.
      • Description associated with the event, not necessarily specific to individual content items.
Custom Data
  • Optional.
  • Specify additional data with arbitrary property names and values
Content Items
  • Optional.
  • Specify properties for content items either as array-type values of equal lengths, or as a single value, which will apply to all items.
    • Content Schema
    • Category or schema for a piece of content, may be used in the future for analytics.
    • One of:
      • COMMERCE_AUCTION
      • COMMERCE_BUSINESS
      • COMMERCE_OTHER
      • COMMERCE_PRODUCT
      • COMMERCE_RESTAURANT
      • COMMERCE_SERVICE
      • COMMERCE_TRAVEL_FLIGHT
      • COMMERCE_TRAVEL_HOTEL
      • COMMERCE_TRAVEL_OTHER
      • GAME_STATE
      • MEDIA_IMAGE
      • MEDIA_MIXED
      • MEDIA_MUSIC
      • MEDIA_OTHER
      • MEDIA_VIDEO
      • OTHER
      • TEXT_ARTICLE
      • TEXT_BLOG
      • TEXT_OTHER
      • TEXT_RECIPE
      • TEXT_REVIEW
      • TEXT_SEARCH_RESULTS
      • TEXT_STORY
      • TEXT_TECHNICAL_DOC
    • Title
      • Title for the individual content item.
    • Description
      • Description of the individual content item.
    • Image URL
      • Image URL for the individual content item.
    • Canonical Identifier
      • Used to allow Branch to unify content/messages for Content Analytics.
    • Publicly Indexable
      • If value is true, content can be viewed by anyone.
      • If value is false, cannot index for public use.
    • Locally Indexable
      • If value is true, content can be indexed for local (device) use.
      • If value is false, cannot index for local use.
    • Price
      • Price for the product/content.
    • Quantity
      • Quantity of the item to be ordered.
      • Example: for PURCHASE, ADD_TO_CART
    • SKU
      • Product SKU or product ID.
    • Product Name
      • Name of the product.
    • Product Brand
      • Brand of the product.
    • Product Category
      • Category of a product. if applicable.
      • One of:
        • ANIMALS_AND_PET_SUPPLIES
        • APPAREL_AND_ACCESSORIES
        • ARTS_AND_ENTERTAINMENT
        • BABY_AND_TODDLER
        • BUSINESS_AND_INDUSTRIAL
        • CAMERAS_AND_OPTICS
        • ELECTRONICS
        • FOOD_BEVERAGES_AND_TOBACCO
        • FURNITURE
        • HARDWARE
        • HEALTH_AND_BEAUTY
        • HOME_AND_GARDEN
        • LUGGAGE_AND_BAGS
        • MATURE
        • MEDIA
        • OFFICE_SUPPLIES
        • RELIGIOUS_AND_CEREMONIAL
        • SOFTWARE
        • SPORTING_GOODS
        • TOYS_AND_GAMES
        • VEHICLES_AND_PARTS
    • Product Variant
      • Variant of the product.
      • Example: red
    • Rating Average
      • Average rating of the item.
    • Rating Count
      • Number of ratings for the item.
    • Rating Max
      • Maximum possible rating for the item.
      • Example: 5.0 if 5 stars is highest possible rating.
    • Creation Timestamp
      • Time the content was created.
    • Exp Date
      • The last time after which this content is no longer valid.
      • Null / 0 mean no limit.
      • Should rarely be set.
    • Condition
      • For auctions, whether the item is new, good, acceptable, etc.
      • One of:
        • OTHER
        • NEW
        • EXCELLENT
        • GOOD
        • FAIR
        • POOR
        • USED
        • REFURBISHED
    • Keywords
      • Keyword.
    • Image Captions
      • String with comma-separated values.
      • Captions associated with the image.
    • Latitude
      • Latitude for a restaurant, business, room (hotel), etc.
    • Longitude
      • Longitude for a restaurant, business, room (hotel), etc.
    • Postal Code
      • Postal/zip code for a restaurant, business, room (hotel), etc.
    • Country
      • Country code for a restaurant, business, room (hotel), etc.
    • Region
      • State or region for a restaurant, business, room (hotel), etc.
    • City
      • City for a restaurant, business, room (hotel), etc.
    • Street
      • Street address for a restaurant, business, room (hotel), etc.
    • Custom Fields
      • Key-value pairs that the app developer would like attached to the content item.

Action - Log Lifecycle Event

Parameters

Parameter Description
Event Type
  • Required.
  • Select a type of commerce event.
OS Type
  • Required.
  • Select a type of operating system on the mobile device.
Device ID
  • Required.
  • Specify one or two device IDs.
  • Different IDs can be selected depending on OS type.
User Data
  • Optional.
  • Specify as many device-identifying parameters as desired:
    • OS Version
      • Number.
      • Version of the operating system.
      • Specific to Android and iOS.
    • Environment
      • String.
      • Usually "FULL_APP".
    • User Agent
      • String.
      • User agent of the browser or app where the event occurred.
    • HTTP Origin
      • String.
      • Current page URL where Web SDK logged web session start.
    • HTTP Referrer
      • String.
      • Referral URL that led to the current page where the Web SDK logged web session started.
    • Local IP
      • String.
      • Local IP of the device (Android only).
    • Country
      • String.
      • Country code of the user, usually based on device settings or user agent string.
    • Language
      • String.
      • Language code of the user, usually based on device settings or user agent string.
    • Brand
      • String.
      • Brand of the device.
    • Model
      • String.
      • Model of the device.
    • App Version
      • String.
      • App version downloaded by the user.
    • Screen DPI
      • Number.
      • Screen DPI.
    • Screen Height
      • Number.
      • Height of the screen.
    • Screen Width
      • Number.
      • Width of the screen.
    • Developer Identity
      • String.
      • Developer-specified identity for a user.
    • Device Fingerprint ID
      • Branch internal-only field for tracking devices.
    • Browser Fingerprint ID
      • Branch internal-only field for tracking browsers.
    • Limit Ad Tracking
      • Value is True if the partner has opted to not be tracked by advertiser.
Event Data
  • Optional.
  • Data specific for the event.
  • Description: string, description associated with the event, not necessarily specific to any individual content items.
Custom Data
  • Optional.
  • Specify additional data with arbitrary property names and values.

Action - Log Custom Event

Parameters

Parameter Description
Event Type
  • Required.
  • Select a type of commerce event.
OS Type
  • Required.
  • Select a type of operating system on the mobile device.
Device ID
  • Required.
  • Specify one or two device IDs.
  • Different IDs can be selected depending on the OS type.
User Data
  • Optional.
  • Specify as many device-identifying parameters as desired:
    • OS Version
      • Number.
      • Version of the operating system.
      • Specific to Android and iOS.
    • Environment
      • String.
      • Usually "FULL_APP".
    • User Agent
      • String.
      • User agent of the browser or app where the event occurred.
    • HTTP Origin
      • String.
      • Current page URL where Web SDK logged web session start.
    • HTTP Referrer
      • String.
      • Referral URL that led to the current page where the Web SDK logged web session started.
    • Local IP
      • String.
      • Local IP of the device (Android only).
    • Country
      • String.
      • Country code of the user, usually based on device settings or user agent string.
    • Language
      • String.
      • Language code of the user, usually based on device settings or user agent string.
    • Brand
      • String.
      • Brand of the device.
    • Model
      • String.
      • Model of the device.
    • App Version
      • String.
      • App version downloaded by the user.
    • Screen DPI
      • Number.
      • Screen DPI.
    • Screen Height
      • Number,
      • Height of the screen.
    • Screen Width
      • Number.
      • Width of the screen.
    • Developer Identity
      • String.
      • Developer-specified identity for a user.
    • Device Fingerprint ID
      • Branch internal-only field for tracking devices.
    • Browser Fingerprint ID
      • Branch internal-only field for tracking browsers.
    • Limit Ad Tracking
      • Value is True if the partner has opted to not be tracked by advertiser.
Custom Data
  • Optional.
  • Specify additional data with arbitrary property names and values

Vendor Documentation