feat(tracker): add new disableCampaignParameters tracker method

EmmanuelRoux · May 28, 2024 · 4cfda65 · 4cfda65
1 parent 243fc46
commit 4cfda65
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/projects/ngx-matomo-client/core/tracker/matomo-tracker.service.spec.ts b/projects/ngx-matomo-client/core/tracker/matomo-tracker.service.spec.ts
@@ -739,6 +739,8 @@ describe('MatomoTracker', () => {
     expectSimpleMethod('enableBrowserFeatureDetection', []),
   );
 
+  it('should disable campaign parameters', expectSimpleMethod('disableCampaignParameters', []));
+
   it('should ignore calls when disabled', () => {
     // Given
     const tracker = createTracker({ disabled: true });

diff --git a/projects/ngx-matomo-client/core/tracker/matomo-tracker.service.ts b/projects/ngx-matomo-client/core/tracker/matomo-tracker.service.ts
@@ -1427,6 +1427,17 @@ export abstract class MatomoTracker {
     this.push(['enableBrowserFeatureDetection']);
   }
 
+  /**
+   * By default, Matomo will send campaign parameters (mtm, utm, etc.) to the tracker and record that information.
+   * Some privacy regulations may not allow for this information to be collected.
+   * If this applies to you, call this method to prevent campaign parameters from being sent to the tracker.
+   *
+   * <b>This method is available as of Matomo 5.1.</b>
+   */
+  disableCampaignParameters(): void {
+    this.push(['disableCampaignParameters']);
+  }
+
   /** Asynchronously call provided method name on matomo tracker instance */
   protected get<G extends Getters<MatomoInstance>>(
     getter: G,