App + Web Events

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
value number No 9.99 The monetary value of the transaction, in units of the specified currency parameter

Example

gtag('event', 'add_payment_info', {
  coupon: 'SUMMER_FUN',
  currency: 'USD',
  items: [{
    item_id: 'SKU_12345',
    item_name: 'jeggings',
    coupon: 'SUMMER_FUN',
    discount: 2.22,
    affiliation: 'Google Store',
    item_brand: 'Gucci',
    item_category: 'pants',
    item_variant: 'black',
    value: 9.99
  }],
  payment_type: 'Credit Card',
  value: 9.99
})

add_shipping_info

This event signifies a user has submitted their shipping 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.
shipping_tier string No Ground The shipping tier (e.g. Ground, Air, Next-day) selected for delivery of the purchased item.
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
value number No 9.99 The monetary value of the transaction, in units of the specified currency parameter

Example

gtag('event', 'add_shipping_info', {
  coupon: 'SUMMER_FUN',
  currency: 'USD',
  items: [{
    item_id: 'SKU_12345',
    item_name: 'jeggings',
    coupon: 'SUMMER_FUN',
    discount: 2.22,
    affiliation: "Google Store",
    item_brand: 'Gucci',
    item_category: 'pants',
    item_variant: 'Black',
    value: 9.99
  }],
  shipping_tier: 'Ground',
  value: 7.77
})

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
value number No 9.99 The monetary value of the transaction, in units of the specified currency parameter

Example

gtag('event', 'add_to_cart', {
  currency: 'USD',
  items: [{
    item_id: 'SKU_12345',
    item_name: 'jeggings',
    coupon: 'SUMMER_FUN',
    discount: 2.22,
    affiliation: 'Google Store',
    item_brand: 'Gucci',
    item_category: 'pants',
    item_variant: 'black',
    value: 9.99
  }],
  value: 7.77
})

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
value number No 9.99 The monetary value of the transaction, in units of the specified currency parameter

Example

gtag('event', 'add_to_wishlist', {
  currency: 'USD',
  items: [{
    item_id: 'SKU_12345',
    item_name: 'jeggings',
    coupon: 'SUMMER_FUN',
    discount: 2.22,
    affiliation: 'Google Store',
    item_brand: 'Gucci',
    item_category: 'pants',
    item_variant: 'black',
    value: 9.99
  }],
  value: 9.99
})

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
value number No 9.99 The monetary value of the transaction, in units of the specified currency parameter

Example

gtag('event', 'begin_checkout', {
  coupon: 'SUMMER_FUN',
  currency: 'USD',
  items: [{
    item_id: 'SKU_12345',
    item_name: 'jeggings',
    coupon: 'SUMMER_FUN',
    discount: 2.22,
    affiliation: 'Google Store',
    item_brand: 'Gucci',
    item_category: 'pants',
    item_variant: 'black',
    value: 9.99
  }],
  value: 7.77
})

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
value number No 9.99 The monetary value of the transaction, in units of the specified currency parameter

Example

gtag('event', 'purchase', {
  affiliation: 'Google Store',
  coupon: 'SUMMER_FUN',
  currency: 'USD',
  items: [{
    item_id: 'SKU_12345',
    item_name: 'jeggings',
    coupon: 'SUMMER_FUN',
    discount: 2.22,
    affiliation: 'Google Store',
    item_brand: 'Gucci',
    item_category: 'pants',
    item_variant: 'black',
    value: 9.99
  }],
  transaction_id: 'T_12345',
  shipping: 3.33,
  value: 12.21,
  tax: 1.11
})

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
value number No 9.99 The monetary value of the transaction, in units of the specified currency parameter

Example

gtag('event', 'refund', {
  affiliation: 'Google Store',
  coupon: 'SUMMER_FUN',
  currency: 'USD',
  items: [{
    item_id: 'SKU_12345',
    item_name: 'jeggings',
    coupon: 'SUMMER_FUN',
    discount: 2.22,
    affiliation: 'Google Store',
    item_brand: 'Gucci',
    item_category: 'pants',
    item_variant: 'black',
    value: 9.99
  }],
  transaction_id: 'T_12345',
  shipping: 3.33,
  value: 12.21,
  tax: 1.11
})

remove_from_cart

This event signifies that an item was removed from a cart.

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
value number No 9.99 The monetary value of the transaction, in units of the specified currency parameter

Example

gtag('event', 'remove_from_cart', {
  currency: 'USD',
  items: [{
    item_id: 'SKU_12345',
    item_name: 'jeggings',
    coupon: 'SUMMER_FUN',
    discount: 2.22,
    affiliation: 'Google Store',
    item_brand: 'Gucci',
    item_category: 'pants',
    item_variant: 'black',
    value: 9.99
  }],
  value: 7.77
})

select_item

This event signifies an item was selected from a list.

Parameters

Name Type Required Example Value 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
value number No 9.99 The monetary value of the transaction, in units of the specified currency parameter

Example

