Search specific term/phrase surrounded by double quotes. e.g. “deep linking”
Exclude records that contain a specific term prefixed with a minus. e.g. Android -Firebase

Facebook Ads

Overview

Branch links can be used together with Facebook ads, allowing you to track ad-driven installs on the Branch dashboard and deep link those new users directly to the content the first time they open your app. Refer to Facebook's Ad Guide to learn more.

Facebook's Ad Platform supports numerous campaign types and a shared set of advertisement formats. To help you navigate Facebook's Advertisement Platform we created this guide detailing how to use Branch links in all major Facebook ad types.

Campaign Support

This documentation supports the following Facebook Ad Campaigns:

Facebook Campaign CategoryCampaign Type/ObjectiveLink users toBranch Documentation LinkBranch Ad Format
AwarenessBrand AwarenessWeblinkCross-platform Display
AwarenessReachWeblinkCross-platform Display
ConsiderationTrafficWeb or ApplinkCross-platform Display
ConsiderationApp InstallsApplinkApp Only: Installs
ConsiderationVideo ViewsWeblinkCross-platform Display
ConsiderationLead GenerationWeb xlinkCross-platform Display
ConversionConversionsWeb or ApplinkCross-platform Display

🚧

Connecting Multiple Apps

If you have more than one app using the same Facebook Account ID, SKAdNetwork data may only appear in one of those apps. Do not connect the same Facebook Account ID in multiple apps to avoid visualization issues.

[x] Facebook has indicated that links are not supported in all placements.

Data Mapping between Branch and Facebook

Event Names

📘

Standard vs Custom Events

Please follow the Tracking Commerce, Content, Lifecycle and Custom Events guide when implementing event tracking in the Branch SDK. When tracking any of the Facebook events that are mapped to the Branch custom event, use the event name from the table below; e.g. branch.logevent('AdClick').

Facebook Event NameBranch Event Name
AdClickCustom
AdImpressionCustom
ContactCustom
CustomizeProductCustom
DonateCustom
fb_mobile_achievement_unlockedUNLOCK_ACHIEVEMENT
MOBILE_APP_INSTALLINSTALL
fb_mobile_activate_appOPEN
fb_mobile_add_payment_infoADD_PAYMENT_INFO
fb_mobile_add_to_cartADD_TO_CART
fb_mobile_add_to_wishlistADD_TO_WISHLIST
fb_mobile_complete_registrationCOMPLETE_REGISTRATION
fb_mobile_content_viewVIEW_ITEM
fb_mobile_initiated_checkoutINITIATE_PURCHASE
fb_mobile_level_achievedACHIEVE_LEVEL
fb_mobile_purchasePURCHASE
fb_mobile_rateRATE
fb_mobile_searchSEARCH
fb_mobile_spent_creditsSPEND_CREDITS
fb_mobile_tutorial_completionCOMPLETE_TUTORIAL
FindLocationCustom
ScheduleCustom
StartTrialSTART_TRIAL
SubmitApplicationCustom
SubscribeCustom

Campaign/Ad Data

Branch DataFacebook Data
last_attributed_touch_data_tilde_ad_set_namecampaign_name
last_attributed_touch_data_tilde_ad_set_idcampaign_id
last_attributed_touch_data_tilde_secondary_publisherpublisher_platform
last_attributed_touch_data_tilde_creative_namecreative_name
last_attributed_touch_data_tilde_creative_idcreative_id
last_attributed_touch_data_tilde_ad_nameadgroup_name
last_attributed_touch_data_tilde_ad_idadgroup_id
last_attributed_touch_data_tilde_campaigncampaign_group_name
last_attributed_touch_data_tilde_campaign_idcampaign_group_id

🚧

Creative Data

Note: creative_id and creative_name are automatically set server-side on Facebook Cost, Clicks, and Impressions sent to Branch.

Metadata

