Google Analytics 4 | Events
Our native Google Analytics 4 integration supports the recommended ecommerce events listed in the table below. Each GA4 event and parameter corresponds to a BODL event schema.
For more information about the integration, see Setting Up Google Analytics 4.
Search
The search event is triggered when a shopper hits enter or clicks the search button after entering a string into the search bar.
Documentation:
| GA4 Parameter | Type | Description | BODL Schema |
| search_term | string | term that was searched for | bodl_v1_keyword_search.search_keyword |
Promotion Banner
The view_promotion event is triggered when a shopper views a promotional banner on the storefront.
Documentation:
| GA4 Parameter | Type | Description | BODL Schema |
| promotion_id | string | banner ID | bodl_v1_view_banner.banner_id |
| promotion_name | string | banner name | bodl_v1_view_banner.banner_name |
Category Page
The view_item_list event is triggered when a shopper views a category page.
Documentation:
| GA4 Parameter | Type | Description | BODL Schema |
| item_list_id | string | product category ID | bodl_v1_product_category_viewed.category_id |
| item_list_name | string | product category name | bodl_v1_product_category_viewed.category_name |
| items | array | products displayed on the page | bodl_v1_product_category_viewed.line_items[] |
Product Page
The view_item event is triggered when a shopper views a product page.
Documentation:
| GA4 Parameter | Type | Description | BODL Schema |
| currency | string | storefront currency displayed | bodl_v1_product_page_viewed.currency |
| value | number | tax-exclusive product price | bodl_v1_product_page_viewed.product_value |
| items | array | product displayed on the page | bodl_v1_product_page_viewed.line_items[] |
Add To Cart
The add_to_cart event is triggered when a shopper adds a product to their cart.
Documentation:
| GA4 Parameter | Type | Description | BODL Schema |
| currency | string | storefront currency displayed | bodl_v1_cart_product_added.currency |
| value | number | product price multiplied by quantity | bodl_v1_cart_product_added.product_value |
| items | array | products added to the cart | bodl_v1_cart_product_added.line_items[] |
Remove From Cart
The remove_from_cart event is triggered when a shopper removes a product from their cart.
Documentation:
| GA4 Parameter | Type | Description | BODL Schema |
| currency | string | storefront currency displayed | bodl_v1_cart_product_removed.currency |
| value | number | product price multiplied by quantity | bodl_v1_cart_product_removed.cart_value |
| items | array | products removed from the cart | bodl_v1_cart_product_removed.line_items[] |
View Cart
The view_cart event is triggered when a shopper views the cart page.
Documentation:
| GA4 Parameter | Type | Description | BODL Schema |
| currency | string | storefront currency displayed | bodl_v1_cart_viewed.currency |
| value | number | final value of the cart | bodl_v1_cart_viewed.cart_value |
| items | array | products in the cart | bodl_v1_cart_viewed.line_items[] |
Begin Checkout
The begin_checkout event is triggered when a shopper initiates the checkout process.
Documentation:
| GA4 Parameter | Type | Description | BODL Schema |
| currency | string | storefront currency displayed | bodl_v1_begin_checkout.currency |
| value | number | final value of the cart | bodl_v1_begin_checkout.cart_value |
| coupon | string array | coupon codes applied to the cart | bodl_v1_begin_checkout.coupon_codes |
| items | array | products in the cart | bodl_v1_begin_checkout.line_items[] |
Add Shipping Info
The add_shipping_info event is triggered when a shopper adds shipping information.
Documentation:
| GA4 Parameter | Type | Description | BODL Schema |
| currency | string | storefront currency displayed | bodl_v1_add_shipping_information.currency |
| value | number | final value of the cart | bodl_v1_add_shipping_information.cart_value |
| coupon | string array | coupon codes applied to the cart | bodl_v1_add_shipping_information.coupon_codes |
| shipping_tier | string | shipping method | bodl_v1_add_shipping_information.shipping_method |
| items | array | products in the cart | bodl_v1_add_shipping_information.line_items[] |
Add Payment Info
The add_payment_info event is triggered when a shopper adds payment information.
Documentation:
| GA4 Parameter | Type | Description | BODL Schema |
| currency | string | storefront currency displayed | bodl_v1_add_payment_information.currency |
| value | number | final value of the cart | bodl_v1_add_payment_information.cart_value |
| coupon | string array | coupon codes applied to the cart | bodl_v1_add_payment_information.coupon_codes |
| payment_type | string | payment type | bodl_v1_add_payment_information.payment_type |
| items | array | products in the cart | bodl_v1_add_payment_information.line_items[] |
Add Payment Info
The purchase event is triggered when a shopper completes checkout.
Documentation:
| GA4 Parameter | Type | Description | BODL Schema |
| currency | string | storefront currency displayed | bodl_v1_order_purchased.currency |
| transaction_id | string | order ID | bodl_v1_order_purchased.order_id |
| value | number | final value of the cart | bodl_v1_order_purchased.cart_value |
| coupon | string array | coupon codes applied to the cart | bodl_v1_order_purchased.coupon_codes |
| shipping | number | shipping cost including tax | bodl_v1_order_purchased.shipping_cost |
| tax | number | tax total | bodl_v1_order_purchased.tax |
| items | array | items purchased | bodl_v1_add_payment_information.line_items[] |
Refund
The refund event is triggered when one or more items is refunded within the BigCommerce control panel or via the BigCommerce API. This is an optional event that requires additional setup to track.
As the event takes place in the control panel rather than on the storefront, there is no BODL mapping. Equivalent BigCommerce API fields are listed in the tables below. Not every field is directly mapped and may require multiple calls.
Documentation:
- Google Analytics 4
- Measurement Protocol (Google Analytics 4)
- Get All Orders (Dev Center)
- Get All Coupons (Dev Center)
- List Order Products (Dev Center)
- Get All Categories (Dev Center)
Paramaters
| GA4 Parameter | Type | Description | API field |
| currency | string | storefront currency displayed | /v2/orders/{order_id}.currency_code |
| value | number | final value of the cart | /v2/orders/{order_id}.total_inc_tax |
| shipping | number | shipping cost including tax | /v2/orders/{order_id}.shipping_cost_inc_tax |
| tax | number | tax total | /v2/orders/{order_id}.total_tax |
| coupon | string | coupon name applied to the cart | /v2/coupons.name |
| items | array | products | /v2/orders/{order_id}/products.products |
Item Parameters
| GA4 Parameter | Type | Description | API field |
| item_id | number | product ID | /v2/orders/{order_id}/products.product_id |
| item_name | string | product name | /v2/orders/{order_id}/products.name |
| discount | number | discount applied to product | /v2/orders/{order_id}/products.applied_discounts.amount |
| index | number | position of item in array | /v2/orders/{order_id}/products |
| item_variant | number | product variant ID | /v2/orders/{order_id}/products.variant_id |
| price | number | product price after discounts | /v2/orders/{order_id}/products.discounted_total_inc_tax |
| quantity | number | product quantity | /v2/orders/{order_id}/products.quantity |
| item_brand | string | product brand | /v2/orders/{order_id}/products.brand |
| item_category | string | product category | /v3/catalog/trees/categories |
| item_category2 | string | second category hierarchy | /v3/catalog/trees/categories |
| item_category3 | string | third category hierarchy | /v3/catalog/trees/categories |
| item_category4 | string | fourth category hierarchy | /v3/catalog/trees/categories |
| item_category5 | string | fifth category hierarchy | /v3/catalog/trees/categories |
© Copyright 2003 - 2024 BigCommerce Pty. Ltd. Shopping Cart Software