Note: This developer site is moving to developers.google.com/tag-platform and will be redirected by September 30, 2021

add_payment_info

This event signifies a user has submitted their payment information.

Parameters

Name Type Required Example value Description
currency string Yes* USD Currency of the items associated with the event, in 3-letter ISO 4217 format.

If set, item-level currency is ignored.
If not set, currency from the first item in items is used.

* If you set value then currency is required for revenue metrics to be computed accurately.
value number Yes* 7.77 The monetary value of the event.

* value is typically required for meaningful reporting. If you mark the event as a conversion then it's recommended you set value.
* currency is required if you set value.
coupon string No SUMMER_FUN The coupon name/code associated with the event.

Event-level and item-level coupon parameters are independent.
payment_type string No Credit Card The chosen method of payment.
items Array<Item> Yes The items for the event.

Item parameters

Name Type Required Example value Description
item_id string Yes* SKU_12345

The ID of the item.

*One of item_id or item_name is required.

item_name string Yes* Stan and Friends Tee

The name of the item.

*One of item_id or item_name is required.

affiliation string No Google Store A product affiliation to designate a supplying company or brick and mortar store location.

Event-level and item-level affiliation parameters are independent.
coupon string No SUMMER_FUN The coupon name/code associated with the item.

Event-level and item-level coupon parameters are independent.
currency string No USD The currency, in 3-letter ISO 4217 format.

If set, event-level currency is ignored.

Multiple currencies per event is not supported. Each item should set the same currency.
discount number No 2.22 The monetary discount value associated with the item.
index number No 5 The index/position of the item in a list.
item_brand string No Google The brand of the item.
item_category string No Apparel The category of the item. If used as part of a category hierarchy or taxonomy then this will be the first category.
item_category2 string No Adult The second category hierarchy or additional taxonomy for the item.
item_category3 string No Shirts The third category hierarchy or additional taxonomy for the item.
item_category4 string No Crew The fourth category hierarchy or additional taxonomy for the item.
item_category5 string No Short sleeve The fifth category hierarchy or additional taxonomy for the item.
item_list_id string No related_products The ID of the list in which the item was presented to the user.

If set, event-level item_list_id is ignored.
If not set, event-level item_list_id is used, if present.
item_list_name string No Related products The name of the list in which the item was presented to the user.

If set, event-level item_list_name is ignored.
If not set, event-level item_list_name is used, if present.
item_variant string No green The item variant or unique code or description for additional item details/options.
location_id string No L_12345 The location associated with the item. It's recommended to use the Google Place ID that corresponds to the associated item. A custom location ID can also be used.

If set, event-level location_id is ignored.
If not set, event-level location_id is used, if present.
price number No 9.99 The monetary price of the item, in units of the specified currency parameter.
quantity number No 1

Item quantity.

add_to_cart

This event signifies that an item was added to a cart for purchase.

Parameters

Name Type Required Example value Description
currency string Yes* USD Currency of the items associated with the event, in 3-letter ISO 4217 format.

If set, item-level currency is ignored.
If not set, currency from the first item in items is used.

* If you set value then currency is required for revenue metrics to be computed accurately.
value number Yes* 7.77 The monetary value of the event.

* value is typically required for meaningful reporting. If you mark the event as a conversion then it's recommended you set value.
* currency is required if you set value.
items Array<Item> Yes The items for the event.

Item parameters

Name Type Required Example value Description
item_id string Yes* SKU_12345

The ID of the item.

*One of item_id or item_name is required.

item_name string Yes* Stan and Friends Tee

The name of the item.

*One of item_id or item_name is required.

affiliation string No Google Store A product affiliation to designate a supplying company or brick and mortar store location.

Event-level and item-level affiliation parameters are independent.
coupon string No SUMMER_FUN The coupon name/code associated with the item.

Event-level and item-level coupon parameters are independent.
currency string No USD The currency, in 3-letter ISO 4217 format.

If set, event-level currency is ignored.

