Migrate Shopify integration

Prior to the launch of the native Didomi/Shopify integration, Didomi provided two scripts that could be manually added to your organization's Shopify store.

Script 1

Propagated consent from Shopify consent categories

Script 2

Checkout handling

In this article, we will cover how to remove these previous scripts so that your organization can migrate to the native Didomi/Shopify integration.

Organizations that have previously implemented script 1 and script 2 should remove those scripts before continuing with the configuration of the Didomi/Shopify native integration.

Remove script 1

Script 1 enabled your organization to propagate consent values for vendors configured in the Didomi CMP from the four Shopify consent categories: Analytics, Marketing, Preferences, and Sale of Data. The native Didomi/Shopify integration will handle this propagation once implemented, so this script should be removed from your Shopify store's theme code.

Navigate to the admin view of your Shopify store and click Online Store on the left-hand panel.

Click the ellipsis inline with the active theme for your online store and select Edit code from the drop-down menu.

In the Shopify store theme code editor, expand the layout menu and select the theme.liquid file.

Delete the Didomi SDK script from the <head> tag in the file. Below is an example of the Didomi SDK script.

Didomi SDK script example

<script type="text/javascript">(function(){function i(e){if(!window.frames[e]){if(document.body&&document.body.firstChild){var t=document.body;var n=document.createElement("iframe");n.style.display="none";n.name=e;n.title=e;t.insertBefore(n,t.firstChild)}else{setTimeout(function(){i(e)},5)}}}function e(n,o,r,f,s){function e(e,t,n,i){if(typeof n!=="function"){return}if(!window[o]){window[o]=[]}var a=false;if(s){a=s(e,i,n)}if(!a){window[o].push({command:e,version:t,callback:n,parameter:i})}}e.stub=true;e.stubVersion=2;function t(i){if(!window[n]||window[n].stub!==true){return}if(!i.data){return}var a=typeof i.data==="string";var e;try{e=a?JSON.parse(i.data):i.data}catch(t){return}if(e[r]){var o=e[r];windown{var n={};n[f]={returnValue:e,success:t,callId:o.callId};if(i.source){i.source.postMessage(a?JSON.stringify(n):n,"*")}},o.parameter)}}if(typeof window[n]!=="function"){window[n]=e;if(window.addEventListener){window.addEventListener("message",t,false)}else{window.attachEvent("onmessage",t)}}}e("__tcfapi","__tcfapiBuffer","__tcfapiCall","__tcfapiReturn");i("__tcfapiLocator")})();</script><script type="text/javascript">(function(){(function(e,i,o){var n=document.createElement("link");n.rel="preconnect";n.as="script";var t=document.createElement("link");t.rel="dns-prefetch";t.as="script";var r=document.createElement("script");r.id="spcloader";r.type="text/javascript";r["async"]=true;r.charset="utf-8";window.didomiConfig=window.didomiConfig||{};window.didomiConfig.sdkPath=window.didomiConfig.sdkPath||o||"https://sdk.privacy-center.org/";const d=window.didomiConfig.sdkPath;var a=d+e+"/loader.js?target_type=notice&target="+i;if(window.didomiConfig&&window.didomiConfig.user){var c=window.didomiConfig.user;var s=c.country;var f=c.region;if(s){a=a+"&country="+s;if(f){a=a+"&region="+f}}}n.href=d;t.href=d;r.src=a;var m=document.getElementsByTagName("script")[0];m.parentNode.insertBefore(n,m);m.parentNode.insertBefore(t,m);m.parentNode.insertBefore(r,m)})("myAPIKey","NoticeID")})();</script>

Next, locate the following line in the theme.liquid file and delete it to stop using the script in your Shopify store theme:

{% render 'didomi-shopify-integration' %}

Save the changes made to the file when finished.

Finally, expand the snippets menu and locate the didomi-shopify-integration.liquid file.

Right-click on the file and select Delete Permanently from the subsequent drop-down menu.