gtag('event', 'select_item', {
  items: [{
    item_id: 'SKU_12345',
    item_name: 'jeggings',
    coupon: 'SUMMER_FUN',
    discount: 2.22,
    index: 5,
    item_list_name: "Related Products",
    item_list_id: "IL_12345",
    affiliation: 'Google Store',
    item_brand: 'Gucci',
    item_category: 'pants',
    item_variant: 'black',
    value: 9.99
  }],
  item_list_name: 'Related products',
  item_list_id: 'related_products'
})

select_promotion

This event signifies an promotion was selected from a list.

Parameters

Name Type Required Example Value Description
items Array<Item> No The items for the event.
promotion_id string No P_12345 The ID of a product promotion.
promotion_name string No Summer Sale The name of a product promotion.

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.

promotion_id string Yes* P_12345 The ID of a product promotion. One of promotion_id or promotion name is required.
promotion_name string Yes* Summer Sale The name of a product promotion. One of promotion_id or promotion name is required.
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
creative_slot string No featured_app_1 The name of a creative slot
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
location_id string No L_12345 The location associated with the event. Preferred to be the Google Place ID that corresponds to the associated item but could be overridden to a custom location ID string.
value number No 9.99 The monetary value of the transaction, in units of the specified currency parameter

Example

gtag('event', 'select_promotion', {
  coupon: 'SUMMER_FUN',
  currency: 'USD',
  items: [{
    item_id: 'SKU_12345',
    item_name: 'jeggings',
    coupon: 'SUMMER_FUN',
    discount: 2.22,
    promotion_id: "P_12345",
    promotion_name: "Summer Sale",
    creative_slot: "featured_app_1",
    location_id: "L_12345",
    affiliation: "Google Store",
    item_brand: 'Gucci',
    item_category: 'pants',
    item_variant: 'Black',
    value: 9.99
  }],
  promotion_id: "P_12345",
  promotion_name: "Summer Sale"
})

view_cart

This event signifies that a user viewed their cart.

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
value number No 9.99 The monetary value of the transaction, in units of the specified currency parameter

Example

gtag('event', 'view_cart', {
  currency: 'USD',
  items: [{
    item_id: 'SKU_12345',
    item_name: 'jeggings',
    coupon: 'SUMMER_FUN',
    discount: 2.22,
    affiliation: 'Google Store',
    item_brand: 'Gucci',
    item_category: 'pants',
    item_variant: 'black',
    value: 9.99
  }],
  value: 7.77
})

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
value number No 9.99 The monetary value of the transaction, in units of the specified currency parameter

Example

gtag('event', 'view_item', {
  currency: 'USD',
  items: [{
    item_id: 'SKU_12345',
    item_name: 'jeggings',
    coupon: 'SUMMER_FUN',
    discount: 2.22,
    affiliation: 'Google Store',
    item_brand: 'Gucci',
    item_category: 'pants',
    item_variant: 'black',
    value: 9.99
  }],
  value: 9.99
})

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
value number No 9.99 The monetary value of the transaction, in units of the specified currency parameter

Example

gtag('event', 'view_item_list', {
  items: [{
    item_id: 'SKU_12345',
    item_name: 'jeggings',
    coupon: 'SUMMER_FUN',
    discount: 2.22,
    index: 5,
    item_list_name: "Related Products",
    item_list_id: "IL_12345",
    affiliation: 'Google Store',
    item_brand: 'Gucci',
    item_category: 'pants',
    item_variant: 'black',
    value: 9.99
  }],
  item_list_name: 'Related products',
  item_list_id: 'related_products'
})

view_promotion

This event signifies an promotion was viewed from a list.

Parameters

Name Type Required Example Value Description
items Array<Item> No The items for the event.
promotion_id string No P_12345 The ID of a product promotion.
promotion_name string No Summer Sale The name of a product promotion.

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.

promotion_id string Yes* P_12345 The ID of a product promotion. One of promotion_id or promotion name is required.
promotion_name string Yes* Summer Sale The name of a product promotion. One of promotion_id or promotion name is required.
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
creative_slot string No featured_app_1 The name of a creative slot
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
location_id string No L_12345 The location associated with the event. Preferred to be the Google Place ID that corresponds to the associated item but could be overridden to a custom location ID string.
value number No 9.99 The monetary value of the transaction, in units of the specified currency parameter

Example

gtag('event', 'view_promotion', {
  coupon: 'SUMMER_FUN',
  currency: 'USD',
  items: [{
    item_id: 'SKU_12345',
    item_name: 'jeggings',
    coupon: 'SUMMER_FUN',
    discount: 2.22,
    promotion_id: "P_12345",
    promotion_name: "Summer Sale",
    creative_slot: "featured_app_1",
    location_id: "L_12345",
    affiliation: "Google Store",
    item_brand: 'Gucci',
    item_category: 'pants',
    item_variant: 'Black',
    value: 9.99
  }],
  promotion_id: "P_12345",
  promotion_name: "Summer Sale"
})