Common event data
Stay organized with collections
Save and categorize content based on your preferences.
The following are event data common across different types of events. These
values can be retrieved using the Event Data variable or the
getEventData API.
| Parameter |
Type |
Example |
Description |
| client_id |
string |
ABC_123 |
Arbitrary ID that anonymously identifies a particular user, device, or browser instance. |
| currency |
string |
USD |
Currency of the purchase or items associated with the event, in 3-letter ISO_4217 format. |
| event_name |
string |
purchase |
The name of the event. |
| ip_override |
string |
1.2.3.4 |
The IP address of the user in IPv4 or IPv6 format. |
| language |
string |
en_us |
The language for the client in ISO 639-1. |
| page_encoding |
string |
UTF-8 |
The text encoding of the page. |
| page_hostname |
string |
example.com |
The hostname portion of page_location. |
| page_location |
string |
https://example.com |
The full document URL of the page. |
| page_path |
string |
/path/to/page |
The path portion of page_location. |
| page_referrer |
string |
https://www.google.com |
Full URL of the page that referred to the user to the page where the event occurred. This is not the value of the Referrer header on the request coming into the server container. |
| page_title |
string |
Home |
The title of the page. |
| screen_resolution |
string |
1024x768 |
Total screen resolution for the user's device. (width by height). |
| user_agent |
string |
|
The client's user agent. |
| user_data.email_address |
string |
foo@example.com |
Email address of the user. |
| user_data.sha256_email_address |
string |
|
Hashed email address of the user. Learn more |
| user_data.phone_number |
string |
+15551234567 |
Phone number of the user. |
| user_data.sha256_phone_number |
string |
|
Hashed phone number of the user. Learn more |
| user_data.address.first_name |
string |
Jane |
First name of the user. |
| user_data.address.sha256_first_name |
string |
|
Hashed first name of the user. Learn more |
| user_data.address.last_name |
string |
Doe |
Last name of the user. |
| user_data.address.sha256_last_name |
string |
|
Hashed last name of the user. Learn more |
| user_data.address.street |
string |
123 Fake St |
Street and number for the address of the user. |
| user_data.address.city |
string |
City Town |
City for the address of the user. |
| user_data.address.region |
string |
CA |
State or territory for the address of the user. |
| user_data.address.postal_code |
string |
54321 |
Postal code for the address of the user. |
| user_data.address.country |
string |
US |
Country code for the address of the user. |
| user_id |
string |
|
Arbitrary ID that is intended to be a known identifier for a user provided by the site owner/library user. |
| value |
number |
10 |
Monetary value of the event that occurred. |
| viewport_size |
string |
725x345 |
Size of the content window. Usually smaller than the screen resolution. (width by height). |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-09 UTC.
[null,null,["Last updated 2024-10-09 UTC."],[[["\u003cp\u003eThis page outlines common event data parameters available across various event types in Google Tag Manager.\u003c/p\u003e\n"],["\u003cp\u003eThese parameters provide information about users, their devices, page details, and event specifics, like currency and value.\u003c/p\u003e\n"],["\u003cp\u003eYou can access event data using the \u003ccode\u003eEvent Data\u003c/code\u003e variable or the \u003ccode\u003egetEventData\u003c/code\u003e API.\u003c/p\u003e\n"],["\u003cp\u003eEvent data can include sensitive information like personally identifiable information (PII) such as email, address, and phone number.\u003c/p\u003e\n"],["\u003cp\u003eFor security and privacy, hashed versions of PII are available, using SHA256 for encryption, in line with Google's data policies.\u003c/p\u003e\n"]]],["Event data, retrievable via the `Event Data` variable or `getEventData` API, includes user, device, and event details. Key parameters are `client_id` (user identifier), `currency`, and `event_name`. Page information like `page_location`, `page_title`, and `page_referrer` is available. User data includes `email_address`, `phone_number`, and address details, with options for hashed versions. Device details include `screen_resolution` and `viewport_size`. Additional fields are `user_agent`, `user_id`, and `value`.\n"],null,["# Common event data\n\nThe following are event data common across different types of events. These\nvalues can be retrieved using the **Event Data** variable or the\n[`getEventData`](/tag-platform/tag-manager/server-side/api#get_event_data) API.\n\n| Parameter | Type | Example | Description |\n|-------------------------------------|----------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| client_id | `string` | ABC_123 | Arbitrary ID that anonymously identifies a particular user, device, or browser instance. |\n| currency | `string` | USD | Currency of the purchase or items associated with the event, in 3-letter ISO_4217 format. |\n| event_name | `string` | purchase | The name of the event. |\n| ip_override | `string` | 1.2.3.4 | The IP address of the user in IPv4 or IPv6 format. |\n| language | `string` | en_us | The language for the client in ISO 639-1. |\n| page_encoding | `string` | UTF-8 | The text encoding of the page. |\n| page_hostname | `string` | example.com | The hostname portion of page_location. |\n| page_location | `string` | https://example.com | The full document URL of the page. |\n| page_path | `string` | /path/to/page | The path portion of page_location. |\n| page_referrer | `string` | https://www.google.com | Full URL of the page that referred to the user to the page where the event occurred. This is not the value of the Referrer header on the request coming into the server container. |\n| page_title | `string` | Home | The title of the page. |\n| screen_resolution | `string` | 1024x768 | Total screen resolution for the user's device. (width by height). |\n| user_agent | `string` | | The client's user agent. |\n| user_data.email_address | `string` | foo@example.com | Email address of the user. |\n| user_data.sha256_email_address | `string` | | Hashed email address of the user. [Learn more](https://support.google.com/google-ads/answer/12785474?sjid=4543074023400780070-NA) |\n| user_data.phone_number | `string` | +15551234567 | Phone number of the user. |\n| user_data.sha256_phone_number | `string` | | Hashed phone number of the user. [Learn more](https://support.google.com/google-ads/answer/12785474?sjid=4543074023400780070-NA) |\n| user_data.address.first_name | `string` | Jane | First name of the user. |\n| user_data.address.sha256_first_name | `string` | | Hashed first name of the user. [Learn more](https://support.google.com/google-ads/answer/12785474?sjid=4543074023400780070-NA) |\n| user_data.address.last_name | `string` | Doe | Last name of the user. |\n| user_data.address.sha256_last_name | `string` | | Hashed last name of the user. [Learn more](https://support.google.com/google-ads/answer/12785474?sjid=4543074023400780070-NA) |\n| user_data.address.street | `string` | 123 Fake St | Street and number for the address of the user. |\n| user_data.address.city | `string` | City Town | City for the address of the user. |\n| user_data.address.region | `string` | CA | State or territory for the address of the user. |\n| user_data.address.postal_code | `string` | 54321 | Postal code for the address of the user. |\n| user_data.address.country | `string` | US | Country code for the address of the user. |\n| user_id | `string` | | Arbitrary ID that is intended to be a known identifier for a user provided by the site owner/library user. |\n| value | `number` | 10 | Monetary value of the event that occurred. |\n| viewport_size | `string` | 725x345 | Size of the content window. Usually smaller than the screen resolution. (width by height). |"]]