You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This guide maps out the standard data Segment expects to see from ecommerce companies. The semantic events detailed below represent the ideal for ecommerce events; not every ecommerce store will take advantage of every event or all of their properties.
6
+
This guide maps out the standard data Segment expects to see from ecommerce companies. The semantic events detailed represent the ideal for ecommerce events; not every ecommerce store takes advantage of every event or all of their properties.
7
7
8
8
## V2
9
9
10
10
Segment now supports a fully **backwards compatible** V2 of the Ecommerce Spec. You can still use V1, but Segment recommends upgrading to V2 as it includes many more spec'd ecommerce events.
11
11
12
12
For more information about the V2 spec, refer to the [Ecommerce V2 docs](/docs/connections/spec/ecommerce/v2/).
13
13
14
-
## V1 Overview
14
+
## V1 overview
15
15
16
-
One of the core components of the Segment [Spec](/docs/connections/spec/) is the [Track](/docs/connections/spec/track) method. It records any arbitrary event that the user has triggered. For Ecommerce tracking, you will be sending**specific event names** that Segment recognizes semantically. That way the Segment app can transform them before sending them off to each different tool.
16
+
One of the core components of the Segment [Spec](/docs/connections/spec/) is the [Track](/docs/connections/spec/track) method. It records any arbitrary event that the user has triggered. For Ecommerce tracking, you send**specific event names** that Segment recognizes semantically. That way the Segment app can transform them before sending them off to each different tool.
17
17
18
-
The `properties` listed in the sections below are **required** for some destinations to function. You can always add your own custom properties (product color, size, etc.) in addition to the required ones.
18
+
The `properties` listed in the following sections are **required** for some destinations to function. You can always add your own custom properties (for example, product color, size) in addition to the required ones.
19
19
20
20
21
21
## Events
@@ -38,11 +38,11 @@ The ecommerce category includes the following semantic events:
Category pages are a staple of Ecommerce. They let the user browse all of the products in a specific category. You'll want to track all of your product category pages so you can quickly see which categories are most popular.
43
+
Category pages are a staple of Ecommerce. They let the user browse all of the products in a specific category. You can track all of your product category pages so you can quickly see which categories are most popular.
44
44
45
-
To do that, you'll want to record a specially recognized event called `Viewed Product Category` using a `track` call. This event fires when a visitor views a product category. That view might happen on a page, screen, or modal.
45
+
To do that, yrecord a specially recognized event called `Viewed Product Category` using a Track call. This event fires when a visitor views a product category. That view might happen on a page, screen, or modal.
46
46
47
47
### Properties
48
48
@@ -76,9 +76,9 @@ Property | Type | Description
76
76
```
77
77
78
78
79
-
## Viewed Product
79
+
## Viewed product
80
80
81
-
The second special event to record for an Ecommerce installation is 'Viewed Product'. To record that you'll use a Track call. This event fires when a visitor views a product. That view might happen on a page, screen, or preview modal.
81
+
The second special event to record for an Ecommerce installation is 'Viewed Product'. To record that, use a Track call. This event fires when a visitor views a product. That view might happen on a page, screen, or preview modal.
82
82
83
83
Note that the properties are required to tell individual tools, like Google Analytics, about the specific product that was viewed. You can always add your own custom properties as well.
84
84
@@ -94,7 +94,8 @@ Property | Type | Description
94
94
`price` | Number | The price ($) of the product being viewed.
95
95
`category` | String | The product category being viewed.
96
96
97
-
_Note: The `sku` and `id` do not have to be different. If they are different, typically the `id` is a database identifier, like `9714107479` and the `sku` is a public-facing identifier like `SEG-02`._
97
+
> info ""
98
+
> The `sku` and `id` do not have to be different. If they are different, typically the `id` is a database identifier, like `9714107479` and the `sku` is a public-facing identifier like `SEG-02`.
98
99
99
100
### Example
100
101
@@ -131,7 +132,7 @@ _Note: The `sku` and `id` do not have to be different. If they are different, ty
131
132
132
133
Next up are two events that are critical to figuring out how your customers are interacting with your products: 'Added Product' and 'Removed Product'. Fire the `Added Product` event when a visitor adds a product to their shopping cart and the `Removed Product` event when a visitor removes a product from their shopping cart.
133
134
134
-
The properties to record for each of these are the same as the ones for the'Viewed Product' event above (of course you can always add more properties of your own too!).
135
+
The properties to record for each of these are the same as the ones for the'Viewed Product' event (you can always add more properties of your own).
135
136
136
137
### Properties
137
138
@@ -209,9 +210,9 @@ Property | Type | Description
209
210
```
210
211
211
212
212
-
## Completing an Order
213
+
## Completing an order
213
214
214
-
The final step is to record a `Order Completed` event when people complete your checkout process. It's the most important event to record, since you'll use it for A/B tests, sales dashboards, conversion pixels and pretty much everything you can think of.
215
+
The final step is to record a `Order Completed` event when people complete your checkout process. It's the most important event to record, since you use it for A/B tests, sales dashboards, conversion pixels and more.
215
216
216
217
Be sure to **include all items in the cart as event properties**, with the same properties from the previous calls, like so:
217
218
@@ -277,8 +278,8 @@ Be sure to **include all items in the cart as event properties**, with the same
277
278
}
278
279
```
279
280
280
-
**Note**: Some destinations require `total` in place of `revenue`. Specific requirements will be outlined in each destination's documentation.
281
+
**Note**: Some destinations require `total` in place of `revenue`. Specific requirements are outlined in each destination's documentation.
281
282
282
-
## Google Analytics Enhanced Ecommerce
283
+
## Google Analytics enhanced ecommerce
283
284
284
285
If you're using Google Analytics enhanced ecommerce, there are some special events you might also want to add. Details are in Segment's [Google Analytics docs](/docs/connections/destinations/catalog/google-analytics/#enabling-enhanced-e-commerce-tracking).
0 commit comments