githubEdit

Facebook Lead Ads

Facebook arrow-up-rightis an online social media and social networking service owned by Metaarrow-up-right. This destination leverages Conversions APIarrow-up-right to help you get improved performance in lead adsarrow-up-right by sharing your CRM data about your leads back to Meta to unlock quality lead optimization.

Key features

The Facebook Lead Ads destination provides the following key features:

  • Events structure: our Events referencearrow-up-right leverages Facebook eventsarrow-up-right, meaning that your data is properly bridged to the expected fields in an optimized way.

  • Prebuilt mappings: data mapping for event-based destinations happens automatically, which simplifies user inputs.

  • Smart mapping: data mapping can be readjusted using your datalayer defined fields.

Destination setup

circle-exclamation

Configuration

Settings
Description

Pixel Id

Required Your pixel identifier associated with your Conversions API event(s). You can retrieve your pixel identifier by accessing the Events Managerarrow-up-right.

Access Token

Required You can generate an access token by entering the Events Managerarrow-up-right, selecting your pixel, and clicking the "Settings" tab. In the "Conversions API" section, you can click the button "Generate access token".

Lead Event Source

Required Set this to the name of the CRM/tool where the leads are coming from (E.g. "Hubspot", "SAP", "Oracle", "Dynamics", "In-house CRM", etc...).

Mapping

Required Your mapping between Facebook's events and yours. In Facebook event name , you can set either a standard eventarrow-up-right or a custom event namearrow-up-right. At least one entry is required. More details are available by following this LINKarrow-up-right.

Quick reference

Commanders Act Events
Facebook Events

[Any Event] [1]

[Any Event] [1]

circle-info

[1] See Mapping for more details.

Field mappings

circle-info

Most properties can be remapped using our "Smart Mapping" feature. Facebook properties are set starting from the path data.0 .

circle-exclamation
Commanders Act Properties
Facebook Properties

Facebook event name

event_name [*][1]

context.event_timestamp

event_time [*][2]

Lead Event Source

custom_data.lead_event_source [*][3]

Lead Id

user_data.lead_id [4]

partners.facebook.fbc

user_data.fbc [5]

user.email

user_data.em [6]

user.phone

user_data.ph [7]

user.id

user_data.external_id [8]

user.firstname

user_data.fn [9]

user.lastname

user_data.ln [9]

user.birthdate

user_data.db [10]

user.gender

user_data.ge [11]

user.city

user_data.ct [12]

user.state_short

user_data.st [13]

user.country

user_data.country [14]

user.zipcode

user_data.zp [15]

context.device.ip

user_data.client_ip_address

context.device.user_agent

user_data.client_user_agent

circle-info

[*] Mandatory property. [1] See Mapping for more details. [2] If this field is not provided, the current timestamp is used. [3] Set this to the name of the CRM/tool where the leads are coming from (E.g. Hubspot , SAP , Oracle , Dynamics , In-house CRM , etc...). [4] The 15 or 16 digit Facebook generated lead identifier. More details are available following this LINKarrow-up-right. [5] The Meta click identifier. More details are available following this LINKarrow-up-right. [6] User email in lowercase, without spaces and hashed via SHA256. If this is passed in clear text, it's automatically hashed. [7] User phone number: remove symbols, letters, and any leading zeros. Phone numbers must include a country code to be used for matching (E.g., the number 1 must precede a phone number in the United States). Always include the country code as part of your customers' phone numbers, even if all of your data is from the same country. If this is passed in clear text, it's automatically hashed via SHA256. [8] User unique identifier for a user in their space and hashed via SHA256, e.g. user_id, loyalty_id, etc. If this is passed in clear text, it's automatically hashed. [9] In lowercase, hashed via SHA256. If this is passed in clear text, it's automatically hashed. [10] User birthdate given as YYYY-MM-DD or YYYYMMDD and hashed via SHA256. If this is passed in clear text, it's automatically hashed. [11] User gender, in lowercase, hashed via SHA256. If this is passed in clear text, it's automatically hashed. Accepted values: f (also female ) or m (also male ). [12] User city, in lowercase with no punctuation, no special characters, no spaces, and hashed via SHA256. If this is passed in clear text, it's automatically hashed. [13] User state, in lowercase with no punctuation, no special characters, no spaces, as 2-character ANSI abbreviation codearrow-up-right, and hashed via SHA256. If this is passed in clear text, it's automatically hashed. [14] User country as two-character ISO 3166-1 alpha-2arrow-up-right, and hashed via SHA256. If this is passed in clear text, it's automatically hashed. [15] User zipcode in lowercase, no spaces, no dash (5 digits for US zip codes and use the area, district, and sector format for the UK), and hashed via SHA256. If this is passed in clear text, it's automatically hashed.

Last updated

Was this helpful?