Multiple currencies per event is not supported. Each item should set the same currency.
discount number No 2.22 The monetary discount value associated with the item.
index number No 5 The index/position of the item in a list.
item_brand string No Google The brand of the item.
item_category string No Apparel The category of the item. If used as part of a category hierarchy or taxonomy then this will be the first category.
item_category2 string No Adult The second category hierarchy or additional taxonomy for the item.
item_category3 string No Shirts The third category hierarchy or additional taxonomy for the item.
item_category4 string No Crew The fourth category hierarchy or additional taxonomy for the item.
item_category5 string No Short sleeve The fifth category hierarchy or additional taxonomy for the item.
item_list_id string No related_products The ID of the list in which the item was presented to the user.

If set, event-level item_list_id is ignored.
If not set, event-level item_list_id is used, if present.
item_list_name string No Related products The name of the list in which the item was presented to the user.

If set, event-level item_list_name is ignored.
If not set, event-level item_list_name is used, if present.
item_variant string No green The item variant or unique code or description for additional item details/options.
location_id string No L_12345 The location associated with the item. It's recommended to use the Google Place ID that corresponds to the associated item. A custom location ID can also be used.

If set, event-level location_id is ignored.
If not set, event-level location_id is used, if present.
price number No 9.99 The monetary price of the item, in units of the specified currency parameter.
quantity number No 1

Item quantity.

add_to_wishlist

The event signifies that an item was added to a wishlist. Use this event to identify popular gift items in your app.

Parameters

Name Type Required Example value Description
currency string Yes* USD Currency of the items associated with the event, in 3-letter ISO 4217 format.

If set, item-level currency is ignored.
If not set, currency from the first item in items is used.

* If you set value then currency is required for revenue metrics to be computed accurately.
value number Yes* 7.77 The monetary value of the event.

* value is typically required for meaningful reporting. If you mark the event as a conversion then it's recommended you set value.
* currency is required if you set value.
items Array<Item> Yes The items for the event.

Item parameters

Name Type Required Example value Description
item_id string Yes* SKU_12345

The ID of the item.

*One of item_id or item_name is required.

item_name string Yes* Stan and Friends Tee

The name of the item.

*One of item_id or item_name is required.

affiliation string No Google Store A product affiliation to designate a supplying company or brick and mortar store location.

Event-level and item-level affiliation parameters are independent.
coupon string No SUMMER_FUN The coupon name/code associated with the item.

Event-level and item-level coupon parameters are independent.
currency string No USD The currency, in 3-letter ISO 4217 format.

If set, event-level currency is ignored.

Multiple currencies per event is not supported. Each item should set the same currency.
discount number No 2.22 The monetary discount value associated with the item.
index number No 5 The index/position of the item in a list.
item_brand string No Google The brand of the item.
item_category string No Apparel The category of the item. If used as part of a category hierarchy or taxonomy then this will be the first category.
item_category2 string No Adult The second category hierarchy or additional taxonomy for the item.
item_category3 string No Shirts The third category hierarchy or additional taxonomy for the item.
item_category4 string No Crew The fourth category hierarchy or additional taxonomy for the item.
item_category5 string No Short sleeve The fifth category hierarchy or additional taxonomy for the item.
item_list_id string No related_products The ID of the list in which the item was presented to the user.

If set, event-level item_list_id is ignored.
If not set, event-level item_list_id is used, if present.
item_list_name string No Related products The name of the list in which the item was presented to the user.

If set, event-level item_list_name is ignored.
If not set, event-level item_list_name is used, if present.
item_variant string No green The item variant or unique code or description for additional item details/options.
location_id string No L_12345 The location associated with the item. It's recommended to use the Google Place ID that corresponds to the associated item. A custom location ID can also be used.

If set, event-level location_id is ignored.
If not set, event-level location_id is used, if present.
price number No 9.99 The monetary price of the item, in units of the specified currency parameter.
quantity number No 1

Item quantity.

begin_checkout

This event signifies that a user has begun a checkout.

Parameters

Name Type Required Example value Description
currency string Yes* USD Currency of the items associated with the event, in 3-letter ISO 4217 format.

If set, item-level currency is ignored.
If not set, currency from the first item in items is used.

* If you set value then currency is required for revenue metrics to be computed accurately.
value number Yes* 7.77 The monetary value of the event.

* value is typically required for meaningful reporting. If you mark the event as a conversion then it's recommended you set value.
* currency is required if you set value.
coupon string No SUMMER_FUN The coupon name/code associated with the event.

Event-level and item-level coupon parameters are independent.
items Array<Item> Yes The items for the event.

Item parameters

