GA4 Dataform Package

Usage

const ga4 = require("@ken-e/dataform-ga4");

const config =  {
  ...
};

ga4(config);

See example.js for advanced usage.

Config Params

| Parameter | Type | Default | Description | | ----------------------------- | -------------------- | ---------------------------- | ------------------------------------------------------------------- | | config | Object | — | The configuration object. | | config.sources | Object | — | Source-related configuration. | | config.sources.schemas | string \| string[] | — | A GA4 schema name or an array of schema names. | | config.sources.database | string (optional) | — | The name of the source database. Uses target.database if omitted. | | config.target | Object | — | Target configuration settings. | | config.target.database | string | — | Target database. | | config.target.stagingSchema | string (optional) | "df_warehouse_gsc_source" | The staging schema name. | | config.target.outputSchema | string (optional) | "df_warehouse_gsc_source" | The output schema name. | | config.enableIntraday | boolean (optional) | false | Flag to enable intraday processing. | | config.enableSessions | boolean (optional) | false | Flag to enable the ga4_session model. | | config.enableItems | boolean (optional) | false | Flag to enable the ga4_items model. | | config.enableUsers | boolean (optional) | false | Flag to enable the ga4_user model. | | config.timezone | string (optional) | "America/New_York" | The timezone for processing. | | config.unwantedReferrals | string (optional) | "samplereferraldomain.biz" | Unwanted referral domains. | | config.defaultEventParams | Object (optional) | — | Default event parameters. | | config.customEventParams | Array (optional) | [] | Custom event parameters. | | config.customQueryParams | Array (optional) | [] | Custom query parameters. | | config.startDate | string (optional) | "2020-10-01" | Start date for data processing. | | config.daysBack | number (optional) | 3 | Lookback window (should be ≥ 3). | | config.contentGroups | Array (optional) | null | Content groups to add to ga4_events. | | config.userIdOverwrite | string (optional) | "anonymous" | User ID overwrite setting. | | config.customEventFields | Array (optional) | [] | Custom fields to add to ga4_events. | | config.customSessionFields | Array (optional) | [] | Custom fields to add to ga4_sessions. | | Returns | Object | — | The processed configuration object. |