This document lists all of the parameters for the Measurement Protocol.
General
Protocol Version
Required for all hit types.
The Protocol version. The current value is '1'. This will only change when there are changes made that are not backwards compatible.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
v |
text | None | None | all |
1Example usage:
v=1
Tracking ID / Web Property ID
Required for all hit types.
The tracking ID / web property ID. The format is UA-XXXX-Y. All collected data is associated by this ID.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
tid |
text | None | None | all |
UA-XXXX-YExample usage:
tid=UA-XXXX-Y
Anonymize IP
Optional.
When present, the IP address of the sender will be anonymized. For example, the IP will be anonymized if any of the following parameters are present in the payload: &aip=, &aip=0, or &aip=1
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
aip |
boolean | None | None | all |
1Example usage:
aip=1
Data Source
Optional.
Indicates the data source of the hit. Hits sent from analytics.js will have data source set to 'web'; hits sent from one of the mobile SDKs will have data source set to 'app'.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
ds |
text | None | None | all |
webExample usage:
ds=web
appExample usage:
ds=app
call centerExample usage:
ds=call%20center
crmExample usage:
ds=crm
Queue Time
Optional.
Used to collect offline / latent hits. The value represents the time delta (in milliseconds) between when the hit being reported occurred and the time the hit was sent. The value must be greater than or equal to 0. Values greater than four hours may lead to hits not being processed.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
qt |
integer | None | None | all |
560Example usage:
qt=560
Cache Buster
Optional.
Used to send a random number in GET requests to ensure browsers and proxies don't cache hits. It should be sent as the final parameter of the request since we've seen some 3rd party internet filtering software add additional parameters to HTTP requests incorrectly. This value is not used in reporting.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
z |
text | None | None | all |
289372387623Example usage:
z=289372387623
User
Client ID
Optional.
This field is required if User ID (uid) is not specified in the request. This anonymously identifies a particular user, device, or browser instance. For the web, this is generally stored as a first-party cookie with a two-year expiration. For mobile apps, this is randomly generated for each particular instance of an application install. The value of this field should be a random UUID (version 4) as described in http://www.ietf.org/rfc/rfc4122.txt.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
cid |
text | None | None | all |
35009a79-1a05-49d7-b876-2b884d0f825bExample usage:
cid=35009a79-1a05-49d7-b876-2b884d0f825b
User ID
Optional.
This field is required if Client ID (cid) is not specified in the request. This is intended to be a known identifier for a user provided by the site owner/tracking library user. It must not itself be PII (personally identifiable information). The value should never be persisted in GA cookies or other Analytics provided storage.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
uid |
text | None | None | all |
as8eknlllExample usage:
uid=as8eknlll
Session
Session Control
Optional.
Used to control the session duration. A value of 'start' forces a new session to start with this hit and 'end' forces the current session to end with this hit. All other values are ignored.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
sc |
text | None | None | all |
startExample usage:
sc=start
endExample usage:
sc=end
IP Override
Optional.
The IP address of the user. This should be a valid IP address in IPv4 or IPv6 format. It will always be anonymized just as though &aip (anonymize IP) had been used.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
uip |
text | None | None | all |
1.2.3.4Example usage:
uip=1.2.3.4
User Agent Override
Optional.
The User Agent of the browser. Note that Google has libraries to identify real user agents. Hand crafting your own agent could break at any time.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
ua |
text | None | None | all |
Opera/9.80 (Windows NT 6.0) Presto/2.12.388 Version/12.14Example usage:
ua=Opera%2F9.80%20%28Windows%20NT%206.0%29%20Presto%2F2.12.388%20Version%2F12.14
Geographical Override
Optional.
The geographical location of the user. The geographical ID should be a two letter country code or a criteria ID representing a city or region (see http://developers.google.com/analytics/devguides/collection/protocol/v1/geoid). This parameter takes precedent over any location derived from IP address, including the IP Override parameter. An invalid code will result in geographical dimensions to be set to '(not set)'.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
geoid |
text | None | None | all |
USExample usage:
geoid=US
21137Example usage:
geoid=21137
Traffic Sources
Document Referrer
Optional.
Specifies which referral source brought traffic to a website. This value is also used to compute the traffic source. The format of this value is a URL.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
dr |
text | None | 2048 Bytes | all |
http://example.comExample usage:
dr=http%3A%2F%2Fexample.com
Campaign Name
Optional.
Specifies the campaign name.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
cn |
text | None | 100 Bytes | all |
(direct)Example usage:
cn=%28direct%29
Campaign Source
Optional.
Specifies the campaign source.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
cs |
text | None | 100 Bytes | all |
(direct)Example usage:
cs=%28direct%29
Campaign Medium
Optional.
Specifies the campaign medium.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
cm |
text | None | 50 Bytes | all |
organicExample usage:
cm=organic
Campaign Keyword
Optional.
Specifies the campaign keyword.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
ck |
text | None | 500 Bytes | all |
Blue ShoesExample usage:
ck=Blue%20Shoes
Campaign Content
Optional.
Specifies the campaign content.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
cc |
text | None | 500 Bytes | all |
contentExample usage:
cc=content
Campaign ID
Optional.
Specifies the campaign ID.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
ci |
text | None | 100 Bytes | all |
IDExample usage:
ci=ID
Google AdWords ID
Optional.
Specifies the Google AdWords Id.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
gclid |
text | None | None | all |
CL6Q-OXyqKUCFcgK2goddQuoHgExample usage:
gclid=CL6Q-OXyqKUCFcgK2goddQuoHg
Google Display Ads ID
Optional.
Specifies the Google Display Ads Id.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
dclid |
text | None | None | all |
d_click_idExample usage:
dclid=d_click_id
System Info
Screen Resolution
Optional.
Specifies the screen resolution.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
sr |
text | None | 20 Bytes | all |
800x600Example usage:
sr=800x600
Viewport size
Optional.
Specifies the viewable area of the browser / device.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
vp |
text | None | 20 Bytes | all |
123x456Example usage:
vp=123x456
Document Encoding
Optional.
Specifies the character set used to encode the page / document.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
de |
text | UTF-8
|
20 Bytes | all |
UTF-8Example usage:
de=UTF-8
Screen Colors
Optional.
Specifies the screen color depth.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
sd |
text | None | 20 Bytes | all |
24-bitsExample usage:
sd=24-bits
User Language
Optional.
Specifies the language.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
ul |
text | None | 20 Bytes | all |
en-usExample usage:
ul=en-us
Java Enabled
Optional.
Specifies whether Java was enabled.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
je |
boolean | None | None | all |
1Example usage:
je=1
Flash Version
Optional.
Specifies the flash version.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
fl |
text | None | 20 Bytes | all |
10 1 r103Example usage:
fl=10%201%20r103
Hit
Hit type
Required for all hit types.
The type of hit. Must be one of 'pageview', 'screenview', 'event', 'transaction', 'item', 'social', 'exception', 'timing'.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
t |
text | None | None | all |
pageviewExample usage:
t=pageview
Non-Interaction Hit
Optional.
Specifies that a hit be considered non-interactive.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
ni |
boolean | None | None | all |
1Example usage:
ni=1
Content Information
Document location URL
Optional.
Use this parameter to send the full URL (document location) of the page on which content resides. You can use the &dh and &dp parameters to override the hostname and path + query portions of the document location, accordingly. The JavaScript clients determine this parameter using the concatenation of the document.location.origin + document.location.pathname + document.location.search browser parameters. Be sure to remove any user authentication or other private information from the URL if present. For 'pageview' hits, either &dl or both &dh and &dp have to be specified for the hit to be valid.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
dl |
text | None | 2048 Bytes | all |
http://foo.com/home?a=bExample usage:
dl=http%3A%2F%2Ffoo.com%2Fhome%3Fa%3Db
Document Host Name
Optional.
Specifies the hostname from which content was hosted.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
dh |
text | None | 100 Bytes | all |
foo.comExample usage:
dh=foo.com
Document Path
Optional.
The path portion of the page URL. Should begin with '/'. For 'pageview' hits, either &dl or both &dh and &dp have to be specified for the hit to be valid.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
dp |
text | None | 2048 Bytes | all |
/fooExample usage:
dp=%2Ffoo
Document Title
Optional.
The title of the page / document.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
dt |
text | None | 1500 Bytes | all |
SettingsExample usage:
dt=Settings
Screen Name
Required for screenview hit type.
This parameter is optional on web properties, and required on mobile properties for screenview hits, where it is used for the 'Screen Name' of the screenview hit. On web properties this will default to the unique URL of the page by either using the &dl parameter as-is or assembling it from &dh and &dp.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
cd |
text | None | 2048 Bytes | screenview |
High ScoresExample usage:
cd=High%20Scores
Content Group
Optional.
You can have up to 5 content groupings, each of which has an associated index between 1 and 5, inclusive. Each content grouping can have up to 100 content groups. The value of a content group is hierarchical text delimited by '/". All leading and trailing slashes will be removed and any repeated slashes will be reduced to a single slash. For example, '/a//b/' will be converted to 'a/b'.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
cg<groupIndex> |
text | None | 100 Bytes | all |
news/sportsExample usage:
cg1=news%2Fsports
Link ID
Optional.
The ID of a clicked DOM element, used to disambiguate multiple links to the same URL in In-Page Analytics reports when Enhanced Link Attribution is enabled for the property.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
linkid |
text | None | None | all |
nav_barExample usage:
linkid=nav_bar
App Tracking
Application Name
Optional.
Specifies the application name. This field is required for any hit that has app related data (i.e., app version, app ID, or app installer ID). For hits sent to web properties, this field is optional.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
an |
text | None | 100 Bytes | all |
My AppExample usage:
an=My%20App
Application ID
Optional.
Application identifier.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
aid |
text | None | 150 Bytes | all |
com.company.appExample usage:
aid=com.company.app
Application Version
Optional.
Specifies the application version.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
av |
text | None | 100 Bytes | all |
1.2Example usage:
av=1.2
Application Installer ID
Optional.
Application installer identifier.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
aiid |
text | None | 150 Bytes | all |
com.platform.vendingExample usage:
aiid=com.platform.vending
Event Tracking
Event Category
Required for event hit type.
Specifies the event category. Must not be empty.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
ec |
text | None | 150 Bytes | event |
CategoryExample usage:
ec=Category
Event Action
Required for event hit type.
Specifies the event action. Must not be empty.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
ea |
text | None | 500 Bytes | event |
ActionExample usage:
ea=Action
Event Label
Optional.
Specifies the event label.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
el |
text | None | 500 Bytes | event |
LabelExample usage:
el=Label
Event Value
Optional.
Specifies the event value. Values must be non-negative.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
ev |
integer | None | None | event |
55Example usage:
ev=55
E-Commerce
Transaction ID
Required for transaction hit type.
Required for item hit type.
A unique identifier for the transaction. This value should be the same for both the Transaction hit and Items hits associated to the particular transaction.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
ti |
text | None | 500 Bytes | transaction, item |
OD564Example usage:
ti=OD564
Transaction Affiliation
Optional.
Specifies the affiliation or store name.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
ta |
text | None | 500 Bytes | transaction |
MemberExample usage:
ta=Member
Transaction Revenue
Optional.
Specifies the total revenue associated with the transaction. This value should include any shipping or tax costs.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
tr |
currency | 0
|
None | transaction |
15.47Example usage:
tr=15.47
Transaction Shipping
Optional.
Specifies the total shipping cost of the transaction.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
ts |
currency | 0
|
None | transaction |
3.50Example usage:
ts=3.50
Transaction Tax
Optional.
Specifies the total tax of the transaction.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
tt |
currency | 0
|
None | transaction |
11.20Example usage:
tt=11.20
Item Name
Required for item hit type.
Specifies the item name.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
in |
text | None | 500 Bytes | item |
ShoeExample usage:
in=Shoe
Item Price
Optional.
Specifies the price for a single item / unit.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
ip |
currency | 0
|
None | item |
3.50Example usage:
ip=3.50
Item Quantity
Optional.
Specifies the number of items purchased.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
iq |
integer | 0
|
None | item |
4Example usage:
iq=4
Item Code
Optional.
Specifies the SKU or item code.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
ic |
text | None | 500 Bytes | item |
SKU47Example usage:
ic=SKU47
Item Category
Optional.
Specifies the category that the item belongs to.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
iv |
text | None | 500 Bytes | item |
BlueExample usage:
iv=Blue
Enhanced E-Commerce
Product SKU
Optional.
The SKU of the product. Product index must be a positive integer between 1 and 200, inclusive. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
pr<productIndex>id |
text | None | 500 Bytes | all |
P12345Example usage:
pr1id=P12345
Product Name
Optional.
The name of the product. Product index must be a positive integer between 1 and 200, inclusive. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
pr<productIndex>nm |
text | None | 500 Bytes | all |
Android T-ShirtExample usage:
pr1nm=Android%20T-Shirt
Product Brand
Optional.
The brand associated with the product. Product index must be a positive integer between 1 and 200, inclusive. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
pr<productIndex>br |
text | None | 500 Bytes | all |
GoogleExample usage:
pr1br=Google
Product Category
Optional.
The category to which the product belongs. Product index must be a positive integer between 1 and 200, inclusive. The product category parameter can be hierarchical. Use / as a delimiter to specify up to 5-levels of hierarchy. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
pr<productIndex>ca |
text | None | 500 Bytes | all |
ApparelExample usage:
pr1ca=Apparel
Apparel/Mens/T-ShirtsExample usage:
pr1ca=Apparel%2FMens%2FT-Shirts
Product Variant
Optional.
The variant of the product. Product index must be a positive integer between 1 and 200, inclusive. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
pr<productIndex>va |
text | None | 500 Bytes | all |
BlackExample usage:
pr1va=Black
Product Price
Optional.
The unit price of a product. Product index must be a positive integer between 1 and 200, inclusive. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
pr<productIndex>pr |
currency | None | None | all |
29.20Example usage:
pr1pr=29.20
Product Quantity
Optional.
The quantity of a product. Product index must be a positive integer between 1 and 200, inclusive. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
pr<productIndex>qt |
integer | None | None | all |
2Example usage:
pr1qt=2
Product Coupon Code
Optional.
The coupon code associated with a product. Product index must be a positive integer between 1 and 200, inclusive. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
pr<productIndex>cc |
text | None | 500 Bytes | all |
SUMMER_SALE13Example usage:
pr1cc=SUMMER_SALE13
Product Position
Optional.
The product's position in a list or collection. Product index must be a positive integer between 1 and 200, inclusive. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
pr<productIndex>ps |
integer | None | None | all |
2Example usage:
pr1ps=2
Product Custom Dimension
Optional.
A product-level custom dimension where dimension index is a positive integer between 1 and 200, inclusive. Product index must be a positive integer between 1 and 200, inclusive. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
pr<productIndex>cd<dimensionIndex> |
text | None | 150 Bytes | all |
MemberExample usage:
pr1cd2=Member
Product Custom Metric
Optional.
A product-level custom metric where metric index is a positive integer between 1 and 200, inclusive. Product index must be a positive integer between 1 and 200, inclusive. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
pr<productIndex>cm<metricIndex> |
integer | None | None | all |
28Example usage:
pr1cm2=28
Product Action
Optional.
The role of the products included in a hit. If a product action is not specified, all product definitions included with the hit will be ignored. Must be one of: detail, click, add, remove, checkout, checkout_option, purchase, refund. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
pa |
text | None | None | all |
detailExample usage:
pa=detail
Transaction ID
Optional.
The transaction ID. This is an additional parameter that can be sent when Product Action is set to 'purchase' or 'refund'. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
ti |
text | None | None | all |
T1234Example usage:
ti=T1234
Affiliation
Optional.
The store or affiliation from which this transaction occurred. This is an additional parameter that can be sent when Product Action is set to 'purchase' or 'refund'. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
ta |
text | None | None | all |
Google StoreExample usage:
ta=Google%20Store
Revenue
Optional.
The total value of the transaction, including tax and shipping. If not sent, this value will be automatically calculated using the product quantity and price fields of all products in the same hit. This is an additional parameter that can be sent when Product Action is set to 'purchase' or 'refund'. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
tr |
currency | None | None | all |
123.21Example usage:
tr=123.21
Tax
Optional.
The total tax associated with the transaction. This is an additional parameter that can be sent when Product Action is set to 'purchase' or 'refund'. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
tt |
currency | None | None | all |
10.78Example usage:
tt=10.78
Shipping
Optional.
The shipping cost associated with the transaction. This is an additional parameter that can be sent when Product Action is set to 'purchase' or 'refund'. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
ts |
currency | None | None | all |
3.55Example usage:
ts=3.55
Coupon Code
Optional.
The transaction coupon redeemed with the transaction. This is an additional parameter that can be sent when Product Action is set to 'purchase' or 'refund'. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
tcc |
text | None | None | all |
SUMMER08Example usage:
tcc=SUMMER08
Product Action List
Optional.
The list or collection from which a product action occurred. This is an additional parameter that can be sent when Product Action is set to 'detail' or 'click'. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
pal |
text | None | None | all |
Search ResultsExample usage:
pal=Search%20Results
Checkout Step
Optional.
The step number in a checkout funnel. This is an additional parameter that can be sent when Product Action is set to 'checkout'. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
cos |
integer | None | None | all |
2Example usage:
cos=2
Checkout Step Option
Optional.
Additional information about a checkout step. This is an additional parameter that can be sent when Product Action is set to 'checkout'. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
col |
text | None | None | all |
VisaExample usage:
col=Visa
Product Impression List Name
Optional.
The list or collection to which a product belongs. Impression List index must be a positive integer between 1 and 200, inclusive. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
il<listIndex>nm |
text | None | None | all |
Search ResultsExample usage:
il1nm=Search%20Results
Product Impression SKU
Optional.
The product ID or SKU. Impression List index must be a positive integer between 1 and 200, inclusive. Product index must be a positive integer between 1 and 200, inclusive. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
il<listIndex>pi<productIndex>id |
text | None | None | all |
P67890Example usage:
il1pi2id=P67890
Product Impression Name
Optional.
The name of the product. Impression List index must be a positive integer between 1 and 200, inclusive. Product index must be a positive integer between 1 and 200, inclusive. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
il<listIndex>pi<productIndex>nm |
text | None | None | all |
Android T-ShirtExample usage:
il1pi2nm=Android%20T-Shirt
Product Impression Brand
Optional.
The brand associated with the product. Impression List index must be a positive integer between 1 and 200, inclusive. Product index must be a positive integer between 1 and 200, inclusive. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
il<listIndex>pi<productIndex>br |
text | None | None | all |
GoogleExample usage:
il1pi2br=Google
Product Impression Category
Optional.
The category to which the product belongs. Impression List index must be a positive integer between 1 and 200, inclusive. Product index must be a positive integer between 1 and 200, inclusive. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
il<listIndex>pi<productIndex>ca |
text | None | None | all |
ApparelExample usage:
il1pi2ca=Apparel
Product Impression Variant
Optional.
The variant of the product. Impression List index must be a positive integer between 1 and 200, inclusive. Product index must be a positive integer between 1 and 200, inclusive. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
il<listIndex>pi<productIndex>va |
text | None | None | all |
BlackExample usage:
il1pi2va=Black
Product Impression Position
Optional.
The product's position in a list or collection. Impression List index must be a positive integer between 1 and 200, inclusive. Product index must be a positive integer between 1 and 200, inclusive. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
il<listIndex>pi<productIndex>ps |
integer | None | None | all |
2Example usage:
il1pi2ps=2
Product Impression Price
Optional.
The price of a product. Impression List index must be a positive integer between 1 and 200, inclusive. Product index must be a positive integer between 1 and 200, inclusive. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
il<listIndex>pi<productIndex>pr |
currency | None | None | all |
29.20Example usage:
il1pi2pr=29.20
Product Impression Custom Dimension
Optional.
A product-level custom dimension where dimension index is a positive integer between 1 and 200, inclusive. Impression List index must be a positive integer between 1 and 200, inclusive. Product index must be a positive integer between 1 and 200, inclusive. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
il<listIndex>pi<productIndex>cd<dimensionIndex> |
text | None | None | all |
MemberExample usage:
il1pi2cd3=Member
Product Impression Custom Metric
Optional.
A product-level custom metric where metric index is a positive integer between 1 and 200, inclusive. Impression List index must be a positive integer between 1 and 200, inclusive. Product index must be a positive integer between 1 and 200, inclusive. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
il<listIndex>pi<productIndex>cm<metricIndex> |
integer | None | None | all |
28Example usage:
il1pi2cm3=28
Promotion ID
Optional.
The promotion ID. Promotion index must be a positive integer between 1 and 200, inclusive. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
promo<promoIndex>id |
text | None | None | all |
SHIPExample usage:
promo1id=SHIP
Promotion Name
Optional.
The name of the promotion. Promotion index must be a positive integer between 1 and 200, inclusive. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
promo<promoIndex>nm |
text | None | None | all |
Free ShippingExample usage:
promo1nm=Free%20Shipping
Promotion Creative
Optional.
The creative associated with the promotion. Promotion index must be a positive integer between 1 and 200, inclusive. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
promo<promoIndex>cr |
text | None | None | all |
Shipping BannerExample usage:
promo1cr=Shipping%20Banner
Promotion Position
Optional.
The position of the creative. Promotion index must be a positive integer between 1 and 200, inclusive. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
promo<promoIndex>ps |
text | None | None | all |
banner_slot_1Example usage:
promo1ps=banner_slot_1
Promotion Action
Optional.
Specifies the role of the promotions included in a hit. If a promotion action is not specified, the default promotion action, 'view', is assumed. To measure a user click on a promotion set this to 'promo_click'. For analytics.js the Enhanced Ecommerce plugin must be installed before using this field.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
promoa |
text | None | None | all |
clickExample usage:
promoa=click
Currency Code
Optional.
When present indicates the local currency for all transaction currency values. Value should be a valid ISO 4217 currency code.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
cu |
text | None | 10 Bytes | all |
EURExample usage:
cu=EUR
Social Interactions
Social Network
Required for social hit type.
Specifies the social network, for example Facebook or Google Plus.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
sn |
text | None | 50 Bytes | social |
facebookExample usage:
sn=facebook
Social Action
Required for social hit type.
Specifies the social interaction action. For example on Google Plus when a user clicks the +1 button, the social action is 'plus'.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
sa |
text | None | 50 Bytes | social |
likeExample usage:
sa=like
Social Action Target
Required for social hit type.
Specifies the target of a social interaction. This value is typically a URL but can be any text.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
st |
text | None | 2048 Bytes | social |
http://foo.comExample usage:
st=http%3A%2F%2Ffoo.com
Timing
User timing category
Required for timing hit type.
Specifies the user timing category.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
utc |
text | None | 150 Bytes | timing |
categoryExample usage:
utc=category
User timing variable name
Required for timing hit type.
Specifies the user timing variable.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
utv |
text | None | 500 Bytes | timing |
lookupExample usage:
utv=lookup
User timing time
Required for timing hit type.
Specifies the user timing value. The value is in milliseconds.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
utt |
integer | None | None | timing |
123Example usage:
utt=123
User timing label
Optional.
Specifies the user timing label.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
utl |
text | None | 500 Bytes | timing |
labelExample usage:
utl=label
Page Load Time
Optional.
Specifies the time it took for a page to load. The value is in milliseconds.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
plt |
integer | None | None | timing |
3554Example usage:
plt=3554
DNS Time
Optional.
Specifies the time it took to do a DNS lookup.The value is in milliseconds.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
dns |
integer | None | None | timing |
43Example usage:
dns=43
Page Download Time
Optional.
Specifies the time it took for the page to be downloaded. The value is in milliseconds.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
pdt |
integer | None | None | timing |
500Example usage:
pdt=500
Redirect Response Time
Optional.
Specifies the time it took for any redirects to happen. The value is in milliseconds.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
rrt |
integer | None | None | timing |
500Example usage:
rrt=500
TCP Connect Time
Optional.
Specifies the time it took for a TCP connection to be made. The value is in milliseconds.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
tcp |
integer | None | None | timing |
500Example usage:
tcp=500
Server Response Time
Optional.
Specifies the time it took for the server to respond after the connect time. The value is in milliseconds.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
srt |
integer | None | None | timing |
500Example usage:
srt=500
DOM Interactive Time
Optional.
Specifies the time it took for Document.readyState to be 'interactive'. The value is in milliseconds.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
dit |
integer | None | None | timing |
500Example usage:
dit=500
Content Load Time
Optional.
Specifies the time it took for the DOMContentLoaded Event to fire. The value is in milliseconds.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
clt |
integer | None | None | timing |
500Example usage:
clt=500
Exceptions
Exception Description
Optional.
Specifies the description of an exception.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
exd |
text | None | 150 Bytes | exception |
DatabaseErrorExample usage:
exd=DatabaseError
Is Exception Fatal?
Optional.
Specifies whether the exception was fatal.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
exf |
boolean | 1
|
None | exception |
0Example usage:
exf=0
Custom Dimensions / Metrics
Custom Dimension
Optional.
Each custom dimension has an associated index. There is a maximum of 20 custom dimensions (200 for Analytics 360 accounts). The dimension index must be a positive integer between 1 and 200, inclusive.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
cd<dimensionIndex> |
text | None | 150 Bytes | all |
SportsExample usage:
cd1=Sports
Custom Metric
Optional.
Each custom metric has an associated index. There is a maximum of 20 custom metrics (200 for Analytics 360 accounts). The metric index must be a positive integer between 1 and 200, inclusive.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
cm<metricIndex> |
number | None | None | all |
47Example usage:
cm1=47
Content Experiments
Experiment ID
Optional.
This parameter specifies that this user has been exposed to an experiment with the given ID. It should be sent in conjunction with the Experiment Variant parameter.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
xid |
text | None | 40 Bytes | all |
Qp0gahJ3RAO3DJ18b0XoUQExample usage:
xid=Qp0gahJ3RAO3DJ18b0XoUQ
Experiment Variant
Optional.
This parameter specifies that this user has been exposed to a particular variation of an experiment. It should be sent in conjunction with the Experiment ID parameter.
| Parameter | Value Type | Default Value | Max Length | Supported Hit Types |
|---|---|---|---|---|
xvar |
text | None | None | all |
1Example usage:
xvar=1
