Google Tag Manager Upgrade Guide
This guide will instruct you on how to upgrade the CookieHub GTM template to the latest version.
Identifying Current Method
CookieHub previously offered three ways to implement CookieHub in GTM. From now on, the only supported method is to use the CookieHub GTM community template as instructed in the latest Google Tag Manager installation instructions.
You can easily identify the method by looking at the tag type in Google Tag Manager:
CookieHub GTM Community Template ✅
The tag type for the CookieHub GTM community template is "CookieHub CMP". If you are currently using this tag, you are already using the latest GTM implementation method.
Please refer to the How to Upgrade CookieHub GTM Community Template section below to upgrade.
Legacy CookieHub GTM Template ❌
If the tag type is "CookieHub," you are using a previous implementation that is not supported anymore and does not include the recommended consent mode setup.
Please refer to the How to Upgrade from legacy GTM implementations to the CookieHub GTM Community Template section below to upgrade.
Custom HTML ❌
If the tag type is "Custom HTML," you are using a legacy implementation that is not supported anymore and does not work with consent mode.
Please refer to the How to Upgrade from legacy GTM implementations to the CookieHub GTM Community Template section below to upgrade.
How to Upgrade CookieHub GTM Community Template
- Log in to your Google Tag Manager account.
- If an upgrade is available, a notification bar will be shown at the top of the workspace:
- Click the "View" link.
- Further information about the update will be shown. Click the CookieHub CMP line.
- A detailed list of changes will be shown. Click Accept Update to proceed.
- When the upgrade has been completed, click Submit to publish the changes.
How to Upgrade from legacy GTM implementations to the CookieHub GTM Community Template
The upgrade steps may vary depending on what triggers and variables are being used and if you have changed the CookieHub default settings, but in most cases, you can simply follow the Google Tag Manager installation instructions. Once completed, remove the old CookieHub tag.
Post-Upgrade Tasks
Below is a list of additional checks that should be done after upgrading to make sure CookieHub and consent mode are correctly set up in Google Tag Manager.
Firing Trigger for CookieHub CMP
Make sure you only use the "Consent Initialization - All Pages" firing trigger for the CookieHub CMP tag. This is very important because CookieHub must load before any other tags that rely on consent mode.
Firing Trigger for Other Tags
In previous CookieHub installations, you may have been instructed to use category-specific firing triggers to load tags in GTM, which include "CookieHub - Allowed Analytics", "CookieHub - Allowed Marketing", etc. While these triggers are still supported and work, they should not be used if you are using consent mode.
For tags with built-in consent mode support, you should use firing triggers as you would normally without CMP, as these tags will automatically check if the user has consented using consent mode signals. To figure out which tags have built-in support for consent mode, check out our Consent Overview guide.
For all other tags, you should set additional consent checks as instructed in the Additional Consent Guide.
Region Defaults for Consent Mode
In CookieHub 2.8 and later, the consent mode defaults are controlled using the CookieHub GTM community template. This applies both to the global consent mode defaults and region-specific defaults.
If you have more than one region configured in your CookieHub instance, set up the regional defaults in the CookieHub GTM community template as instructed in the Regions section in the Google Tag Manager installation guide.
The reason for this is that CookieHub hasn't loaded and hasn't looked up the user's location at the time when the CookieHub GTM community template sets the consent mode defaults.
Previously, this was handled by sending a consent mode update signal once CookieHub is loaded, but this is not in line with the consent mode recommendations as the consent mode update signal should only be sent when the user has interacted with the CookieHub dialog.