Skip to main content

Custom Dimensions

Custom dimensions and metrics are additional data that can be sent with events. They are split into 3 scopes, user, event and item. This is a change from Universal Analytics, and is well documented elsewhere so it isn't detailed here.

There are 3 places where custom dimensions can be set:

  • Configuration settings
  • Shared event settings
  • Event fields to set

Configuration settings

Within the GA4 Google Tag you can use the "Configuration Settings Variable" to set configuration parameters. These are not custom dimensions, and we recommend only valid parameters should be set here.

Think of this as how your GA configuration should function, rather than what data it should send along with hits.

Shared event settings

Shared event settings are parameters that will be sent with every event. There is a list of 'valid' parameters, but this is also where we would add 'page level' custom dimensions.

Event fields to set

These are parameters that apply to a specific event. For data-track events, we hav

How does this work with data-track

The data-track tag has an additional shared event settings variable, where we set all of the allowed custom dimensions, such as category, action, label, context etc.

Note that when using the data attribute API, link_text, link_urls, file_name, and file_extension will automatically be sent as parameters if applicable.

Commonly used configuration settings

NameScopeTypeExample valueDescription
send_page_viewEventBooleantrueTODO

Commonly used shared event settings

User scoped

NameScopeTypeExample valueDescription
authorization_statusUserString11 / 0 to represent authorized / not authorized
bpidUserString3000093925;3001592458;3002782314;3003810391Business Partner ID- used to identify B2B partners
resolved_byUserStringIPTODO
sap_hybrid_idUserStringD9757671118F1EEF95B4942C6490C8A9TODO
sap_outbound_idUserString8B125A75F34234CE0A32B254C77610DA0DF8TODO
snidUserStringf6f43599-019c-48f8-8bb3-c4051b84faacTODO
user_search_versionUserString4The search version a user is set to use on Discovery

Event scoped

NameScopeTypeExample valueDescription
ab_test_valueEventStringnature-onwards-journey=falseTODO
access_typeEventString openTODO
article_typeEventStringcase reportTODO
associated_content_typesEventStringresearchTODO
book_product_typeEventStringencylopaediaTODO
book_seriesEventStringMethods in Molecular BiologyTODO
book_series_idEventString558TODO
book_titleEventStringComputer Vision – ECCV 2024TODO
collection_idEventStringbhfffjiadcTODO
collection_journal_idEventString12859TODO
collection_journal_titlesEventStringBMC MedicineTODO
content_cmsEventStringpolopolyTODO
content_idEventStringarticleTODO
content_typeEventStringarticleTODO
country_code_non_customersEventStringUSTODO
custom_defined_referrerEventStringhttps://www.google.com/TODO
darwinEventStringtrueTODO
doiEventString10.1038/s41586-022-05232-9TODO
e_isbnEventString978-94-007-0753-5TODO
eisbn_formattedEventString9781441910059TODO
full_htmlEventStringYTODO
ga_session_idEventString1731609155TODO
ga_session_numberEventString1TODO
grid_idEventStringgrid.459983.aTODO
has_bodyEventStringYTODO
is_authorizedEventStringYTODO
journal_idEventString41598TODO
journal_pcodeEventStringNatureTODO
journal_titleEventStringscientific reportsTODO
logged_in_to_sn_profileEventStringtrueTODO
magazineEventStringtrueTODO
oa_licenceEventStringtrueTODO
open_accessEventStringtrueTODO
organization_nameEventStringSpringer Nature AffiliatesTODO
organization_name_non_customersEventStringChina MobileTODO
organization_typeEventStringEducationTODO
organization_type_non_customersEventStringEducationTODO
page_typeEventStringarticleTODO
pisbn_formattedEventString9783319246109TODO
pmcEventStringLTODO
pmc_primary_subjectEventStringMedicine & Public HealthTODO
pmc_secondary_subject_1EventStringPlant SciencesTODO
pmc_secondary_subject_code_1EventStringL24000TODO
primary_article_typeEventStringreviewsTODO
pub_dateEventString2025-03-06TODO
publisher_brandEventStringSpringerTODO
recommendation_algorithmEventStringwhere-to-submit--collection; 0.0.1TODO
rs_embedded_userEventStringtrueTODO
rs_modelEventStringxgboostTODO
rs_policy_idEventStringspeedy-BootstrappedUCBTODO
rs_recommenderEventStringsemanticTODO
rs_timestampEventString1715487816TODO
search_termEventStringmachine learningTODO
snapp_submission_idEventString39c49657-2977-4c9c-980e-910344f0d6a4TODO
sntEventStringGeologyTODO
subject_termsEventStringpsychologyTODO
token_in_urlEventStringprtst0416pTODO
user_registeredEventStringtrueTODO
user_skipped_address_pageEventStringtrueTODO

Commonly used individual event settings

NameScopeTypeExample valueDescriptionStatus
actionEventstringOpen search trayDescribes what the user didDeprecated (superceded by the event name)
categoryEventstringHeaderDescribes the context within which an event happenedDeprecated (superceded by context)
labelEventstringButtonProvide specific detail about the event or element, such as whether it was a link or a buttonActive
contextEventstringSite headerThe context within which an event happened, can be applied to the track element, or a parent element. Similar to the legacy data-track-component.Active
indexEventnumber1The index/position of the item in a listActive
item_idEventstringC_12345The ID of the content interacted withActive
methodEventstringDialogThe method in which the interaction happenedActive
typeEventstringC_12345A more generic type than content_type, e.g. link or buttonActive
valueEventstringHomeA value that identifies a particular item by name, e.g. the text of a somethingActive

Heads Up!

If you want to use the custom dimensions in reports and explorations, you must register them in the GA interface. Contatct GA Enablement if you wish to have a new custom dimension set in GA.

You might see a value of (not set) for a custom dimension during the first 48 hours.