You are here

Home » API reference » Google Analytics 4.x

google_analytics.schema.yml in Google Analytics 4.x

Same filename and directory in other branches
  1. 8.3 config/schema/google_analytics.schema.yml
  2. 8.2 config/schema/google_analytics.schema.yml
config/schema/google_analytics.schema.yml

File

config/schema/google_analytics.schema.yml
View source 
  1. # Schema for the configuration files of the google_analytics module.

  2. 

  3. google_analytics.settings:

  4.   type: config_object

  5.   label: 'Google Analytics settings'

  6.   mapping:

  7.     account:

  8.       type: string

  9.       label: 'Web Property ID'

  10.     premium:

  11.       type: boolean

  12.       label: 'Premium account'

  13.     domain_mode:

  14.       type: integer

  15.       label: 'What are you tracking?'

  16.     cross_domains:

  17.       type: string

  18.       label: 'List of top-level domains'

  19.     visibility:

  20.       type: mapping

  21.       label: 'Visibility'

  22.       mapping:

  23.         request_path_mode:

  24.           type: integer

  25.           label: 'Add tracking to specific pages'

  26.         request_path_pages:

  27.           type: string

  28.           label: 'Pages by their paths'

  29.         user_role_mode:

  30.           type: integer

  31.           label: 'Add tracking for specific roles'

  32.         user_role_roles:

  33.           type: sequence

  34.           label: 'Roles'

  35.           sequence:

  36.             type: string

  37.             label: 'Role'

  38.         user_account_mode:

  39.           type: integer

  40.           label: 'Allow users to customize tracking on their account page'

  41.     track:

  42.       type: mapping

  43.       label: 'Links and downloads'

  44.       mapping:

  45.         outbound:

  46.           type: boolean

  47.           label: 'Track clicks on outbound links'

  48.         mailto:

  49.           type: boolean

  50.           label: 'Track clicks on mailto links'

  51.         files:

  52.           type: boolean

  53.           label: 'Track downloads'

  54.         files_extensions:

  55.           type: string

  56.           label: 'File extension list'

  57.         colorbox:

  58.           type: boolean

  59.           label: 'Track content in colorbox modal dialogs'

  60.         linkid:

  61.           type: boolean

  62.           label: 'Enable enhanced link attribution'

  63.         urlfragments:

  64.           type: boolean

  65.           label: 'Track changing URL fragments as pageviews'

  66.         userid:

  67.           type: boolean

  68.           label: 'Track User ID'

  69.         messages:

  70.           type: sequence

  71.           label: 'Track messages of type'

  72.           sequence:

  73.             type: string

  74.             label: 'Message type'

  75.         site_search:

  76.           type: boolean

  77.           label: 'Track internal search'

  78.         adsense:

  79.           type: boolean

  80.           label: 'Track AdSense ads'

  81.         displayfeatures:

  82.           type: boolean

  83.           label: 'Track display features'

  84.     privacy:

  85.       type: mapping

  86.       label: 'Privacy'

  87.       mapping:

  88.         anonymizeip:

  89.           type: boolean

  90.           label: 'Anonymize visitors IP address'

  91.     custom:

  92.       type: mapping

  93.       label: 'Custom variables'

  94.       mapping:

  95.         dimension:

  96.           type: sequence

  97.           label: 'Custom dimensions'

  98.           sequence:

  99.             type: mapping

  100.             label: 'Dimension'

  101.             mapping:

  102.               index:

  103.                 type: integer

  104.                 label: Index

  105.               name:

  106.                 type: string

  107.                 label: Name

  108.               value:

  109.                 type: string

  110.                 label: Value

  111.         metric:

  112.           type: sequence

  113.           label: 'Custom metrics'

  114.           sequence:

  115.             type: mapping

  116.             label: 'Metric'

  117.             mapping:

  118.               index:

  119.                 type: integer

  120.                 label: Index

  121.               name:

  122.                 type: string

  123.                 label: Name

  124.               value:

  125.                 type: string

  126.                 label: Value

  127.     codesnippet:

  128.       type: mapping

  129.       label: 'Custom code snippets'

  130.       mapping:

  131.         create:

  132.           type: sequence

  133.           label: 'Parameters'

  134.           sequence:

  135.             type: ignore

  136.             label: 'Parameter'

  137.         before:

  138.           type: string

  139.           label: 'Code snippet (before)'

  140.         after:

  141.           type: string

  142.           label: 'Code snippet (after)'

  143.     translation_set:

  144.       type: boolean

  145.       label: 'Track translation sets as one unit'

  146.     cache:

  147.       type: boolean

  148.       label: 'Locally cache tracking code file'

  149.     debug:

  150.       type: boolean

  151.       label: 'Load debugging code of Google Universal Analytics'