@mparticle/web-google-analytics-4-server-kit 1.0.0

package/README.md

@@ -0,0 +1,30 @@
+# mParticle Google Analytis 4 Server Side Kit Integration
+
+Google's server side API for GA4 requires a `client_id` which still necessitates loading Google's SDK. In this kit, mParticle loads the SDK, collects the `client_id`, and sends this as an integration attribute to our server to include it on events sent to GA4.
+
+# Usage
+JS kits are automatically included with your mParticle.js file when loading mParticle via the [snippet](https://docs.mparticle.com/developers/sdk/web/getting-started/#add-the-sdk-snippet).
+
+If loading mParticle via [npm](https://docs.mparticle.com/developers/sdk/web/self-hosting/), you will have to manually include the server side GA4 kit via npm:
+
+```
+npm i @mparticle/web-google-analytics-4-server-kit
+```
+
+Full documentation on usage can be found [here](https://docs.mparticle.com/integrations/google-analytics-4/event/).
+
+#License
+
+Copyright 2022 mParticle, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/dist/GoogleAnalytics4EventForwarderServerSide-Kit.common.js

@@ -0,0 +1,129 @@
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/* eslint-disable no-undef */
+
+//
+//  Copyright 2022 mParticle, Inc.
+//
+//  Licensed under the Apache License, Version 2.0 (the 'License');
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an 'AS IS' BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+
+
+// This GA4 server side kit loads gtag, gets the client id, and sets it as an integration attribute on the core sdk.
+// This kit does not have a `processEvent` method because no events should be sent client side.
+
+var name = 'GoogleAnalytics4EventForwarder',
+    GA4MODULENUMBER = 160;
+
+var constructor = function() {
+    var self = this;
+    self.name = name;
+
+    function initForwarder(forwarderSettings, service, testMode) {
+        mParticle._setIntegrationDelay(GA4MODULENUMBER, true);
+
+        var measurementId = forwarderSettings.measurementId;
+        window.dataLayer = window.dataLayer || [];
+
+        window.gtag = function() {
+            window.dataLayer.push(arguments);
+        };
+
+        if (!testMode) {
+            var clientScript = document.createElement('script');
+            clientScript.type = 'text/javascript';
+            clientScript.async = true;
+            clientScript.src =
+                'https://www.googletagmanager.com/gtag/js?id=' + measurementId;
+            (
+                document.getElementsByTagName('head')[0] ||
+                document.getElementsByTagName('body')[0]
+            ).appendChild(clientScript);
+
+            clientScript.onload = function() {
+                gtag('js', new Date());
+
+                gtag('get', measurementId, 'client_id', function(clientId) {
+                    setClientId(clientId, GA4MODULENUMBER);
+                });
+                return;
+            };
+        }
+    }
+
+    this.init = initForwarder;
+};
+    
+function setClientId(clientId, GA4MODULENUMBER) {
+    var GA4CLIENTID = 'client_id';
+    var ga4IntegrationAttributes = {};
+    ga4IntegrationAttributes[GA4CLIENTID] = clientId;
+    mParticle.setIntegrationAttribute(
+        GA4MODULENUMBER,
+        ga4IntegrationAttributes
+    );
+    mParticle._setIntegrationDelay(GA4MODULENUMBER, false);
+}
+
+function getId() {
+    return GA4MODULENUMBER;
+}
+
+if (window && window.mParticle && window.mParticle.addForwarder) {
+    window.mParticle.addForwarder({
+        name: name,
+        constructor: constructor,
+        getId: getId,
+    });
+}
+
+function register(config) {
+    if (!config) {
+        window.console.log(
+            'You must pass a config object to register the kit ' + name
+        );
+        return;
+    }
+
+    if (!isObject(config)) {
+        window.console.log(
+            "'config' must be an object. You passed in a " + typeof config
+        );
+        return;
+    }
+
+    if (isObject(config.kits)) {
+        config.kits[name] = {
+            constructor: constructor,
+        };
+    } else {
+        config.kits = {};
+        config.kits[name] = {
+            constructor: constructor,
+        };
+    }
+    window.console.log(
+        'Successfully registered ' + name + ' to your mParticle configuration'
+    );
+}
+
+function isObject(val) {
+    return (
+        val != null && typeof val === 'object' && Array.isArray(val) === false
+    );
+}
+
+var GoogleAnalytics4EventForwarderServerSide = {
+    register: register,
+};
+
+exports.default = GoogleAnalytics4EventForwarderServerSide;

package/dist/GoogleAnalytics4EventForwarderServerSide-Kit.iife.js

@@ -0,0 +1,132 @@
+var mParticleGA4 = (function (exports) {
+    /* eslint-disable no-undef */
+
+    //
+    //  Copyright 2022 mParticle, Inc.
+    //
+    //  Licensed under the Apache License, Version 2.0 (the 'License');
+    //  you may not use this file except in compliance with the License.
+    //  You may obtain a copy of the License at
+    //
+    //      http://www.apache.org/licenses/LICENSE-2.0
+    //
+    //  Unless required by applicable law or agreed to in writing, software
+    //  distributed under the License is distributed on an 'AS IS' BASIS,
+    //  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    //  See the License for the specific language governing permissions and
+    //  limitations under the License.
+
+
+    // This GA4 server side kit loads gtag, gets the client id, and sets it as an integration attribute on the core sdk.
+    // This kit does not have a `processEvent` method because no events should be sent client side.
+
+    var name = 'GoogleAnalytics4EventForwarder',
+        GA4MODULENUMBER = 160;
+
+    var constructor = function() {
+        var self = this;
+        self.name = name;
+
+        function initForwarder(forwarderSettings, service, testMode) {
+            mParticle._setIntegrationDelay(GA4MODULENUMBER, true);
+
+            var measurementId = forwarderSettings.measurementId;
+            window.dataLayer = window.dataLayer || [];
+
+            window.gtag = function() {
+                window.dataLayer.push(arguments);
+            };
+
+            if (!testMode) {
+                var clientScript = document.createElement('script');
+                clientScript.type = 'text/javascript';
+                clientScript.async = true;
+                clientScript.src =
+                    'https://www.googletagmanager.com/gtag/js?id=' + measurementId;
+                (
+                    document.getElementsByTagName('head')[0] ||
+                    document.getElementsByTagName('body')[0]
+                ).appendChild(clientScript);
+
+                clientScript.onload = function() {
+                    gtag('js', new Date());
+
+                    gtag('get', measurementId, 'client_id', function(clientId) {
+                        setClientId(clientId, GA4MODULENUMBER);
+                    });
+                    return;
+                };
+            }
+        }
+
+        this.init = initForwarder;
+    };
+        
+    function setClientId(clientId, GA4MODULENUMBER) {
+        var GA4CLIENTID = 'client_id';
+        var ga4IntegrationAttributes = {};
+        ga4IntegrationAttributes[GA4CLIENTID] = clientId;
+        mParticle.setIntegrationAttribute(
+            GA4MODULENUMBER,
+            ga4IntegrationAttributes
+        );
+        mParticle._setIntegrationDelay(GA4MODULENUMBER, false);
+    }
+
+    function getId() {
+        return GA4MODULENUMBER;
+    }
+
+    if (window && window.mParticle && window.mParticle.addForwarder) {
+        window.mParticle.addForwarder({
+            name: name,
+            constructor: constructor,
+            getId: getId,
+        });
+    }
+
+    function register(config) {
+        if (!config) {
+            window.console.log(
+                'You must pass a config object to register the kit ' + name
+            );
+            return;
+        }
+
+        if (!isObject(config)) {
+            window.console.log(
+                "'config' must be an object. You passed in a " + typeof config
+            );
+            return;
+        }
+
+        if (isObject(config.kits)) {
+            config.kits[name] = {
+                constructor: constructor,
+            };
+        } else {
+            config.kits = {};
+            config.kits[name] = {
+                constructor: constructor,
+            };
+        }
+        window.console.log(
+            'Successfully registered ' + name + ' to your mParticle configuration'
+        );
+    }
+
+    function isObject(val) {
+        return (
+            val != null && typeof val === 'object' && Array.isArray(val) === false
+        );
+    }
+
+    var GoogleAnalytics4EventForwarderServerSide = {
+        register: register,
+    };
+
+    exports.default = GoogleAnalytics4EventForwarderServerSide;
+
+    return exports;
+
+}({}));

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@mparticle/web-google-analytics-4-server-kit",
+  "version": "1.0.0",
+  "description": "mParticle integration sdk for Google Analytics (server side)",
+  "main": "dist/GoogleAnalytics4EventForwarderServerSide-Kit.common.js",
+  "browser": "dist/GoogleAnalytics4EventForwarderServerSide-Kit.iife.js",
+  "scripts": {
+    "build": "rollup --config rollup.config.js",
+    "watch": "rollup --config rollup.config.js -w"
+  },
+  "author": "mParticle Developers <developers@mparticle.com> (https://www.mparticle.com)",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": "https://github.com/mparticle-integrations/mparticle-javascript-integration-google-analytics-4/tree/master/packages/GA4Server",
+  "devDependencies": {
+    "rollup": "^1.15.6"
+  }
+}

package/rollup.config.js

@@ -0,0 +1,31 @@
+const input = 'src/GoogleAnalytics4EventForwarderServerSide.js';
+
+const outputOptions = {
+    exports: 'named',
+    strict: false,
+};
+
+const builds = {
+    // for dynamic script tag loading of GA4 server side kit
+    server_iife: {
+        input,
+        output: {
+            ...outputOptions,
+            name: 'mParticleGA4',
+            file: 'dist/GoogleAnalytics4EventForwarderServerSide-Kit.iife.js',
+            format: 'iife',
+        },
+    },
+    // creates npm module for GA4 server side kit
+    server_cjs: {
+        input,
+        output: {
+            ...outputOptions,
+            name: 'mParticleGA4',
+            file: 'dist/GoogleAnalytics4EventForwarderServerSide-Kit.common.js',
+            format: 'cjs',
+        },
+    },
+};
+
+export default [builds.server_iife, builds.server_cjs];

package/src/GoogleAnalytics4EventForwarderServerSide.js

@@ -0,0 +1,125 @@
+/* eslint-disable no-undef */
+
+//
+//  Copyright 2022 mParticle, Inc.
+//
+//  Licensed under the Apache License, Version 2.0 (the 'License');
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an 'AS IS' BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+
+
+// This GA4 server side kit loads gtag, gets the client id, and sets it as an integration attribute on the core sdk.
+// This kit does not have a `processEvent` method because no events should be sent client side.
+
+var name = 'GoogleAnalytics4EventForwarder',
+    GA4MODULENUMBER = 160;
+
+var constructor = function() {
+    var self = this;
+    self.name = name;
+
+    function initForwarder(forwarderSettings, service, testMode) {
+        mParticle._setIntegrationDelay(GA4MODULENUMBER, true);
+
+        var measurementId = forwarderSettings.measurementId;
+        window.dataLayer = window.dataLayer || [];
+
+        window.gtag = function() {
+            window.dataLayer.push(arguments);
+        };
+
+        if (!testMode) {
+            var clientScript = document.createElement('script');
+            clientScript.type = 'text/javascript';
+            clientScript.async = true;
+            clientScript.src =
+                'https://www.googletagmanager.com/gtag/js?id=' + measurementId;
+            (
+                document.getElementsByTagName('head')[0] ||
+                document.getElementsByTagName('body')[0]
+            ).appendChild(clientScript);
+
+            clientScript.onload = function() {
+                gtag('js', new Date());
+
+                gtag('get', measurementId, 'client_id', function(clientId) {
+                    setClientId(clientId, GA4MODULENUMBER);
+                });
+                return;
+            };
+        }
+    }
+
+    this.init = initForwarder;
+};
+    
+function setClientId(clientId, GA4MODULENUMBER) {
+    var GA4CLIENTID = 'client_id';
+    var ga4IntegrationAttributes = {};
+    ga4IntegrationAttributes[GA4CLIENTID] = clientId;
+    mParticle.setIntegrationAttribute(
+        GA4MODULENUMBER,
+        ga4IntegrationAttributes
+    );
+    mParticle._setIntegrationDelay(GA4MODULENUMBER, false);
+}
+
+function getId() {
+    return GA4MODULENUMBER;
+}
+
+if (window && window.mParticle && window.mParticle.addForwarder) {
+    window.mParticle.addForwarder({
+        name: name,
+        constructor: constructor,
+        getId: getId,
+    });
+}
+
+function register(config) {
+    if (!config) {
+        window.console.log(
+            'You must pass a config object to register the kit ' + name
+        );
+        return;
+    }
+
+    if (!isObject(config)) {
+        window.console.log(
+            "'config' must be an object. You passed in a " + typeof config
+        );
+        return;
+    }
+
+    if (isObject(config.kits)) {
+        config.kits[name] = {
+            constructor: constructor,
+        };
+    } else {
+        config.kits = {};
+        config.kits[name] = {
+            constructor: constructor,
+        };
+    }
+    window.console.log(
+        'Successfully registered ' + name + ' to your mParticle configuration'
+    );
+}
+
+function isObject(val) {
+    return (
+        val != null && typeof val === 'object' && Array.isArray(val) === false
+    );
+}
+
+export default {
+    register: register,
+};