Magento 2 Extension
GoogleTagManager 2
Add GTM to Magento including e-commerce dataLayer and FPC
Training in Magento 2, Shopware 6, React and Vue Training in Magento 2, Shopware 6, React and Vue Training in Magento 2, Shopware 6, React and Vue
Add GTM to Magento including e-commerce dataLayer and FPC
This extension has been written - with love - by Jisse Reitsma, founder of Yireo, three times Magento Master, partner of ExtDN, trainer and author. Jisse has been in the Magento ecosystem for many years and has created numerous Magento extensions. He also has been pushing better coding practices, like CI/CD, clean coding, coding standards and testing.
This extension is hosted on GitHub:
https://github.com/yireo/Yireo_GoogleTagManager2
Login to your Google Tag Manager account. Follow the Google instructions to create a new Google Tag Manager container. Extract the Container Public ID from your new container. Configure your new ID in Magento through Store> Configuration> [Sales] Google Tag Manager.
The extension has the following configuration options:
This extension adds the following attributes automatically to the data layer. There is no backend option to tune this, so if you want to make changes, change the PHTML templates in your own theme.
customerLoggedIn = Whether the customer has logged incustomerId = ID of the customercustomerGroupId = Customer group IDcustomerGroupCode = Customer group codecategoryId = Category IDcategoryName = Category namecategoryProducts = Listing of top 3 productsproductId = Product IDproductName = Product nameproductSku = Product SKUproductPrice = Product pricetransactionId = Order IDtransactionDate = Order datetransactionAffiliation = Website nametransactionTotal = Order totaltransactionTax = Order taxtransactionShipping = Shipping amounttransactionPayment = Payment methodtransactionCurrency = Currency of websitetransactionPromoCode = Promotional code used for ordertransactionProducts = Listing of all items in cart sku = Item SKUname = Item nameprice = Item pricecategory = Listing of category IDsquantity = Item quantityNote that on a product page with an URL that also identifies a category, both the product attributes and the category attributes are added.
This module does not use XML rewrites to change core classes. It uses two insertion modes - one using the XML layout, one using an observed event core_block_abstract_to_html_after.
When you want to track conversions in your Magento checkout, our extension helps out as well: It adds the relevant information to all your checkout and cart pages. Do you want to know which variables are on the success page? Use the Yireo CheckoutTester extension to preview that page and view its HTML source.
Bring your towel.
We recommend to install Magento 2 extensions via composer. See the Composer project for instructions on how to get composer up and running. Once composer is installed, use the following command to install our extension.
composer require yireo/magento2-googletagmanager2This will make composer download the package from Packagist. After the composer installation has finished, use the following commands to enable the module within Magento:
bin/magento module:enable Yireo_GoogleTagManager2
bin/magento cache:clean
bin/magento setup:upgradeAfter these commands, the extension is ready for use in Magento. If you were already logged into the Magento Admin Panel, make sure to logout and log back in again, before proceeding. Do not forget to grab yourself a manual copy of our extension as a backup.
Please note that we strongly recommend using composer instead. If you bump into issues with this manual procedure, the first thing we need to ask is whether you have installed all dependencies, as mentioned in the composer.json file of this extension. If the composer.json file of this extension mentions requirements, you need to fulfill these requirements. This could involve checking for PHP requirements but also installing third party add-ons. Sounds difficult? Yes! That's why we can only recommend you to use composer. The manual installation does NOT make your life easier, even if you think it does.
Do use composer: It allows for dependency tracking and in the end, prevents breaking your site. However, in some cases, it might be required to do a non-composer installation. For these exceptional situations, download the module ZIP from our site (under the tab File Downloads). Next, create a folder with the following name and copy to the ZIP contents to it:
app/code/Yireo/GoogleTagManager2After the files have been uploaded, confirm that all files are in place. For instance, you should have a file like app/code/Yireo/GoogleTagManager2/etc/module.xml. Next, use the following commands to enable the module within Magento:
bin/magento module:enable Yireo_GoogleTagManager2
bin/magento cache:clean
bin/magento setup:upgradeAfter these commands, the extension is ready for use in Magento. If you were already logged into the Magento Admin Panel, make sure to logout and log back in again, before proceeding. Do not forget to grab yourself a manual copy of our extension as a backup.
Head over to the GitHub repository for downloads: https://github.com/yireo/Yireo_GoogleTagManager2
No, it is not. As a policy, all our Yireo software is unencrypted - we do not make use of technologies like ionCube or ZendOptimizer. All PHP-code is open source, but for commercial extensions the code is only given to paying customers.
You probably would like to know if this extension is working under a specific Magento version 2.X.Y. However, from a technical point of view, the question is wrong: The major Magento version 2.X.Y is not semantical but instead used for marketing purposes. It doesn't give any guarantees.
Instead, we maintain compatibility with the actual modules that lie underneath (like Magento_Catalog or the Magento Framework). And version management for these dependencies is handled via composer. We strongly advice you to rely on composer to answer the question whether our extension works under a specific Magento version. This is the only way to guarantee compatibility in a professional way.
Alternatively, study our CHANGELOG for details on the progress we made.
This extension is offered for free. Feel free to go the GitHub repository (see the link under Quick Start> Downloads) and open an Issue there. Please note that this is a voluntary open source project. The more helpful you are in describing the issue at hand, the more likely volunteers can come in to help you with the issue.
No, currently it is not. This is a voluntary project that never needed this. If you want this to be included, either create and send a Pull Request to share this with the community. Or send a mail to info@yireo.com so we can discuss to start a custom project (paid per hour) for this.
If you run into problems, we are happy to help you out with the following resources:
We usually respond in 24 hours but understand this is all done on a voluntary basis. Also note that we require you to collaborate together with us. Interpret errors as best as you can, before claiming our time. Free software does not automatically lead into free support as well.
This extension ships with PHPUnit tests. The generic PHPUnit configuration in Magento 2 will pick up on these tests. To only test Yireo extensions, simply run PHPUnit from within this folder. Note that this assumes that the extension is installed via composer. For instance:
phpunit
Also note that Mockery (mockery/mockery) is used for the integration tests. If you want to test this module, you need to install its dev-dependencies:
composer require yireo/magento2-googletagmanager2 --dev
The JavaScript code ships with MochaJS unit tests. To install the stuff, simply run (within this extension directory) the following:
npm install
npm run mocha
Or just use yarn:
yarn
npm run mocha
2.2 (2.2.5, 2.2.6, 2.2.7, 2.2.8, 2.2.9, 2.2.10) 2.3 (2.3.2, 2.3.3, 2.3.4, 2.3.5, 2.3.5-p1, 2.3.5-p2, 2.3.6, 2.3.7) 2.4 (2.4.0, 2.4.1, 2.4.2, 2.4.2-p1) magento/framework: ^101.2|^102.0|^103.0magento/module-catalog: ^100.1|^101.0|^102.0|^103.0|^104.0magento/module-checkout: ^100.1magento/module-cookie: ^100.0magento/module-customer: ^100.1|^101.0|^102.0|^103.0magento/module-directory: ^100.1magento/module-quote: ^100.1|^101.0magento/module-sales: ^100.1|^101.0|^102.0|^103.0magento/module-store: ^100.1|^101.0php: >=7.2.0ext-json: *ext-pcre: *All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
gooogletagmanager_container for most datalayer blocksCategory block to no longer depend on onLoadedProductCollectionScript, Category, Product, Generic, Custom)\Yireo\GoogleTagManager2\Util\GetCurrentProduct\Yireo\GoogleTagManager2\Util\GetCurrentCategoryRe-add CSP whitelisting
ExtDN forms a network of Magento extension developers, that strive for a better extension quality - both on a technical level and from an end-users point of view. With industry leaders like Fooman and aHeadworks, ExtDN lifts up the Magento extension space to a new level. And Yireo is proud to be part of this.
We don't write too commercial stuff, we focus on the technology (which we love) and we regularly come up with innovative solutions. Via our newsletter, you can keep yourself up to date on all of this coolness. Subscribing only takes seconds.
Sign up for the Yireo newsletter