add_payment_info

This event signifies a user has submitted their payment information.

Parameters

Name Type Required Example Value Description
coupon string No SUMMER_FUN Coupon code used for a purchase.
currency string (ISO 4217) No USD Currency of the purchase or items associated with the event, in 3-letter ISO 4217 format.
items Array<Item> No The items for the event.
payment_type string No Credit Card The chosen method of payment.
value number No 7.77 The monetary value of the event.

Item Parameters

Name Type Required Example Value Description
item_id string Yes* SKU_12345

Item ID (context-specific).

*One of item_id or item_name is required for product or impression data.

item_name string Yes* jeggings

Item Name (context-specific).

*One of item_id or item_name is required for product or impression data.

affiliation string No Google Store A product affiliation to designate a supplying company or brick and mortar store location.
coupon string No SUMMER_FUN Coupon code used for a purchase
discount number No 2.22 Monetary value of discount associated with a purchase
item_brand string No Gucci Item brand
item_category string No pants Item Category (context-specific). item_category2 through item_category5 can also be used if the item has many categories.
item_variant string No Black Item variant
price number No 9.99 The monetary price of the item, in units of the specified currency parameter
currency string No USD The currency, in 3-letter ISO 4217 format.

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 No USD Currency of the items associated with the event, in 3-letter ISO 4217 format.
items Array<Item> No The items for the event.
value number No 7.77 The monetary value of the event.

Item Parameters

Name Type Required Example Value Description
item_id string Yes* SKU_12345

Item ID (context-specific).

*One of item_id or item_name is required for product or impression data.

item_name string Yes* jeggings

Item Name (context-specific).

*One of item_id or item_name is required for product or impression data.

affiliation string No Google Store A product affiliation to designate a supplying company or brick and mortar store location.
coupon string No SUMMER_FUN Coupon code used for a purchase
discount number No 2.22 Monetary value of discount associated with a purchase
item_brand string No Gucci Item brand
item_category string No pants Item Category (context-specific). item_category2 through item_category5 can also be used if the item has many categories.
item_variant string No Black Item variant
price number No 9.99 The monetary price of the item, in units of the specified currency parameter
currency string No USD The currency, in 3-letter ISO 4217 format.

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 No USD Currency of the items associated with the event, in 3-letter ISO 4217 format.
items Array<Item> No The items for the event.
value number No 7.77 The monetary value of the event.

Item Parameters

Name Type Required Example Value Description
item_id string Yes* SKU_12345

Item ID (context-specific).

*One of item_id or item_name is required for product or impression data.

item_name string Yes* jeggings

Item Name (context-specific).

*One of item_id or item_name is required for product or impression data.

affiliation string No Google Store A product affiliation to designate a supplying company or brick and mortar store location.
coupon string No SUMMER_FUN Coupon code used for a purchase
discount number No 2.22 Monetary value of discount associated with a purchase
item_brand string No Gucci Item brand
item_category string No pants Item Category (context-specific). item_category2 through item_category5 can also be used if the item has many categories.
item_variant string No Black Item variant
price number No 9.99 The monetary price of the item, in units of the specified currency parameter
currency string No USD The currency, in 3-letter ISO 4217 format.

begin_checkout

This event signifies that a user has begun the process of checkout out.

Parameters

name Type Required Example Description
coupon string No SUMMER_FUN Coupon code used for a purchase.
currency string (ISO 4217) No USD Currency of the purchase or items associated with the event, in 3-letter ISO 4217 format.
items Array<Item> No The items for the event.
value number No 7.77 The monetary value of the event.

Item Parameters

Name Type Required Example Value Description
item_id string Yes* SKU_12345

Item ID (context-specific).

*One of item_id or item_name is required for product or impression data.

item_name string Yes* jeggings

Item Name (context-specific).

*One of item_id or item_name is required for product or impression data.

affiliation string No Google Store A product affiliation to designate a supplying company or brick and mortar store location.
coupon string No SUMMER_FUN Coupon code used for a purchase
discount number No 2.22 Monetary value of discount associated with a purchase
item_brand string No Gucci Item brand
item_category string No pants Item Category (context-specific). item_category2 through item_category5 can also be used if the item has many categories.
item_variant string No Black Item variant
price number No 9.99 The monetary price of the item, in units of the specified currency parameter
currency string No USD The currency, in 3-letter ISO 4217 format.

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 Description
currency string No USD The currency of the lead, in 3-letter ISO 4217 format.
value number No 99.99 The value of the lead.

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 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 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 Description
affiliation string No Google Store A product affiliation to designate a supplying company or brick and mortar store location.
coupon string No SUMMER_FUN Coupon code used for a purchase.
currency string (ISO 4217) No USD Currency of the purchase or items associated with the event, in 3-letter ISO 4217 format.
items Array<Item> No The items for the event.
transaction_id string No T_12345 The unique identifier of a transaction
shipping number No 3.33 Shipping cost associated with a transaction.
tax number No 1.11 Tax cost associated with a transaction.
value number No 12.21 The monetary value of the event, in units of the specified currency parameter.

Item Parameters

Name Type Required Example Value Description
item_id string Yes* SKU_12345

Item ID (context-specific).

*One of item_id or item_name is required for product or impression data.

item_name string Yes* jeggings

Item Name (context-specific).

*One of item_id or item_name is required for product or impression data.

