Measurement Protocol Parameter Reference

This documentation is for Universal Analytics. See Measurement Protocol (Google Analytics 4) if you are using Google Analytics 4. Google Analytics Measurement MeasurementProtocol(UniversalAnalytics) Language English BahasaIndonesia Deutsch Español Français Português–Brasil Русский 中文–简体 日本語 한국어 Signin Guides Reference Support Google Analytics Measurement MeasurementProtocol(UniversalAnalytics) Guides Reference Support ProtocolReference ParameterReference GeographicalIDs ThisdocumentationisforUniversalAnalytics.SeeMeasurementProtocol(GoogleAnalytics4)ifyouareusingGoogleAnalytics4. Home Products GoogleAnalytics Measurement MeasurementProtocol(UniversalAnalytics) Reference MeasurementProtocolParameterReference ThisdocumentlistsalloftheparametersfortheMeasurementProtocol. General User Session TrafficSources SystemInfo Hit ContentInformation Apps Events E-Commerce EnhancedE-Commerce SocialInteractions Timing Exceptions CustomDimensions/Metrics General ProtocolVersion Requiredforallhittypes. TheProtocolversion.Thecurrentvalueis'1'.Thiswillonlychangewhentherearechangesmadethatarenotbackwardscompatible. Parameter ValueType DefaultValue MaxLength SupportedHitTypes v text None None all Examplevalue:1 Exampleusage:v=1 TrackingID/WebPropertyID Requiredforallhittypes. ThetrackingID/webpropertyID.TheformatisUA-XXXX-Y.AllcollecteddataisassociatedbythisID. Parameter ValueType DefaultValue MaxLength SupportedHitTypes tid text None None all Examplevalue:UA-XXXX-Y Exampleusage:tid=UA-XXXX-Y AnonymizeIP Optional. Whenpresent,theIPaddressofthesenderwillbeanonymized.Forexample,theIPwillbeanonymizedifanyofthefollowingparametersarepresentinthepayload:&aip=,&aip=0,or&aip=1 Parameter ValueType DefaultValue MaxLength SupportedHitTypes aip boolean None None all Examplevalue:1 Exampleusage:aip=1 DisablingAdvertisingPersonalization Optional. Usethisparametertomarkaneventasdisabledforadvertisingpersonalization,includingforeventsfromapropertywithasettingthatotherwisepermitsadspersonalization.Forexample,ifatransactionismarkedtodisableadvertisingpersonalization,itwon'tbeusedwhenpopulatingaremarketingaudiencefor"pastpurchasers". Parameter ValueType DefaultValue MaxLength SupportedHitTypes npa boolean None None all Examplevalue:1 Exampleusage:npa=1 DataSource Optional. Indicatesthedatasourceofthehit.Hitssentfromanalytics.jswillhavedatasourcesetto'web';hitssentfromoneofthemobileSDKswillhavedatasourcesetto'app'. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ds text None None all Examplevalue:web Exampleusage:ds=web Examplevalue:app Exampleusage:ds=app Examplevalue:callcenter Exampleusage:ds=call%20center Examplevalue:crm Exampleusage:ds=crm QueueTime Optional. Usedtocollectoffline/latenthits.Thevaluerepresentsthetimedelta(inmilliseconds)betweenwhenthehitbeingreportedoccurredandthetimethehitwassent.Thevaluemustbegreaterthanorequalto0.Valuesgreaterthanfourhoursmayleadtohitsnotbeingprocessed. Parameter ValueType DefaultValue MaxLength SupportedHitTypes qt integer None None all Examplevalue:560 Exampleusage:qt=560 CacheBuster Optional. UsedtosendarandomnumberinGETrequeststoensurebrowsersandproxiesdon'tcachehits.Itshouldbesentasthefinalparameteroftherequestsincewe'veseensome3rdpartyinternetfilteringsoftwareaddadditionalparameterstoHTTPrequestsincorrectly.Thisvalueisnotusedinreporting. Parameter ValueType DefaultValue MaxLength SupportedHitTypes z text None None all Examplevalue:289372387623 Exampleusage:z=289372387623 User ClientID Optional. ThisfieldisrequiredifUserID(uid)isnotspecifiedintherequest.Thispseudonymouslyidentifiesaparticularuser,device,orbrowserinstance.Fortheweb,thisisgenerallystoredasafirst-partycookiewithatwo-yearexpiration.Formobileapps,thisisrandomlygeneratedforeachparticularinstanceofanapplicationinstall.ThevalueofthisfieldshouldbearandomUUID(version4)asdescribedinhttp://www.ietf.org/rfc/rfc4122.txt. Parameter ValueType DefaultValue MaxLength SupportedHitTypes cid text None None all Examplevalue:35009a79-1a05-49d7-b876-2b884d0f825b Exampleusage:cid=35009a79-1a05-49d7-b876-2b884d0f825b UserID Optional. ThisfieldisrequiredifClientID(cid)isnotspecifiedintherequest.Thisisintendedtobeaknownidentifierforauserprovidedbythesiteowner/libraryuser.ItmustnotitselfbePII(personallyidentifiableinformation).ThevalueshouldneverbepersistedinGoogleAnalyticscookiesorotherAnalyticsprovidedstorage. Parameter ValueType DefaultValue MaxLength SupportedHitTypes uid text None None all Examplevalue:as8eknlll Exampleusage:uid=as8eknlll Session SessionControl Optional. Usedtocontrolthesessionduration.Avalueof'start'forcesanewsessiontostartwiththishitand'end'forcesthecurrentsessiontoendwiththishit.Allothervaluesareignored. Parameter ValueType DefaultValue MaxLength SupportedHitTypes sc text None None all Examplevalue:start Exampleusage:sc=start Examplevalue:end Exampleusage:sc=end IPOverride Optional. TheIPaddressoftheuser.ThisshouldbeavalidIPaddressinIPv4orIPv6format.Itwillalwaysbeanonymizedjustasthough&aip(anonymizeIP)hadbeenused. Parameter ValueType DefaultValue MaxLength SupportedHitTypes uip text None None all Examplevalue:1.2.3.4 Exampleusage:uip=1.2.3.4 UserAgentOverride Optional. TheUserAgentofthebrowser.NotethatGooglehaslibrariestoidentifyrealuseragents.Handcraftingyourownagentcouldbreakatanytime. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ua text None None all Examplevalue:Opera/9.80(WindowsNT6.0)Presto/2.12.388Version/12.14 Exampleusage:ua=Opera%2F9.80%20%28Windows%20NT%206.0%29%20Presto%2F2.12.388%20Version%2F12.14 GeographicalOverride Optional. Thegeographicallocationoftheuser.ThegeographicalIDshouldbeatwolettercountrycodeoracriteriaIDrepresentingacityorregion(seehttp://developers.google.com/analytics/devguides/collection/protocol/v1/geoid).ThisparametertakesprecedentoveranylocationderivedfromIPaddress,includingtheIPOverrideparameter.Aninvalidcodewillresultingeographicaldimensionstobesetto'(notset)'. Parameter ValueType DefaultValue MaxLength SupportedHitTypes geoid text None None all Examplevalue:US Exampleusage:geoid=US Examplevalue:21137 Exampleusage:geoid=21137 TrafficSources DocumentReferrer Optional. Specifieswhichreferralsourcebroughttraffictoawebsite.Thisvalueisalsousedtocomputethetrafficsource.TheformatofthisvalueisaURL. Parameter ValueType DefaultValue MaxLength SupportedHitTypes dr text None 2048Bytes all Examplevalue:http://example.com Exampleusage:dr=http%3A%2F%2Fexample.com CampaignName Optional. Specifiesthecampaignname. Parameter ValueType DefaultValue MaxLength SupportedHitTypes cn text None 100Bytes all Examplevalue:(direct) Exampleusage:cn=%28direct%29 CampaignSource Optional. Specifiesthecampaignsource. Parameter ValueType DefaultValue MaxLength SupportedHitTypes cs text None 100Bytes all Examplevalue:(direct) Exampleusage:cs=%28direct%29 CampaignMedium Optional. Specifiesthecampaignmedium. Parameter ValueType DefaultValue MaxLength SupportedHitTypes cm text None 50Bytes all Examplevalue:organic Exampleusage:cm=organic CampaignKeyword Optional. Specifiesthecampaignkeyword. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ck text None 500Bytes all Examplevalue:BlueShoes Exampleusage:ck=Blue%20Shoes CampaignContent Optional. Specifiesthecampaigncontent. Parameter ValueType DefaultValue MaxLength SupportedHitTypes cc text None 500Bytes all Examplevalue:content Exampleusage:cc=content CampaignID Optional. SpecifiesthecampaignID. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ci text None 100Bytes all Examplevalue:ID Exampleusage:ci=ID GoogleAdsID Optional. SpecifiestheGoogleAdId. Parameter ValueType DefaultValue MaxLength SupportedHitTypes gclid text None None all Examplevalue:CL6Q-OXyqKUCFcgK2goddQuoHg Exampleusage:gclid=CL6Q-OXyqKUCFcgK2goddQuoHg GoogleDisplayAdsID Optional. SpecifiestheGoogleDisplayAdsId. Parameter ValueType DefaultValue MaxLength SupportedHitTypes dclid text None None all Examplevalue:d_click_id Exampleusage:dclid=d_click_id SystemInfo ScreenResolution Optional. Specifiesthescreenresolution. Parameter ValueType DefaultValue MaxLength SupportedHitTypes sr text None 20Bytes all Examplevalue:800x600 Exampleusage:sr=800x600 Viewportsize Optional. Specifiestheviewableareaofthebrowser/device. Parameter ValueType DefaultValue MaxLength SupportedHitTypes vp text None 20Bytes all Examplevalue:123x456 Exampleusage:vp=123x456 DocumentEncoding Optional. Specifiesthecharactersetusedtoencodethepage/document. Parameter ValueType DefaultValue MaxLength SupportedHitTypes de text UTF-8 20Bytes all Examplevalue:UTF-8 Exampleusage:de=UTF-8 ScreenColors Optional. Specifiesthescreencolordepth. Parameter ValueType DefaultValue MaxLength SupportedHitTypes sd text None 20Bytes all Examplevalue:24-bits Exampleusage:sd=24-bits UserLanguage Optional. Specifiesthelanguage. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ul text None 20Bytes all Examplevalue:en-us Exampleusage:ul=en-us JavaEnabled Optional. SpecifieswhetherJavawasenabled. Parameter ValueType DefaultValue MaxLength SupportedHitTypes je boolean None None all Examplevalue:1 Exampleusage:je=1 FlashVersion Optional. Specifiestheflashversion. Parameter ValueType DefaultValue MaxLength SupportedHitTypes fl text None 20Bytes all Examplevalue:101r103 Exampleusage:fl=10%201%20r103 Hit Hittype Requiredforallhittypes. Thetypeofhit.Mustbeoneof'pageview','screenview','event','transaction','item','social','exception','timing'. Parameter ValueType DefaultValue MaxLength SupportedHitTypes t text None None all Examplevalue:pageview Exampleusage:t=pageview Non-InteractionHit Optional. Specifiesthatahitbeconsiderednon-interactive. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ni boolean None None all Examplevalue:1 Exampleusage:ni=1 ContentInformation DocumentlocationURL Optional. UsethisparametertosendthefullURL(documentlocation)ofthepageonwhichcontentresides.Youcanusethe&dhand&dpparameterstooverridethehostnameandpath+queryportionsofthedocumentlocation,accordingly.TheJavaScriptclientsdeterminethisparameterusingtheconcatenationofthedocument.location.origin+document.location.pathname+document.location.searchbrowserparameters.BesuretoremoveanyuserauthenticationorotherprivateinformationfromtheURLifpresent.For'pageview'hits,either&dlorboth&dhand&dphavetobespecifiedforthehittobevalid. Parameter ValueType DefaultValue MaxLength SupportedHitTypes dl text None 2048Bytes all Examplevalue:http://foo.com/home?a=b Exampleusage:dl=http%3A%2F%2Ffoo.com%2Fhome%3Fa%3Db DocumentHostName Optional. Specifiesthehostnamefromwhichcontentwashosted. Parameter ValueType DefaultValue MaxLength SupportedHitTypes dh text None 100Bytes all Examplevalue:foo.com Exampleusage:dh=foo.com DocumentPath Optional. ThepathportionofthepageURL.Shouldbeginwith'/'.For'pageview'hits,either&dlorboth&dhand&dphavetobespecifiedforthehittobevalid. Parameter ValueType DefaultValue MaxLength SupportedHitTypes dp text None 2048Bytes all Examplevalue:/foo Exampleusage:dp=%2Ffoo DocumentTitle Optional. Thetitleofthepage/document. Parameter ValueType DefaultValue MaxLength SupportedHitTypes dt text None 1500Bytes all Examplevalue:Settings Exampleusage:dt=Settings ScreenName Requiredforscreenviewhittype. Thisparameterisoptionalonwebproperties,andrequiredonmobilepropertiesforscreenviewhits,whereitisusedforthe'ScreenName'ofthescreenviewhit.OnwebpropertiesthiswilldefaulttotheuniqueURLofthepagebyeitherusingthe&dlparameteras-isorassemblingitfrom&dhand&dp. Parameter ValueType DefaultValue MaxLength SupportedHitTypes cd text None 2048Bytes screenview Examplevalue:HighScores Exampleusage:cd=High%20Scores ContentGroup Optional. Youcanhaveupto5contentgroupings,eachofwhichhasanassociatedindexbetween1and5,inclusive.Eachcontentgroupingcanhaveupto100contentgroups.Thevalueofacontentgroupishierarchicaltextdelimitedby'/".Allleadingandtrailingslasheswillberemovedandanyrepeatedslasheswillbereducedtoasingleslash.Forexample,'/a//b/'willbeconvertedto'a/b'. Parameter ValueType DefaultValue MaxLength SupportedHitTypes cg text None 100Bytes all Examplevalue:news/sports Exampleusage:cg1=news%2Fsports LinkID Optional. TheIDofaclickedDOMelement,usedtodisambiguatemultiplelinkstothesameURLinIn-PageAnalyticsreportswhenEnhancedLinkAttributionisenabledfortheproperty. Parameter ValueType DefaultValue MaxLength SupportedHitTypes linkid text None None all Examplevalue:nav_bar Exampleusage:linkid=nav_bar Apps ApplicationName Optional. Specifiestheapplicationname.Thisfieldisrequiredforanyhitthathasapprelateddata(i.e.,appversion,appID,orappinstallerID).Forhitssenttowebproperties,thisfieldisoptional. Parameter ValueType DefaultValue MaxLength SupportedHitTypes an text None 100Bytes all Examplevalue:MyApp Exampleusage:an=My%20App ApplicationID Optional. Applicationidentifier. Parameter ValueType DefaultValue MaxLength SupportedHitTypes aid text None 150Bytes all Examplevalue:com.company.app Exampleusage:aid=com.company.app ApplicationVersion Optional. Specifiestheapplicationversion. Parameter ValueType DefaultValue MaxLength SupportedHitTypes av text None 100Bytes all Examplevalue:1.2 Exampleusage:av=1.2 ApplicationInstallerID Optional. Applicationinstalleridentifier. Parameter ValueType DefaultValue MaxLength SupportedHitTypes aiid text None 150Bytes all Examplevalue:com.platform.vending Exampleusage:aiid=com.platform.vending Events EventCategory Requiredforeventhittype. Specifiestheeventcategory.Mustnotbeempty. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ec text None 150Bytes event Examplevalue:Category Exampleusage:ec=Category EventAction Requiredforeventhittype. Specifiestheeventaction.Mustnotbeempty. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ea text None 500Bytes event Examplevalue:Action Exampleusage:ea=Action EventLabel Optional. Specifiestheeventlabel. Parameter ValueType DefaultValue MaxLength SupportedHitTypes el text None 500Bytes event Examplevalue:Label Exampleusage:el=Label EventValue Optional. Specifiestheeventvalue.Valuesmustbenon-negative. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ev integer None None event Examplevalue:55 Exampleusage:ev=55 E-Commerce TransactionID Requiredfortransactionhittype. Requiredforitemhittype. Auniqueidentifierforthetransaction.ThisvalueshouldbethesameforboththeTransactionhitandItemshitsassociatedtotheparticulartransaction. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ti text None 500Bytes transaction,item Examplevalue:OD564 Exampleusage:ti=OD564 TransactionAffiliation Optional. Specifiestheaffiliationorstorename. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ta text None 500Bytes transaction Examplevalue:Member Exampleusage:ta=Member TransactionRevenue Optional. Specifiesthetotalrevenueassociatedwiththetransaction.Thisvalueshouldincludeanyshippingortaxcosts. Parameter ValueType DefaultValue MaxLength SupportedHitTypes tr currency 0 None transaction Examplevalue:15.47 Exampleusage:tr=15.47 TransactionShipping Optional. Specifiesthetotalshippingcostofthetransaction. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ts currency 0 None transaction Examplevalue:3.50 Exampleusage:ts=3.50 TransactionTax Optional. Specifiesthetotaltaxofthetransaction. Parameter ValueType DefaultValue MaxLength SupportedHitTypes tt currency 0 None transaction Examplevalue:11.20 Exampleusage:tt=11.20 ItemName Requiredforitemhittype. Specifiestheitemname. Parameter ValueType DefaultValue MaxLength SupportedHitTypes in text None 500Bytes item Examplevalue:Shoe Exampleusage:in=Shoe ItemPrice Optional. Specifiesthepriceforasingleitem/unit. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ip currency 0 None item Examplevalue:3.50 Exampleusage:ip=3.50 ItemQuantity Optional. Specifiesthenumberofitemspurchased. Parameter ValueType DefaultValue MaxLength SupportedHitTypes iq integer 0 None item Examplevalue:4 Exampleusage:iq=4 ItemCode Optional. SpecifiestheSKUoritemcode. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ic text None 500Bytes item Examplevalue:SKU47 Exampleusage:ic=SKU47 ItemCategory Optional. Specifiesthecategorythattheitembelongsto. Parameter ValueType DefaultValue MaxLength SupportedHitTypes iv text None 500Bytes item Examplevalue:Blue Exampleusage:iv=Blue EnhancedE-Commerce ProductSKU Optional. TheSKUoftheproduct.Productindexmustbeapositiveintegerbetween1and200,inclusive.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes prid text None 500Bytes all Examplevalue:P12345 Exampleusage:pr1id=P12345 ProductName Optional. Thenameoftheproduct.Productindexmustbeapositiveintegerbetween1and200,inclusive.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes prnm text None 500Bytes all Examplevalue:AndroidT-Shirt Exampleusage:pr1nm=Android%20T-Shirt ProductBrand Optional. Thebrandassociatedwiththeproduct.Productindexmustbeapositiveintegerbetween1and200,inclusive.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes prbr text None 500Bytes all Examplevalue:Google Exampleusage:pr1br=Google ProductCategory Optional. Thecategorytowhichtheproductbelongs.Productindexmustbeapositiveintegerbetween1and200,inclusive.Theproductcategoryparametercanbehierarchical.Use/asadelimitertospecifyupto5-levelsofhierarchy.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes prca text None 500Bytes all Examplevalue:Apparel Exampleusage:pr1ca=Apparel Examplevalue:Apparel/Mens/T-Shirts Exampleusage:pr1ca=Apparel%2FMens%2FT-Shirts ProductVariant Optional. Thevariantoftheproduct.Productindexmustbeapositiveintegerbetween1and200,inclusive.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes prva text None 500Bytes all Examplevalue:Black Exampleusage:pr1va=Black ProductPrice Optional. Theunitpriceofaproduct.Productindexmustbeapositiveintegerbetween1and200,inclusive.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes prpr currency None None all Examplevalue:29.20 Exampleusage:pr1pr=29.20 ProductQuantity Optional. Thequantityofaproduct.Productindexmustbeapositiveintegerbetween1and200,inclusive.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes prqt integer None None all Examplevalue:2 Exampleusage:pr1qt=2 ProductCouponCode Optional. Thecouponcodeassociatedwithaproduct.Productindexmustbeapositiveintegerbetween1and200,inclusive.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes prcc text None 500Bytes all Examplevalue:SUMMER_SALE13 Exampleusage:pr1cc=SUMMER_SALE13 ProductPosition Optional. Theproduct'spositioninalistorcollection.Productindexmustbeapositiveintegerbetween1and200,inclusive.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes prps integer None None all Examplevalue:2 Exampleusage:pr1ps=2 ProductCustomDimension Optional. Aproduct-levelcustomdimensionwheredimensionindexisapositiveintegerbetween1and200,inclusive.Productindexmustbeapositiveintegerbetween1and200,inclusive.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes prcd text None 150Bytes all Examplevalue:Member Exampleusage:pr1cd2=Member ProductCustomMetric Optional. Aproduct-levelcustommetricwheremetricindexisapositiveintegerbetween1and200,inclusive.Productindexmustbeapositiveintegerbetween1and200,inclusive.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes prcm integer None None all Examplevalue:28 Exampleusage:pr1cm2=28 ProductAction Optional. Theroleoftheproductsincludedinahit.Ifaproductactionisnotspecified,allproductdefinitionsincludedwiththehitwillbeignored.Mustbeoneof:detail,click,add,remove,checkout,checkout_option,purchase,refund.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes pa text None None all Examplevalue:detail Exampleusage:pa=detail TransactionID Optional. ThetransactionID.ThisisanadditionalparameterthatcanbesentwhenProductActionissetto'purchase'or'refund'.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ti text None None all Examplevalue:T1234 Exampleusage:ti=T1234 Affiliation Optional. Thestoreoraffiliationfromwhichthistransactionoccurred.ThisisanadditionalparameterthatcanbesentwhenProductActionissetto'purchase'or'refund'.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ta text None None all Examplevalue:GoogleStore Exampleusage:ta=Google%20Store Revenue Optional. Thetotalvalueofthetransaction,includingtaxandshipping.Ifnotsent,thisvaluewillbeautomaticallycalculatedusingtheproductquantityandpricefieldsofallproductsinthesamehit.ThisisanadditionalparameterthatcanbesentwhenProductActionissetto'purchase'or'refund'.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes tr currency None None all Examplevalue:123.21 Exampleusage:tr=123.21 Tax Optional. Thetotaltaxassociatedwiththetransaction.ThisisanadditionalparameterthatcanbesentwhenProductActionissetto'purchase'or'refund'.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes tt currency None None all Examplevalue:10.78 Exampleusage:tt=10.78 Shipping Optional. Theshippingcostassociatedwiththetransaction.ThisisanadditionalparameterthatcanbesentwhenProductActionissetto'purchase'or'refund'.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ts currency None None all Examplevalue:3.55 Exampleusage:ts=3.55 CouponCode Optional. Thetransactioncouponredeemedwiththetransaction.ThisisanadditionalparameterthatcanbesentwhenProductActionissetto'purchase'or'refund'.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes tcc text None None all Examplevalue:SUMMER08 Exampleusage:tcc=SUMMER08 ProductActionList Optional. Thelistorcollectionfromwhichaproductactionoccurred.ThisisanadditionalparameterthatcanbesentwhenProductActionissetto'detail'or'click'.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes pal text None None all Examplevalue:SearchResults Exampleusage:pal=Search%20Results CheckoutStep Optional. Thestepnumberinacheckoutfunnel.ThisisanadditionalparameterthatcanbesentwhenProductActionissetto'checkout'.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes cos integer None None all Examplevalue:2 Exampleusage:cos=2 CheckoutStepOption Optional. Additionalinformationaboutacheckoutstep.ThisisanadditionalparameterthatcanbesentwhenProductActionissetto'checkout'.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes col text None None all Examplevalue:Visa Exampleusage:col=Visa ProductImpressionListName Optional. Thelistorcollectiontowhichaproductbelongs.ImpressionListindexmustbeapositiveintegerbetween1and200,inclusive.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ilnm text None None all Examplevalue:SearchResults Exampleusage:il1nm=Search%20Results ProductImpressionSKU Optional. TheproductIDorSKU.ImpressionListindexmustbeapositiveintegerbetween1and200,inclusive.Productindexmustbeapositiveintegerbetween1and200,inclusive.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ilpiid text None None all Examplevalue:P67890 Exampleusage:il1pi2id=P67890 ProductImpressionName Optional. Thenameoftheproduct.ImpressionListindexmustbeapositiveintegerbetween1and200,inclusive.Productindexmustbeapositiveintegerbetween1and200,inclusive.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ilpinm text None None all Examplevalue:AndroidT-Shirt Exampleusage:il1pi2nm=Android%20T-Shirt ProductImpressionBrand Optional. Thebrandassociatedwiththeproduct.ImpressionListindexmustbeapositiveintegerbetween1and200,inclusive.Productindexmustbeapositiveintegerbetween1and200,inclusive.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ilpibr text None None all Examplevalue:Google Exampleusage:il1pi2br=Google ProductImpressionCategory Optional. Thecategorytowhichtheproductbelongs.ImpressionListindexmustbeapositiveintegerbetween1and200,inclusive.Productindexmustbeapositiveintegerbetween1and200,inclusive.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ilpica text None None all Examplevalue:Apparel Exampleusage:il1pi2ca=Apparel ProductImpressionVariant Optional. Thevariantoftheproduct.ImpressionListindexmustbeapositiveintegerbetween1and200,inclusive.Productindexmustbeapositiveintegerbetween1and200,inclusive.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ilpiva text None None all Examplevalue:Black Exampleusage:il1pi2va=Black ProductImpressionPosition Optional. Theproduct'spositioninalistorcollection.ImpressionListindexmustbeapositiveintegerbetween1and200,inclusive.Productindexmustbeapositiveintegerbetween1and200,inclusive.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ilpips integer None None all Examplevalue:2 Exampleusage:il1pi2ps=2 ProductImpressionPrice Optional. Thepriceofaproduct.ImpressionListindexmustbeapositiveintegerbetween1and200,inclusive.Productindexmustbeapositiveintegerbetween1and200,inclusive.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ilpipr currency None None all Examplevalue:29.20 Exampleusage:il1pi2pr=29.20 ProductImpressionCustomDimension Optional. Aproduct-levelcustomdimensionwheredimensionindexisapositiveintegerbetween1and200,inclusive.ImpressionListindexmustbeapositiveintegerbetween1and200,inclusive.Productindexmustbeapositiveintegerbetween1and200,inclusive.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ilpicd text None None all Examplevalue:Member Exampleusage:il1pi2cd3=Member ProductImpressionCustomMetric Optional. Aproduct-levelcustommetricwheremetricindexisapositiveintegerbetween1and200,inclusive.ImpressionListindexmustbeapositiveintegerbetween1and200,inclusive.Productindexmustbeapositiveintegerbetween1and200,inclusive.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes ilpicm integer None None all Examplevalue:28 Exampleusage:il1pi2cm3=28 PromotionID Optional. ThepromotionID.Promotionindexmustbeapositiveintegerbetween1and200,inclusive.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes promoid text None None all Examplevalue:SHIP Exampleusage:promo1id=SHIP PromotionName Optional. Thenameofthepromotion.Promotionindexmustbeapositiveintegerbetween1and200,inclusive.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes promonm text None None all Examplevalue:FreeShipping Exampleusage:promo1nm=Free%20Shipping PromotionCreative Optional. Thecreativeassociatedwiththepromotion.Promotionindexmustbeapositiveintegerbetween1and200,inclusive.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes promocr text None None all Examplevalue:ShippingBanner Exampleusage:promo1cr=Shipping%20Banner PromotionPosition Optional. Thepositionofthecreative.Promotionindexmustbeapositiveintegerbetween1and200,inclusive.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes promops text None None all Examplevalue:banner_slot_1 Exampleusage:promo1ps=banner_slot_1 PromotionAction Optional. Specifiestheroleofthepromotionsincludedinahit.Ifapromotionactionisnotspecified,thedefaultpromotionaction,'view',isassumed.Tomeasureauserclickonapromotionsetthisto'promo_click'.Foranalytics.jstheEnhancedEcommercepluginmustbeinstalledbeforeusingthisfield. Parameter ValueType DefaultValue MaxLength SupportedHitTypes promoa text None None all Examplevalue:click Exampleusage:promoa=click CurrencyCode Optional. Whenpresentindicatesthelocalcurrencyforalltransactioncurrencyvalues.ValueshouldbeavalidISO4217currencycode. Parameter ValueType DefaultValue MaxLength SupportedHitTypes cu text None 10Bytes all Examplevalue:EUR Exampleusage:cu=EUR SocialInteractions SocialNetwork Requiredforsocialhittype. Specifiesthesocialnetwork,forexampleFacebookorGooglePlus. Parameter ValueType DefaultValue MaxLength SupportedHitTypes sn text None 50Bytes social Examplevalue:facebook Exampleusage:sn=facebook SocialAction Requiredforsocialhittype. Specifiesthesocialinteractionaction.ForexampleonGooglePluswhenauserclicksthe+1button,thesocialactionis'plus'. Parameter ValueType DefaultValue MaxLength SupportedHitTypes sa text None 50Bytes social Examplevalue:like Exampleusage:sa=like SocialActionTarget Requiredforsocialhittype. Specifiesthetargetofasocialinteraction.ThisvalueistypicallyaURLbutcanbeanytext. Parameter ValueType DefaultValue MaxLength SupportedHitTypes st text None 2048Bytes social Examplevalue:http://foo.com Exampleusage:st=http%3A%2F%2Ffoo.com Timing Usertimingcategory Requiredfortiminghittype. Specifiestheusertimingcategory. Parameter ValueType DefaultValue MaxLength SupportedHitTypes utc text None 150Bytes timing Examplevalue:category Exampleusage:utc=category Usertimingvariablename Requiredfortiminghittype. Specifiestheusertimingvariable. Parameter ValueType DefaultValue MaxLength SupportedHitTypes utv text None 500Bytes timing Examplevalue:lookup Exampleusage:utv=lookup Usertimingtime Requiredfortiminghittype. Specifiestheusertimingvalue.Thevalueisinmilliseconds. Parameter ValueType DefaultValue MaxLength SupportedHitTypes utt integer None None timing Examplevalue:123 Exampleusage:utt=123 Usertiminglabel Optional. Specifiestheusertiminglabel. Parameter ValueType DefaultValue MaxLength SupportedHitTypes utl text None 500Bytes timing Examplevalue:label Exampleusage:utl=label PageLoadTime Optional. Specifiesthetimeittookforapagetoload.Thevalueisinmilliseconds. Parameter ValueType DefaultValue MaxLength SupportedHitTypes plt integer None None timing Examplevalue:3554 Exampleusage:plt=3554 DNSTime Optional. SpecifiesthetimeittooktodoaDNSlookup.Thevalueisinmilliseconds. Parameter ValueType DefaultValue MaxLength SupportedHitTypes dns integer None None timing Examplevalue:43 Exampleusage:dns=43 PageDownloadTime Optional. Specifiesthetimeittookforthepagetobedownloaded.Thevalueisinmilliseconds. Parameter ValueType DefaultValue MaxLength SupportedHitTypes pdt integer None None timing Examplevalue:500 Exampleusage:pdt=500 RedirectResponseTime Optional. Specifiesthetimeittookforanyredirectstohappen.Thevalueisinmilliseconds. Parameter ValueType DefaultValue MaxLength SupportedHitTypes rrt integer None None timing Examplevalue:500 Exampleusage:rrt=500 TCPConnectTime Optional. SpecifiesthetimeittookforaTCPconnectiontobemade.Thevalueisinmilliseconds. Parameter ValueType DefaultValue MaxLength SupportedHitTypes tcp integer None None timing Examplevalue:500 Exampleusage:tcp=500 ServerResponseTime Optional. Specifiesthetimeittookfortheservertorespondaftertheconnecttime.Thevalueisinmilliseconds. Parameter ValueType DefaultValue MaxLength SupportedHitTypes srt integer None None timing Examplevalue:500 Exampleusage:srt=500 DOMInteractiveTime Optional. SpecifiesthetimeittookforDocument.readyStatetobe'interactive'.Thevalueisinmilliseconds. Parameter ValueType DefaultValue MaxLength SupportedHitTypes dit integer None None timing Examplevalue:500 Exampleusage:dit=500 ContentLoadTime Optional. SpecifiesthetimeittookfortheDOMContentLoadedEventtofire.Thevalueisinmilliseconds. Parameter ValueType DefaultValue MaxLength SupportedHitTypes clt integer None None timing Examplevalue:500 Exampleusage:clt=500 Exceptions ExceptionDescription Optional. Specifiesthedescriptionofanexception. Parameter ValueType DefaultValue MaxLength SupportedHitTypes exd text None 150Bytes exception Examplevalue:DatabaseError Exampleusage:exd=DatabaseError IsExceptionFatal? Optional. Specifieswhethertheexceptionwasfatal. Parameter ValueType DefaultValue MaxLength SupportedHitTypes exf boolean 1 None exception Examplevalue:0 Exampleusage:exf=0 CustomDimensions/Metrics CustomDimension Optional. Eachcustomdimensionhasanassociatedindex.Thereisamaximumof20customdimensions(200forAnalytics360accounts).Thedimensionindexmustbeapositiveintegerbetween1and200,inclusive. Parameter ValueType DefaultValue MaxLength SupportedHitTypes cd text None 150Bytes all Examplevalue:Sports Exampleusage:cd1=Sports CustomMetric Optional. Eachcustommetrichasanassociatedindex.Thereisamaximumof20custommetrics(200forAnalytics360accounts).Themetricindexmustbeapositiveintegerbetween1and200,inclusive. Parameter ValueType DefaultValue MaxLength SupportedHitTypes cm number None None all Examplevalue:47 Exampleusage:cm1=47 Exceptasotherwisenoted,thecontentofthispageislicensedundertheCreativeCommonsAttribution4.0License,andcodesamplesarelicensedundertheApache2.0License.Fordetails,seetheGoogleDevelopersSitePolicies.JavaisaregisteredtrademarkofOracleand/oritsaffiliates. Lastupdated2020-11-20UTC. [{ "type":"thumb-down", "id":"missingTheInformationINeed", "label":"MissingtheinformationIneed" },{ "type":"thumb-down", "id":"tooComplicatedTooManySteps", "label":"Toocomplicated/toomanysteps" },{ "type":"thumb-down", "id":"outOfDate", "label":"Outofdate" },{ "type":"thumb-down", "id":"samplesCodeIssue", "label":"Samples/codeissue" },{ "type":"thumb-down", "id":"otherDown", "label":"Other" }] [{ "type":"thumb-up", "id":"easyToUnderstand", "label":"Easytounderstand" },{ "type":"thumb-up", "id":"solvedMyProblem", "label":"Solvedmyproblem" },{ "type":"thumb-up", "id":"otherUp", "label":"Other" }] GitHub TryGoogleAnalyticssamples StackOverflow Askquestionsusingthegoogle-analyticstag Twitter Follow@googleanalyticsonTwitter Videos ViewGoogleAnalyticsvideosonYouTube Connect Community&Updates GettingHelp ReportinganIssue ProductInfo Protocol/SDKPolicy BrandingPolicy Developerconsoles GoogleAPIConsole GoogleCloudPlatformConsole GooglePlayConsole FirebaseConsole ActionsonGoogleConsole CastSDKDeveloperConsole ChromeWebStoreDashboard Android Chrome Firebase GoogleCloudPlatform Allproducts Terms Privacy SignupfortheGoogleDevelopersnewsletter Subscribe Language English BahasaIndonesia Deutsch Español Français Português–Brasil Русский 中文–简体 日本語 한국어