feat: ketch config added for ga4 (#963)

Co-authored-by: Moumita Mandal <[email protected]> Co-authored-by: Anant Jain <[email protected]> Co-authored-by: Ujjwal Abhishek <[email protected]> Co-authored-by: ujjwal-ab <[email protected]>
rudderlabs · Oct 6, 2023 · 89faa0e · 89faa0e
1 parent 7026ada
commit 89faa0e
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 46 deletions.
diff --git a/src/configurations/destinations/ga4/db-config.json b/src/configurations/destinations/ga4/db-config.json
@@ -16,7 +16,8 @@
       "eventFilteringOption",
       "extendPageViewParams",
       "oneTrustCookieCategories",
-      "overrideClientAndSessionId"
+      "overrideClientAndSessionId",
+      "ketchConsentPurposes"
     ],
     "excludeKeys": [],
     "supportedSourceTypes": [
@@ -70,7 +71,8 @@
         "whitelistedEvents",
         "blacklistedEvents",
         "eventFilteringOption",
-        "oneTrustCookieCategories"
+        "oneTrustCookieCategories",
+        "ketchConsentPurposes"
       ],
       "web": [
         "debugView",

diff --git a/src/configurations/destinations/ga4/schema.json b/src/configurations/destinations/ga4/schema.json
@@ -1,10 +1,7 @@
 {
   "configSchema": {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "required": [
-      "apiSecret",
-      "typesOfClient"
-    ],
+    "required": ["apiSecret", "typesOfClient"],
     "type": "object",
     "properties": {
       "apiSecret": {
@@ -13,10 +10,7 @@
       },
       "typesOfClient": {
         "type": "string",
-        "enum": [
-          "gtag",
-          "firebase"
-        ],
+        "enum": ["gtag", "firebase"],
         "default": "gtag"
       },
       "debugMode": {
@@ -25,11 +19,7 @@
       },
       "eventFilteringOption": {
         "type": "string",
-        "enum": [
-          "disable",
-          "whitelistedEvents",
-          "blacklistedEvents"
-        ],
+        "enum": ["disable", "whitelistedEvents", "blacklistedEvents"],
         "default": "disable"
       },
       "whitelistedEvents": {
@@ -68,15 +58,24 @@
           }
         }
       },
+      "ketchConsentPurposes": {
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "purpose": {
+              "type": "string",
+              "pattern": "(^\\{\\{.*\\|\\|(.*)\\}\\}$)|(^env[.].+)|^(.{0,100})$"
+            }
+          }
+        }
+      },
       "capturePageView": {
         "type": "object",
         "properties": {
           "web": {
             "type": "string",
-            "enum": [
-              "rs",
-              "gtag"
-            ],
+            "enum": ["rs", "gtag"],
             "default": "rs"
           }
         }
@@ -124,25 +123,15 @@
         "properties": {
           "android": {
             "type": "string",
-            "enum": [
-              "cloud",
-              "device"
-            ]
+            "enum": ["cloud", "device"]
           },
           "ios": {
             "type": "string",
-            "enum": [
-              "cloud",
-              "device"
-            ]
+            "enum": ["cloud", "device"]
           },
           "web": {
             "type": "string",
-            "enum": [
-              "cloud",
-              "device",
-              "hybrid"
-            ]
+            "enum": ["cloud", "device", "hybrid"]
           }
         }
       }
@@ -155,9 +144,7 @@
               "const": "gtag"
             }
           },
-          "required": [
-            "typesOfClient"
-          ]
+          "required": ["typesOfClient"]
         },
         "then": {
           "properties": {
@@ -166,9 +153,7 @@
               "pattern": "(^\\{\\{.*\\|\\|(.*)\\}\\}$)|(^env[.].+)|^(G-.{1,100})$|^$"
             }
           },
-          "required": [
-            "measurementId"
-          ]
+          "required": ["measurementId"]
         }
       },
       {
@@ -178,9 +163,7 @@
               "const": "firebase"
             }
           },
-          "required": [
-            "typesOfClient"
-          ]
+          "required": ["typesOfClient"]
         },
         "then": {
           "properties": {
@@ -189,11 +172,9 @@
               "pattern": "(^\\{\\{.*\\|\\|(.*)\\}\\}$)|(^env[.].+)|^(.{1,100})$"
             }
           },
-          "required": [
-            "firebaseAppId"
-          ]
+          "required": ["firebaseAppId"]
         }
       }
     ]
   }
-}
+}
diff --git a/src/configurations/destinations/ga4/ui-config.json b/src/configurations/destinations/ga4/ui-config.json
@@ -238,14 +238,40 @@
                     "note": "Input your OneTrust category names by pressing ‘Enter’ after each entry",
                     "configKey": "oneTrustCookieCategories",
                     "tagKey": "oneTrustCookieCategory",
-                    "placeholder": "e.g: Credit card visit",
+                    "placeholder": "e.g: Marketing",
                     "default": [
                       {
                         "oneTrustCookieCategory": ""
                       }
                     ]
                   }
                 ]
+              },
+              {
+                "title": "Ketch consent purpose settings",
+                "note": [
+                  "Enter your Ketch purpose Id if you have them configured. ",
+                  {
+                    "text": "Learn more ",
+                    "link": "https://www.rudderstack.com/docs/sources/event-streams/sdks/consent-manager/ketch/"
+                  },
+                  "about RudderStack and Ketch Consent Manager integration."
+                ],
+                "fields": [
+                  {
+                    "type": "tagInput",
+                    "label": "Purpose ID",
+                    "note": "Input your Ketch purpose Id by pressing ‘Enter’ after each entry",
+                    "configKey": "ketchConsentPurposes",
+                    "tagKey": "purpose",
+                    "placeholder": "e.g: Marketing",
+                    "default": [
+                      {
+                        "purpose": ""
+                      }
+                    ]
+                  }
+                ]
               }
             ]
           }