Name Type Required Example value Description
item_id string Yes* SKU_12345

The ID of the item.

*One of item_id or item_name is required.

item_name string Yes* Stan and Friends Tee

The name of the item.

*One of item_id or item_name is required.

affiliation string No Google Store A product affiliation to designate a supplying company or brick and mortar store location.

Event-level and item-level affiliation parameters are independent.
coupon string No SUMMER_FUN The coupon name/code associated with the item.

Event-level and item-level coupon parameters are independent.
currency string No USD The currency, in 3-letter ISO 4217 format.

If set, event-level currency is ignored.

Multiple currencies per event is not supported. Each item should set the same currency.
discount number No 2.22 The monetary discount value associated with the item.
index number No 5 The index/position of the item in a list.
item_brand string No Google The brand of the item.
item_category string No Apparel The category of the item. If used as part of a category hierarchy or taxonomy then this will be the first category.
item_category2 string No Adult The second category hierarchy or additional taxonomy for the item.
item_category3 string No Shirts The third category hierarchy or additional taxonomy for the item.
item_category4 string No Crew The fourth category hierarchy or additional taxonomy for the item.
item_category5 string No Short sleeve The fifth category hierarchy or additional taxonomy for the item.
item_list_id string No related_products The ID of the list in which the item was presented to the user.

If set, event-level item_list_id is ignored.
If not set, event-level item_list_id is used, if present.
item_list_name string No Related products The name of the list in which the item was presented to the user.

If set, event-level item_list_name is ignored.
If not set, event-level item_list_name is used, if present.
item_variant string No green The item variant or unique code or description for additional item details/options.
location_id string No L_12345 The location associated with the item. It's recommended to use the Google Place ID that corresponds to the associated item. A custom location ID can also be used.

If set, event-level location_id is ignored.
If not set, event-level location_id is used, if present.
price number No 9.99 The monetary price of the item, in units of the specified currency parameter.
quantity number No 1

Item quantity.

exception

An exception event is logged when the normal flow of an app's execution is interrupted.

Parameters

Name Type Required Example value Description
description string No Missing required field. The description of the exception that occurred.
fatal boolean No true Whether or not the exception was a fatal one.

generate_lead

Log this event when a lead has been generated to understand the efficacy of your re-engagement campaigns.

Parameters

Name Type Required Example value Description
currency string Yes* USD Currency of the items associated with the event, in 3-letter ISO 4217 format.

If set, item-level currency is ignored.
If not set, currency from the first item in items is used.

* If you set value then currency is required for revenue metrics to be computed accurately.
value number Yes* 7.77 The monetary value of the event.

* value is typically required for meaningful reporting. If you mark the event as a conversion then it's recommended you set value.
* currency is required if you set value.

join_group

Log this event when a user joins a group such as a guild, team, or family. Use this event to analyze how popular certain groups or social features are.

Parameters

Name Type Required Example value Description
group_id string No G_12345 The ID of the group.

login

Send this event to signify that a user has logged in.

Parameters

Name Type Required Example value Description
method string No Google The method used to login.

page_view

This event signifies a user has viewed a page.

Parameters

Name Type Required Example value Description
page_location string No https://example.com The URL of the page.
client_id string No ABC_123 The client ID.
language string No en_us The language for the client. See Language tags and codes.
page_encoding string No UTF-8 The encoding of the page.
page_title string No Home The title of the page.
user_agent string No The client's user agent.

purchase

This event signifies when one or more items is purchased by a user.

Parameters

Name Type Required Example value Description
currency string Yes* USD Currency of the items associated with the event, in 3-letter ISO 4217 format.

If set, item-level currency is ignored.
If not set, currency from the first item in items is used.

* If you set value then currency is required for revenue metrics to be computed accurately.
transaction_id string Yes T_12345 The unique identifier of a transaction.
value number Yes* 12.21 The monetary value of the event.

* value is required for meaningful reporting and to populate the purchasers predictive audience.
* currency is required if you set value.
affiliation string No Google Store A product affiliation to designate a supplying company or brick and mortar store location.

Event-level and item-level affiliation parameters are independent.
coupon string No SUMMER_FUN The coupon name/code associated with the event.

Event-level and item-level coupon parameters are independent.
shipping number No 3.33 Shipping cost associated with a transaction.
tax number No 1.11 Tax cost associated with a transaction.
items Array<Item> Yes The items for the event.

