consent-8.x-1.0-alpha5/config/schema/consent.schema.yml

consent_block_settings:
  type: block_settings
  label: 'Consent Layer Block settings'
  mapping:
    trigger:
      type: mapping
      label: 'Trigger for user consents'
      mapping:
        storage:
          type: boolean
          label: 'Submit user consents to the backend storage.'
        click:
          type: boolean
          label: 'Enable automatic opt-in when clicking.'
        scroll:
          type: boolean
          label: 'Enable automatic opt-in when scrolling.'

oil_config_params:
  type: mapping
  label: 'OIL.js configuration parameters'
  mapping:
    preview_mode:
      type: boolean
      label: 'The preview mode is useful when testing OIL in a production or live environment.'
    config_version:
      type: integer
      label: 'Specifies the version of your OIL configuration.'
    advanced_settings:
      type: boolean
      label: 'Shows an advanced settings button, displaying the Cookie Preference Center.'
    advanced_settings_purposes_default:
      type: boolean
      label: 'All purposes in the advanced settings layer should be activated by default'
    cookie_expires_in_days:
      type: integer
      label: 'Value in days until the domain cookie used to save the users decision in days'
    cpc_type:
      type: string
      label: 'Specifies the type (the layout) of the Cookie Preference Center.'
    default_to_optin:
      type: boolean
      label: 'Signal opt-in to vendors while still displaying the Opt-In layer to the end user'
    gdpr_applies_globally:
      type: boolean
      label: 'Flag to indicate that publisher is from the EU.'
    iabVendorListUrl:
      type: string
      label: 'IAB Vendorlist to use'
    locale_url:
      type: string
      label: 'Locale Url'
    locale:
      type: mapping
      label: 'Locale settings'
      mapping:
        localeId:
          type: string
          label: 'Locale ID, e.g. enEN_01'
        version:
          type: integer
          label: 'Locale text version'
        texts:
          type: mapping
          label: 'Texts'
          mapping:
            label_intro_heading:
              type: string
              label: 'The headline of the layer'
            label_intro:
              type: string
              label: 'The text of the layer'
            label_button_yes:
              type: string
              label: 'The label of the consent button'
            label_button_back:
              type: string
              label: 'The label of the back button in cookie preference center (CPC)'
            label_button_advanced_settings:
              type: string
              label: 'The text of the link to the cookie preference center'
            label_cpc_heading:
              type: string
              label: 'The headline of the cookie preference center'
            label_cpc_text:
              type: string
              label: 'The intro text of the cookie preference center'
            label_cpc_activate_all:
              type: string
              label: 'The label of the button that activates all purposes'
            label_cpc_deactivate_all:
              type: string
              label: 'The label of the button that deactivates all purposes'
            label_cpc_purpose_desc:
              type: string
              label: 'The headline of the purposes section (standard CPC) or its intro text (Tab-based CPC)'
            label_cpc_purpose_optout_confirm_heading:
              type: string
              label: 'The headline of the opt-out confirmation dialog.'
            label_cpc_purpose_optout_confirm_text:
              type: string
              label: 'The text of the opt-out confirmation dialog.'
            label_cpc_purpose_optout_confirm_proceed:
              type: string
              label: 'The confirmation button label of the opt-out confirmation dialog.'
            label_cpc_purpose_optout_confirm_cancel:
              type: string
              label: 'The cancel button label of the opt-out confirmation dialog.'
            label_nocookie_head:
              type: string
              label: 'The headline that is shown if user has disallowed all cookies.'
            label_nocookie_text:
              type: string
              label: 'The text that is shown if user has disallowed all cookies.'
            label_poi_group_list_heading:
              type: string
              label: 'Headline for POI group section'
            label_poi_group_list_text:
              type: string
              label: 'Text for POI group section'
            label_third_party:
              type: string
              label: 'The headline of the vendors section in CPC'
    persist_min_tracking:
      type: boolean
      label: 'If minimum tracking should result in removing all OIL cookies from the users browser and close the layer and store this selection in the oil cookie.'
    poi_activate_poi:
      type: boolean
      label: 'Activates or deactivates Power Opt-In.'
    poi_group_name:
      type: 'string'
      label: 'POI group name. POI only affects those sites with the same group name (mandatory if POI is activated).'
    poi_hub_origin:
      type: string
      label: 'The origin of the hub.js installation'
    poi_hub_path:
      type: string
      label: 'The path to the hub.html installation on the origin, if any.'
    poi_subscriber_set_cookie:
      type: boolean
      label: 'Whether to set the SOI cookie on POI opt-ins or not.'
    publicPath:
      type: string
      label: 'The server path from which all chunks and resources will be loaded.'
    require_optout_confirm:
      type: boolean
      label: 'Flag to activate the opt-out confirmation dialog within Cookie Preference Center.'
    show_limited_vendors_only:
      type: boolean
      label: 'Flag to only show the vendors limited by iabVendorWhitelist or iabVendorBlacklist in the CPC'
    theme:
      type: string
      label: 'The theme for the layer.'
    timeout:
      type: integer
      label: 'Value in seconds until the opt-in layer will be automatically hidden. 0 or lower deactivates auto-hide.'

block.settings.oil_consent_layer:
  type: consent_block_settings
  label: 'OIL Consent Block settings'
  mapping:
    oil:
      type: oil_config_params
      label: 'OIL.js configuration parameters'