fbq v0.1.4

fbq

Cleanly integrates facebook pixel into your projects.

Install

npm install --save fbq

Usage

Simple usecase

import { init, track } from 'fbq'

const pixel = 'xxxxxxxxxxxxxxx' // https://facebook.com/business/help/742478679120153

init(pixel)
track('PageView')

More complex usecase

import { init, track, trackCustom } from 'fbq'

const pixel = 'xxxxxxxxxxxxxxx' // https://facebook.com/business/help/742478679120153
const advancedMatching = {
    email: 'john@example.com',
    id: 'xxxxxxxxxxx'
} // https://www.facebook.com/business/help/611774685654668

const options = { 
    autoConfig: false
} // https://developers.facebook.com/docs/facebook-pixel/advanced#automatic-configuration

init(pixel)
track('PageView', advancedMatching, options)

API

Type aliases

• TrackType

Functions

• init
• track
• trackCustom

Type aliases

TrackType

Ƭ TrackType: "AddPaymentInfo" | "AddToCart" | "AddToWishlist" | "CompleteRegistration" | "Contact" | "CustomizeProduct" | "Donate" | "FindLocation" | "InitiateCheckout" | "Lead" | "Purchase" | "Schedule" | "Search" | "StartTrial" | "SubmitApplication" | "Subscribe" | "ViewContent" | "PageView"

Defined in index.ts:33

Functions

Const init

▸ init(pixelId: string, advancedMatching: object, options: object): boolean

Defined in index.ts:4

Parameters:

▪ pixelId: string

▪Default value advancedMatching: object= {}

▪Default value options: object= { autoConfig: true }

Returns: boolean

Const track

▸ track(trackType: TrackType, options?: any): boolean

Defined in index.ts:39

Parameters:

Returns: boolean

Const trackCustom

▸ trackCustom<T>(trackType: T, options?: any): boolean

Defined in index.ts:49

Type parameters:

▪ T: string

Parameters:

Returns: boolean

License

License: MIT