Item parameters

Name Type Required Example value Description
item_id string Yes* SKU_12345

The ID of the item.

*One of item_id or item_name is required.

item_name string Yes* Stan and Friends Tee

The name of the item.

*One of item_id or item_name is required.

affiliation string No Google Store A product affiliation to designate a supplying company or brick and mortar store location.

Event-level and item-level affiliation parameters are independent.
coupon string No SUMMER_FUN The coupon name/code associated with the item.

Event-level and item-level coupon parameters are independent.
currency string No USD The currency, in 3-letter ISO 4217 format.

If set, event-level currency is ignored.

Multiple currencies per event is not supported. Each item should set the same currency.
discount number No 2.22 The monetary discount value associated with the item.
index number No 5 The index/position of the item in a list.
item_brand string No Google The brand of the item.
item_category string No Apparel The category of the item. If used as part of a category hierarchy or taxonomy then this will be the first category.
item_category2 string No Adult The second category hierarchy or additional taxonomy for the item.
item_category3 string No Shirts The third category hierarchy or additional taxonomy for the item.
item_category4 string No Crew The fourth category hierarchy or additional taxonomy for the item.
item_category5 string No Short sleeve The fifth category hierarchy or additional taxonomy for the item.
item_list_id string No related_products The ID of the list in which the item was presented to the user.

If set, event-level item_list_id is ignored.
If not set, event-level item_list_id is used, if present.
item_list_name string No Related products The name of the list in which the item was presented to the user.

If set, event-level item_list_name is ignored.
If not set, event-level item_list_name is used, if present.
item_variant string No green The item variant or unique code or description for additional item details/options.
location_id string No L_12345 The location associated with the item. It's recommended to use the Google Place ID that corresponds to the associated item. A custom location ID can also be used.

If set, event-level location_id is ignored.
If not set, event-level location_id is used, if present.
price number No 9.99 The monetary price of the item, in units of the specified currency parameter.
quantity number No 1

Item quantity.

refund

This event signifies a refund was issued.

Parameters

Name Type Required Example value Description
currency string Yes* USD Currency of the items associated with the event, in 3-letter ISO 4217 format.

If set, item-level currency is ignored.
If not set, currency from the first item in items is used.

* If you set value then currency is required for revenue metrics to be computed accurately.
transaction_id string Yes T_12345 The unique identifier of a transaction.
value number Yes* 7.77 The monetary value of the event.

* value is typically required for meaningful reporting. If you mark the event as a conversion then it's recommended you set value.
* currency is required if you set value.
affiliation string No Google Store A product affiliation to designate a supplying company or brick and mortar store location.

Event-level and item-level affiliation parameters are independent.
coupon string No SUMMER_FUN The coupon name/code associated with the event.

Event-level and item-level coupon parameters are independent.
shipping number No 3.33 Shipping cost associated with a transaction.
tax number No 1.11 Tax cost associated with a transaction.
items Array<Item> No* The items for the event.

* items is required for partial refunds but it can be omitted for full refunds.

Item parameters

Name Type Required Example value Description
item_id string Yes* SKU_12345

The ID of the item.

*One of item_id or item_name is required.

item_name string Yes* Stan and Friends Tee

The name of the item.

*One of item_id or item_name is required.

affiliation string No Google Store A product affiliation to designate a supplying company or brick and mortar store location.

Event-level and item-level affiliation parameters are independent.
coupon string No SUMMER_FUN The coupon name/code associated with the item.

Event-level and item-level coupon parameters are independent.
currency string No USD The currency, in 3-letter ISO 4217 format.

If set, event-level currency is ignored.

Multiple currencies per event is not supported. Each item should set the same currency.
discount number No 2.22 The monetary discount value associated with the item.
index number No 5 The index/position of the item in a list.
item_brand string No Google The brand of the item.
item_category string No Apparel The category of the item. If used as part of a category hierarchy or taxonomy then this will be the first category.
item_category2 string No Adult The second category hierarchy or additional taxonomy for the item.
item_category3 string No Shirts The third category hierarchy or additional taxonomy for the item.
item_category4 string No Crew The fourth category hierarchy or additional taxonomy for the item.
item_category5 string No Short sleeve The fifth category hierarchy or additional taxonomy for the item.
item_list_id string No related_products The ID of the list in which the item was presented to the user.

