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

In this article:

Table of Contents Placeholder

Connector Actions

Action Name AudienceStream EventStream
Send Conversion

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:

  • Access Token
    • Required.
    • Access Token of the Facebook System User who has access to the Ad Account and to the Offline Event Set.
  • Business Manager ID
    • Required.
    • This value can be found on Facebook Business Manager > Business Settings > Business Info > Business Manager Info page.

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 Conversion

Parameters

Parameter Description
Offline Event Set
Client IP Address
  • Required if Data Processing option is mapped to LDU and geolocation is requested.
Content Ids
  • Unique identifier or receipt for each transaction or order in an offline event set.
  • Example: ATN10001
Content Type
  • Required for Dynamic Ads.
  • Any valid Dynamic Ad content-type.
  • Example: product
Currency
  • Required for "Purchase" event.
  • Three-letter ISO currency code
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.
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.
Event Name
Event Time
  • Required
  • Unix timestamp, in seconds.
Item Number
  • Unique identifier to distinguish events with the same order or transaction, such as "1" or "a".
Namespace ID
  • Numeric scope used to resolve third-party User ID or Lead ID .
  • See Match Keys.
Order ID
  • Unique identifier or receipt for each transaction or order in an offline event set.
  • Example: ATN10001
Upload Tag
  • Required.
  • String to track event uploads.
  • Example: "monthly" or "in-store uploads"
Value
  • Required for "Purchase" event.
  • Monetary value of conversion event.
City
  • Lowercase.
  • No punctuation or spaces.
Country
  • 2-letter country codes in ISO 3166-1 alpha-2 format.
Day of birth
  • DD from 01 to 31.
Email Address
  • Identify a user based on their email address.
  • The address will be converted to lowercase.
First Initial
  • Lowercase.
  • No punctuation or special characters.
  • In UTF-8 format.
First Name
  • Lowercase.
  • No punctuation or special characters.
  • In UTF-8 format.
Gender
  • Values are:
    • m for male
    • f for female
  • Uppercase values will be converted to lowercase.
Last Name
  • Lowercase.
  • No punctuation or special characters.
  • In UTF-8 format.
Lead ID from Lead Ads
  • The value of the Lead ID.
Mobile Advertiser ID
  • Specify value of either Apple Advertising ID or Android Advertising ID to target a mobile user.
Month of birth
  • MM from 01 to 12.
Phone Number
  • Identify a user based on their phone number.
  • Prefix the phone number with country code if "Country" field is not specified.
  • Symbols, letters, and any leading zeroes are removed.
Third-party user ID
  • ID in external system
US State
  • 2-character ANSI abbreviation code, in lowercase.
Year of birth
  • YYYY from 1900 to current year.
Zip Code
  • Postal code.
  • Exact format depends on country.
Check this box if the Target User Identifier Data is already hashed
  • Check if Target User Identifier data is already hashed.
Custom Data Properties
  • Optional
  • Custom properties not specified by Facebook
Template Variables
  • Optional.
  • Supported for the Custom Data Properties section.
  • Provide template variables as data input for templates.
  • For more information, see the Template Variables Guide.
  • Name nested template variables with the dot notation, such as items.name.
  • Nested template variables are typically built from data layer list attributes.
Templates
  • Optional
  • Provide valid JSON templates to be referenced in the Custom Data Properties section
  • Templates are injected by name with double curly braces into supported fields, such as {{SomeTemplateName}}.
  • For more information, see the Templates Guide.