---
title: Facebook App Events Connector Setup Guide
description: This article describes how to set up the Facebook App Events connector.
url: https://docs.tealium.com/server-side-connectors/facebook-app-events-connector/
---
## API information

This connector uses the following vendor API:

* API Name: Facebook Graph API - Marketing API
* API Version: v25.0
* API Endpoint: `https://graph.facebook.com`

## How it works

Report app installs and in-app conversions through this API and send data back to Facebook Analytics. Use this on mobile devices without the Facebook SDK. For detailed information, see the [Facebook App Events API](https://developers.facebook.com/docs/marketing-api/app-event-api#install_parameters) documentation.

## Configuration

Go to the Connector Marketplace and add a new connector. Read the [Connector Overview](https://docs.tealium.com/about-connectors/) article for general instructions on how to add a connector.

After adding the connector, configure the following settings:

* **Application ID**: The App ID listed on your app dashboard at Facebook for Developers.

## Actions

| Action Name| AudienceStream | EventStream|
|:----------------|:-------------------|:----------------|
| Send Event      | ✓                  | ✓               |

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.

### Send Event

#### Parameters

| Parameter                      | Description                                                                                                                                                                                                                                                                                                                                                                              |
|:-----------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Data Processing Options            | <ul><li>(Required) Map value to LDU to have Facebook process event with Limited Data Use restrictions.</li><li>Otherwise map `None` to specify that the event should not be processed with Limited Data Use restrictions.</li><li>For more information, see [Facebook Data Processing Options](https://developers.facebook.com/docs/marketing-apis/data-processing-options).</li></ul> |
| Advertiser ID                      | <ul><li>(Required) Apple IDFA or Google Advertising ID.</li></ul>                                                                                                                                                                                                                                                                                                                     |
| Advertiser Tracking Enabled        | <ul><li>(Required) Options are `0` for disabled; `1` for enabled.</li></ul>                                                                                                                                                                                                                                                                                                           |
| App Tracking Enabled               | <ul><li>(Required) Options are `0` for disabled; `1` for enabled.</li></ul>                                                                                                                                                                                                                                                                                                           |
| Attribution                        | <ul><li>(Required) Mobile cookie from a device.</li><li>Applies to Android and pre-iOS 6 devices.</li><li>For other devices, use `advertiser_id`.</li></ul>                                                                                                                                                                                                                           |
| Client IP Address                  | <ul><li>(Required) Device's IP address in IPv4 or IPv6 format.</li></ul>                                                                                                                                                                                                                                                                                                              |
| Event                              | <ul><li>(Required) Type of event being sent through the App Events API.</li></ul>                                                                                                                                                                                                                                                                                                         |
| App User ID                        | <ul><li>(Optional) A unique combination of letters and numbers no more than 100 characters long stored on the device of the user.</li></ul>                                                                                                                                                                                                                                           |
| Bundle ID                          | <ul><li>(Optional) A unique string that identifies your application to the system.</li></ul>                                                                                                                                                                                                                                                                                          |
| Bundle Short Version               | <ul><li>(Optional) The publicly visible version of your app.</li></ul>                                                                                                                                                                                                                                                                                                                |
| Bundle Version                     | <ul><li>(Optional) The internal version number of your app.</li></ul>                                                                                                                                                                                                                                                                                                                 |
| Data Processing Options Country    | <ul><li>Required if Data Processing Options is mapped to LDU.</li><li>Map country code associated with user event.</li><li>Accepted code values:  <ul><li>`1` for the United States of America</li><li>`0` to request country to be geolocated by Facebook</li></ul> </li><li>Geolocation also requires mapping the "Client IP Address" attribute.</li></ul>                                 |
| Data Processing Options State      | <ul><li>Required if Data Processing Options is mapped to LDU.</li><li>Map the state code associated with the user event.</li><li>Accepted code values: <ul><li>`0` — Meta-performed geolocation (requires Client IP Address)</li><li>`1000` — California</li><li>`1001` — Colorado</li><li>`1002` — Connecticut</li><li>`1003` — Florida</li><li>`1004` — Oregon</li><li>`1005` — Texas</li><li>`1006` — Montana</li><li>`1007` — Delaware</li><li>`1008` — Nebraska</li><li>`1009` — New Hampshire</li><li>`1010` — New Jersey</li><li>`1011` — Minnesota</li><li>`1012` — Maryland</li><li>`1013` — Rhode Island</li></ul></li><li>Geolocation (`0`) requires mapping the "Client IP Address" attribute.</li><li>For offline events where no Client IP Address is available, use an explicit state code (`1000`–`1013`).</li></ul>                                              |
| App Package Name                   | <ul><li>(Required) String for the app package name.</li></ul>                                                                                                                                                                                                                                                                                                                         |
| Available Storage Size             | <ul><li>(Required) Integer value for the available external storage space, in GB.</li></ul>                                                                                                                                                                                                                                                                                           |
| Carrier Name                       | <ul><li>(Required) String for the carrier name.</li><li>If the carrier name is not available, use `NoCarrier`.</li></ul>                                                                                                                                                                                                                                                              |
| CPU Cores                          | <ul><li>(Required) Integer for the number of CPU cores.</li></ul>                                                                                                                                                                                                                                                                                                                     |
| Device Locale                      | <ul><li>(Required) String for two letters for the locale language in lowercase, concatenated with an underscore character (`_`) and two letters for the country code, in uppercase.</li></ul>                                                                                                                                                                                         |
| Device Model Name                  | <ul><li>(Required) String for the device model name.</li></ul>                                                                                                                                                                                                                                                                                                                        |
| Device Timezone                    | <ul><li>(Required) String for the device timezone.</li></ul>                                                                                                                                                                                                                                                                                                                          |
| Device Timezone Abbreviation       | <ul><li>(Required) String for the device timezone abbreviation.</li></ul>                                                                                                                                                                                                                                                                                                             |
| External Storage Size              | <ul><li>(Required) Integer for the total external storage size, in GB.</li></ul>                                                                                                                                                                                                                                                                                                      |
| OS Version                         | <ul><li>(Required) String for the operating system version.</li></ul>                                                                                                                                                                                                                                                                                                                 |
| Pkg Info Version Code              | <ul><li>(Required) Integer for the PackageInfo version code.</li></ul>                                                                                                                                                                                                                                                                                                                |
| Pkg Info Version Name              | <ul><li>(Required) String for the PackageInfo version name.</li></ul>                                                                                                                                                                                                                                                                                                                 |
| Screen Density                     | <ul><li>(Required) Float for the screen density in the `%.2f` format.</li><li>The decimal separator must be a dot.</li></ul>                                                                                                                                                                                                                                                          |
| Screen Height                      | <ul><li>(Required) Integer for the screen height, in pixels.</li></ul>                                                                                                                                                                                                                                                                                                                |
| Screen Width                       | <ul><li>(Required) Integer for the screen width, in pixels.</li></ul>                                                                                                                                                                                                                                                                                                                 |
| Extended Info Format               | <ul><li>(Optional) Extended info format version and source indicator.</li><li>Default value is `a2`.</li></ul>                                                                                                                                                                                                                                                                        |
| Event Name                         | <ul><li>Select event from drop-down list or create a new event.</li></ul>                                                                                                                                                                                                                                                                                                                    |
| `_logTime`                         | <ul><li>(Optional) Recommended parameter to specify the time of event, specified in Unix time.</li></ul>                                                                                                                                                                                                                                                                              |
| `_valueToSum`                      | <ul><li>(Optional) Numeric value of individual event to be summed in reporting.</li><li>See above for recommended events to attach to.</li></ul>                                                                                                                                                                                                                                      |
| `fb_content_id`                    | <ul><li>(Optional) International Article Number (EAN), when applicable, or other product or content identifiers.</li></ul>                                                                                                                                                                                                                                                            |
| `fb_content_type`                  | <ul><li>(Optional) For example, a music, video, or product description.</li></ul>                                                                                                                                                                                                                                                                                                     |
| `fb_currency`                      | <ul><li>(Optional) ISO 4217 code.</li><li>Examples: `EUR`, `USD`, `JPY`.</li><li>Required when passing `_valueToSum` as a price or a purchase amount.</li></ul>                                                                                                                                                                                                                       |
| `fb_description`                   | <ul><li>(Optional) A string description.</li></ul>                                                                                                                                                                                                                                                                                                                                    |
| `fb_level`                         | <ul><li>(Optional) Level of a game.</li></ul>                                                                                                                                                                                                                                                                                                                                         |
| `fb_max_rating_value`              | <ul><li>(Optional) Upper bounds of a rating scale,</li><li>Example: `5` on a 5-star scale.</li></ul>                                                                                                                                                                                                                                                                                  |
| `fb_num_items`                     | <ul><li>(Optional) Number of items.</li></ul>                                                                                                                                                                                                                                                                                                                                         |
| `fb_payment_info_available`        | <ul><li>(Optional) Values are `1` for yes, `0` for no.</li></ul>                                                                                                                                                                                                                                                                                                                      |
| `fb_registration_method`           | <ul><li>(Optional) Facebook, Email, X, etc.</li></ul>                                                                                                                                                                                                                                                                                                                           |
| `fb_search_string`                 | <ul><li>(Optional) The text string that was searched for.</li></ul>                                                                                                                                                                                                                                                                                                                   |
| `fb_success`                       | <ul><li>(Optional) Values are `1` for yes, `0` for no.</li></ul>                                                                                                                                                                                                                                                                                                                      |
| IDs                                | <ul><li>(Optional) Product IDs.</li><li>Array values of same length only, they will be paired in order when sent to Facebook.</li></ul>                                                                                                                                                                                                                                               |
| Quantities                         | <ul><li>(Optional) Product Quantities.</li><li>Array values of same length only, they will be paired in order when sent to Facebook.</li></ul>                                                                                                                                                                                                                                        |
| Email                              | <ul><li>(Optional) Email address.</li></ul>                                                                                                                                                                                                                                                                                                                                           |
| First Name                         | <ul><li>(Optional) First Name.</li></ul>                                                                                                                                                                                                                                                                                                                                              |
| Last Name                          | <ul><li>(Optional) Last Name.</li></ul>                                                                                                                                                                                                                                                                                                                                               |
| Phone                              | <ul><li>(Optional) Phone Number.</li><li>Include only digits with country code, area code, and number. For example, `16505551212`.</li></ul>                                                                                                                                                                                                                                                                                                                                            |
| External ID                        | <ul><li>(Optional) Any unique ID from the advertiser, such as loyalty membership ID, user ID, and external cookie ID.</li></ul>                                                                                                                                                                                                                                                       |
| Gender                             | <ul><li>(Optional) Options are `f` for female, `m` for male.</li><li>If unknown, leave blank.</li></ul>                                                                                                                                                                                                                                                                               |
| Birthdate                          | <ul><li>(Optional) Birth year, month, then date.</li></ul>                                                                                                                                                                                                                                                                                                                            |
| City                               | <ul><li>(Optional) City Name.</li></ul>                                                                                                                                                                                                                                                                                                                                               |
| State or Province                  | <ul><li>(Optional) Two-letter state or province code.</li></ul>                                                                                                                                                                                                                                                                                                                       |
| Zip or Postal Code                 | <ul><li>(Optional) Numeric zip or postal code.</li></ul>                                                                                                                                                                                                                                                                                                                              |
| Country                            | <ul><li>(Optional) Lowercase two-letter country code.</li></ul>                                                                                                                                                                                                                                                                                                                       |
| User Data is Already SHA256 Hashed | <ul><li>(Optional) Check box if user data is already SHA256 hashed.</li></ul>                                                                                                                                                                                                                                                                                                         |