affiliation string No Google Store A product affiliation to designate a supplying company or brick and mortar store location.
coupon string No SUMMER_FUN Coupon code used for a purchase
discount number No 2.22 Monetary value of discount associated with a purchase
item_brand string No Gucci Item brand
item_category string No pants Item Category (context-specific). item_category2 through item_category5 can also be used if the item has many categories.
item_variant string No Black Item variant
tax number No 1.11 Tax cost associated with a transaction
price number No 9.99 The monetary price of the item, in units of the specified currency parameter
currency string No USD The currency, in 3-letter ISO 4217 format.

refund

This event signifies a refund was issued.

Parameters

Name Type Required Example Description
affiliation string No Google Store A product affiliation to designate a supplying company or brick and mortar store location.
coupon string No SUMMER_FUN Coupon code used for a purchase.
currency string (ISO 4217) No USD Currency of the purchase or items associated with the event, in 3-letter ISO 4217 format.
items Array<Item> No The items for the event.
transaction_id string No T_12345 The unique identifier of a transaction.
shipping number No 3.33 Shipping cost associated with a transaction.
tax number No 1.11 Tax cost associated with a transaction.
value number No 12.21 The monetary value of the event, in units of the specified currency parameter.

Item Parameters

Name Type Required Example Value Description
item_id string Yes* SKU_12345

Item ID (context-specific).

*One of item_id or item_name is required for product or impression data.

item_name string Yes* jeggings

Item Name (context-specific).

*One of item_id or item_name is required for product or impression data.

affiliation string No Google Store A product affiliation to designate a supplying company or brick and mortar store location.
coupon string No SUMMER_FUN Coupon code used for a purchase
discount number No 2.22 Monetary value of discount associated with a purchase
item_brand string No Gucci Item brand
item_category string No pants Item Category (context-specific). item_category2 through item_category5 can also be used if the item has many categories.
item_variant string No Black Item variant
tax number No 1.11 Tax cost associated with a transaction
price number No 9.99 The monetary price of the item, in units of the specified currency parameter
currency string No USD The currency, in 3-letter ISO 4217 format.

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 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 to identify viral content.

Parameters

Name Type Required Example Description
method string No Twitter The method in which the content is shared.
content_type string No image The type of shared content.
content_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 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 Description
currency string No USD Currency of the items associated with the event, in 3-letter ISO 4217 format.
items Array<Item> No The items for the event.
value number No 7.77 The monetary value of the event.

Item Parameters

Name Type Required Example Value Description
item_id string Yes* SKU_12345

Item ID (context-specific).

*One of item_id or item_name is required for product or impression data.

item_name string Yes* jeggings

Item Name (context-specific).

*One of item_id or item_name is required for product or impression data.

affiliation string No Google Store A product affiliation to designate a supplying company or brick and mortar store location.
coupon string No SUMMER_FUN Coupon code used for a purchase
discount number No 2.22 Monetary value of discount associated with a purchase
item_brand string No Gucci Item brand
item_category string No pants Item Category (context-specific). item_category2 through item_category5 can also be used if the item has many categories.
item_variant string No Black Item variant
price number No 9.99 The monetary price of the item, in units of the specified currency parameter
currency string No USD The currency, in 3-letter ISO 4217 format.

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 Description
items Array<Item> No The items for the event.
item_list_name string No Related products The name of the list in which the item was presented to the user.
item_list_id string No IL_12345 The ID of the list in which the item was presented to the user.

Item Parameters

Name Type Required Example Value Description
item_id string Yes* SKU_12345

Item ID (context-specific).

*One of item_id or item_name is required for product or impression data.

item_name string Yes* jeggings

Item Name (context-specific).

*One of item_id or item_name is required for product or impression data.

affiliation string No Google Store A product affiliation to designate a supplying company or brick and mortar store location.
coupon string No SUMMER_FUN Coupon code used for a purchase
discount number No 2.22 Monetary value of discount associated with a purchase
index number No 5 The index of the item in a list
item_brand string No Gucci Item brand
item_category string No pants Item Category (context-specific). item_category2 through item_category5 can also be used if the item has many categories.
item_list_name string No Related products The name of the list in which the item was presented to the user
item_list_id string No IL_12345 The ID of the list in which the item was presented to the user
item_variant string No Black Item variant
price number No 9.99 The monetary price of the item, in units of the specified currency parameter
currency string No USD The currency, in 3-letter ISO 4217 format.

view_search_results

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

Parameters

Name Type Required Example 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

Item ID (context-specific).

*One of item_id or item_name is required for product or impression data.

item_name string Yes* jeggings

Item Name (context-specific).

*One of item_id or item_name is required for product or impression data.

affiliation string No Google Store A product affiliation to designate a supplying company or brick and mortar store location.
coupon string No SUMMER_FUN Coupon code used for a purchase
discount number No 2.22 Monetary value of discount associated with a purchase
index number No 5 The index of the item in a list
item_brand string No Gucci Item brand
item_category string No pants Item Category (context-specific). item_category2 through item_category5 can also be used if the item has many categories.
item_list_name string No Related products The name of the list in which the item was presented to the user
item_list_id string No IL_12345 The ID of the list in which the item was presented to the user
item_variant string No Black Item variant
price number No 9.99 The monetary price of the item, in units of the specified currency parameter
currency string No USD The currency, in 3-letter ISO 4217 format.