google_analytics — module reference
Rendered from the module's own manifest, and from nothing written by hand. What the module does is its own page.
| |
|---|
| Module id | google_analytics |
| Name | Google Analytics |
| Version | 1.0.0 |
| Ships from | @endora-commerce/mod-google-analytics |
| Licence | MIT |
Activation
An operator switches this module on and off on /platform/modules. The choice is the setting google_analytics.module_enabled, and it defaults to on.
Dependencies
| Module | Binding | What it means |
|---|
audit_logs | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
auth | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
cms | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
sales_channels | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
settings | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
Permissions
| Code | Label | Also needs |
|---|
google_analytics:read | View Google Analytics configuration | — |
google_analytics:write | Manage Google Analytics configuration and custom events | — |
Command palette
| Action | Opens | Permission |
|---|
new-google-analytics-event | /google-analytics/new | google_analytics:write |
open-google-analytics | /google-analytics | google_analytics:read |
Settings
| Code | Name | Type |
|---|
google_analytics.enabled | Enable Google Analytics | boolean |
google_analytics.enhanced_ecommerce_enabled | Enhanced Ecommerce | boolean |
google_analytics.measurement_id | Measurement ID | string |
google_analytics.module_enabled | Google Analytics module enabled | boolean |
google_analytics.require_consent | Require analytics consent | boolean |
google_analytics.server_side_api_secret | Measurement Protocol API secret | secret |
google_analytics.server_side_enabled | Server-side tagging | boolean |
google_analytics.server_side_endpoint | Server-side endpoint | string |
Translations
Bundles at i18n inside the module, one file per shipped language.
Operator commands
None.