Branch Key-Value PairFacebook MMP Key-Value PairFacebook event(s) supported
event_data.revenue_valueToSumfb_mobile_add_to_cart, fb_mobile_add_to_wishlist, fb_mobile_initiated_checkout, fb_mobile_purchase, fb_mobile_spent_credits, fb_mobile_content_view
event_data.currencyfb_currencyfb_mobile_add_to_cart, fb_mobile_add_to_wishlist, fb_mobile_initiated_checkout, fb_mobile_purchase, fb_mobile_content_view
content_items(array).$quantityfb_num_itemsfb_mobile_initiated_checkout, fb_mobile_purchase
content_items (array)fb_content (array)fb_mobile_add_to_cart, fb_mobile_add_to_wishlist, fb_mobile_tutorial_completion, fb_mobile_initiated_checkout, fb_mobile_purchase, fb_mobile_rate, fb_mobile_spent_credits, fb_mobile_content_view
content_items[i].$skufb_content_idfb_mobile_add_to_cart, fb_mobile_add_to_wishlist, fb_mobile_tutorial_completion, fb_mobile_initiated_checkout, fb_mobile_purchase, fb_mobile_rate, fb_mobile_spent_credits, fb_mobile_content_view
content_items[i].$product_categoryfb_content (array)fb_mobile_add_to_cart, fb_mobile_add_to_wishlist, fb_mobile_initiated_checkout, fb_mobile_purchase, fb_mobile_rate, fb_mobile_search, fb_mobile_spent_credits, fb_mobile_content_view
content_items[i].$product_brandfb_content (array)fb_mobile_add_to_cart, fb_mobile_add_to_wishlist, fb_mobile_initiated_checkout, fb_mobile_purchase, fb_mobile_rate, fb_mobile_search, fb_mobile_spent_credits, fb_mobile_content_view
content_items[i].$product_namefb_content (array)fb_mobile_add_to_cart, fb_mobile_add_to_wishlist, fb_mobile_initiated_checkout, fb_mobile_purchase, fb_mobile_rate, fb_mobile_search, fb_mobile_spent_credits, fb_mobile_content_view
content_items[i].$pricefb_content (array)fb_mobile_add_to_cart, fb_mobile_add_to_wishlist, fb_mobile_initiated_checkout, fb_mobile_purchase, fb_mobile_rate, fb_mobile_search, fb_mobile_spent_credits, fb_mobile_content_view
content_items[i].$og_titlefb_content (array)fb_mobile_add_to_cart, fb_mobile_add_to_wishlist, fb_mobile_initiated_checkout, fb_mobile_purchase, fb_mobile_rate, fb_mobile_search, fb_mobile_spent_credits, fb_mobile_content_view
content_items[i].$keywordsfb_content (array)fb_mobile_add_to_cart, fb_mobile_add_to_wishlist, fb_mobile_initiated_checkout, fb_mobile_purchase, fb_mobile_rate, fb_mobile_search, fb_mobile_spent_credits, fb_mobile_content_view
content_items[i].$custom_fieldsfb_content (array)fb_mobile_add_to_cart, fb_mobile_add_to_wishlist, fb_mobile_initiated_checkout, fb_mobile_purchase, fb_mobile_rate, fb_mobile_search, fb_mobile_spent_credits, fb_mobile_content_view
event_data.search_queryfb_search_stringfb_mobile_search
custom_data.fb_payment_info_availablefb_payment_info_availablefb_mobile_initiated_checkout
custom_data.levelfb_levelfb_mobile_level_achieved
custom_data.fb_successfb_successfb_mobile_add_payment_info, fb_mobile_tutorial_completion, fb_mobile_search
custom_data.fb_registration_methodfb_registration_methodfb_mobile_complete_registration

Branch will send all content items tracked for an event, if supported.

Also, Branch will automatically map "fb_content_type":"product" for in-app events when the advertiser tracks ContentMetadata via a Branch SDK. Otherwise, Branch will not add the fb_content_type variable.

