Get Started – iOS

This guide shows you how to add App Events to your new or existing app by integrating the Facebook SDK then logging these events.

Before You Start

You will need:

• A Facebook Developer Account
• A Facebook Ad Account
• A Facebook app

Step 1: Configure Your Facebook App

Go to the App Dashboard, click My Apps, and create a new app if you don't already have one. Navigate to Settings > Basic to view the App Details Panel with your App ID, your App Secret, and other details about your app.

Scroll down to the bottom of page, and click Add Platform. Choose iOS, add your app details, and save your changes.

Set up your app for advertising by adding the following details:

• App Domains - Provide Apple App Store URL of your app.
• Privacy Policy URL - Provide a Privacy Policy URL. Required to take your app public.
• Terms of Service URL - Provide a Terms of Service URL.
• Platform - Scroll to the bottom of the Settings panel to add the iOS Platform.

To learn more about adding details to your app, such as an icon or category, visit the App Development docs.

Step 2: Link your Ad Account

To run ads and measure installs in the Ads Manager, associate at least one Ad Account with your App.

1. In the App Dashboard click Settings > Advanced.
2. In Authorized Ad Account IDs, add your Ad Account IDs. You can get your ad account IDs from your Ads Manager.
3. If you also have a business account, in Authorized Businesses, add your Business Manager ID. You can find your Business Manager id in the URL of your Business Manager

Step 3: Set Up Your Development Environment

The following procedure uses Swift Package Manager to set up your development environment in xCode.

1. In Xcode, click File > Swift Packages > Add Package Dependency.
2. In the dialog that appears, enter the repository URL: https://github.com/facebook/facebook-ios-sdk.
3. In Version, select Up to Next Major and take the default option.
4. Complete the prompts to select the libraries you'd like to use in your project.
5. To use the Objective-C interface exclusively, import the 'FBSDK'-prefixed module.
   Example: import FBSDKCoreKit
   To use the enhanced Swift interface in your code, import the 'Facebook'-prefixed module.
   Example: import FacebookCore

Step 4: Register and Configure Your App with Facebook

Add Your Bundle Identifier and enable Single Sign-On for your app.

Step 5: Configure Your Project

Step 6: Connect Your App Delegate and Scene Delegate

    
// AppDelegate.swift
import UIKit
import FacebookCore

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {    
    func application(
        _ application: UIApplication,
        didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
    ) -> Bool {          
        ApplicationDelegate.shared.application(
            application,
            didFinishLaunchingWithOptions: launchOptions
        )

        return true
    }
          
    func application(
        _ app: UIApplication,
        open url: URL,
        options: [UIApplication.OpenURLOptionsKey : Any] = [:]
    ) -> Bool {
        ApplicationDelegate.shared.application(
            app,
            open: url,
            sourceApplication: options[UIApplication.OpenURLOptionsKey.sourceApplication] as? String,
            annotation: options[UIApplication.OpenURLOptionsKey.annotation]
        )
    }  
}

// SceneDelegate.swift
import FacebookCore
  ...
func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {
    guard let url = URLContexts.first?.url else {
        return
    }

    ApplicationDelegate.shared.application(
        UIApplication.shared,
        open: url,
        sourceApplication: nil,
        annotation: [UIApplication.OpenURLOptionsKey.annotation]
    )
}

Step 7: Add App Events

There are three ways events are tracked in your app:

• Automatically Logged Events - App installs, launches, and in-app purchases are automatically logged with the Facebook SDK.
• The Codeless App Events tool - Use this tool to add Standard Events without adding code to your app.
• Manually Logged Events - Add code to your app to track Standard and Custom Events.

Automatically Logged Events

When using the Facebook SDK, certain events in your app are automatically logged and collected for Facebook Events Manager unless you disable automatic event logging. These events are relevant for all use cases - targeting, measurement and optimization.

