This article describes how to set up the Facebook App Events connector in your Customer Data Hub account.

In this article:

Table of Contents Placeholder

Connector Actions

Action Name AudienceStream EventStream
Send Event

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 documentation.

Configure Settings

Go to the Connector Marketplace and add a new connector. Read the Connector Overview 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.

Action Settings - Parameters and Options

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.

Action - Send Event

Parameters

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