After July 2021, the 2.3.x release line will no longer receive quality updates, or user guide updates. PHP 7.3 reaches end of support in December 2021 and Adobe Commerce 2.3.x reaches end of support in September 2022. We strongly recommend planning your upgrade now to Adobe Commerce 2.4.x to help maintain PCI compliance.

Google Tag Manager

The information on this page is intended for Adobe Commerce 2.3 customers who are on an extended support contract. The Adobe Commerce Merchant Documentation for current releases is published on the Adobe Experience League.
Magento Commerce only. Learn more.

Google Tag Manager helps you manage the many tags, or snippets of code, that are related to your marketing campaign events. Google Tag Manager gives you the ability to add tracking tags to your site to measure the audience, or to personalize, retarget, or conduct search engine marketing initiatives.

Google Tag Manager directly transfers data and events to Google Analytics, Enhanced Ecommerce and other third-party analytics solutions, to produce a clear picture of how well your site, products, and promotions are performing.

You should have a Google Analytics and Tag Manager account to continue this process. The following instructions walk you through the process of configuring your Google accounts, configuring your Magento store, and creating a tag.

If your business is subject to privacy regulations such as the General Data Protection Regulation and/or the California Consumer Privacy Act, see Google Privacy Settings.

Step 1. Configure Your Google Analytics Account

See Google’s Set up Site Search for the basics you need to get started. Also see the Google guides for Google Analytics and Google Tag Manager.

  1. Sign in to your Google Analytics account.

  2. To enable Internal Site Search Tracking, do the following:

    • Navigate to Select View > View Settings.

    • Set Site Search Tracking to On.

    • Set Query parameter to q.

    • When complete, Save the settings.

  3. To enable display features, do the following:

    • Choose Property Settings.

    • Under Advertising Features, set Enable Demographics and Interest Reports to On.

    • Save the settings.

  4. To enable Ecommerce Tracking, do the following:

    • Navigate to Select View > Ecommerce Settings.

    • Set Enable Ecommerce to On.

    • Set Enable Enhanced Ecommerce Reporting to On.

    • Save the settings.

  5. Reload the page to verify that all the settings remain On.

    If not all settings are On, repeat the previous steps, save, and reload the page. Repeat this process until all settings are set to On.

Step 2. Configure Your Google Tag Manager Account

The following instructions show how to configure a new container with the basic settings. A sample Composer configuration (.json) file is used to simplify the process, importing to generate a tag in a new container. For this example, we recommend that you create a new container, rather than modify an existing container.

For additional information, see Google’s Container export and import. These instructions walk-through importing a sample JSON to a new container.

  1. Download the linked file GTM_M2_Config_json.txt and do the following:

    • Open the file in an editor, and save as GTM_M2_Config.json.

    • Zip the file to produce an archive called GTM_M2_Config.zip.

      The zipped file will be uploaded directly to Google Tag Manager, and does not need to be copied to your server.

  2. Navigate to AdminContainer > Import Container.

  3. Click Choose container file and select the json file.

  4. Under Choose workspace, click New.

  5. Enter a title and description, then click Save.

  6. Select one of the following actions to import the file:

    • The Overwrite option should be selected for the new container.
    • The Merge option should be selected is you are using an existing container.
  7. Click Preview to review the tags, triggers, and variables.

  8. To edit the Google Analytics ID that is referenced in variables, do the following:

    • Navigate to VariablesUser-Defined Variables.

    • Choose Google Analytics. Then, update the placeholder (UA-xxxxxx-x) with your own GA ID.

  9. Follow Google’s instructions to add tags, triggers, and variables to the new container.

    If you have settings in another container that you want to use, they can be moved to the new container.

  10. Click Confirm when complete.

  11. Follow Google’s instructions to publish the new container.

Step 3. Configure Your Store

  1. Log in to the Admin of your Magento store.

  2. On the Admin sidebar, go to Stores > Settings > Configuration.

  3. In the left panel, expand Sales and choose Google API.

  4. Expand Expansion selector the Google Analytics section and configure the following:

    Sales configuration - Google Analytics Google API - Google Tag Manager

    • Set Enable to Yes.

    • Set Account type to Google Tag Manager.

    • In the Container ID field, enter your GTM ID (GTM-xxxxxx).

    • If you are also using Google Analytics to content experiments, set Enable Content Experiments to Yes.

    • Use the default values for the remaining fields.

  5. When complete, click Save Config.

  6. Test your Google Tag Manager settings to verify that everything works correctly.

Field Descriptions

Field Scope Description
Enable Store View Determines if Google Analytics Enhanced Ecommerce can be used to analyze activity in your store. Options: Yes / No
Account type Store View Determines the Google tracking code that is used to monitor store activity and traffic. Options: Google Analytics / Google Tag Manager
Anonymize IP Store View Determines if identifying information is removed from IP addresses that appear in Google Analytics results.
Enable Content Experiments Store View Activates Google Content Experiments, which can be used to test up to ten different versions of the same page. Options: Yes / No
Container Id Store View If Google Tag manager is already installed and configured for your store, the Container ID appears automatically in this field.
List property for the catalog page Store View Identifies the Tag Manager property associated with the catalog page. Default value: Catalog Page
List property for the cross-sell block Store View Identifies the Tag Manager property associated with the cross-sell block. Default value: Cross-sell
List property for the up-sell block Store View Identifies the Tag Manager property associated with the up-sell block. Default value: Up-sell
List property for the related products block Store View Identifies the Tag Manager property associated with the related products block. Default value: Related Products
List property for the search results page Store View Identifies the Tag Manager property associated with the search results page. Default value: Search Results
“Internal Promotions” for promotions field “Label” Store View Identifies the Tag Manager property associated with the labels for internal promotions. Default value: Label