There are three key events collected as part of the Automatic App Event Logging: App Install, App Launch, and Purchase. When automatic logging is enabled, advertisers are able to disable these events, as well as other Facebook internal events such as login impression events. However, if you have disabled automatic logging, but still want to log specific events, such as install or purchase events, manually implement logging for these events in your app.

Caveats

These instructions are for version 4.0 and higher of the SDK. If you are still using version 3.X, omit "SDK" from your App Event calls. For example, you would use FBAppEvents instead of FBSDKAppEvents.

In-app purchase logging is automatically enabled for apps that have installed or upgraded to v4.39. For apps running an earlier version, enable in-app purchase events in Basic > Settings iOS card in the app dashboard or add the purchase event code manually.

Get Device Consent

Starting with iOS 14.5, you will need to set AdvertiserTrackingEnabled and log each time you give a device permission to share data with Facebook. If a device provides consent, call the setAdvertiserTrackingEnabled method of the FBSDKSettings class and set it to YES for Objective-C or true for Swift. If a device does not allow tracking, set setAdvertiserTrackingEnabled to NO for Objective-C or false for Swift. The method will return a boolean value to indicate whether the method is set successfully or not.

// Set AdvertiserTrackingEnabled to YES if a device provides consent
[FBSDKSettings setAdvertiserTrackingEnabled:YES];

// Set AdvertiserTrackingEnabled to true if a device provides consent
Settings.setAdvertiserTrackingEnabled(true)

// Set AdvertiserTrackingEnabled to true if a device provides consent
FB.Mobile.SetAdvertiserTrackingEnabled(true)

// Set AdvertiserTrackingEnabled to NO if a device does not provide consent
[FBSDKSettings setAdvertiserTrackingEnabled:NO];

// Set AdvertiserTrackingEnabled to false if a device does not provide consent
Settings.setAdvertiserTrackingEnabled(false)

// Set AdvertiserTrackingEnabled to false if a device does not provide consent
FB.Mobile.SetAdvertiserTrackingEnabled(false)

<key>FacebookAutoLogAppEventsEnabled</key>
<false/>

Settings.isAutoLogAppEventsEnabled = true

[FBSDKSettings setAutoLogAppEventsEnabled:YES];

Settings.isAutoLogAppEventsEnabled = false

[FBSDKSettings setAutoLogAppEventsEnabled:NO];

<key>FacebookAdvertiserIDCollectionEnabled</key>
<false/>

Settings.isAdvertiserIDCollectionEnabled = false

[FBSDKSettings setAdvertiserIDCollectionEnabled:@YES];

Settings.isAdvertiserIDCollectionEnabled = false

[FBSDKSettings setAdvertiserIDCollectionEnabled:@NO];

Manually Log Events

To log a custom event, just pass the name of the event as an NSString:

[FBSDKAppEvents logEvent:@"battledAnOrc"];

Event Parameters

Facebook has created a set of useful event parameters for inclusion with standard events or with your own custom events. You can also provide your own parameters.

These pre-defined parameters are intended to provide guidance on common logging patterns, and may have a more readable form in reporting and other UIs. Log the set of parameters you're interested in seeing broken down. The recommended description for these are guidance only - you can use these parameters for whatever makes sense for your app.

The parameters are passed via an NSDictionary where the key holds the parameter name as an NSString (iOS SDK constants for the pre-defined ones are listed below), and the value must be either an NSString or an NSNumber.

Step 8: Test Your Events

The App Ads Helper allows you to test the app events in your app to ensure that your app is sending events to Facebook.

1. Open the App Ads Helper.
2. In Select an App, choose your app and choose Submit.
3. Scroll the bottom and choose Test Event.
4. Start your app and send an event. The event should appear page.

Learn More

• Best Practices Guide - View a wide variety of sample apps and how each handles App Events.
• FAQ - Check out our Frequently Asked Questions.

Example Apps

We have created some examples for different app types to make it easier for you to see how you can use app events. Each of the example apps provides a screen by screen breakdown of the different events and parameters that can be collected. At the end of each section, there is a table listing the recommended events and parameters for each app. And, if necessary, you can create your own events and parameters.