If set, event-level item_list_id is ignored.
If not set, event-level item_list_id is used, if present.
item_list_name string No Related products The name of the list in which the item was presented to the user.

If set, event-level item_list_name is ignored.
If not set, event-level item_list_name is used, if present.
item_variant string No green The item variant or unique code or description for additional item details/options.
location_id string No L_12345 The location associated with the item. It's recommended to use the Google Place ID that corresponds to the associated item. A custom location ID can also be used.

If set, event-level location_id is ignored.
If not set, event-level location_id is used, if present.
price number No 9.99 The monetary price of the item, in units of the specified currency parameter.
quantity number No 1

Item quantity.

Use this event to contextualize search operations. This event can help you identify the most popular content in your app.

Parameters

Name Type Required Example value Description
search_term string Yes t-shirts The term that was searched for.

select_content

This event signifies that a user has selected some content of a certain type. This event can help you identify popular content and categories of content in your app.

Parameters

Name Type Required Example value Description
content_type string No product The type of selected content.
item_id string No I_12345 An identifier for the item that was selected.

share

Use this event when a user has shared content.

Parameters

Name Type Required Example value Description
method string No Twitter The method in which the content is shared.
content_type string No image The type of shared content.
item_id string No C_12345 The ID of the shared content.

sign_up

This event indicates that a user has signed up for an account. Use this event to understand the different behaviors of logged in and logged out users.

Parameters

Name Type Required Example value Description
method string No Google The method used for sign up.

view_item

This event signifies that some content was shown to the user. Use this event to discover the most popular items viewed.

Parameters

Name Type Required Example value Description
currency string Yes* USD Currency of the items associated with the event, in 3-letter ISO 4217 format.

If set, item-level currency is ignored.
If not set, currency from the first item in items is used.

* If you set value then currency is required for revenue metrics to be computed accurately.
value number Yes* 7.77 The monetary value of the event.

* value is typically required for meaningful reporting. If you mark the event as a conversion then it's recommended you set value.
* currency is required if you set value.
items Array<Item> Yes The items for the event.

Item parameters

Name Type Required Example value Description
item_id string Yes* SKU_12345

The ID of the item.

*One of item_id or item_name is required.

item_name string Yes* Stan and Friends Tee

The name of the item.

*One of item_id or item_name is required.

affiliation string No Google Store A product affiliation to designate a supplying company or brick and mortar store location.

Event-level and item-level affiliation parameters are independent.
coupon string No SUMMER_FUN The coupon name/code associated with the item.

Event-level and item-level coupon parameters are independent.
currency string No USD The currency, in 3-letter ISO 4217 format.

If set, event-level currency is ignored.

Multiple currencies per event is not supported. Each item should set the same currency.
discount number No 2.22 The monetary discount value associated with the item.
index number No 5 The index/position of the item in a list.
item_brand string No Google The brand of the item.
item_category string No Apparel The category of the item. If used as part of a category hierarchy or taxonomy then this will be the first category.
item_category2 string No Adult The second category hierarchy or additional taxonomy for the item.
item_category3 string No Shirts The third category hierarchy or additional taxonomy for the item.
item_category4 string No Crew The fourth category hierarchy or additional taxonomy for the item.
item_category5 string No Short sleeve The fifth category hierarchy or additional taxonomy for the item.
item_list_id string No related_products The ID of the list in which the item was presented to the user.

If set, event-level item_list_id is ignored.
If not set, event-level item_list_id is used, if present.
item_list_name string No Related products The name of the list in which the item was presented to the user.

If set, event-level item_list_name is ignored.
If not set, event-level item_list_name is used, if present.
item_variant string No green The item variant or unique code or description for additional item details/options.
location_id string No L_12345 The location associated with the item. It's recommended to use the Google Place ID that corresponds to the associated item. A custom location ID can also be used.

If set, event-level location_id is ignored.
If not set, event-level location_id is used, if present.
price number No 9.99 The monetary price of the item, in units of the specified currency parameter.
quantity number No 1

Item quantity.

view_item_list

Log this event when the user has been presented with a list of items of a certain category.

Parameters

Name Type Required Example value Description
item_list_id string No related_products The ID of the list in which the item was presented to the user.

