Class Fbq

Implements

FbqCaller

Index

Properties

Accessors

Methods

track trackCustom init track trackCustom

Properties

`Protected`pixelId

pixelId: string

Accessors

fbq

get fbq(): FbqFunction
Gets the instance of the Facebook Pixel (fbq).

Returns FbqFunction
The global fbq instance.

Throws
Will throw an error if the Fbq instance is not initialized.
- Defined in packages/pixel/dist/browser/lib/Tracking/Facebook/Fbq.d.ts:41

`Static`fbq

get fbq(): FbqFunction
Gets the instance of the Facebook Pixel (fbq).

Returns FbqFunction
The global fbq instance.

Throws
Will throw an error if the Fbq instance is not initialized.
- Defined in packages/pixel/dist/browser/lib/Tracking/Facebook/Fbq.d.ts:34

Methods

track

track(
    event: FacebookStandardEventNames,
    data?: JsonObject,
    eventID?: string,
): void
Tracks a specified Facebook standard event using the Facebook Pixel. This will only call the pixel with the specified eventID.
Parameters
- event: FacebookStandardEventNames
  The Facebook standard event to track.
- Optionaldata: JsonObject
  Optional additional data to send with the event.
- OptionaleventID: string
  An optional unique identifier for the event.
Returns void
Implementation of FbqCaller.track
- Defined in packages/pixel/dist/browser/lib/Tracking/Facebook/Fbq.d.ts:76

trackCustom

trackCustom(event: string, data: JsonObject, eventID?: string): void
Tracks a custom event using Facebook's tracking pixel. This will only call the pixel with the specified eventID.
Parameters
- event: string
  The name of the custom event to track.
- data: JsonObject
  An object containing additional data to send with the event.
- OptionaleventID: string
  An optional unique identifier for the event.
Returns void
Implementation of FbqCaller.trackCustom
- Defined in packages/pixel/dist/browser/lib/Tracking/Facebook/Fbq.d.ts:85

`Static`init

init(pixelId: string): Fbq
Initializes the Fbq instance with the given pixel ID.
Parameters
- pixelId: string
  The Facebook Pixel ID to initialize the Fbq instance with.
Returns Fbq
A new instance of Fbq.

Throws
Will throw an error if the Fbq instance is not initialized.
- Defined in packages/pixel/dist/browser/lib/Tracking/Facebook/Fbq.d.ts:49

`Static`track

track(
    event: FacebookStandardEventNames,
    data?: JsonObject,
    eventID?: string,
): void
Tracks a Facebook standard event using the Facebook Pixel. This will call all initialized pixels.
Parameters
- event: FacebookStandardEventNames
  The Facebook standard event to track.
- Optionaldata: JsonObject
  Optional additional data to send with the event.
- OptionaleventID: string
  An optional unique identifier for the event.
Returns void
- Defined in packages/pixel/dist/browser/lib/Tracking/Facebook/Fbq.d.ts:58

`Static`trackCustom

trackCustom(event: string, data: JsonObject, eventID?: string): void
Tracks a custom event using Facebook's tracking pixel. This will call all initialized pixels.
Parameters
- event: string
  The name of the custom event to track.
- data: JsonObject
  An object containing additional data to send with the event.
- OptionaleventID: string
  An optional unique identifier for the event.
Returns void
- Defined in packages/pixel/dist/browser/lib/Tracking/Facebook/Fbq.d.ts:67