Facebook Pixel Tag Setup Guide - Tealium Learning Center

To make Facebook Pixel Event IDs available as server-side attributes, set Generate Event ID to true and use the latest version of the ... Expand/CollapseMenu TLC Home Home Discussions&Ideas Discussions&Ideas ProductGuides ProductGuides KnowledgeBase KnowledgeBase DeveloperDocs DeveloperDocs Education Education Blog Blog SupportDesk SupportDesk SignInHelp Client-SideTags AllSectionsThisSectionDocumentationUsers Turnonsuggestions Auto-suggesthelpsyouquicklynarrowdownyoursearchresultsbysuggestingpossiblematchesasyoutype. Showingresultsfor  Show  only  | Searchinsteadfor  Didyoumean:  TLC : ProductGuides : Client-SideTags : FacebookPixelTagSetupGuide ArticleOptions ArticleHistory SubscribetoRSSFeed EmailtoaFriend PrinterFriendlyPage FlagPost Options SubscribetoRSSFeed EmailtoaFriend PrinterFriendlyPage FlagPost FacebookPixelTagSetupGuide ThisarticledescribeshowtosetuptheFacebookPixeltaginyourTealiumiQTagManagementaccount. ForinformationaboutthelegacyFacebookPixel,seeFacebookPixelSetupGuide(Legacy). Inthisarticle: TableofContentsPlaceholder HowitWorks TagOverview PurchasetrackingoccursautomaticallywhenanorderIDispopulated. Youmayenteracomma-separatedlistofPixelIDsinthePixelIDfield. TomakeFacebookPixelEventIDsavailableasserver-sideattributes,setGenerateEventIDtotrueandusethelatestversionoftheTealiumCollecttag. Thetemplateautomaticallyattemptstocalculatethenum_itemsvalueifaproductquantityarrayispresent. Usemappingto: ToggletrackSingle(truebydefault) ToggledisablePushState(falsebydefault) Dynamicallysetthetagconfigurations OverridetheE-Commerceextensionvalues SupportstheseE-Commerceextensionparameters: OrderID SubTotal Currency ListofProductIDs ListofProductCategories ListofProductPrices ListofProductQuantities ListofProductNames ConversionsAPIforWeb TosupporttheFacebookConversionsAPIforWeb,thetaggeneratesauniqueeventIDforeacheventtrackedandsendittoTealiumEventStreamforuseintheFacebookConversionsconnector.TheeventIDmaybemappedintheconnectortosynchronizetheweb-basedonserver-basedintegrations.ThisfeaturerequiresanactiveTealiumCollecttag. Thetagemitsneweventattributesusingthefollowingnamingconvention: fb_event_id__ Forexample:fb_event_id_Purchase_32:"028b2ade7478..."orfb_event_id_PageView_32 IDswerepreviouslygeneratedasfb_event_id_.TheseIDswillcontinuetobegeneratedbutareconsideredlegacy.ThenewIDsallowforusewithmultipleFacebooktagsfiringonasinglepageandofferastrongertiebacktotherelatedtag.Ifyouareusingthelegacyversion,youmustchangetheconnectortothenewID. SeetheFacebookConversionsConnectorSetupGuide. TagConfiguration First,gototheTealiumTagMarketplaceandaddtheFacebookPixeltag(Learnmoreabouthowtoaddatag). Afteraddingthetag,configurethefollowingsettings: PixelID YourFacebookPixelID. ThePixelIDappearsasalongseriesofnumbersinthecodesnippet. YoumayentermultiplePixelIDsusingacomma-separatedlist,withoutspaces. Example:fbq("init","12345678901234"); AdvancedMatching EnableandpassdatatotheFacebookAdvancedMatchingservice. Example:fbq("init","12345678901234",{em:"6dd8b7d7..."}); GenerateEventID AutomaticallygenerateaneventIDforeveryFacebooktrackingevent. EventIDattributesfollowthenamingconvention:fb_event_id_ Example:fb_event_id_Purchase:"028b2ade7478..." EventMapping FacebookPixeleventsareconfiguredthroughdatamappingsbyselectingavariablethatmapstoaneventandenteringatrigger.Thetriggerinitiatestheeventwhenthevariableisequaltoaspecificvalue,asdemonstratedinthefollowingusecase. UseCase:PurchaseEvent Tosetupapurchaseevent: Selecttealium_eventfromthevariabledrop-downlistandclickSelectaDestination. IntheCategorysection,selectEvents. SettheWhenmappedvariableequalsfieldtoPurchase,whichisthevaluetealium_eventmustequaltotriggerapurchase. IntheTriggereventdrop-downlist,selectPurchase,whichistheeventthatistriggeredwhentealium_eventequalspurchase.Ifadditionaldataneedstobesentwiththepurchaseeventthatisnotalreadycoveredbythebuilt-inE-Commerceextensionmappings,useCustomParameterstomapadditionalpurchasedata. Thefollowingexamplepassestheproductbrandwiththepurchaseevent: Selectproduct_brandfromthevariabledrop-downlistandclickSelectaDestination. IntheCategorysection,selectEventspecificParameters. SettheDestinationfieldtothenamebrandfortheCustomParameter. IntheForeventdrop-downlist,selecttheeventPurchasewhichtheCustomParametercollectswith. TestthemappingsbyusingtheFacebookPixelHelperortheDeveloperToolsofferedbyyourbrowser. UsetheNetworkPanelandfilteringforFacebooktodisplayallthenetworkrequestscontainingFacebookasakeyword. Confirmthepurchaseeventwassuccessfulbylookingatthenameoftherequest. OpentherequestandscrolldowntotheQueryStringParameterstoseethevaluesofthethedatamappingsthatwereconfigured:purchase,product_id,andproduct_brand. DataMappings Datamappingsfollowahierarchyinwhichspecificmappings,suchasEvent-SpecificParameters,takeprecedenceovermoregeneralmappings.Forexample,ifyoumapavariabletotheCurrencydestinationintheStandardTrackingParameterstabandtotheCurrencydestinationfortheViewContentevent,theViewContentmappingtakesprecedenceoverthegeneralmapping,butonlyfortheViewContentevent.Forallotherevents,theStandardTrackingmappingisused. Mappingistheprocessofsendingdatafromadatalayervariabletothecorrespondingdestinationvariableofthevendortag.Forinstructionsonhowtomapavariabletoatagdestination,seeDataMappings. Theavailablecategoriesare: TagConfigurations Destination Variable Type Description PixelID pixel_id [String] YourFacebookPixelID. ThePixelIDappearsasalongseriesofnumbersinthecodesnippet. YoumayentermultiplePixelIDsusingacomma-separatedlist,withoutspaces. Example:fbq("init","12345678901234"); ToggleAutomaticPageView auto_page_view Boolean [true/false] ToggletoenableordisableautomaticPageViewtracking. ToggleswhetherornottoautomaticallytriggeraPageVieweventwithapageload. Defaultvalueistrue. ToggleAdvancedMatching advanced_matching Boolean [true/false] ToggletoenableordisablethecollectionofAdvancedMatchingdata. Toggleswhetherornottocaptureandsendadvancedmatchingdata. Defaultvalueistrue. GenerateEventIDs generate_event_id Boolean [true/false] ToggletoenableordisablethegenerationofEventIDsforeachFacebooktrackingevent. ToggleswhetherornotauniqueEventIDisgeneratedforeachFacebooktrackingevent. Requiresthemostrecentversionoftheutag.jsfileinordertogeneratetheIDs. Defaultvalueisfalse. AutomaticallyCalculateNumberofItems calc_items Boolean [true/false] Toggletocontrolwhetherornottoautomaticallydeterminethenumberofitemsforanevent. UsesthedatamappedtoProductQuantitiestodeterminethenumber. ToggleswhetherornottoautomaticallycalculatethenumberofitemsinaFacebooktrackingeventbasedonthenumberofitemsintheproduct_quantityarray. Defaultvalueistrue. ToggletrackSingleUsage track_single Boolean [true/false] EnableordisabletheuseoftrackSingleforFacebooktrackingevents. ToggleswhetherornottousetrackSingleforFacebookPixeltrackingcalls. Defaultvalueistrue. Ifsettofalse,thevaluetrackisusedforallFacebooktrackingcalls. ToggledisablePushStateUsage disablePushState Boolean [true/false] TogglesthedisablePushStatesetting. ToggletoenableordisablethedisablePushStateoptionwhichcontrolswhetherornottopreventthetriggeringofmultiplePageViewsonthesamepage(forSinglePageApps). Defaultvalueisfalse. AdvancedMatching Destination Variable Type Description Email am.em [String] Emailaddress FirstName am.fn [String] Firstname LastName am.ln [String] Lastname PhoneNumber am.ph [String] Telephonenumber Gender am.ge [String] Gender DateofBirth am.db [String] Dateofbirth City am.ct [String] City State am.st [String] State Zip am.zp [String] ZipCode ExternalID am.external_id [String] ExternalID E-Commerce SincetheFacebookPixeltagise-commerceenabled,itautomaticallyusesthedefaultE-CommerceExtensionmappings.Manuallymappinginthiscategoryisnotneededunlessyouwanttooverrideanyextensionmappingsoryourdesirede-commercevariableisnotofferedintheextension. Destination Variable Description E-CommerceExtensionVariable OrderID order_id Uniqueidentifierassignedtothefinalorder. Overrides_corder. _corder SubTotal sub_total Subtotalamountofthefinalorder. Overrides_csubtotal. _csubtotal Currency order_currency Currencyusedinthepayment. Overrides_ccurrency. _ccurrency ListofProductIDs product_id Uniqueidentifierofeachproductintheproductarray. Overrides_cprod. _cprod ListofProductNames product_name Nameofeachproductintheproductarray. Overrides_cprodname. _cprodname ListofProductQuantities product_quantity Quantityofproductsintheproductarray. Overrides_cquan. _cquan ListofCategories product_category Categoryofeachproductintheproductarray. Overrides_ccat. _ccat ListofPrices product_unit_price Unitpriceofeachproductintheproductarray. Overrides_cprice. _cprice StandardTrackingParameters Destination Variable Type Description Currency currency [String] Thecurrencyforthevalueoftheevent. ContentCategory content_category [Array,String] Categoryofthepage/product. ContentName content_name [Array,String] Nameofthepage/product ContentIDs content_ids [Array] TheproductIDsorSKUsassociatedwiththeevent ContentType content_type [String] TheproducttypeassociatedwiththecontentIDs,whichmatchesthetypesgiveninyourFacebookproductfeed. Inmostcasesthisiseitherproductorproduct_group. DynamicAdshaveotherlegitimatevaluesforeachbusinessvertical. Contents contents [Array,JSONObject] AnarrayofJSONobjectsthatcontainsthequantityandthecontentIDs. PredictedLifetimeValue predicted_ltv [String] Predictedlifetimevalueofasubscriberasdefinedbytheadvertiser. Expressedasanexactvalue SearchString search_string [String] UsedwiththeSearchevent. Thestringenteredbythevisitorforthesearch. Status status [String] UsedwiththecompleteRegistrationevent. Thestatusoftheregistration. NumberofItems num_items [Number] Thenumberofitemsfortheevent. Thenumberofitemsisautomaticallycalculatedbasedonthevaluesinthedatamappedforquantity. Disabletheautomaticcalculationbysettingcalc_items(u.data.calc_items)tofalse,usingdatamappingoranextension. Value value [String] Thevalueofauserperformingthiseventtothebusiness. ContentType Setthecontent_typeparameterbymappingtoitdirectlyineithertheStandardTrackingParameterstab,ortheEvent-specificParametermappings. TheContentTypetaballowsyoutoconditionallysetthecontent_typeparametertoanyofthefollowingsupportedvalues: destination flight home_listing hotel product product_group vehicle Ifthemappedvariableequalsthevalueyouenterinthefield,thenthevalueissettothetypeyouselectfromthedrop-downlist.Inmostcases,thevaluesproductorproduct_groupareused,andthatvaluemustmatchthecontent_typeyouspecifyfortheproductsinyourproductfeeduploadedtoFacebook.OthervaluesaremostcommonlyusedwithDynamicAds. Variable Description destination Destination. flight Flight. home_listing HomeListing. hotel Hotel. product Product. product_group ProductGroup. vehicle Vehicle. Events EventName Description AddPaymentInfo Addpaymentinformation. AddToCart Addtocart. AddToWishlist Addtowishlist. CompleteRegistration Completeregistration. Contact Contact. CustomizeProduct Customizeproduct. Donate Donate. FindLocation Findlocation. InitiateCheckout Initiatecheckout. Lead Lead. PageView Pageview. Purchase Purchase. Schedule Schedule. Search Search. StartTrial Starttrial. SubmitApplication Submitapplication. Subscribe Subscribe. ViewContent Viewcontent. Custom Enterthenameofyourcustomeventinthefieldprovided. Event-specificParameters Inordertomapaparameterforaspecificeventonly,firstselectthenameoftheparameterfromthedrop-downlist, Enterthenameoftheparameteryouwanttosetandthenselectthenameoftheeventforwhichyouwanttosetthatparameter. Ifyouaremappingaparameterforacustomevent,youmustenterthenameofthecustomeventinthefieldthatappears. Ifyouwanttoenteracustomparametername,selecttheCustomoptionfromtheparameterdrop-downlistandenterthenameofthecustomparameterinthefieldthatdisplays. Ifyouwanttospecifyacustomeventfortheevent-specificmappingtooccur,selecttheCustomoptionfromtheeventsdrop-downlistandenterthenameofthecustomeventinthefieldthatdisplays. Variable Description AddPaymentInfo Addpaymentinformation. AddToCart Addtocart. AddToWishlist Addtowishlist. CompleteRegistration Completeregistration. Contact Contact. CustomizeProduct Customizeproduct. Donate Donate. FindLocation Findlocation. InitiateCheckout Initiatecheckout. Lead Lead. PageView Pageview. Purchase Purchase. Schedule Schedule. Search Search. StartTrial Starttrial. SubmitApplication Submitapplication. Subscribe Subscribe. ViewContent Viewcontent. Custom Custom. AutomotiveParameters Destination Variable Description BodyStyle body_style Bodystyle. ConditionofVehicle condition_of_vehicle Conditionofvehicle. Country country Country. Drivetrain drivetrain Drivetrain. ExteriorColor exterior_color Exteriorcolor. FuelType fuel_type Fueltype. InteriorColor interior_color Interiorcolor. LeadType lead_type Leadtype. Make make Make. Model model Model. PostalCode postal_code Postalcode. PreferredPriceRange preferred_price_range Array. Preferredpricerange. Mustbeanarraythatcontainstheminimumandmaximumpreferredprices. Price price Price. RegistrationType registration_type Registrationtype. SearchType search_type Searchtype. StateofVehicle state_of_vehicle Stateofvehicle. Transmission transmission Transmission. Trim trim Trim. ViewContentType viewcontent_type Viewcontenttype. VIN vin VINnumber Year year Year. DestinationParameters Variable Description city City. country Country. num_adults Numberofadults. num_children Numberofchildren. region Region. suggested_destinations Array. Suggesteddestinations. Mustbeanarrayofthesuggesteddestinations. travel_start Travelstartdate. travel_end Travelenddate. FlightParameters Variable >Description departing_arrival_date Departingarrivaldate. departing_departure_date Departingdeparturedate. destination_ids DestinationIDs. num_adults Numberofadults. num_children Numberofchildren. num_infants Numberofinfants. preferred_num_stops Preferrednumberofstops. price Price. returning_arrival_date Returningarrivaldate. returning_departure_date Returningdeparturedate. travel_class Travelclass. user_score Userscore. HotelParameters Variable Description checkin_date Check-indate. checkout_date Check-outdate. city City. country Country. destination_ids Array. DestinationIDs. MustbeanarraythatcontainsDestinationIDs. hotel_score Hotelscore. num_adults Numberofadults. num_children Numberofchildren. preferred_neighborhoods Array. Preferredneighborhoods. preferred_price_range Array. Preferredpricerange. preferred_star_ratings Preferredstarratings. region Region. user_score Userscore. MovieParameters Variable Description movieref Moviereferrer. RealEstateParameters Variable Description availability Availability. city City. country Country. lease_start_date Leasestartdate. lease_end_date Leaseenddate. listing_type Listingtype. neighborhood Neighborhood. preferred_baths_range Array. Preferredbathsrange. preferred_beds_range Array. Preferredbedsrange. preferred_price_range Array. Preferredpricerange. property_type Propertytype. region Region. CookieConsent Variable Description grant grantcookieconsent revoke revokecookieconsent LimitedDataUse Variable Description   lmt_data.use_ldu(UseLDU) Iftrue,useFacebook’sLimitedDataUseoption Iffalse,donotuseFacebook’sLimitedDataUseoption lmt_data.ldu_types.geolocate(LDUshouldGeolocate) Iftrue,theLDUgeolocatestheuser. Iffalse,theLDUdoesnotgeolocatetheuser.If“UseLDU”isenabled,then“LDUshouldGeolocate”isalsoenabledbydefault. lmt_data.ldu_types.california(LDUisCalifornia) Iftrue,setsthestateandcountryCalifornia-specificvaluesinsidethetemplate.OnlyenablethisoptioniftheuserislocatedinCaliforniaandneedstobeprocessedwithLimitedDataUse. Iffalse,doesnotsettheuser’sstateandcountryCalifornia-specificvaluesinsidethetemplate. VendorDocumentation Seethefollowingvendordocumentationformoreinformation: FacebookPixelDeveloperDocumentation. MigratingfromDeprecatedPixels Reference:StandardandCustomEvents TheFacebookPixelFAQ AdvertiserHelpCenter:UsingFacebookPixelwithTealium ConversionTrackingwiththePixel Versionhistory Lastupdate: ‎11-09-2020 09:25AM Updatedby: Tony_Taliaferro RelatedTopics BranchMobileRemoteCommandTagSetupGuide AmobeePixelTagSetupGuide TikTokPixelTagSetupGuide EmarketeerTagSetupGuide MNTNSmarterPixelTagSetupGuide LinkedInInsightTagSetupGuide Products TealiumiQTagManagement TealiumEventStream TealiumAudienceStream TealiumDataAccess TealiumforMobile Company Tealium.com Blog Careers ContactUs Events CopyrightAllRightsReserved©2008-2021 Public