Ignored if set at the item-level.
item_list_name string No Related products The name of the list in which the item was presented to the user.

Ignored if set at the item-level.
items Array<Item> Yes The items for the event.

Item parameters

Name Type Required Example value Description
item_id string Yes* SKU_12345

The ID of the item.

*One of item_id or item_name is required.

item_name string Yes* Stan and Friends Tee

The name of the item.

*One of item_id or item_name is required.

affiliation string No Google Store A product affiliation to designate a supplying company or brick and mortar store location.

Event-level and item-level affiliation parameters are independent.
coupon string No SUMMER_FUN The coupon name/code associated with the item.

Event-level and item-level coupon parameters are independent.
currency string No USD The currency, in 3-letter ISO 4217 format.

If set, event-level currency is ignored.

Multiple currencies per event is not supported. Each item should set the same currency.
discount number No 2.22 The monetary discount value associated with the item.
index number No 5 The index/position of the item in a list.
item_brand string No Google The brand of the item.
item_category string No Apparel The category of the item. If used as part of a category hierarchy or taxonomy then this will be the first category.
item_category2 string No Adult The second category hierarchy or additional taxonomy for the item.
item_category3 string No Shirts The third category hierarchy or additional taxonomy for the item.
item_category4 string No Crew The fourth category hierarchy or additional taxonomy for the item.
item_category5 string No Short sleeve The fifth category hierarchy or additional taxonomy for the item.
item_list_id string No related_products The ID of the list in which the item was presented to the user.

If set, event-level item_list_id is ignored.
If not set, event-level item_list_id is used, if present.
item_list_name string No Related products The name of the list in which the item was presented to the user.

If set, event-level item_list_name is ignored.
If not set, event-level item_list_name is used, if present.
item_variant string No green The item variant or unique code or description for additional item details/options.
location_id string No L_12345 The location associated with the item. It's recommended to use the Google Place ID that corresponds to the associated item. A custom location ID can also be used.

If set, event-level location_id is ignored.
If not set, event-level location_id is used, if present.
price number No 9.99 The monetary price of the item, in units of the specified currency parameter.
quantity number No 1

Item quantity.

view_search_results

Log this event when the users has been presented with the results of a search.

Parameters

Name Type Required Example value Description
search_term string No Clothing The term used for the search.
items Array<Item> No The items for the event.

Item parameters

Name Type Required Example value Description
item_id string Yes* SKU_12345

The ID of the item.

*One of item_id or item_name is required.

item_name string Yes* Stan and Friends Tee

The name of the item.

*One of item_id or item_name is required.

affiliation string No Google Store A product affiliation to designate a supplying company or brick and mortar store location.

Event-level and item-level affiliation parameters are independent.
coupon string No SUMMER_FUN The coupon name/code associated with the item.

Event-level and item-level coupon parameters are independent.
currency string No USD The currency, in 3-letter ISO 4217 format.

If set, event-level currency is ignored.

Multiple currencies per event is not supported. Each item should set the same currency.
discount number No 2.22 The monetary discount value associated with the item.
index number No 5 The index/position of the item in a list.
item_brand string No Google The brand of the item.
item_category string No Apparel The category of the item. If used as part of a category hierarchy or taxonomy then this will be the first category.
item_category2 string No Adult The second category hierarchy or additional taxonomy for the item.
item_category3 string No Shirts The third category hierarchy or additional taxonomy for the item.
item_category4 string No Crew The fourth category hierarchy or additional taxonomy for the item.
item_category5 string No Short sleeve The fifth category hierarchy or additional taxonomy for the item.
item_list_id string No related_products The ID of the list in which the item was presented to the user.

If set, event-level item_list_id is ignored.
If not set, event-level item_list_id is used, if present.
item_list_name string No Related products The name of the list in which the item was presented to the user.

If set, event-level item_list_name is ignored.
If not set, event-level item_list_name is used, if present.
item_variant string No green The item variant or unique code or description for additional item details/options.
location_id string No L_12345 The location associated with the item. It's recommended to use the Google Place ID that corresponds to the associated item. A custom location ID can also be used.

If set, event-level location_id is ignored.
If not set, event-level location_id is used, if present.
price number No 9.99 The monetary price of the item, in units of the specified currency parameter.
quantity number No 1

Item quantity.