|
| 1 | +<!DOCTYPE html> |
| 2 | +<html lang="en" class="govuk-template "> |
| 3 | + |
| 4 | +<head> |
| 5 | + <meta charset="utf-8"> |
| 6 | + <title>Development approach | GOV.UK GA4 Implementation record</title> |
| 7 | + <link rel="stylesheet" type="text/css" href="/stylesheets/screen.css"/> |
| 8 | + <meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover"> |
| 9 | + <meta name="theme-color" content="#0b0c0c"> |
| 10 | + |
| 11 | + <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| 12 | + |
| 13 | + <meta name="twitter:card" content="summary" /> |
| 14 | + <meta name="twitter:domain" content="docs.publishing.service.gov.uk" /> |
| 15 | + <meta name="twitter:image" content="https://docs.publishing.service.gov.uk/assets/govuk/assets/rebrand/images/govuk-opengraph-image.png" /> |
| 16 | + <meta name="twitter:title" content="GOV.UK Developer Documentation" /> |
| 17 | + <meta name="twitter:url" content="https://docs.publishing.service.gov.uk/analytics/approach.html" /> |
| 18 | + |
| 19 | + <meta property="og:image" content="https://docs.publishing.service.gov.uk/assets/govuk/assets/rebrand/images/govuk-opengraph-image.png" /> |
| 20 | + <meta property="og:site_name" content="GOV.UK Developer Documentation" /> |
| 21 | + <meta property="og:type" content="object" /> |
| 22 | + <meta property="og:url" content="https://docs.publishing.service.gov.uk/analytics/approach.html" /> |
| 23 | + <meta name="description" content="Our development approach for implementing GA4 on GOV.UK Publishing."> |
| 24 | + <script> |
| 25 | + document.addEventListener('DOMContentLoaded', function () { |
| 26 | + var markup = `<div id="global-cookie-message" data-module="cookie-banner" data-nosnippet="" aria-label="Can we store analytics cookies on your device?" class="gem-c-cookie-banner govuk-clearfix govuk-cookie-banner js-banner-wrapper" role="region" hidden="hidden" title="Can we store analytics cookies on your device?"> <div class="govuk-cookie-banner__message govuk-width-container"> <div class="govuk-grid-row"> <div class="govuk-grid-column-two-thirds"> <h2 class="govuk-cookie-banner__heading govuk-heading-m">Can we store analytics cookies on your device?</h2> <div tabindex="-1" class="govuk-cookie-banner__content gem-c-cookie-banner__confirmation"> <div class="gem-c-cookie-banner__content"><p class='govuk-body'>We’d like to set some cookies to understand how you use this site and remember your settings.</p><p class='govuk-body'>We also use cookies set by other sites to help us deliver content from their services.</p></div> <p class="gem-c-cookie-banner__confirmation-message--accepted govuk-body" hidden data-ga4-cookie-banner data-module="ga4-link-tracker" data-ga4-track-links-only data-ga4-set-indexes data-ga4-link="{"event_name":"navigation","type":"cookie banner","section":"You have accepted additional cookies"}" >You have accepted additional cookies. <span class="gem-c-cookie-banner__confirmation-message">You can <a class="govuk-link" href="/cookies.html">change your cookie settings</a> at any time.</span></p> <p class="gem-c-cookie-banner__confirmation-message--rejected govuk-body" hidden>You have rejected additional cookies. <span class="gem-c-cookie-banner__confirmation-message">You can <a class="govuk-link" href="/cookies.html">change your cookie settings</a> at any time.</span></p> </div> </div> </div> <div class="js-confirmation-buttons govuk-button-group"> <button class="gem-c-button govuk-button" type="submit" data-accept-cookies="true" data-cookie-types="all">Accept additional cookies</button> <button class="gem-c-button govuk-button" type="submit" data-reject-cookies="true">Reject additional cookies</button> <a class="govuk-link" href="/cookies.html">View cookies</a> </div> <div hidden class="js-hide-button govuk-button-group"> <button class="gem-c-cookie-banner__hide-button govuk-button" data-hide-cookie-banner="true" data-module="ga4-event-tracker" data-ga4-event="{"event_name":"select_content","type":"cookie banner","action":"closed","section":"You have accepted additional cookies"}" > Hide cookie message </button> </div> </div> </div>`; |
| 27 | + var banner = document.createElement('div'); |
| 28 | + banner.innerHTML = markup; |
| 29 | + document.body.prepend(banner); |
| 30 | + }) |
| 31 | +</script> |
| 32 | + |
| 33 | +</head> |
| 34 | + |
| 35 | +<body class="govuk-template__body "> |
| 36 | + <script> |
| 37 | + document.body.className = ((document.body.className) ? document.body.className + ' js-enabled' : 'js-enabled'); |
| 38 | + </script> |
| 39 | + |
| 40 | + <a href="#main-content" class="govuk-skip-link" data-module="govuk-skip-link">Skip to main content</a> |
| 41 | + |
| 42 | + <header class="govuk-header " role="banner" data-module="govuk-header"> |
| 43 | + <div class="govuk-header__container"> |
| 44 | + <div class="govuk-width-container"> |
| 45 | + <div class="govuk-header__logo"> |
| 46 | + <a href="/analytics/" class="govuk-header__link govuk-header__link--homepage"> |
| 47 | + <svg |
| 48 | + focusable="false" |
| 49 | + role="img" |
| 50 | + class="govuk-header__logotype" |
| 51 | + xmlns="http://www.w3.org/2000/svg" |
| 52 | + viewBox="0 0 148 30" |
| 53 | + height="30" |
| 54 | + width="148" |
| 55 | + aria-label="GOV.UK" |
| 56 | + > |
| 57 | + <title>GOV.UK</title> |
| 58 | + <path d="M22.6 10.4c-1 .4-2-.1-2.4-1-.4-.9.1-2 1-2.4.9-.4 2 .1 2.4 1s-.1 2-1 2.4m-5.9 6.7c-.9.4-2-.1-2.4-1-.4-.9.1-2 1-2.4.9-.4 2 .1 2.4 1s-.1 2-1 2.4m10.8-3.7c-1 .4-2-.1-2.4-1-.4-.9.1-2 1-2.4.9-.4 2 .1 2.4 1s0 2-1 2.4m3.3 4.8c-1 .4-2-.1-2.4-1-.4-.9.1-2 1-2.4.9-.4 2 .1 2.4 1s-.1 2-1 2.4M17 4.7l2.3 1.2V2.5l-2.3.7-.2-.2.9-3h-3.4l.9 3-.2.2c-.1.1-2.3-.7-2.3-.7v3.4L15 4.7c.1.1.1.2.2.2l-1.3 4c-.1.2-.1.4-.1.6 0 1.1.8 2 1.9 2.2h.7c1-.2 1.9-1.1 1.9-2.1 0-.2 0-.4-.1-.6l-1.3-4c-.1-.2 0-.2.1-.3m-7.6 5.7c.9.4 2-.1 2.4-1 .4-.9-.1-2-1-2.4-.9-.4-2 .1-2.4 1s0 2 1 2.4m-5 3c.9.4 2-.1 2.4-1 .4-.9-.1-2-1-2.4-.9-.4-2 .1-2.4 1s.1 2 1 2.4m-3.2 4.8c.9.4 2-.1 2.4-1 .4-.9-.1-2-1-2.4-.9-.4-2 .1-2.4 1s0 2 1 2.4m14.8 11c4.4 0 8.6.3 12.3.8 1.1-4.5 2.4-7 3.7-8.8l-2.5-.9c.2 1.3.3 1.9 0 2.7-.4-.4-.8-1.1-1.1-2.3l-1.2 4c.7-.5 1.3-.8 2-.9-1.1 2.5-2.6 3.1-3.5 3-1.1-.2-1.7-1.2-1.5-2.1.3-1.2 1.5-1.5 2.1-.1 1.1-2.3-.8-3-2-2.3 1.9-1.9 2.1-3.5.6-5.6-2.1 1.6-2.1 3.2-1.2 5.5-1.2-1.4-3.2-.6-2.5 1.6.9-1.4 2.1-.5 1.9.8-.2 1.1-1.7 2.1-3.5 1.9-2.7-.2-2.9-2.1-2.9-3.6.7-.1 1.9.5 2.9 1.9l.4-4.3c-1.1 1.1-2.1 1.4-3.2 1.4.4-1.2 2.1-3 2.1-3h-5.4s1.7 1.9 2.1 3c-1.1 0-2.1-.2-3.2-1.4l.4 4.3c1-1.4 2.2-2 2.9-1.9-.1 1.5-.2 3.4-2.9 3.6-1.9.2-3.4-.8-3.5-1.9-.2-1.3 1-2.2 1.9-.8.7-2.3-1.2-3-2.5-1.6.9-2.2.9-3.9-1.2-5.5-1.5 2-1.3 3.7.6 5.6-1.2-.7-3.1 0-2 2.3.6-1.4 1.8-1.1 2.1.1.2.9-.3 1.9-1.5 2.1-.9.2-2.4-.5-3.5-3 .6 0 1.2.3 2 .9l-1.2-4c-.3 1.1-.7 1.9-1.1 2.3-.3-.8-.2-1.4 0-2.7l-2.9.9C1.3 23 2.6 25.5 3.7 30c3.7-.5 7.9-.8 12.3-.8m28.3-11.6c0 .9.1 1.7.3 2.5.2.8.6 1.5 1 2.2.5.6 1 1.1 1.7 1.5.7.4 1.5.6 2.5.6.9 0 1.7-.1 2.3-.4s1.1-.7 1.5-1.1c.4-.4.6-.9.8-1.5.1-.5.2-1 .2-1.5v-.2h-5.3v-3.2h9.4V28H55v-2.5c-.3.4-.6.8-1 1.1-.4.3-.8.6-1.3.9-.5.2-1 .4-1.6.6s-1.2.2-1.8.2c-1.5 0-2.9-.3-4-.8-1.2-.6-2.2-1.3-3-2.3-.8-1-1.4-2.1-1.8-3.4-.3-1.4-.5-2.8-.5-4.3s.2-2.9.7-4.2c.5-1.3 1.1-2.4 2-3.4.9-1 1.9-1.7 3.1-2.3 1.2-.6 2.6-.8 4.1-.8 1 0 1.9.1 2.8.3.9.2 1.7.6 2.4 1s1.4.9 1.9 1.5c.6.6 1 1.3 1.4 2l-3.7 2.1c-.2-.4-.5-.9-.8-1.2-.3-.4-.6-.7-1-1-.4-.3-.8-.5-1.3-.7-.5-.2-1.1-.2-1.7-.2-1 0-1.8.2-2.5.6-.7.4-1.3.9-1.7 1.5-.5.6-.8 1.4-1 2.2-.3.8-.4 1.9-.4 2.7zM71.5 6.8c1.5 0 2.9.3 4.2.8 1.2.6 2.3 1.3 3.1 2.3.9 1 1.5 2.1 2 3.4s.7 2.7.7 4.2-.2 2.9-.7 4.2c-.4 1.3-1.1 2.4-2 3.4-.9 1-1.9 1.7-3.1 2.3-1.2.6-2.6.8-4.2.8s-2.9-.3-4.2-.8c-1.2-.6-2.3-1.3-3.1-2.3-.9-1-1.5-2.1-2-3.4-.4-1.3-.7-2.7-.7-4.2s.2-2.9.7-4.2c.4-1.3 1.1-2.4 2-3.4.9-1 1.9-1.7 3.1-2.3 1.2-.5 2.6-.8 4.2-.8zm0 17.6c.9 0 1.7-.2 2.4-.5s1.3-.8 1.7-1.4c.5-.6.8-1.3 1.1-2.2.2-.8.4-1.7.4-2.7v-.1c0-1-.1-1.9-.4-2.7-.2-.8-.6-1.6-1.1-2.2-.5-.6-1.1-1.1-1.7-1.4-.7-.3-1.5-.5-2.4-.5s-1.7.2-2.4.5-1.3.8-1.7 1.4c-.5.6-.8 1.3-1.1 2.2-.2.8-.4 1.7-.4 2.7v.1c0 1 .1 1.9.4 2.7.2.8.6 1.6 1.1 2.2.5.6 1.1 1.1 1.7 1.4.6.3 1.4.5 2.4.5zM88.9 28 83 7h4.7l4 15.7h.1l4-15.7h4.7l-5.9 21h-5.7zm28.8-3.6c.6 0 1.2-.1 1.7-.3.5-.2 1-.4 1.4-.8.4-.4.7-.8.9-1.4.2-.6.3-1.2.3-2v-13h4.1v13.6c0 1.2-.2 2.2-.6 3.1s-1 1.7-1.8 2.4c-.7.7-1.6 1.2-2.7 1.5-1 .4-2.2.5-3.4.5-1.2 0-2.4-.2-3.4-.5-1-.4-1.9-.9-2.7-1.5-.8-.7-1.3-1.5-1.8-2.4-.4-.9-.6-2-.6-3.1V6.9h4.2v13c0 .8.1 1.4.3 2 .2.6.5 1 .9 1.4.4.4.8.6 1.4.8.6.2 1.1.3 1.8.3zm13-17.4h4.2v9.1l7.4-9.1h5.2l-7.2 8.4L148 28h-4.9l-5.5-9.4-2.7 3V28h-4.2V7zm-27.6 16.1c-1.5 0-2.7 1.2-2.7 2.7s1.2 2.7 2.7 2.7 2.7-1.2 2.7-2.7-1.2-2.7-2.7-2.7z"></path> |
| 59 | + </svg> |
| 60 | + </a> |
| 61 | + </div> |
| 62 | + <div class="govuk-header__content"> |
| 63 | + <a href="/analytics/" class="govuk-header__link govuk-header__service-name"> |
| 64 | + Implementation record |
| 65 | + </a> |
| 66 | + </div> |
| 67 | + </div> |
| 68 | + </div> |
| 69 | + </header> |
| 70 | + |
| 71 | + <div class="govuk-width-container "> |
| 72 | + <main class="govuk-main-wrapper"> |
| 73 | + <div class="govuk-grid-row"> |
| 74 | + <div class="govuk-grid-column-one-third"> |
| 75 | + <ul class="govuk-list"> |
| 76 | + <li> |
| 77 | + <a href="/analytics/" class="govuk-link">Implementation record</a> |
| 78 | + </li> |
| 79 | + </ul> |
| 80 | + |
| 81 | + <hr class="govuk-section-break govuk-section-break--m govuk-section-break--visible"> |
| 82 | + |
| 83 | + <ul class="govuk-list"> |
| 84 | + <li> |
| 85 | + <a href="/analytics/data.html" class="govuk-link">Data</a> |
| 86 | + </li> |
| 87 | + <ul class="govuk-list govuk-list--bullet"> |
| 88 | + <li> |
| 89 | + <a href="/analytics/events.html" class="govuk-link">Events</a> |
| 90 | + </li> |
| 91 | + <li> |
| 92 | + <a href="/analytics/attributes.html" class="govuk-link">Attributes</a> |
| 93 | + </li> |
| 94 | + <li> |
| 95 | + <a href="/analytics/schema.html" class="govuk-link">Data schemas</a> |
| 96 | + </li> |
| 97 | + </ul> |
| 98 | + </ul> |
| 99 | + |
| 100 | + <hr class="govuk-section-break govuk-section-break--m govuk-section-break--visible"> |
| 101 | + |
| 102 | + <ul class="govuk-list"> |
| 103 | + <li> |
| 104 | + <a href="/analytics/docs.html" class="govuk-link">Documentation</a> |
| 105 | + </li> |
| 106 | + <ul class="govuk-list govuk-list--bullet"> |
| 107 | + <li> |
| 108 | + <a href="/analytics/approach.html" class="govuk-link">Development approach</a> |
| 109 | + </li> |
| 110 | + <li> |
| 111 | + <a href="/analytics/consent.html" class="govuk-link">Consent handling</a> |
| 112 | + </li> |
| 113 | + <li> |
| 114 | + <a href="/analytics/pii.html" class="govuk-link">Personally identifiable information</a> |
| 115 | + </li> |
| 116 | + <li> |
| 117 | + <a href="/analytics/trackers.html" class="govuk-link">Trackers</a> |
| 118 | + </li> |
| 119 | + <li> |
| 120 | + <a href="/analytics/further_docs.html" class="govuk-link">Further reading</a> |
| 121 | + </li> |
| 122 | + </ul> |
| 123 | + </ul> |
| 124 | + |
| 125 | + <hr class="govuk-section-break govuk-section-break--m govuk-section-break--visible"> |
| 126 | + |
| 127 | + <ul class="govuk-list"> |
| 128 | + <li> |
| 129 | + <a href="/analytics/progress.html" class="govuk-link">Implementation progress</a> |
| 130 | + </li> |
| 131 | + </ul> |
| 132 | + </div> |
| 133 | + <div class="govuk-grid-column-two-thirds" id="main-content" role="main"> |
| 134 | + <h1 class="govuk-heading-l"> |
| 135 | + Development approach |
| 136 | +</h1> |
| 137 | + |
| 138 | +<p class="govuk-body">This is our high-level approach to implementing tracking across our applications.</p> |
| 139 | + |
| 140 | +<ul class="govuk-list govuk-list--bullet"> |
| 141 | + <li> |
| 142 | + For elements that are consistent from page to page (such as the header, footer and breadcrumbs) tracking should be enabled by default. |
| 143 | + </li> |
| 144 | + |
| 145 | + <li> |
| 146 | + For elements within the content of a page, tracking should be controllable. Specifically, tracking should be enabled on <a href="https://components.publishing.service.gov.uk/component-guide" class="govuk-link">components</a> by default but disabled with a ‘disable_ga4’ option. This provides the flexibility to disable tracking in the unforeseen event of some kind of tracking collision or duplication. |
| 147 | + </li> |
| 148 | + |
| 149 | + <li> |
| 150 | + For elements that are inside content coming from a publishing interface, such as <a href="https://components.publishing.service.gov.uk/component-guide/govspeak" class="govuk-link">govspeak</a> elements, tracking should be decided on a case by case basis. The most likely approach would be to enable tracking by default. This removes the need to provide publishers with an option to enable tracking on their content, which could get much more complex. |
| 151 | + </li> |
| 152 | +</ul> |
| 153 | + |
| 154 | +<p class="govuk-body">Enabling tracking should be as simple as possible. For this reason, tracking should be handled internally by components unless external data is required, that is, unless something unique must be passed from the application to the component to track it correctly.</p> |
| 155 | + |
| 156 | +<p class="govuk-body">During the development phase of the GA4 migration our approach with components was not to enable tracking by default, but to have a ‘ga4_tracking’ option that allowed tracking to be enabled. This allowed us greater control during testing and deployment.</p> |
| 157 | + |
| 158 | + </div> |
| 159 | + </div> |
| 160 | + </main> |
| 161 | + </div> |
| 162 | + |
| 163 | + <footer class="govuk-footer " role="contentinfo"> |
| 164 | + <div class="govuk-width-container "> |
| 165 | + <div class="govuk-footer__meta"> |
| 166 | + <div class="govuk-footer__meta-item govuk-footer__meta-item--grow"> |
| 167 | + <h2 class="govuk-visually-hidden">Support links</h2> |
| 168 | + <ul class="govuk-footer__inline-list"> |
| 169 | + <li class="govuk-footer__inline-list-item"> |
| 170 | + <a class="govuk-footer__link" href="/cookies.html"> |
| 171 | + Cookies |
| 172 | + </a> |
| 173 | + </li> |
| 174 | + </ul> |
| 175 | + <svg aria-hidden="true" focusable="false" class="govuk-footer__licence-logo" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 483.2 195.7" height="17" width="41"> |
| 176 | + <path fill="currentColor" d="M421.5 142.8V.1l-50.7 32.3v161.1h112.4v-50.7zm-122.3-9.6A47.12 47.12 0 0 1 221 97.8c0-26 21.1-47.1 47.1-47.1 16.7 0 31.4 8.7 39.7 21.8l42.7-27.2A97.63 97.63 0 0 0 268.1 0c-36.5 0-68.3 20.1-85.1 49.7A98 98 0 0 0 97.8 0C43.9 0 0 43.9 0 97.8s43.9 97.8 97.8 97.8c36.5 0 68.3-20.1 85.1-49.7a97.76 97.76 0 0 0 149.6 25.4l19.4 22.2h3v-87.8h-80l24.3 27.5zM97.8 145c-26 0-47.1-21.1-47.1-47.1s21.1-47.1 47.1-47.1 47.2 21 47.2 47S123.8 145 97.8 145" /> |
| 177 | + </svg> |
| 178 | + <span class="govuk-footer__licence-description"> |
| 179 | + All content is available under the |
| 180 | + <a class="govuk-footer__link" href="https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/" rel="license">Open Government Licence v3.0</a>, except where otherwise stated |
| 181 | + </span> |
| 182 | + </div> |
| 183 | + <div class="govuk-footer__meta-item"> |
| 184 | + <a class="govuk-footer__link govuk-footer__copyright-logo" href="https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/">© Crown copyright</a> |
| 185 | + </div> |
| 186 | + </div> |
| 187 | + </div> |
| 188 | + </footer> |
| 189 | + |
| 190 | + <script src="/javascripts/application.js"></script> |
| 191 | + <script> |
| 192 | + window.GOVUKFrontend.initAll() |
| 193 | + </script> |
| 194 | +</body> |
| 195 | +</html> |
0 commit comments