Integrating GCM v2 on Next.js using CookieYes GTM Template

Last updated on December 24, 2024

Welcome to our comprehensive guide on how to integrate GCM v2 on Next.js using the CookieYes GTM Template. This step-by-step tutorial will walk you through the process of setting up Google Consent Mode v2 on your Next.js Website, ensuring proper functionality and compliance with privacy regulations.

For New Users:

1. Create a CookieYes Account:
   Create a CookieYes account using your Next.js website’s URL.
2. Customise Your Cookie Banner:
   1. Select your Banner Language.
   2. Choose a Layout and Colour that suits your website design.
   3. Click Next Step to proceed.
3. Choose Installation Method:
   On the setup screen, select Install with Google Tag Manager as your installation method.

You can customise the consent banner according to your website’s requirements.

For Existing Users:

1. Log in to CookieYes:
   Log in to your CookieYes account with your existing credentials.
2. Remove the CookieYes Script:
   Ensure you remove the existing CookieYes script from your website.
3. Ensure that Google Consent Mode is enabled.
   By default, the Basic Consent Mode feature is enabled. If you have previously disabled it, follow these steps to turn it back on:
   1. Navigate to CookieYes Dashboard > Advanced Settings.
   2. In Advanced Settings, toggle the button (to the right) labelled “Support GCM“ to enable the Basic Consent Mode.

Step 1: Create an Account

1. Sign Up for a Google Tag Manager account 
2. Set up a container for your website.

Step 2: Add CookieYes CMP Template

1. Navigate to the container Dashboard and click Tags > New to create a new tag.
   
   
2. Name the tag, then click Tag Configuration > Discover more tag types in the Community Template Gallery.
   
   
   
   
3. Search for CookieYes CMP.
4. Select the CookieYes CMP template and click Add to workspace > Add to add it to your GTM installation.
   
   

Step 3: Configure CookieYes Tag

Insert the CookieYes website key, set other fields to appropriate values, and save the tag after naming it.

Insert the CookieYes Website Key

For New User:

1. Head back to the CookieYes setup screen and locate the Website Key.
2. Click the Copy key button to copy the Website Key to your clipboard.
3. In GTM, paste the copied key into this field labelled Website Keysite Key:
   • Head back to the CookieYes account.
   • Go to Advanced Settings and click Get Installation Code.
     
     

For Existing User

1. Head back to the CookieYes account.
2. Go to Advanced Settings and click Get Installation Code.
   
   
3. In the modal, click Install with Google Tag Manager > Copy code.
   
   
   
   
4. In the GTM account, paste the copied key into this field labelled Website Key.

• Set Default Consent Settings:
  • Click Add Setting.
  • Select Enabled/Disabled from the drop-down for each cookie category based on your requirements.
  • Set the Region by entering the ISO-standardized (ISO 3166-2) codes for the regions you intend to geo-target. If you do not want to geo-target specific regions, enter All in the Regions field. Refer to the ISO 3166-2 standard for appropriate region codes.
  • Click Add.
    
    

• Set the trigger:
  • Choose Consent Initialization – All Pages as the firing trigger. This ensures the tag activates before any other tags.
    
    

Step 4:Publish Changes

1. Click Save to complete the integration of CookieYes with the Google Consent Mode.
   
   
2. Click Submit and Publish to Publish your Container version.
   
   

To integrate Google Tag Manager into your Next.js project, navigate to src/app > layout.tsx follow these steps:

Step 1:Import the next/script component.

To load GTM in your Next.js application, add the following import statement at the top of the file:

import Script from "next/script";
const GTM_ID = "GTM-XXXXXXX";

Step 2:Add the Google Tag Manager script.

Insert the following Google Tag Manager script and NoScript tags into the layout.tsx file:

{/* Google Tag Manager Script */}
        { <Script id='gtm' strategy='afterInteractive'>
          {`
            (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
            new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
            j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
            'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
            })(window,document,'script','dataLayer','${GTM_ID}');
          `}
        </Script>}
        {
          /* Google Tag Manager NoScript (for when JavaScript is disabled) */
          <noscript>
            <iframe
              src={`https://www.googletagmanager.com/ns.html?id=${GTM_ID}`}
              height='0'
              width='0'
              style={{ display: "none", visibility: "hidden" }}
              title='Google Tag Manager'
            />
          </noscript>
        }

For both new and existing users, follow these steps to verify GCM integration on your website:

1. If you are a new user, first verify the cookie banner installation:
   • Go to the CookieYes setup screen and click Verify.
   • You will see the message: “You have successfully implemented a cookie banner on your site!”
     
     
2. After verifying the banner or if you’re an existing user, proceed to verify GCM:
   • Go to Dashboard > Advanced Settings.
   • Scroll to the Google Consent Mode (GCM) section.
   • Click Check now next to Check GCM status to run the configuration check.
     
     
     
     

If the configuration is correct, you will see a success message stating, ‘No error detected’. If you encounter any error after running this check, refer to our GCM Troubleshooting Guide to resolve them and check again.

To further confirm the setup is correct, follow the steps in our Verification Documentation.

To set Advance Consent Mode, follow the below set:

1. Navigate to CookieYes Dashboard > Advanced Settings.
2. To set up Advanced Consent Mode in GCM, toggle the button (to the right) labelled “Allow Google tags to fire before consent”.
   
   
3. Now, go back to your GTM account, click Submit, and then Publish to reflect the change on your website.

Enabling only the Support GCM option implements basic functionality, firing only allowed tags based on user consent. When you also activate Allow Google tags to fire before consent, it ensures Google tags fire even before the user consents to the banner, but they operate without setting cookies until the user provides consent. This balance allows for some data collection while respecting user privacy choices.

By following these steps, you will have integrated Google Consent Mode with your Next.js website using CookieYes CMP. You can complete your website scanning from the CookieYes Dashboard and explore further customizations and features.

For further assistance, our dedicated GCM