casraf/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/chenasraf/DefinitelyTyped.git synced 2026-05-18 01:49:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

🤖 Merge PR #65728 [facebook-pixel] Add eventID option by @araj-dev

Browse Source
This commit is contained in:
araj
2023-06-09 20:13:36 +09:00
committed by GitHub
parent 1671d2ed2b
commit 4bd2af332d
2 changed files with 48 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
types/facebook-pixel/facebook-pixel-tests.ts
View File

@@ -66,3 +66,18 @@ fbq('track', 'Purchase',
content_type: 'product'
}
);
// Any event can contain an eventID parameter to deduplicate events sent
// https://developers.facebook.com/docs/marketing-api/conversions-api/deduplicate-pixel-and-server-events
fbq('track', 'PageView', {}, {eventID: 'my-event-id'});
fbq('track', 'ViewContent', {
content_name: 'The Avengers Trailer',
content_category: 'Entertainment',
value: 1.50,
currency: 'USD',
}, {eventID: 'my-event-id'});
fbq('trackSingle', '<FB_PIXEL_ID>', 'ViewContent', viewContentParam, {eventID: 'my-event-id'});
fbq('trackCustom', 'MyCustomEvent', custom_params, {eventID: 'my-event-id'});

60
types/facebook-pixel/index.d.ts vendored
View File

@@ -11,34 +11,36 @@ declare module facebook.Pixel {
interface Event {
(eventType:string, InitialAppId:string):void;
(eventType:string, InitialAppId:string, eventName:string,
parameters:
facebook.Pixel.ViewContentParameters |
ViewContentParameters |
SearchParameters |
AddToCartParameters |
AddToWishlistParameters |
InitiateCheckoutParameters |
AddPaymentInfoParameters |
PurchaseParameters |
LeadParameters |
CompleteRegistrationParameters
):void;
(eventType:string, eventName:string):void;
(eventType:string, eventName:string, parameters:facebook.Pixel.ViewContentParameters):void;
(eventType:string, eventName:string, parameters:ViewContentParameters):void;
(eventType:string, eventName:string, parameters:SearchParameters):void;
(eventType:string, eventName:string, parameters:AddToCartParameters):void;
(eventType:string, eventName:string, parameters:AddToWishlistParameters):void;
(eventType:string, eventName:string, parameters:InitiateCheckoutParameters):void;
(eventType:string, eventName:string, parameters:AddPaymentInfoParameters):void;
(eventType:string, eventName:string, parameters:PurchaseParameters):void;
(eventType:string, eventName:string, parameters:LeadParameters):void;
(eventType:string, eventName:string, parameters:CompleteRegistrationParameters):void;
(eventType:string, eventName:string, parameters:CustomParameters):void;
parameters:
facebook.Pixel.ViewContentParameters |
ViewContentParameters |
SearchParameters |
AddToCartParameters |
AddToWishlistParameters |
InitiateCheckoutParameters |
AddPaymentInfoParameters |
PurchaseParameters |
LeadParameters |
CompleteRegistrationParameters |
CustomParameters,
option?: EventIDOptions):void;
(eventType:string, eventName:string, parameters:facebook.Pixel.DPA.AddToCartParameters):void;
(eventType:string, eventName:string, parameters:facebook.Pixel.DPA.PurchaseParameters):void;
(eventType:string, eventName:string, parameters:facebook.Pixel.DPA.ViewContentParameters):void;
(eventType:string, eventName:string):void;
(eventType:string, eventName:string, parameters:facebook.Pixel.ViewContentParameters, option?: EventIDOptions):void;
(eventType:string, eventName:string, parameters:ViewContentParameters, option?: EventIDOptions):void;
(eventType:string, eventName:string, parameters:SearchParameters, option?: EventIDOptions):void;
(eventType:string, eventName:string, parameters:AddToCartParameters, option?: EventIDOptions):void;
(eventType:string, eventName:string, parameters:AddToWishlistParameters, option?: EventIDOptions):void;
(eventType:string, eventName:string, parameters:InitiateCheckoutParameters, option?: EventIDOptions):void;
(eventType:string, eventName:string, parameters:AddPaymentInfoParameters, option?: EventIDOptions):void;
(eventType:string, eventName:string, parameters:PurchaseParameters, option?: EventIDOptions):void;
(eventType:string, eventName:string, parameters:LeadParameters, option?: EventIDOptions):void;
(eventType:string, eventName:string, parameters:CompleteRegistrationParameters, option?: EventIDOptions):void;
(eventType:string, eventName:string, parameters:CustomParameters, option?: EventIDOptions):void;
(eventType:string, eventName:string, parameters:facebook.Pixel.DPA.AddToCartParameters, option?: EventIDOptions):void;
(eventType:string, eventName:string, parameters:facebook.Pixel.DPA.PurchaseParameters, option?: EventIDOptions):void;
(eventType:string, eventName:string, parameters:facebook.Pixel.DPA.ViewContentParameters, option?: EventIDOptions):void;
}
@@ -120,6 +122,10 @@ declare module facebook.Pixel {
}
type CustomParameters = Record<string,any>;
interface EventIDOptions {
eventID:string;
}
}
// For Facebook Tag API using Dynamic Product Ads