Confirm the decision to delete the didomi-shopify-integration.liquid file in the subsequent modal and click Delete.

Remove script 2

Script 2 enabled your organization to integrate the Didomi CMP into the Shopify checkout process by using a custom pixel within the Shopify store.

In order to remove this script, navigate to the admin view of your Shopify store and click Settings on the left-hand panel.

Click Customer events on the left-hand panel of the subsequent page.

Select the pixel where the Didomi script is added from the list.

Locate the script in the code editor for the pixel and remove it from the code. Below is an example.

Script 2 example

window.dataLayer = window.dataLayer || [];
function gtag() {
  dataLayer.push(arguments);
}

function areVendorsEnabledInToken() {
  const cookieName = "didomi_token";
  const vendorsToCheck = ["google", "c:googleana-4TXnJigR"];

  // Get the value of a specific cookie
  const getCookieValue = (cookieName) => {
    const cookies = document.cookie.split("; ");
    const cookie = cookies.find((c) => c.startsWith(`${cookieName}=`));
    return cookie ? decodeURIComponent(cookie.split("=")[1]) : null;
  };

  // Decode Base64 and parse JSON
  const decodeBase64Cookie = (base64String) => {
    const decodedString = atob(base64String);
    return JSON.parse(decodedString);
  };

  // Check which vendors are enabled
  const checkVendors = (cookieData, vendorsToCheck) => {
    const result = {};
    vendorsToCheck.forEach((vendor) => {
      result[vendor] =
        cookieData &&
        cookieData.vendors &&
        cookieData.vendors.enabled &&
        cookieData.vendors.enabled.includes(vendor);
    });
    return result;
  };

  // Retrieve Didomi token from cookies or localStorage
  const didomiToken =
    getCookieValue(cookieName) || localStorage.getItem(cookieName);

  if (!didomiToken) {
    console.error(`Cookie ${cookieName} not found.`);
    return null;
  }

  return checkVendors(decodeBase64Cookie(didomiToken), vendorsToCheck);
}

if (
  window.location.href.includes("/checkout/") ||
  window.location.href.includes("/checkouts/")
) {
  gtag("consent", "default", {
    ad_storage: "denied",
    analytics_storage: "denied",
    functionality_storage: "denied",
    personalization_storage: "denied",
    security_storage: "granted",
    ad_user_data: "denied",
    ad_personalization: "denied",
    wait_for_update: 500,
  });

  analytics.subscribe("page_viewed", () => {
    const { google, "c:googleana-4TXnJigR": googleAnalytics } =
      areVendorsEnabledInToken();
    gtag("consent", "update", {
      ad_storage: google ? "granted" : "denied",
      analytics_storage: googleAnalytics ? "granted" : "denied",
      functionality_storage: google ? "granted" : "denied",
      personalization_storage: google ? "granted" : "denied",
      security_storage: "granted",
      ad_user_data: google ? "granted" : "denied",
      ad_personalization: google ? "granted" : "denied",
      wait_for_update: 500,
    });
  });
}

Click Save when finished.

Last updated 2 days ago

