# Facebook App Events
[**Facebook App Events**](https://developers.facebook.com/docs/app-events/) is Facebook's event tracking functionality. It lets you track events via your app or web page, including user activities such as app installation, purchases, etc. This information is sent to Facebook for analytics and ad targeting, optimization, and measurement.
RudderStack supports Facebook App Events as a destination to which you can send your event data seamlessly.
**Find the open-source transformer code for this destination in our** [**GitHub repo**](https://github.com/rudderlabs/rudder-transformer/tree/master/v0/destinations/fb)**.**
## Getting Started
To enable sending data to Facebook App Events, you will first need to add it as a destination in RudderStack. Once the destination is configured and enabled, events from RudderStack will start flowing to App Events.
Before configuring App Events as a destination, verify if Facebook supports the source platform by referring to the table below:
| **Connection Mode** | **Web** | **Mobile** | **Server** |
| ------------------- | ------------- | ------------- | ---------- |
| **Device mode** | - | **Supported** | - |
| **Cloud mode** | **Supported** | **Supported** | - |
To know more about the difference between Cloud mode and Device mode in RudderStack, read the [RudderStack connection modes](https://rudderstack.com/docs/rudderstack-cloud/rudderstack-connection-modes/) guide.
Once you have confirmed that the source supports sending events to Facebook App Events, follow these steps:
* From your [**RudderStack dashboard**](https://app.rudderlabs.com/), add the source. From the list of destinations, select **Facebook App Events**.
* Assign a name to the destination and click on **Next**. You should then see the following screen:
.png?alt=media)
### Connection settings
The connection settings required to configure App Events as a destination in RudderStack are listed below:
* Enter the **Facebook App ID**.
The following options are applicable if you are using the Device mode to send your events to Facebook:
* **Limited Data Use**: If this option is enabled, you can send the country and state of the end-user so that Facebook processes the user data according to the data regulations set for that region.
For more information on this option, refer to the [Limited Data Use](https://rudderstack.com/docs/destinations/advertising/facebook-app-events/#limited-data-use) section below.
* Click on **Next** to complete the configuration.
That's it! Facebook App Events should now be added and enabled as a destination in RudderStack.
## Adding Facebook App Events to Your Project
Depending on your platform of integration, follow these steps below to add App Events to your project:
iOS Android To add Facebook to your iOS project:
* Add the following line to your [CocoaPods](https://cocoapods.org/) `Podfile` :
```groovy
pod 'Rudder-Facebook'
```
* Initialize the Facebook App Events iOS SDK just before intializing the RudderStack iOS SDK as shown:
```objectivec
[[FBSDKApplicationDelegate sharedInstance] application:application
didFinishLaunchingWithOptions:launchOptions];
```
* Send the user's consent to App Events as shown below:
* For **Objective-C**:
```objectivec
// Set AdvertiserTrackingEnabled to YES if a user provides consent
[FBSDKSettings setAdvertiserTrackingEnabled:YES];
// Set AdvertiserTrackingEnabled to NO if a user does not provide consent
[FBSDKSettings setAdvertiserTrackingEnabled:NO];
```
* For **Swift**:
```swift
// Set AdvertiserTrackingEnabled to true if a user provides consent
Settings.setAdvertiserTrackingEnabled(true)
// Set AdvertiserTrackingEnabled to false if a user does not provide consent
Settings.setAdvertiserTrackingEnabled(false)
```
* Configure your project by adding the following lines to `(...)` in your `Info.plist` :
```markup
CFBundleURLTypes
CFBundleURLSchemes
fbAPP-ID
FacebookAppID
APP-ID
FacebookClientToken
CLIENT-TOKEN
FacebookDisplayName
APP-NAME
```
Make sure you replace `fbAPP-ID` , `APP-ID`, `CLIENT-TOKEN`, `APP-NAME` with the app-specific details from the [Facebook for Developers platform](https://developers.facebook.com/).
* After adding the dependency, register the `RudderFacebookFactory` with your `RudderClient` initialization as a `factory` of `RudderConfig`. To do this, run the following command to import the `RudderFacebookFactory.h` file in your `AppDelegate.m` file:
```objectivec
#import
```
* Then, add the RudderStack iOS SDK initialization as shown:
```objectivec
RSConfigBuilder *builder = [[RSConfigBuilder alloc] init];
[builder withDataPlaneUrl:DATA_PLANE_URL];
[builder withFactory:[RudderFacebookFactory instance]];
[RSClient getInstance:WRITE_KEY config:[builder build]];
```
To add Facebook App Events to your Android project, follow these steps:
* Add the repository, as shown:
```groovy
repositories {
mavenCentral()
}
```
* Add the following lines to your `app/build.gradle` file under the `dependencies` section, as shown:
```groovy
implementation 'com.rudderstack.android.sdk:core:1.+'
implementation 'com.rudderstack.android.integration:facebook:1.0.0'
implementation 'com.facebook.android:facebook-android-sdk:11.1.0'
```
* Open your `/app/res/values/strings.xml` file and add the following lines. \*\*Remember to replace `[APP_ID]` with your actual app ID\*\*.
```markup
[APP_ID]
fb[APP_ID]
```
* In the `app/manifests/AndroidManifest.xml`file, add a `meta-data` element to the `application` element as shown: {/\*
```markup
...
...
```
\*/}
* Finally, change the initialization of your `RudderClient` in your `Application` class, as shown:
```java
val rudderClient = RudderClient.getInstance(
this,
WRITE_KEY,
RudderConfig.Builder()
.withDataPlaneUrl(DATA_PLANE_URL)
.withFactory(FacebookIntegrationFactory.FACTORY)
.build()
)
```
## Identify
For App Events, RudderStack supports the `identify` calls only in the mobile device mode.
The `identify` call from RudderStack sets the `userId` through the `setUserID` method from `AppEventsLogger`.
RudderStack sets the following properties (if available) using the `setUserData` method.
* `email`
* `firstName`
* `lastName`
* `phone`
* `birthday`
* `gender`
* `city`
* `state`
* `zip`
* `country`
A sample `identify` call for an iOS application is shown below:
```objectivec
[[RSClient sharedInstance] identify:@"developer_user_id"
traits:@{@"email": @"bar@foo.com"}];
```
## Track
The `track` call from RudderStack is logged to Facebook using the `logEvent` method of the `AppEventsLogger` class. RudderStack uses the same `eventName` as you have passed to the `track` method. Along with that, it will pass all the `properties` after converting them into an accepted format.
A sample `track` call for an iOS application is as shown:.
```objectivec
[[RSClient sharedInstance] track:@"Accepted Terms of Service"
properties:@{
@"foo": @"bar",
@"foo_int": @134
}];
```
When `revenue` and `currency` are present in the event properties of any `track` call, RudderStack makes a `Purchase` call to Facebook using its `logPurchase` API along with the normal `track` call using the `logEvent` API.
If `currency` is absent in the event properties RudderStack sets the default value to `USD`.
## Page
The `page` method lets you record your website's page views with any additional relevant information about the viewed page. You need not pass the event name as RudderStack automatically sets it to `Viewed Page`.
A sample `page` call using the RudderStack Android SDK is as shown:
```javascript
rudderanalytics.page();
```
The `page` call is directly passed on to Facebook as a `track` event via its `logEvent` API, with the event name as `Viewed Page` along with the the associated properties.
## Screen
The `screen` method lets you record your users' screen views on their devices, along with any associated properties. This call is similar to the `page` call, but is exclusive to your mobile device.
A sample `screen` call using the RudderStack Android SDK is as shown:
```objectivec
[[RSClient sharedInstance] screen:@"Home" properties:@{
@"category" : @"launcher"
}];
```
In the above snippet, RudderStack captures the information related to the viewed screen, such as screen name and `category`.
The above `screen` call is directly passed on to Facebook as a `track` event via its `logEvent` API, with the event name as `Viewed {screen name} screen` along with the the associated properties. The above example will be sent as a `track` event with name `Viewed Home screen` along with its properties.
## Limited Data Use
In July 2020, Facebook released a [**Limited Data Use**](https://developers.facebook.com/docs/marketing-apis/data-processing-options) feature to give businesses better control over how their data is used in their **California Consumer Privacy Act (CCPA)** compliance efforts.
You can now send the **Limited Data Use** data processing parameters to Facebook for each event via RudderStack, so that Facebook can appropriately apply the user’s data choice.
To use this feature, simply enable the **Limited Data Use** setting on the RudderStack dashboard and control its behavior via the following data processing parameters:
| **Parameter** | **Default Value** | **Description** |
| ----------------------------------- | ----------------- | --------------------------------------------------------------- |
| **Data Processing Options State** | **`0`** | Use Facebook’s geolocation to determine the end-user's state. |
| **Data Processing Options Country** | **`0`** | Use Facebook’s geolocation to determine the end-user's country. |
Learn more about the different data processing options accepted by Facebook [here](https://developers.facebook.com/docs/marketing-apis/data-processing-options).
## Configuring Facebook App Events SDK Based on User Consent
This section highlights the different consent-based options for configuring the App Events SDK.
### Disable Automatically Logged Events
iOS Android
* To disable automatic event logging, open the application's `.plist` as code in Xcode and add the following XML to the property dictionary:
```markup
FacebookAutoLogAppEventsEnabled
```
* In some cases, you can delay the collection of automatically logged events to obtain user consent or fulfill legal obligations instead of disabling it entirely. To do so, call the `setAutoLogAppEventsEnabled` method of the `FBSDKSettings` class to re-enable auto-logging after the end-user provides the required consent.
* In **Objective-C**:
```objectivec
[FBSDKSettings setAutoLogAppEventsEnabled:YES];
```
* In **Swift**:
```swift
FBSDKSettings.setAutoLogAppEventsEnabled(true)
```
* To suspend event collection for any reason, set the `setAutoLogAppEventsEnabled` method to `NO` for iOS or `false` for Swift, as shown:
* In **Objective-C**:
```objectivec
[FBSDKSettings setAutoLogAppEventsEnabled:NO];
```
* In **Swift**:
```swift
FBSDKSettings.setAutoLogAppEventsEnabled(false)
```
* To disable automatically logged events, add the following to your `AndroidManifest.xml` file: {/\*
```markup
...
...
```
\*/}
* In some cases, you can delay the collection of automatically logged events to obtain user consent or fulfill legal obligations instead of disabling it entirely. To do so, call the `setAutoLogAppEventsEnabled()` method of the `FacebookSDK` class and set it to `true` . This re-enables event logging after the end-user has provided the required consent.
```java
setAutoLogAppEventsEnabled(true);
```
* To suspend event logging again for any reason, set the `setAutoLogAppEventsEnabled()` method to `false`, as shown:
```java
setAutoLogAppEventsEnabled(false);
```
### Disable Collection of Advertiser IDs
iOS Android
* To disable the collection of advertiser ID, open the application's `.plist` as code in Xcode and add the following XML to the property dictionary:
```markup
FacebookAdvertiserIDCollectionEnabled
```
* In some cases, you can delay the collection of `advertiser_id` to obtain the user consent or fulfill any legal obligations instead of disabling it entirely. To do so, call the `setAdvertiserIDCollectionEnabled` method of the `FBSDKSettings` class and set it to `YES` for iOS, or `true` for Swift after the end-user provides consent, as shown:
* In **Objective-C**:
```objectivec
[FBSDKSettings setAdvertiserIDCollectionEnabled:@YES];
```
* In **Swift**:
```swift
FBSDKSettings.setAdvertiserIDCollectionEnabled(true);
```
* To suspend collection for any reason, set the `setAdvertiserIDCollectionEnabled` method to `NO` for iOS or `false` for Swift.
* In **Objective-C**:
```objectivec
[FBSDKSettings setAdvertiserIDCollectionEnabled:@NO];
```
* In **Swift**:
```swift
FBSDKSettings.setAdvertiserIDCollectionEnabled(false)
```
* To disable collection of `advertiser-id`, add the following code to your `AndroidManifest.xml` file:
```markup
...
...
```
* In some cases, you can delay the collection of `advertiser_id` to obtain user consent or fulfill any legal obligations instead of disabling it entirely. To do so, call the `setAdvertiserIDCollectionEnabled()` method of the `FacebookSDK` class and set it to `true` . This re-enables the collection of `advertiser_id` after the end-user provides the required consent, as shown:
```java
setAdvertiserIDCollectionEnabled(true);
```
* To suspend collection for any reason, set the `setAdvertiserIDCollectionEnabled()` method to `false`, as shown:
```java
setAdvertiserIDCollectionEnabled(false)
```
### Disable Automatic SDK Initialization
Android To disable automatic SDK initialization in case of the Android SDK, add the following to your `AndroidManifest.xml` file:
```markup
...
...
```
In some cases, you can delay the SDK initialization to obtain user consent or fulfill any legal obligations instead of disabling it entirely. To do so, call the class method `setAutoInitEnabled` and set it to `true` to manually initialize the SDK after the end-user provides the required consent.
```java
FacebookSdk.setAutoInitEnabled(true)
FacebookSdk.fullyInitialize()
```
## FAQs
### Where do I get the Facebook App ID?
You can find the **Facebook App ID** by logging into your Facebook Developer account, and navigating to the **Home** page of your Application dashboard.
### Where do I get the Facebook Client Token?
You can find the **Facebook Client Token** by logging into your Facebook Developer account. Then, navigate to **Settings** - **Advanced** - **Client Token** in your app dashboard.
## Contact Us
If you come across any issues while configuring Facebook App Events with RudderStack, feel free to [**contact us**](mailto:%20docs@rudderstack.com) or start a conversation in our [**Slack**](https://rudderstack.com/join-rudderstack-slack-community) community.
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://rudderlabs.gitbook.io/rudderlabs-1/docs/destinations/advertising/facebook-app-events.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.