Facebook pixel integration

A Facebook pixel is a web-only analytics tool from Facebook. As of v4.34 of the Facebook SDK, you can record pixel events in an app’s webview. You can also convert Facebook Pixel events into Facebook App events. To do this, use Hybrid Mobile App Events.

It’s also now possible to use a Facebook pixel with the Adjust SDK, without integrating the Facebook SDK.

Example app

• iOS example app

Facebook integration

Facebook App ID

To start working with Facebook pixels, follow the steps below:

As described in Facebook’s iOS SDK guide you will need to add your Facebook App ID to the app by doing the following:

1. In Xcode, right click on your project’s Info.plist file and select Open As —> Source Code.
2. Insert the following XML snippet into the body of your file just before the final </dict> element:

<dict>
  <key>FacebookAppID</key>
  <string>{your-app-id}</string>
</dict>

Replace {your-app-id} with your app’s App ID. You can find this in the Facebook App Dashboard.

Facebook pixel configuration

Follow Facebook’s guide on how to integrate the Facebook pixel. The Javascript code should look something like this:

1
<!-- Facebook Pixel Code -->
2
<script>
3
   !function(f,b,e,v,n,t,s)
4
   fbq('init', <YOUR_PIXEL_ID>);
5
   fbq('track', 'PageView');
6
</script>
7
<!-- End Facebook Pixel Code -->

Next, update your Facebook pixel code. You can find the instructions in the Hybrid Mobile App Events guide under Update Your Pixel.

1
fbq('init', <YOUR_PIXEL_ID>);
2
fbq('set', 'mobileBridge', <YOUR_PIXEL_ID>, <YOUR_FB_APP_ID>);

Adjust SDK integration

Augment the web view

Follow the integration guide for iOS web view apps. Add a call to the augmentHybridWebView method when loading the Web View bridge.

1
- (void)viewWillAppear:(BOOL)animated {
2
    UIWebView *webView = [[UIWebView alloc] initWithFrame:self.view.bounds];
3
    /// or with WKWebView:
4
    /// WKWebView *webView = [[WKWebView alloc] initWithFrame:self.view.bounds];
5

6
    /// add @property (nonatomic, strong) AdjustBridge *adjustBridge; on your interface
7
    self.adjustBridge = [[AdjustBridge alloc] init];
8
    [self.adjustBridge loadUIWebViewBridge:webView];
9
    /// optionally you can add a web view delegate so that you can also capture its events
10
    /// [self.adjustBridge loadUIWebViewBridge:webView webViewDelegate:(UIWebViewDelegate*)self];
11

12
    /// or with WKWebView:
13
    /// [self.adjustBridge loadWKWebViewBridge:webView];
14
    /// optionally you can add a web view delegate so that you can also capture its events
15
    /// [self.adjustBridge loadWKWebViewBridge:webView wkWebViewDelegate:(id<WKNavigationDelegate>)self];
16
    [self.adjustBridge augmentHybridWebView];

Event name registration

The Adjust web bridge SDK translates Facebook pixel events into Adjust events.

To use this feature, you need to map Facebook pixels to specific Adjust events. You can also configure a default Adjust event token. To use a default token, you need to add the token before starting the Adjust SDK and recording any pixel event. This includes the copy-pasted fbq('track', 'PageView'); event from the Facebook pixel configuration.

To map events, call the addFbPixelMapping method on your config instance. Use the Facebook event name and Adjust event token as parameters. You need to call this before you initialize the Adjust SDK.

1
adjustConfig.addFbPixelMapping("fb_mobile_search", adjustEventTokenForSearch);
2
adjustConfig.addFbPixelMapping(
3
   "fb_mobile_purchase",
4
   adjustEventTokenForPurchase,
5
);

The Adjust SDK logs warnings if it can’t find a default event token for certain events.

1
There is not a default event token configured or a mapping found for event named: 'fb_mobile_search'. It won't be measured as an adjust event.

You can also set a default Adjust event if you don’t have mapping configured. To do this, call adjustConfig.setFbPixelDefaultEventToken(defaultEventToken); before initializing the Adjust SDK.