<script type="text/javascript">(function(){function i(e){if(!window.frames[e]){if(document.body&&document.body.firstChild){var t=document.body;var n=document.createElement("iframe");n.style.display="none";n.name=e;n.title=e;t.insertBefore(n,t.firstChild)}else{setTimeout(function(){i(e)},5)}}}function e(n,o,r,f,s){function e(e,t,n,i){if(typeof n!=="function"){return}if(!window[o]){window[o]=[]}var a=false;if(s){a=s(e,i,n)}if(!a){window[o].push({command:e,version:t,callback:n,parameter:i})}}e.stub=true;e.stubVersion=2;function t(i){if(!window[n]||window[n].stub!==true){return}if(!i.data){return}var a=typeof i.data==="string";var e;try{e=a?JSON.parse(i.data):i.data}catch(t){return}if(e[r]){var o=e[r];windown{var n={};n[f]={returnValue:e,success:t,callId:o.callId};if(i.source){i.source.postMessage(a?JSON.stringify(n):n,"*")}},o.parameter)}}if(typeof window[n]!=="function"){window[n]=e;if(window.addEventListener){window.addEventListener("message",t,false)}else{window.attachEvent("onmessage",t)}}}e("__tcfapi","__tcfapiBuffer","__tcfapiCall","__tcfapiReturn");i("__tcfapiLocator")})();</script><script type="text/javascript">(function(){(function(e,i,o){var n=document.createElement("link");n.rel="preconnect";n.as="script";var t=document.createElement("link");t.rel="dns-prefetch";t.as="script";var r=document.createElement("script");r.id="spcloader";r.type="text/javascript";r["async"]=true;r.charset="utf-8";window.didomiConfig=window.didomiConfig||{};window.didomiConfig.sdkPath=window.didomiConfig.sdkPath||o||"https://sdk.privacy-center.org/";const d=window.didomiConfig.sdkPath;var a=d+e+"/loader.js?target_type=notice&target="+i;if(window.didomiConfig&&window.didomiConfig.user){var c=window.didomiConfig.user;var s=c.country;var f=c.region;if(s){a=a+"&country="+s;if(f){a=a+"&region="+f}}}n.href=d;t.href=d;r.src=a;var m=document.getElementsByTagName("script")[0];m.parentNode.insertBefore(n,m);m.parentNode.insertBefore(t,m);m.parentNode.insertBefore(r,m)})("myAPIKey","NoticeID")})();</script>

window.dataLayer = window.dataLayer || [];
function gtag() {
  dataLayer.push(arguments);
}

function areVendorsEnabledInToken() {
  const cookieName = "didomi_token";
  const vendorsToCheck = ["google", "c:googleana-4TXnJigR"];

  // Get the value of a specific cookie
  const getCookieValue = (cookieName) => {
    const cookies = document.cookie.split("; ");
    const cookie = cookies.find((c) => c.startsWith(`${cookieName}=`));
    return cookie ? decodeURIComponent(cookie.split("=")[1]) : null;
  };

  // Decode Base64 and parse JSON
  const decodeBase64Cookie = (base64String) => {
    const decodedString = atob(base64String);
    return JSON.parse(decodedString);
  };

  // Check which vendors are enabled
  const checkVendors = (cookieData, vendorsToCheck) => {
    const result = {};
    vendorsToCheck.forEach((vendor) => {
      result[vendor] =
        cookieData &&
        cookieData.vendors &&
        cookieData.vendors.enabled &&
        cookieData.vendors.enabled.includes(vendor);
    });
    return result;
  };

  // Retrieve Didomi token from cookies or localStorage
  const didomiToken =
    getCookieValue(cookieName) || localStorage.getItem(cookieName);

  if (!didomiToken) {
    console.error(`Cookie ${cookieName} not found.`);
    return null;
  }

  return checkVendors(decodeBase64Cookie(didomiToken), vendorsToCheck);
}

if (
  window.location.href.includes("/checkout/") ||
  window.location.href.includes("/checkouts/")
) {
  gtag("consent", "default", {
    ad_storage: "denied",
    analytics_storage: "denied",
    functionality_storage: "denied",
    personalization_storage: "denied",
    security_storage: "granted",
    ad_user_data: "denied",
    ad_personalization: "denied",
    wait_for_update: 500,
  });

  analytics.subscribe("page_viewed", () => {
    const { google, "c:googleana-4TXnJigR": googleAnalytics } =
      areVendorsEnabledInToken();
    gtag("consent", "update", {
      ad_storage: google ? "granted" : "denied",
      analytics_storage: googleAnalytics ? "granted" : "denied",
      functionality_storage: google ? "granted" : "denied",
      personalization_storage: google ? "granted" : "denied",
      security_storage: "granted",
      ad_user_data: google ? "granted" : "denied",
      ad_personalization: google ? "granted" : "denied",
      wait_for_update: 500,
    });
  });
}