-
Notifications
You must be signed in to change notification settings - Fork 72
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2326 from graphcommerce-org/fix/ga-gtm-docs
Create a 'Third-Party Libraries' page that includes further details on tools such as Google Analytics and Google Tag Manager.
- Loading branch information
Showing
2 changed files
with
148 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
"@graphcommerce/docs": patch | ||
--- | ||
|
||
Create a 'Third-Party Libraries' page that includes further details on tools such as Google Analytics and Google Tag Manager. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,143 @@ | ||
--- | ||
menu: Google TagManager / Analytics | ||
--- | ||
|
||
# Google Libraries | ||
|
||
GraphCommerce integrates with Google Analytics and Google Tagmanager and offers | ||
a generic Datalayer solution that can be used for other analytics tools. | ||
|
||
--- | ||
|
||
- [Google Analytics](#google-analytics) | ||
- [Google Tag Manager](#google-tag-manager) | ||
- [Google Datalayer](#datalayer) | ||
- [Google Recapatcha](#core) | ||
|
||
--- | ||
|
||
## Google TagManager | ||
|
||
The `@graphcommerce/googletagmanager` package makes it easy to add **Google Tag | ||
Manager (GTM)** to your GraphCommerce webshop. | ||
|
||
1. **Install the Package:** Ensure you have installed the | ||
`@graphcommerce/googleanalytics` package. | ||
2. **Configuration:** Add the following configuration values in your | ||
`graphcommerce.config.js`: | ||
|
||
```js | ||
// graphcommerce.config.js | ||
const config = { | ||
googleTagmanagerId: 'GTM-X1X1X1X', | ||
|
||
storefront: [ | ||
{ locale: 'en', magentoStoreCode: 'en_US', defaultLocale: true }, | ||
{ | ||
locale: 'nl', | ||
magentoStoreCode: 'nl_NL', | ||
googleTagmanagerId: 'GTM-X2X2X2X', // Optionally override per storeview | ||
}, | ||
], | ||
} | ||
``` | ||
|
||
3. **GTM Setup:** Ensure you have set up your GTM account and container. Refer | ||
to the | ||
[official GTM documentation](https://developers.google.com/tag-manager/quickstart) | ||
for initial setup steps. | ||
4. [Configure Google analytics](#configure-google-analytics) | ||
|
||
## Google Analytics | ||
|
||
The `@graphcommerce/googleanalytics` package makes it easy to add Google | ||
Analytics GA4 to your GraphCommerce webshop. | ||
|
||
### Installation | ||
|
||
To use this package, follow these steps: | ||
|
||
1. **Install the Package:** Ensure you have installed the | ||
`@graphcommerce/googleanalytics` package. | ||
2. **Configuration:** Add the following configuration values in your | ||
`graphcommerce.config.js`: | ||
|
||
```js | ||
// graphcommerce.config.js | ||
const config = { | ||
googleAnalyticsId: 'GTM-X1X1X1X', | ||
|
||
storefront: [ | ||
{ locale: 'en', magentoStoreCode: 'en_US', defaultLocale: true }, | ||
{ | ||
locale: 'nl', | ||
magentoStoreCode: 'nl_NL', | ||
googleAnalyticsId: 'GTM-X2X2X2X', // Optionally override per storeview | ||
}, | ||
], | ||
} | ||
``` | ||
|
||
### Configure Google analytics | ||
|
||
Configure the `Page changes based on browser history events.` in Google | ||
Analytics. Refer to the | ||
[official documentation](https://developers.google.com/analytics/devguides/collection/ga4/single-page-applications?implementation=browser-history#implement_single-page_application_measurement) | ||
for more details. | ||
|
||
## Datalayer | ||
|
||
### Supported Events | ||
|
||
The following events are supported by default in GraphCommerce: | ||
|
||
- `add_to_cart` | ||
- `add_to_cart_error` (custom) | ||
- `view_cart` | ||
- `begin_checkout` | ||
- `add_payment_info` | ||
- `purchase` | ||
- `view_item_list` | ||
- `select_item` | ||
- `remove_from_cart` | ||
- `add_shipping_info` | ||
- `remove_from_cart` | ||
- `view_item` | ||
- `cwv_* metrics` | ||
|
||
### Core web vitals | ||
|
||
Enable core web vitals tracking. | ||
|
||
```js | ||
const confog = { | ||
dataLayer: { coreWebVitals: true }, | ||
} | ||
``` | ||
|
||
## Google Recaptcha | ||
|
||
1. **Install the Package:** Ensure you have installed the | ||
`@graphcommerce/googleanalytics` package. | ||
2. **Configuration:** Add the following configuration values in your | ||
`graphcommerce.config.js`: | ||
|
||
```js | ||
// graphcommerce.config.js | ||
const config = { | ||
googleRecaptchaKey: 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', | ||
|
||
storefront: [ | ||
{ locale: 'en', magentoStoreCode: 'en_US', defaultLocale: true }, | ||
{ | ||
locale: 'nl', | ||
magentoStoreCode: 'nl_NL', | ||
googleRecaptchaKey: 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', // Optionally override per storeview | ||
}, | ||
], | ||
} | ||
``` | ||
|
||
## Next Steps | ||
|
||
- Learn about [Translations](../framework/translations.md) in GraphCommerce |