Find out more about Managed Components here for inspiration and motivation details.
- Make sure you're running node version >=17.
- Install dependencies with
npm i - Run unit test watcher with
npm run test:dev
Settings are used to configure the tool in a Component Manager config file
property is a long number that identifies your Facebook Ads account. You can obtain it from the Events Manager underneath your site name.
accessToken is a string used to authenticate when sending server side events in your name. You can obtain it following the information here.
testKey is used to test your app or web browser events using test events tool Learn more
Fields are properties that can/must be sent with certain events
ev can be "PageView", "Contact", "Add to Cart" one of the standard Facebook events, or a custom name.
predicted_ltv is the predicted lifetime value of a subscriber as defined by the advertiser and expressed as an exact value.
status can be used with the CompleteRegistration event, to show the status of the registration.
value represents the value of a user performing this event to the business
em user email
ph 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.
fn using Roman alphabet a-z characters is recommended. Lowercase only with no punctuation.
ln using Roman alphabet a-z characters is recommended. Lowercase only with no punctuation.
db accepts the YYYYMMDD format accommodating a range of month, day and year combinations, with or without punctuation.
ge can be an initial in lowercase.
ct using Roman alphabet a-z characters is recommended. Lowercase only with no punctuation, no special characters, and no spaces.
st use the 2-character ANSI abbreviation code in lowercase. Normalize states outside the U.S. in lowercase with no punctuation, no special characters, and no spaces.
zp use lowercase with no spaces and no dash. Use only the first 5 digits for U.S. zip codes. Use the area, district, and sector format for the UK.
country use the lowercase, 2-letter country codes in ISO 3166-1 alpha-2. \n Important Note: Always include your customers' countries’ even if all of your country codes are from the same country. We match on a global scale, and this simple step helps us match as many people as possible from your list.
external_id any unique ID from the advertiser, such as loyalty membership IDs, user IDs, and external cookie IDs
subscription_id the subscription ID for the user in this transaction; it is similar to the order ID for an individual product.
fb_login_id is the ID issued by Facebook when a person first logs into an instance of an app. This is also known as App-Scoped ID
lead_id is the ID associated with a lead generated by Facebook's Lead Ads
data_processing_options holds the processing options you would like Facebook to enable for a specific event or record. If you do not provide a value for Data Processing Options, this field will not be included. Read more about the accepted values in Data Processing Options
data_processing_options_country holds the country that you want to associate with this data processing option. If you do not provide a value for Data Processing Options, this field will not be included. Read more about the accepted values in Data Processing Options
data_processing_options_country holds the state that you want to associate to this data processing option. If you set a country, you must also set a state. Otherwise, Facebook will perform geolocation. If you do not provide a value for Data Processing Options, this field will not be included. Read more about the accepted values in Data Processing Options
Licensed under the Apache License.
Thanks to everyone contributing in any manner for this repo and to everyone working on Open Source in general.
Thanks goes to these wonderful people (emoji key):
 Simona Badoiu 💻 |
 Yo'av Moshe 💻 |
 Ruskin 💻 |
This project follows the all-contributors specification. Contributions of any kind welcome!