The following events are recommended for retail and ecommerce apps and websites. To learn how to implement these events for your website, refer to the developer documentation.
Retail and ecommerce apps should log the events listed in this article and the events for all apps. Logging events along with their prescribed parameters ensures maximum available detail in reports and lets you benefit from the latest Firebase features and integrations as they become available.
| Event | Trigger | Parameters |
|---|---|---|
| add_payment_info | when a user submits their payment information | coupon, currency, items, payment_type, value |
| add_shipping_info | when a user submits their shipping information | coupon, currency, items, shipping_tier, value |
| add_to_cart | when a user adds items to cart | currency, items, value |
| add_to_wishlist | when a user adds items to a wishlist | currency, items, value |
| begin_checkout | when a user begins checkout | coupon, currency, items, value |
| generate_lead | when a user submits a form or request for information | value, currency |
| purchase | when a user completes a purchase | affiliation, coupon, currency, items, transaction_id, shipping, tax, value (required parameter) |
| refund | when a refund is issued | affiliation, coupon, currency, items, transaction_id, shipping, tax, value |
| remove_from_cart | when a user removes items from a cart | currency, items, value |
| select_item | when an item is selected from a list | items, item_list_name, item_list_id |
| select_promotion | when a user selects a promotion | items, promotion_id, promotion_name, creative_name, creative_slot, location_id |
| view_cart | when a user views their cart | currency, items, value |
| view_item | when a user views an item | currency, items, value |
| view_item_list | when a user sees a list of items/offerings | items, item_list_name, item_list_id |
| view_promotion | when a promotion is shown to a user | items, promotion_id, promotion_name, creative_name, creative_slot, location_id |
Considerations for updating SDKs to Android 17.2.5 (or later) and/or iOS: 16.20.0 (or later)
If you used prior versions of either SDK and are planning to upgrade to Android 17.2.5 (or later) and/or iOS 16.20.0 (or later), you should consider the following:
- Upon upgrade and from that point forward, you will only be able to access item data within the repeated items array; item data will no longer be available in standard event parameters as it has been prior to these SDK versions.
- This change was made to support multiple-product analysis.
- You may need to adjust your references to item/product data as a result.
There is a BigQuery schema format change during this upgrade. Item/product data will begin to appear in a repeated field, enabling analysis of multiple products within a single event. You should take care to adjust any query that references item/product data fields during this upgrade.