Viewing Facebook Data

You can see analytics on impressions, clicks, installs, opens and conversion events on various pages of the Branch Dashboard.

📘

Reporting Discrepancies

Facebook's Advanced Mobile Measurement Agreement

On October 29th, 2021 Facebook deprecated the AMM (Advanced Mobile Measurement) program, resulting in click and impression log-level data no longer available to export. Advertisers that incorporate installs into their attribution model can still measure the aggregate number of view-through and click-through installs from Facebook in Ads Manager and in their Branch dashboard to the ad ID level of granularity.

To programmatically export aggregate data for your Facebook campaigns, you can use Branch’s Aggregate API.

You can also allow agencies and ad networks to pull aggregate data themselves and be confident that 3rd parties will only be exporting data filtered to the access level they've been granted

Any event attributed to a Facebook ad will look like an organic event when accessed via Webhooks, the Daily Export API, and CSV Exports.

Data Limitations

👍

Data Limitations

  • Branch may redact specific metrics/events (ex. INSTALLS) through the Branch Dashboard or through Aggregate Exports of Facebook-attributed campaigns when aggregation levels are not high enough to prevent the potential de-anonymization of specific Facebook users or if it is non-aggregated view-through and click-through data.
    • In these cases, the Branch Dashboad will display "undisclosed" in reports and Aggregate Expots will show null in responses.
  • Only for Android events, you can get the event detail but not "undisclosed" with Facebook Install Referrer
  • We cannot send device-level Facebook attribution data to third parties, unless attribution results utilized the Facebook Install Referrer or Aggregate Event Measurement
  • This data is also not returned in the deep link session initialization callback within the app. If you have analytics needs that are not met by the Branch Dashboard, please contact us and include "Facebook MMP + Feature Request" in the subject.
  • Branch will purge last-attributed data after 60 days.
Branch featureFacebook data included
Dashboard visualizationsPre-aggregated analytics
Query APIPre-aggregated analytics
LiveviewPre-aggregated analytics
Daily Export APINot supported
CSV ExportsPre-aggregated analytics
WebhooksPre-aggregated analytics
Data IntegrationsNot supported

Facebook Limited Data Use

On July 1st 2020, Facebook introduced a new Limited Data Use (LDU) feature to support customer compliance with the California Consumer Privacy Act (CCPA). This feature enables you to limit how Facebook uses the data of California users collected by you or by third parties on your behalf.

If the Limited Data Use feature is enabled, Facebook has indicated it will process such data in accordance with their role as a “service provider” under the CCPA, with respect to personal information from residents in California; i.e. Facebook will limit use of that data subject to their State-Specific Terms.

By default, Branch’s Facebook integration has the Limited Data Use feature enabled. This means that Branch sends Facebook the LDU flag as enabled with your Branch conversion data by default. Therefore, conversion metrics (e.g installs or other down funnel events) for California users will not be available in your reporting. NOTE: You will still see aggregate click, impression, and cost data for users in California.

However, Branch has provided a customer-controlled toggle in the event you desire to disable the Limited Data Use feature in your dashboard configuration. We recommend that you consult with your legal counsel to understand any implications of disabling the Limited Data Use feature for the Facebook integration as they pertain to CCPA or other state specific data protection laws, and to determine whether disabling the Limited Data Use feature will meet your needs.

To disable the Limited Data Use feature:

  1. In the left-hand navigation panel under Channels & Links, click on Ads and then click Partner Management.

  2. Find and select Facebook using the Ad Partners search feature.

  3. On the Ad Partner settings: Facebook page, click on the Events Config tab.

  4. On the Event Config tab, scroll down to the bottom and deselect Limited Data Use (LDU) Flag.

  5. Click Save.

Troubleshooting

We also have a document with FAQs and Advanced Options for Facebook Ads. We recommend starting with one of the guides above, then jumping into the FAQ and Advanced Options when you have questions or need to troubleshoot.


What’s Next