An Angular library to simplify the use of a Facebook Pixel with support for eventID to fortify Facebook deduplication with ConversionsAPI reports.
npm install ngx-pixel-eventid
An Angular library to simplify tracking using a Facebook Pixel with support for the eventID argument.
head section of all pages, after which you can use the fbq function. However, in Angular it's not as straight-forward. The main two problems are as follows:
npm install ngx-pixel-eventid
app.module.ts. Make sure you use the forRoot() method. Within this method, add your Facebook Pixel ID.
typescript
import { PixelModule } from 'ngx-pixel-eventid';
@NgModule({
declarations: [
AppComponent
],
imports: [
BrowserModule,
PixelModule.forRoot({ enabled: true, pixelId: 'YOUR_PIXEL_ID' })
],
providers: [],
bootstrap: [AppComponent]
})
export class AppModule { }
`
$3
Add the library as an imported provider into the providers array in the app.config.ts file:
`typescript
import { PixelModule } from 'ngx-pixel-eventid';
export const appConfig: ApplicationConfig = {
providers: [
importProvidersFrom(
PixelModule.forRoot({ enabled: true, pixelId: 'YOUR_PIXEL_ID' })
),
]
};
`
NOTE: By default, the library does not start tracking immediately. In most cases this requires user consent to comply with GDPR and other privacy regulations. If you would still like start tracking as soon as your app module loads, include the enabled: true parameter in when you call forRoot().
3. Add it to your components/service
In any component where you would like to track certain events, you can import the ngx-pixel service with import { PixelService } from 'ngx-pixel-eventid';
Then you can inject the service into your component as follows:
`TypeScript
export class HomeComponent {
constructor(
private pixel: PixelService
) { }
}
`
4. Tracking events
There are two groups of events that you can track, namely Standard events and Custom events.
$3
Standard events are common events that Facebook has created. You can find the full list here. You can track a Standard event like this:
!Track Standard events using ngx-pixel
The first argument is the type of event as defined by Facebook. The optional second argument can be used to pass more information about the event. The optional third argument is the eventID you generated that you also send with the ConversionAPI request call for this event. E.g.:
`typescript
this.pixel.track('InitiateCheckout', {
content_ids: ['ABC123', 'XYZ456'], // Item SKUs
value: 100, // Value of all items
currency: 'USD' // Currency of the value
}, {
eventID: 'OMG987'
});
`
$3
Tracking Custom events works very similar to tracking Standard events. The only major difference is that there are no TypeScript interfaces and therefore no Intellisense. This is because the event name and optional properties can be anything. Tracking a custom event with ngx-pixel looks like this:
`TypeScript
this.pixel.trackCustom('MyCustomEvent');
`
And just like with Standard events, you can add more properties and the eventID. Adding properties is recommended, since this enables you to create even more specific audiences within Facebook Business Manager. Which properties you add is completely up to you. Here is an example:
`TypeScript
this.pixel.trackCustom('MyCustomEvent', {
platform: 'limewire'
}, {
eventID: 'OMG987'
})
`
---
Enabling and disabling ngx-pixel
ngx-pixel is disabled by default. In many cases, tracking without user consent is not allowed by privacy regulations like the European GDPR. ngx-pixel also doesn't inject the Facebook scripts until it is iniaitlized (upon consent), which helps cut down the initial loading size and time of your application.
Enabling ngx-pixel immediately
It is still possible to initialize ngx-pixel as soon as your app module loads.
When adding ngx-pixel to app.module.ts, add the parameter enabled: true.
`TypeScript
imports: [
BrowserModule,
PixelModule.forRoot({ enabled: true, pixelId: 'YOUR_PIXEL_ID'})
],
`
Enabling ngx-pixel from a component
You can also enable ngx-pixel from within any of your components, like so:
`TypeScript
export class HomeComponent {
constructor(
private pixel: PixelService
) { }
onConsent(): void {
this.pixel.initialize();
}
}
`
Enabling with a dynamic Pixel ID
In situations where the Pixel ID needs to be changed dynamically, this can be done using initialize() with the new Pixel ID as an optional argument.
Notes:
- A Pixel ID still needs to be provided when importing ngx-pixel in the module.
- The previous instance should be removed with remove() before initializing a new Pixel ID.
- This approach should not be used in combination with serverside rendering (SSR). As the module is initialized on each request, the Pixel script will default to the ID provided in the module.
Disabling ngx-pixel
Disabling works very similar to enabling from within a component and looks like this:
`TypeScript
export class HomeComponent {
constructor(
private pixel: PixelService
) { }
onRevokeConsent(): void {
this.pixel.remove();
}
}
``