Custom Configuration
The definitions/custom/config.js file allows you to customize various aspects of the GA4Dataform models. You can control settings such as custom parameters, event filtering, hostname filtering, start date, and data validation checks.
If you are interested in seeing how these can be implemented after the install, take a look at the Post-Installation Guide!
Click on each card below to see more details!
GA4 Start Date
GA4_START_DATE: "2020-01-01"
Description: Defines the starting date for the GA4 data that the model should process.
Customization: Change this date to reflect the earliest data you want to include in your reports. For example, if you started collecting GA4 data on a different date, modify this to match that date.
Custom Event Parameters
CUSTOM_EVENT_PARAMS_ARRAY: []
Description: This allows you to specify custom event parameters that are not part of the standard GA4 data. The custom parameters will be added to the event_params_custom column.
Customization: Add parameters using the format "{ name: "paramname", type: "TYPE", renameTo: "outputcolumnname" }".
| Field | Description |
|---|---|
| name | The original event parameter name to extract |
| type | Data type for extraction and storage. int: Extracts from int_value, stores as INT; string: Extracts from all values, stores as STRING; decimal: Extracts from all numerical values, stores as FLOAT |
| renameTo | Optional - New name for the output column. If not specified, original parameter name is used |
| cleaningMethod | Optional - Transformation method to apply: lowerSQL: Converts string outputs to lowercase |
CUSTOM_EVENT_PARAMS_ARRAY: [
{ name: 'custom_param', type: 'string', renameTo: 'custom_output' },
{ name: 'n_items', type: 'int' }
]
Custom Item Parameters
CUSTOM_ITEM_PARAMS_ARRAY: []
Description: Similar to event parameters, but for item custom dimensions and metrics. These will be stored in the items.item_params_custom.* column.
Customization: Add custom item parameters in the same format.
| Field | Description |
|---|---|
| name | The original item parameter name to extract |
| type | Data type for extraction and storage. int: Extracts from int_value, stores as INT; string: Extracts from all values, stores as STRING; decimal: Extracts from all numerical values, stores as FLOAT |
| renameTo | Optional - New name for the output column. If not specified, original parameter name is used |
| cleaningMethod | Optional - Transformation method to apply: lowerSQL: Converts string outputs to lowercase |
CUSTOM_ITEM_PARAMS_ARRAY: [
{ name: "stock_status", type: "string" }
]
Custom URL Parameters
CUSTOM_URL_PARAMS_ARRAY: []
Description: Allows you to extract custom URL parameters into their own columns.
Customization: Define custom URL parameters you want to extract in the format "{ name: "param_name", cleaningMethod: method }". Note that URL params will always be strings. These will be stored in the url_params_custom column.
Cleaning Methods: For now, the only cleaning method supported is lowerSQL. This will transform the string to lower case. Note: use lowerSQL without quotes.
CUSTOM_URL_PARAMS_ARRAY: [
{ name: "q", cleaningMethod: lowerSQL },
{ name: "product-size", renameTo: "size" }
]
User Properties
CUSTOM_USER_PROPERTIES_ARRAY: []
Description: Allows you to extract user properties into their own columns.
Customization: Define user properties you want to extract in the format "{ name: "param_name", cleaningMethod: method }". These will be stored in the user_properties column.
| Field | Description |
|---|---|
| name | The original user property name to extract |
| type | Data type for extraction and storage. int: Extracts from int_value, stores as INT; string: Extracts from all values, stores as STRING; decimal: Extracts from all numerical values, stores as FLOAT |
| renameTo | Optional - New name for the output column. If not specified, original parameter name is used |
| cleaningMethod | Optional - Transformation method to apply: lowerSQL: Converts string outputs to lowercase |
CUSTOM_USER_PROPERTIES_ARRAY: [
{ name: "lifetime_value", type: "decimal" },
{ name: "membership_status", renameTo: "membership" }
]
Event and Hostname Filters
EVENTS_TO_EXCLUDE: []
Description: List the event names that should be excluded from the events table.
Customization: Add event names you don’t want to process.
Example:
EVENTS_TO_EXCLUDE: ["user_engagement", "scroll"]
HOSTNAME_EXCLUDE: []
HOSTNAME_INCLUDE_ONLY: []
Description: Exclude or include specific hostnames from the data.
Customization: Add hostnames to either list based on whether you want to include or exclude them from the data.
Example:
HOSTNAME_EXCLUDE: []
HOSTNAME_INCLUDE_ONLY: [ "www.ga4dataform.com", "ga4dataform.com" ]
Last Non-Direct Lookback Days
LAST_NON_DIRECT_LOOKBACK_DAYS: 90
Description: Defines the number of days to look back when assigning a source for a user who lands on your site without any known sources.
Customization: Change the number of days to your liking.
Data Quality Assertions
These assertions check the data for consistency and quality. You can enable or disable specific checks by setting them to true or false.
Event ID UniquenessASSERTIONS_EVENT_ID_UNIQUENESS: true
Ensures that each event has a unique event ID.
Session ID UniquenessASSERTIONS_SESSION_ID_UNIQUENESS: true
Ensures that each session has a unique session ID.
Session Duration ValidityASSERTIONS_SESSION_DURATION_VALIDITY: true
Ensures that session durations are valid and within reasonable limits.
Session ValidityASSERTIONS_SESSIONS_VALIDITY: true
Validates that session data is correct.
Tables TimelinessASSERTIONS_TABLES_TIMELINESS: true
Checks if the GA4 tables are up to date.
Transaction ID CompletenessASSERTIONS_TRANSACTION_ID_COMPLETENESS: false
Checks if transaction IDs are present for purchase events.
User Pseudo ID CompletenessASSERTIONS_USER_PSEUDO_ID_COMPLETENESS: false
Ensures that the "user_pseudo_id" is present for all hits.
If you use Advanced Consent Mode, this assertion will always fail.