Source code
Revision control
Copy as Markdown
Other Tools
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# yaml-language-server: $schema=schemas/ExperimentFeatureManifest.schema.json
# Features must be added here to be accessible through the NimbusFeature API.
"no-feature-firefox-desktop":
description: A dummy feature for experiments that target no feature.
owner: beth@mozilla.com
applications:
- firefox-desktop
- firefox-desktop-background-task
hasExposure: false
variables: {}
testFeature:
description: Test only feature
owner: beth@mozilla.com
applications:
- firefox-desktop
- firefox-desktop-background-task
hasExposure: false
isEarlyStartup: true
variables:
enabled:
type: boolean
description: Whether or not this feature is enabled
testInt:
type: int
fallbackPref: nimbus.testing.testInt
description: Int pref used by platform API tests
testSetString:
type: string
setPref:
branch: user
pref: nimbus.testing.testSetString
description: A string pref set by Nimbus tests
nimbus-qa-1:
description: A feature for testing pref-setting on the default branch.
owner: beth@mozilla.com
hasExposure: false
variables:
value:
type: string
setPref:
branch: default
pref: nimbus.qa.pref-1
description: The value to set for the pref.
nimbus-qa-2:
description: A feature for testing pref-setting on the user branch.
owner: beth@mozilla.com
hasExposure: false
variables:
value:
type: string
setPref:
branch: user
pref: nimbus.qa.pref-2
description: The value to set for the pref.
# Note: this feature is not for general use. If you want to run an experiment
# that sets prefs, you *must* register your feature in this manifest and specify
# the prefs you will control.
prefFlips:
description: Flip arbitrary prefs. Controlled by release management.
owner: beth@mozilla.com
hasExposure: false
variables:
prefs:
type: json
description: "The prefs to set."
schema:
uri: resource://nimbus/schemas/PrefFlipsFeature.schema.json
path: toolkit/components/nimbus/schemas/PrefFlipsFeature.schema.json
# `search` is for search engine experimentation features which do not require
# isEarlyStartup to be set.
search:
description: Search engine experimentation support and testing features.
owner: search-and-suggest-program@mozilla.com
hasExposure: false
variables:
extraParams:
type: json
description: >-
This allows extra parameters to be set for search engines requests including,
where calls to the suggestions API, the search engine configuration defines
those parameters.
The use of this field should be coordinated with the Search team.
The field value is an array of objects with key/value fields. For example:
[
{"key": "google_channel_row", "value": "foo"}
]
This is matched to a section in the search configuration:
"extraParams": [
{
"name": "channel",
"pref": "google_channel_row",
"condition": "pref"
}
],
In this case, the resulting URL for the appropriate search engine would have
`&channel=foo` added to the URL when doing searches.
If the key is not referenced in the search configuration, then no parameter
will be added. Only the search team can update the configuration.
logEnabled:
type: boolean
setPref:
branch: default
pref: browser.search.log
description: >-
Whether or not enable search log in their console.
richSuggestionsFeatureGate:
type: boolean
setPref:
branch: default
pref: browser.urlbar.richSuggestions.featureGate
description: >-
Feature gate that controls whether Rich Suggestions are enabled.
scotchBonnetEnableOverride:
type: boolean
setPref:
branch: default
pref: browser.urlbar.scotchBonnet.enableOverride
description: >-
Whether or not enabling scotch bonnet feature.
If this variable is true, the following features are available as default.
* Unified search button
* Secondary action buttons
* Search term persistence
* Intuitive search keywords
* HTTP swap
serpEventTelemetryCategorizationEnabled:
type: boolean
setPref:
branch: default
pref: browser.search.serpEventTelemetryCategorization.enabled
description: Whether the Glean SERP event telemetry for SERP categorization is enabled.
trendingEnabled:
type: boolean
setPref:
branch: default
pref: browser.urlbar.trending.featureGate
description: Feature gate that controls whether trending suggestions are enabled.
trendingRequireSearchMode:
type: boolean
setPref:
branch: default
pref: browser.urlbar.trending.requireSearchMode
description: Controls whether trending suggestions are only shown in search mode or not.
trendingMaxResultsNoSearchMode:
type: int
setPref:
branch: default
pref: browser.urlbar.trending.maxResultsNoSearchMode
description: The maximum number of trending results mode outside search mode.
newSearchConfigEnabled:
type: boolean
setPref:
branch: user
pref: browser.search.newSearchConfig.enabled
description: >-
Whether search-config-v2 is enabled for the user. This will only take
effect when the user restarts.
Obsolete. This is kept until all multi-feature roll-outs using it are
ended to prevent un-enrollment.
targetExperiment:
type: string
description: >-
The slug of the experiment someone is requesting enrollment and branch
information for. (Note that the featureId needs to be set to "search".)
# `searchConfiguration` is for search experiment features for items that require
# isEarlyStartup to be true. These items may require a reload of the search
# engine configuration, and an additional reload may happen during the startup
# process.
searchConfiguration:
description: Search experimentation support for the engine configuration
owner: search-and-suggest-program@mozilla.com
isEarlyStartup: true
hasExposure: false
variables:
experiment:
type: string
fallbackPref: browser.search.experiment
description: >-
Used to activate only matching configurations that contain the value in
`experiment`
seperatePrivateDefaultUIEnabled:
type: boolean
description: Whether the UI for the separate private default feature is enabled.
seperatePrivateDefaultUrlbarResultEnabled:
type: boolean
description: Whether the urlbar result for the separate private default is shown.
urlbar:
description: The Address Bar
owner: search-and-suggest-program@mozilla.com
hasExposure: true
exposureDescription: >-
The timing of the exposure event depends on the experiment, but generally
the event is recorded once per app session when the user first encounters
the UI of the experiment in which they're enrolled.
variables:
actionsOnboardingTimesToShow:
type: int
fallbackPref: browser.urlbar.quickactions.timesToShowOnboardingLabel
description: >-
The number of times a user should be shown the actions onboarding label.
addonsFeatureGate:
type: boolean
fallbackPref: browser.urlbar.addons.featureGate
description: >-
Feature gate that controls whether all aspects of the addons suggestion
feature are exposed to the user.
addonsShowLessFrequentlyCap:
type: int
description: >-
If defined and non-zero, this is the maximum number of times the user
will be able to click the "Show less frequently" command for addon
suggestions. If undefined or zero, the user will be able to click the
command without any limit.
autoFillAdaptiveHistoryEnabled:
type: boolean
fallbackPref: browser.urlbar.autoFill.adaptiveHistory.enabled
description: Whether enabling adaptive history autofill.
autoFillAdaptiveHistoryMinCharsThreshold:
type: int
fallbackPref: browser.urlbar.autoFill.adaptiveHistory.minCharsThreshold
description: Minimum char length of the user's search string to trigger adaptive history autofill.
autoFillAdaptiveHistoryUseCountThreshold:
type: string
description: This value assumes float expression like "0.47". Threshold for use count of input history that we handle as adaptive history autofill. If the use count is this value or more, it will be a candidate.
fakespotFeatureGate:
type: boolean
fallbackPref: browser.urlbar.fakespot.featureGate
description: >-
Feature gate that controls whether all aspects of the Fakespot suggestion
feature are exposed to the user.
fakespotMinKeywordLength:
type: int
description: >-
The minimum prefix length of a Fakespot keyword the user must type to
trigger the suggestion.
fakespotShowLessFrequentlyCap:
type: int
fallbackPref: browser.urlbar.fakespot.showLessFrequentlyCap
description: >-
If defined and non-zero, this is the maximum number of times the user
will be able to click the "Show less frequently" command for Fakespot
suggestions. If undefined or zero, the user will be able to click the
command without any limit.
fakespotSuggestedIndex:
type: int
fallbackPref: browser.urlbar.fakespot.suggestedIndex
description: >-
The index of Fakespot results within the Firefox Suggest section. A
negative index is relative to the end of the section.
keywordExposureResults:
type: string
setPref:
pref: browser.urlbar.keywordExposureResults
branch: user
description: >-
Comma-separated list of result types that should trigger
keyword-exposure telemetry. Keyword exposures can be recorded along with
result exposures. To enable keyword exposures for a result type, you
must add it both to this variable and to `exposureResults`. The only
exception is the "rust_exposure" result type, which can be added to this
variable even if it's not in `exposureResults` since it's enabled by
setting the `quickSuggestExposureSuggestionTypes` variable. Keyword
exposures are recorded in the `urlbar-keyword-exposure` ping. See that
ping's description for more.
mdnFeatureGate:
type: boolean
setPref:
branch: default
pref: browser.urlbar.mdn.featureGate
description: >-
Feature gate that controls whether all aspects of the mdn suggestion
feature are exposed to the user.
merinoClientVariants:
type: string
fallbackPref: browser.urlbar.merino.clientVariants
description: >-
Comma separated list of client variants to report to the Merino server.
May impact server behavior.
merinoEndpointURL:
type: string
fallbackPref: browser.urlbar.merino.endpointURL
description: >-
The Merino endpoint URL, not including parameters. An empty string will
cause Firefox not to fetch from Merino.
merinoProviders:
type: string
fallbackPref: browser.urlbar.merino.providers
description: >-
Comma-separated list of providers to request from the Merino server.
Merino will return suggestions only for these providers.
merinoTimeoutMs:
type: int
fallbackPref: browser.urlbar.merino.timeoutMs
description: Timeout for Merino fetches (ms)
exposureResults:
type: string
setPref:
pref: browser.urlbar.exposureResults
branch: user
description: >-
Comma-separated list of result types that should trigger exposure
telemetry, which is recorded in the `exposure` event. By default
exposure results are visible like usual, but they can be hidden by
setting the `showExposureResults` variable to false. To also record
keyword exposures for a result type, include it in the
`keywordExposureResults` variable as well.
showExposureResults:
type: boolean
setPref:
pref: browser.urlbar.showExposureResults
branch: user
description: >-
Boolean used to determine if the results defined in `exposureResults` should be shown in search results. Should be false for Control branch of an experiment.
pocketFeatureGate:
type: boolean
fallbackPref: browser.urlbar.pocket.featureGate
description: >-
Feature gate that controls whether all aspects of the Pocket suggestions
feature are exposed to the user.
pocketShowLessFrequentlyCap:
type: int
description: >-
If defined and non-zero, this is the maximum number of times the user
will be able to click the "Show less frequently" command for Pocket
suggestions. If undefined or zero, the user will be able to click the
command without any limit.
pocketSuggestIndex:
type: int
description: >-
The group-relative suggestedIndex of Pocket suggestions within the Firefox
Suggest section.
quickSuggestAllowPositionInSuggestions:
type: boolean
fallbackPref: browser.urlbar.quicksuggest.allowPositionInSuggestions
description: Whether quick suggest results can be shown in position specified in the suggestions.
quickSuggestAmpTopPickCharThreshold:
type: int
fallbackPref: browser.urlbar.quicksuggest.ampTopPickCharThreshold
description: >-
Character-count threshold (inclusive) for showing AMP suggestions as top
picks. If an AMP suggestion is triggered by a keyword at least this many
characters long, it will be shown as a top pick. When this variable is
set, full keywords will also show AMP suggestions as top picks even if
they have fewer characters than this threshold.
quickSuggestContextualOptInEnabled:
type: boolean
setPref:
branch: default
pref: browser.urlbar.quicksuggest.contextualOptIn
description: Whether the Firefox Suggest contextual opt-in result is enabled. If true, this implicitly disables shouldShowOnboardingDialog.
quickSuggestContextualOptInSayHello:
type: boolean
setPref:
branch: default
pref: browser.urlbar.quicksuggest.contextualOptIn.sayHello
description: Controls which variant of the copy is used for the Firefox Suggest contextual opt-in result.
quickSuggestContextualOptInTopPosition:
type: boolean
setPref:
branch: default
pref: browser.urlbar.quicksuggest.contextualOptIn.topPosition
description: Controls whether the Firefox Suggest contextual opt-in result appears at the top of results or at the bottom, after one-off buttons.
quickSuggestDataCollectionEnabled:
type: boolean
description: Whether data collection should be enabled by default. If this variable is specified, it will override the value implied by the scenario. It will never override the user's local preference to disable (or enable) data collection, if the user has already toggled that preference.
quickSuggestEnabled:
type: boolean
fallbackPref: browser.urlbar.quicksuggest.enabled
description: Gate for the Firefox Suggest feature as a whole. If false, the Firefox Suggest preferences UI and Suggest suggestions will not be shown. If true, the preferences UI will be shown, and the user can turn suggestions on or off.
quickSuggestExposureSuggestionTypes:
type: string
setPref:
pref: browser.urlbar.quicksuggest.exposureSuggestionTypes
branch: user
description: >-
Comma-separated list of Suggest exposure suggestion types to enable.
Exposure suggestions are used to test potential exposures. They trigger
exposure telemetry based on a set of keywords you provide but they are
never visible. Set this variable to the `suggestion_type` defined in the
remote settings record(s) that contains your keywords. If you want to
test multiple suggestion types, separate them with commas, but also
consider using one experiment branch per type, especially if you are
also enabling keyword exposures. Exposure suggestions are recorded in
telemetry with the "rust_exposure" result type. It's not necessary to
include "rust_exposure" in `exposureResults`. Unless you are testing
other results in the same experiment branch, it's also not necessary to
set `showExposureResults: false`. To also record keyword exposures,
include "rust_exposure" in `keywordExposureResults`.
quickSuggestHideSettingsUI:
type: boolean
fallbackPref: browser.urlbar.quicksuggest.hideSettingsUI
description: >-
This variable is intended to be used in potential exposure experiments
in regions and locales where Suggest normally isn't enabled. Potential
exposure suggestions are implemented in Suggest, and this variable lets
us enable core Suggest functionality but keep it hidden. Set both
`quickSuggestEnabled` and `quickSuggestHideSettingsUI` to true, along
with `quickSuggestExposureSuggestionTypes`. This variable does NOT hide
visible suggestions and other UI that can be independently enabled with
other Nimbus variables. But since all visible suggestions are disabled
by default for users not in the Suggest population, as long as you don't
set any Nimbus variables to enable other suggestions and UI, Suggest
will remain hidden.
quickSuggestImpressionCapsSponsoredEnabled:
type: boolean
fallbackPref: browser.urlbar.quicksuggest.impressionCaps.sponsoredEnabled
description: Whether sponsored suggestions are subject to impression frequency caps. If false, sponsored suggestions can be shown an unlimited number of times over any given period. If true, sponsored suggestion impressions will be subject to the caps in the remote settings configuration.
quickSuggestImpressionCapsNonSponsoredEnabled:
type: boolean
fallbackPref: browser.urlbar.quicksuggest.impressionCaps.nonSponsoredEnabled
description: Whether non-sponsored suggestions are subject to impression frequency caps. If false, non-sponsored suggestions can be shown an unlimited number of times over any given period. If true, non-sponsored suggestion impressions will be subject to the caps in the remote settings configuration.
quickSuggestMlEnabled:
type: boolean
fallbackPref: browser.urlbar.quicksuggest.mlEnabled
description: >-
Whether Suggest will use the ML backend in addition to Rust.
quickSuggestNonSponsoredEnabled:
type: boolean
description: Whether non-sponsored suggestions should be enabled by default. If this variable is specified, it will override the value implied by the scenario. It will never override the user's local preference to disable (or enable) non-sponsored suggestions, if the user has already toggled that preference.
quickSuggestNonSponsoredIndex:
type: int
fallbackPref: browser.urlbar.quicksuggest.nonSponsoredIndex
description: >-
The index of non-sponsored QuickSuggest results within the general
group. A negative index is relative to the end of the group
quickSuggestOnboardingDialogVariation:
type: string
description: >-
Specify the messages/UI variation for QuickSuggest onboarding dialog. This value is case insensitive.
quickSuggestRankingMode:
type: string
fallbackPref: browser.urlbar.quicksuggest.rankingMode
description: >-
Specify the ranking mode for QuickSuggest.
- "default": ranking by static scores specified by individual providers.
- "interest": ranking by relevance scores provided by `ContentRelevancyManager`.
- "random": ranking by randomly selecting a winner out of candidates.
Note that this ranking mode can still be overridden by `quickSuggestScoreMap`.
If the ranking mode is unspecified or set to any unknown values, it will default
to the static score based ranking.
enum:
- default
- interest
- random
quickSuggestScenario:
# IMPORTANT: This should not have a fallbackPref. See UrlbarPrefs.sys.mjs.
type: string
description: The Firefox Suggest scenario in which the user is enrolled
enum:
- history
- offline
- online
quickSuggestScoreMap:
type: json
description: >-
A JSON object that maps telemetry result types to suggestion scores. If
a telemetry result type is present in this map, the client will use the
corresponding score as the score for all suggestions of the type,
overriding all other sources of scores for the type. In other words,
the scores in this map will override scores that are set in remote
settings and Merino as well as scores that are hardcoded in the client.
Example entries: `"amo": 0.5`, `"adm_sponsored": 0.9`
quickSuggestShouldShowOnboardingDialog:
type: boolean
fallbackPref: browser.urlbar.quicksuggest.shouldShowOnboardingDialog
description: Whether or not to show the QuickSuggest onboarding dialog
quickSuggestShowOnboardingDialogAfterNRestarts:
type: int
fallbackPref: browser.urlbar.quicksuggest.showOnboardingDialogAfterNRestarts
description: Show QuickSuggest onboarding dialog after N browser restarts
quickSuggestSponsoredEnabled:
type: boolean
description: Whether sponsored suggestions should be enabled by default. If this variable is specified, it will override the value implied by the scenario. It will never override the user's local preference to disable (or enable) sponsored suggestions, if the user has already toggled that preference.
quickSuggestSponsoredIndex:
type: int
fallbackPref: browser.urlbar.quicksuggest.sponsoredIndex
description: >-
The index of sponsored Firefox Suggest results within the Firefox Suggest
section when "Show search suggestions ahead of browsing history in
address bar results" is checked. When not checked, the index is hardcoded
as -1. Negative indexes are relative to the end of the section.
quickSuggestSponsoredPriority:
type: boolean
fallbackPref: browser.urlbar.quicksuggest.sponsoredPriority
description: >-
Whether or not showing sponsored suggestion as priority.
If this variable is true, the following things are processed.
* "Sponsored" label is shown as the group label.
* Change the suggested index to 1.
* Handle as top pick.
recentSearchesFeatureGate:
type: boolean
setPref:
branch: default
pref: browser.urlbar.recentsearches.featureGate
description: Gate for the recent searches feature.
recentSearchesMaxResults:
type: int
setPref:
branch: default
pref: browser.urlbar.recentsearches.maxResults
description: The maximum number of recent searches to show.
showSearchTermsFeatureGate:
type: boolean
fallbackPref: browser.urlbar.showSearchTerms.featureGate
description: Gate for the show search terms feature. If false, the preference#search will not show the search terms feature checkbox, and search terms will never persist in the urlbar. If true, the preference checkbox will be shown on preferences#search, and the user can choose to persist search terms on or off in the urlbar.
weatherFeatureGate:
type: boolean
fallbackPref: browser.urlbar.weather.featureGate
description: >-
Feature gate that controls whether all aspects of the weather suggestion
feature are exposed to the user.
weatherKeywordsMinimumLength:
type: int
description: >-
If defined and non-zero, the weather suggestion will be triggered by
typing any prefix of a full weather keyword when the prefix is at least
`weatherKeywordsMinimumLength` characters long. If this variable is
absent or zero, Firefox will fall back to the minimum length defined in
remote settings. If neither Nimbus nor remote settings defines a minimum
length, only full keywords will trigger the suggestion.
weatherShowLessFrequentlyCap:
type: int
description: >-
If defined and non-zero, this is the maximum number of times the user
will be able to click the "Show less frequently" command for weather
suggestions. If undefined or zero, the user will be able to click the
command without any limit.
weatherUiTreatment:
type: int
fallbackPref: browser.urlbar.weather.uiTreatment
description: >-
The UI treatment to use for weather suggestions. Possible values:
0: (default) Simplest UI with current temperature and location
1: Simpler UI, adds current conditions, high/low, and URL
2: Full UI, adds forecast
yelpMinKeywordLength:
type: int
description: >-
The minimum prefix length of a Yelp keyword the user must type to
trigger the suggestion.
yelpMlEnabled:
type: boolean
fallbackPref: browser.urlbar.yelp.mlEnabled
description: >-
Whether Yelp suggestions will be served from the Suggest ML backend
instead of Rust.
yelpFeatureGate:
type: boolean
fallbackPref: browser.urlbar.yelp.featureGate
description: >-
Feature gate that controls whether all aspects of the Yelp suggestion
feature are exposed to the user.
yelpShowLessFrequentlyCap:
type: int
fallbackPref: browser.urlbar.yelp.showLessFrequentlyCap
description: >-
If defined and non-zero, this is the maximum number of times the user
will be able to click the "Show less frequently" command for Yelp
suggestions. If undefined or zero, the user will be able to click the
command without any limit.
yelpSuggestNonPriorityIndex:
type: int
description: >-
The group-relative suggestedIndex of Yelp suggestions within the Firefox
Suggest section. Ignored when `yelpSuggestPriority` is true.
yelpSuggestPriority:
type: boolean
fallbackPref: browser.urlbar.yelp.priority
description: >-
Whether or not showing yelp suggestion as priority.
If this variable is true, the following things are processed.
* Change the suggested index to 1.
* Handle as top pick.
originsAlternativeEnable:
description: >-
Use an alternative ranking algorithm for autofilling origins, that is
mainly domains of Web pages. When the user types the beginning of an
origin, we autofill the whole origin. Whether autofill happens depends
on the ranking algorithm. Bookmarks are always autofilled anyway.
type: boolean
setPref:
branch: user
pref: "places.frecency.origins.alternative.featureGate"
originsDaysCutOff:
description: >-
The alternative ranking algorithm only considers pages visited in the
last N days, where N is controlled by this variable.
type: int
setPref:
branch: user
pref: "places.frecency.origins.alternative.daysCutOff"
pagesAlternativeEnable:
description: >-
Use an alternative ranking algorithm for sorting history and bookmarks
among the urlbar results.
type: boolean
setPref:
branch: user
pref: "places.frecency.pages.alternative.featureGate"
pagesNumSampledVisits:
description: >-
The number of recent visits to sample when calculating the ranking of
a page. Examining all the visits would be expensive, so we only sample
recent visits.
type: int
setPref:
branch: user
pref: "places.frecency.pages.alternative.numSampledVisits"
pagesHalfLifeDays:
description: >-
The number of days after which the ranking halves. This implements the
"recency" part of the algorithm.
type: int
setPref:
branch: user
pref: "places.frecency.pages.alternative.halfLifeDays"
pagesHighWeight:
description: >-
The weight to use for the high importance bucket.
type: int
setPref:
branch: user
pref: "places.frecency.pages.alternative.highWeight"
pagesMediumWeight:
description: >-
The weight to use for the medium importance bucket.
type: int
setPref:
branch: user
pref: "places.frecency.pages.alternative.mediumWeight"
pagesLowWeight:
description: >-
The weight to use for the low importance bucket.
type: int
setPref:
branch: user
pref: "places.frecency.pages.alternative.lowWeight"
aboutwelcome:
description: "The about:welcome page"
owner: omc@mozilla.com
hasExposure: true
exposureDescription: >-
Exposure is sent once per browsing session when the about:welcome URL is
first accessed.
isEarlyStartup: true
variables:
enabled:
type: boolean
fallbackPref: browser.aboutwelcome.enabled
description: >-
Should users see about:welcome? If this is false, users will see a
regular new tab instead.
id:
type: string
description: >-
Descriptive ID for the about:welcome content
screens:
type: json
fallbackPref: browser.aboutwelcome.screens
description: Content to show in the onboarding flow
modalScreens:
type: json
fallbackPref: browser.aboutwelcome.modalScreens
description: Content to show in the onboarding modal, if different from that in the onboarding flow
languageMismatchEnabled:
type: boolean
fallbackPref: intl.multilingual.aboutWelcome.languageMismatchEnabled
description: >-
Suggest to change the language on about:welcome when there is a mismatch with
the OS.
transitions:
type: boolean
description: Enable transition effect between screens
showModal:
type: boolean
fallbackPref: browser.aboutwelcome.showModal
description: >-
Should users see window modal onboarding
requireAction:
type: boolean
fallbackPref: browser.aboutwelcome.requireAction
description: >-
When showModal is enabled, should action be required to proceed (show as a window modal with dismiss using the ESC key disabled)
backdrop:
type: string
fallbackPref: browser.aboutwelcome.backdrop
description: >-
Specify the color to be used to update the background color
toolbarButtonEnabled:
type: boolean
setPref:
branch: user
pref: browser.aboutwelcome.toolbarButtonEnabled
description: >-
Should the return to about:welcome toolbar button be shown
moreFromMozilla:
description: "New page on about:preferences to suggest more Mozilla products"
owner: omc@mozilla.com
hasExposure: true
exposureDescription: >-
Exposure is sent once per browsing session when the about:preferences URL is
first accessed.
variables:
enabled:
type: boolean
fallbackPref: browser.preferences.moreFromMozilla
description: Should users see the new more from Mozilla section.
template:
type: string
fallbackPref: browser.preferences.moreFromMozilla.template
description: UI template used to display Mozilla products. Possible values simple, advanced. Default is simple.
windowsLaunchOnLogin:
description: "New checkbox in about:preferences startup section to start Firefox on Windows login"
owner: omc@mozilla.com
hasExposure: true
exposureDescription: >-
Exposure is sent once per browsing session when the about:preferences URL is
first accessed.
variables:
enabled:
type: boolean
setPref:
branch: default
pref: browser.startup.windowsLaunchOnLogin.enabled
description: Should users see the Windows launch on login checkbox.
firefoxBridge:
description: "Controls for Firefox Bridge extension and extension registration"
owner: install-update@mozilla.com
hasExposure: false
variables:
enabled:
type: boolean
setPref:
branch: default
pref: browser.firefoxbridge.enabled
description: >-
Should Firefox Bridge be registered within firefoxBridgeNativeMessaging
startup idle task for use with native messaging proxy.
abouthomecache:
description: "The startup about:home cache."
owner: omc@mozilla.com, mconley@mozilla.com
hasExposure: false
variables:
enabled:
type: boolean
description: Is the feature enabled?
setPref:
branch: user
pref: browser.startup.homepage.abouthome_cache.enabled
newtab:
description: "The about:newtab page"
owner: omc@mozilla.com
hasExposure: true
exposureDescription: >-
Exposure is sent once per browsing session when the first newtab page loads
(either about:newtab or about:home).
isEarlyStartup: true
variables:
newTheme:
type: boolean
description: Enable the new theme
customizationMenuEnabled:
type: boolean
fallbackPref: browser.newtabpage.activity-stream.customizationMenu.enabled
description: Enable the customization panel inside of the newtab
prefsButtonIcon:
type: string
description: Icon url to use for the preferences button
topSitesContileEnabled:
type: boolean
fallbackPref: browser.topsites.contile.enabled
description: Enable the Contile integration for Sponsored Top Sites
topSitesUseAdditionalTilesFromContile:
type: boolean
description: Allow Contile to use additonal sponsored top sites
newtabUnifiedAds:
description: Mozilla Ad Routing Service (MARS) unified ads service
owner: mcrawford@mozilla.com, sdowne@mozilla.com
hasExposure: false
variables:
unifiedAdsEndpoint:
description: The URL for the MARS API endpoint.
type: string
setPref:
branch: user
pref: browser.newtabpage.activity-stream.unifiedAds.endpoint
unifiedAdsSpocsEnabled:
type: boolean
description: >-
Enable MARS endpoint to serve ads for recommended stories
setPref:
branch: user
pref: browser.newtabpage.activity-stream.unifiedAds.spocs.enabled
unifiedAdsTilesEnabled:
type: boolean
description: >-
Enable MARS endpoint to serve content for top sites tiles
setPref:
branch: user
pref: browser.newtabpage.activity-stream.unifiedAds.tiles.enabled
unifiedAdsFeedEnabled:
type: boolean
description: >-
Enable AdsFeed to manage all ads request/serving logic
setPref:
branch: user
pref: browser.newtabpage.activity-stream.unifiedAds.adsFeed.enabled
unifiedAdsFeedTilesEnabled:
type: boolean
description: >-
Enable AdsFeed to query MARS server to fetch/serve top sites tiles
setPref:
branch: user
pref: browser.newtabpage.activity-stream.unifiedAds.adsFeed.tiles.enabled
newtabSpocsCache:
description: The about:newtab sponsored content cache.
owner: sdowne@mozilla.com
hasExposure: false
variables:
spocsCacheTimeout:
type: int
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.spocs.cacheTimeout
description: >-
Set sponsored content cache timeout in minutes.
spocsStartupCache:
type: boolean
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.spocs.startupCache.enabled
description: >-
Controls if spocs should be included in startup cache.
newtabAdSizingExperiment:
description: >-
Change the default ad size and UI for certain ad formats.
owner: achurchwell@mozilla.com, sdowne@mozilla.com
hasExposure: false
variables:
variantA:
type: boolean
setPref:
branch: user
pref: browser.newtabpage.activity-stream.newtabAdSize.variant-a
description: >-
Variant A ad size and UI.
variantB:
type: boolean
setPref:
branch: user
pref: browser.newtabpage.activity-stream.newtabAdSize.variant-b
description: >-
Variant B ad size and UI.
leaderboard:
type: boolean
setPref:
branch: user
pref: browser.newtabpage.activity-stream.newtabAdSize.leaderboard
description: >-
Leaderboard ad size and UI.
leaderboard_position:
type: string
setPref:
branch: user
pref: browser.newtabpage.activity-stream.newtabAdSize.leaderboard.position
description: >-
Leaderboard row position.
billboard:
type: boolean
setPref:
branch: user
pref: browser.newtabpage.activity-stream.newtabAdSize.billboard
description: >-
Billboard ad size and UI.
billboard_position:
type: string
setPref:
branch: user
pref: browser.newtabpage.activity-stream.newtabAdSize.billboard.position
description: >-
Billboard row position.
newtabLayoutExperiment:
description: >-
Change the default layout of new tab by adjusting sizes and spacing of elements.
owner: achurchwell@mozilla.com, sdowne@mozilla.com
hasExposure: false
variables:
variantA:
type: boolean
setPref:
branch: user
pref: browser.newtabpage.activity-stream.newtabLayouts.variant-a
description: >-
Variant A in layouts experiment.
variantB:
type: boolean
setPref:
branch: user
pref: browser.newtabpage.activity-stream.newtabLayouts.variant-b
description: >-
Variant B in layouts experiment.
newtabSponsoredContent:
description: >-
Change and control the sponsored content on newtab.
owner: sdowne@mozilla.com
hasExposure: false
variables:
spocPositions:
type: string
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.spoc-positions
description: CSV string of spoc position indexes on newtab Pocket grid
spocPlacements:
type: string
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.placements.spocs
description: CSV string of spoc placement ids on newtab Pocket grid. A placement id tells our ad server where the ads are intended to be displayed.
spocCounts:
type: string
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.placements.spocs.counts
description: CSV string of spoc placement counts on newtab Pocket grid. The count tells the ad server how many ads to return for this position and placement.
tilesPlacements:
type: string
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.placements.tiles
description: CSV string of tiles placement ids on newtab tiles section. A placement id tells our ad server where the ads are intended to be displayed.
tilesCounts:
type: string
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.placements.tiles.counts
description: CSV string of tiles placement counts on newtab tiles section. The count tells the ad server how many ads to return for this position and placement.
newtabTopicSelection:
description: the about:newtab topic selection experience.
owner: nbarrett@mozilla.com
hasExposure: false
variables:
availableTopics:
type: string
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.topicSelection.topics
description: >-
List of available topics to select for topic selection
suggestedTopics:
type: string
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.topicSelection.suggestedTopics
description: >-
List of pre-selected topics to display on first run of topic selection modal
topicSelectionOnboarding:
type: boolean
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.topicSelection.onboarding.enabled
description: >-
Turns on and off topic selection onbaording
regionTopicsConfig:
description: A comma-separated list of regions that get topics selection by default.
type: string
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.topicSelection.region-topics-config
localeTopicsConfig:
description: A comma-separated list of locales that get topics selection by default.
type: string
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.topicSelection.locale-topics-config
regionTopicLabelConfig:
description: A comma-separated list of regions that get topic labels by default.
type: string
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.topicLabels.region-topic-label-config
localeTopicLabelConfig:
description: A comma-separated list of locales that get topic Labels by default.
type: string
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.topicLabels.locale-topic-label-config
newtabContextualContent:
description: about:newtab contextual content feed
owner: nbarrett@mozilla.com
hasExposure: false
variables:
contextualContentEnabled:
type: boolean
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.contextualContent.enabled
description: >-
Override the contextual content enabled value set via region/locale
localeContextualContentConfig:
type: string
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.contextualContent.locale-content-config
description: >-
A comma-separated list of locales that get contextual content by default.
regionContextualContentConfig:
type: string
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.contextualContent.region-content-config
description: >-
A comma-separated list of regions that get contextual content by default.
contextualContentFeeds:
type: string
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.contextualContent.feeds
description: >-
CSV list of possible feeds for the contextual content feed
contextualContentSelectedFeed:
type: string
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.contextualContent.selectedFeed
description: >-
currently selected feed to display in the Contextual Content component
newTabSectionsExperiment:
description: about:newtab section UI update
owner: nbarrett@mozilla.com, mcrawford@mozilla.com
hasExposure: false
variables:
sectionsEnabled:
type: boolean
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.sections.enabled
description: >-
Enable the Section UI for recommended stories on newtab
cardRefreshThumbsUpDownEnabled:
type: boolean
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.sections.cards.thumbsUpDown.enabled
description: >-
Enable the thumbs up/down buttons in the revised pocket story
card UI in recommended stories on newtab
cardRefreshEnabled:
type: boolean
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.sections.cards.enabled
description: >-
Enable the revised pocket story card UI in recommended stories on newtab
localeSectionstConfig:
type: string
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.sections.locale-content-config
description: >-
A comma-separated list of locales that get contextual content by default.
regionSectionsConfig:
type: string
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.sections.region-content-config
description: >-
A comma-separated list of regions that get contextual content by default.
sectionsPersonalization:
type: boolean
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.sections.personalization.enabled
description: >-
Enable personalized sections layout. Allow users to follow/unfollow topic sections.
pocketNewtab:
description: The Pocket section in newtab
owner: sdowne@mozilla.com
hasExposure: false
isEarlyStartup: true
variables:
spocTopsitesPositions:
type: string
fallbackPref: browser.newtabpage.activity-stream.discoverystream.spoc-topsites-positions
description: CSV string of spoc position indexes on newtab topsites section
contileTopsitesPositions:
type: string
fallbackPref: browser.newtabpage.activity-stream.discoverystream.contile-topsites-positions
description: CSV string of contile position indexes on newtab topsites section
spocAdTypes:
type: string
fallbackPref: browser.newtabpage.activity-stream.discoverystream.spocAdTypes
description: CSV string of data to set the spoc content.
spocZoneIds:
type: string
fallbackPref: browser.newtabpage.activity-stream.discoverystream.spocZoneIds
description: CSV string of data to set the spoc content.
spocTopsitesAdTypes:
type: string
fallbackPref: browser.newtabpage.activity-stream.discoverystream.spocTopsitesAdTypes
description: CSV string of data to set the spoc content.
spocTopsitesZoneIds:
type: string
fallbackPref: browser.newtabpage.activity-stream.discoverystream.spocTopsitesZoneIds
description: CSV string of data to set the spoc content.
spocTopsitesPlacementEnabled:
type: boolean
fallbackPref: browser.newtabpage.activity-stream.discoverystream.spocTopsitesPlacement.enabled
description: Tuns on and off the sponsored topsites placement.
spocSiteId:
type: string
fallbackPref: browser.newtabpage.activity-stream.discoverystream.spocSiteId
description: String ID to set the spoc content.
widgetPositions:
type: string
fallbackPref: browser.newtabpage.activity-stream.discoverystream.widget-positions
description: CSV string of widget position indexes on newtab grid
hybridLayout:
type: boolean
fallbackPref: browser.newtabpage.activity-stream.discoverystream.hybridLayout.enabled
description: Enable compact cards on newtab grid only for specific breakpoints
hideCardBackground:
type: boolean
fallbackPref: browser.newtabpage.activity-stream.discoverystream.hideCardBackground.enabled
description: Removes Pocket card background and borders.
fourCardLayout:
type: boolean
fallbackPref: browser.newtabpage.activity-stream.discoverystream.fourCardLayout.enabled
description: Enable four Pocket cards per row.
newFooterSection:
type: boolean
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.newFooterSection.enabled
description: Enable an updated Pocket section topics footer
saveToPocketCard:
type: boolean
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.saveToPocketCard.enabled
description: >-
A save to Pocket button inside the card, shown on the card thumbnail, on
hover.
saveToPocketCardRegions:
type: string
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.saveToPocketCardRegions
description: >-
CSV string of regions that support the save to Pocket button inside the card.
hideDescriptions:
type: boolean
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.hideDescriptions.enabled
description: >-
Hide or display descriptions for Pocket stories on newtab.
hideDescriptionsRegions:
type: string
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.hideDescriptionsRegions
description: >-
CSV string of regions that hide descriptions for Pocket stories on newtab.
compactGrid:
type: boolean
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.compactGrid.enabled
description: >-
Reduce the number of pixels between the Pocket cards on newtab.
compactImages:
type: boolean
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.compactImages.enabled
description: >-
Reduce the height on Pocket card images on newtab.
imageGradient:
type: boolean
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.imageGradient.enabled
description: >-
Add a gradient to the bottom of Pocket card images on newtab to blend the
image in with the card.
titleLines:
type: int
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.titleLines
description: >-
Changes the maximum number of lines a title can be for Pocket cards on newtab.
descLines:
type: int
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.descLines
description: >-
Changes the maximum number of lines a description can be for Pocket cards on newtab.
onboardingExperience:
type: boolean
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.onboardingExperience.enabled
description: >-
Enables an onboarding experience for Pocket section on newtab.
essentialReadsHeader:
type: boolean
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.essentialReadsHeader.enabled
description: >-
Updates the Pocket section header and title to say "Today’s Essential Reads",
moves the "Recommended by Pocket" header to the right side.
editorsPicksHeader:
type: boolean
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.editorsPicksHeader.enabled
description: >-
Updates the Pocket section header and title to say "Editor’s Picks", if used with
essentialReadsHeader, creates a second section 2 rows down for editorsPicksHeader.
recentSavesEnabled:
type: boolean
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.recentSaves.enabled
description: >-
Updates the Pocket section with a new header and 1 row of recently saved Pocket stories.
readTime:
type: boolean
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.readTime.enabled
description: >-
Displays an estimated read time for Pocket cards on newtab.
newSponsoredLabel:
type: boolean
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.newSponsoredLabel.enabled
description: >-
Updates the sponsored label position to below the image for Pocket cards on newtab.
sendToPocket:
type: boolean
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.sendToPocket.enabled
description: >-
Decides what to do when a logged out user click "Save to Pocket" from a Pocket card.
wallpapers:
type: boolean
setPref:
branch: user
pref: browser.newtabpage.activity-stream.newtabWallpapers.enabled
description: >-
Turns on and off wallpaper support.
wallpapersV2:
type: boolean
setPref:
branch: user
pref: browser.newtabpage.activity-stream.newtabWallpapers.v2.enabled
description: >-
Turns on and off updated wallpaper experience.
wallpapersHighlightEnabled:
type: boolean
setPref:
branch: user
pref: browser.newtabpage.activity-stream.newtabWallpapers.highlightEnabled
description: >-
Turns on and off wallpaper feature highlight.
wallpaperHighlightHeaderText:
type: string
setPref:
branch: user
pref: browser.newtabpage.activity-stream.newtabWallpapers.highlightHeaderText
description: >-
Changes the wallpaper feature highlight header
wallpaperHighlightContentText:
type: string
setPref:
branch: user
pref: browser.newtabpage.activity-stream.newtabWallpapers.highlightContentText
description: >-
Changes the wallpaper feature highlight content
wallpaperHighlightCtaText:
type: string
setPref:
branch: user
pref: browser.newtabpage.activity-stream.newtabWallpapers.highlightCtaText
description: >-
Changes the wallpaper feature highlight cta
currentWallpaper:
type: string
setPref:
branch: user
pref: browser.newtabpage.activity-stream.newtabWallpapers.wallpaper
description: >-
Changes the currently selected wallpaper
weatherLocationSearch:
type: boolean
setPref:
branch: user
pref: browser.newtabpage.activity-stream.weather.locationSearchEnabled
description: >-
Turns on and off location search for newtab weather widget
recsPersonalized:
type: boolean
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.recs.personalized
description: >-
Enables Pocket stories personalization.
spocsPersonalized:
type: boolean
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.spocs.personalized
description: >-
Enables Pocket sponsored content personalization.
discoveryStreamConfig:
description: A JSON blob of discovery stream configuration.
type: string
setPref:
branch: user
pref: "browser.newtabpage.activity-stream.discoverystream.config"
spocsEndpoint:
description: The URL for the spocs endpoint.
type: string
setPref:
branch: user
pref: "browser.newtabpage.activity-stream.discoverystream.spocs-endpoint"
spocsEndpointAllowlist:
description: Comma separated list of allowed endpoints for fetching spocs
type: string
setPref:
branch: user
pref: "browser.newtabpage.activity-stream.discoverystream.endpoints"
spocsClearEndpoint:
description: URL for deleting any server data when a user opts out of sponsored content
type: string
setPref:
branch: user
pref: "browser.newtabpage.activity-stream.discoverystream.endpointSpocsClear"
ctaButtonSponsors:
description: A CSV list of sponsors that should use a button CTA.
type: string
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.ctaButtonSponsors
ctaButtonVariant:
description: Specifies which variant to use for any sponsors in ctaButtonSponsors
type: string
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.ctaButtonVariant
spocMessageVariant:
description: Adds some message dialogs explainging sponsored content to the user
type: string
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.spocMessageVariant
regionStoriesConfig:
description: A comma-separated list of region to get stories for.
type: string
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.region-stories-config
regionBffConfig:
type: string
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.region-bff-config
description: A comma-separated list of regions to get stories from the recommendations BFF. Also requires region-stories-config.
merinoProviderEnabled:
type: boolean
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.merino-provider.enabled
description: Sets the recommendations provider service to Merino.
merinoProviderEndpoint:
type: string
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.merino-provider.endpoint
description: Merino endpoint to use for recommendations.
regionStoriesBlock:
description: A comma-separated list of regions that do not get stories, regardless of locale-list-config.
type: string
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.region-stories-block
localeListConfig:
description: A comma-separated list of locales that get stories, regardless of region-stories-config.
type: string
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.locale-list-config
regionSpocsConfig:
description: A comma-separated list of regions that get spocs by default.
type: string
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.region-spocs-config
regionWeatherConfig:
description: A comma-separated list of regions that get weather by default.
type: string
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.region-weather-config
localeWeatherConfig:
description: A comma-separated list of locales that weather widget supports.
type: string
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.locale-weather-config
topSitesMaxSponsored:
# Defined under `pocketNewtab` as it needs to be used along with other variables
type: int
description: The maximum number of sponsored Top Sites to be displayed
topSitesContileMaxSponsored:
# Defined under `pocketNewtab` as it needs to be used along with other variables
type: int
description: The maximum number of sponsored Top Sites used from Contile
topSitesContileSovEnabled:
# Defined under `pocketNewtab` as it needs to be used along with other variables
description: Enable the Share-of-Voice feature for Sponsored Topsites.
type: boolean
fallbackPref: >-
browser.topsites.contile.sov.enabled
pocketFeedParameters:
type: string
fallbackPref: >-
browser.newtabpage.activity-stream.discoverystream.pocket-feed-parameters
description: >-
Add parameters to Pocket feed URL.
merinoFeedExperiment:
type: boolean
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.merino-feed-experiment
description: >-
Should we pass the experiment branch and slug to the Merino feed request.
thumbsUpDown:
type: boolean
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.thumbsUpDown.enabled
description: Display thumbs up and down buttons on recommended stories
regionThumbsUpDownConfig:
description: A comma-separated list of regions that get thumbs up and down buttons by default.
type: string
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.thumbsUpDown.region-thumbs-config
description: Display thumbs up and down buttons on recommended stories
localeThumbsUpDownConfig:
description: A comma-separated list of locales that get thumbs up and down buttons by default.
type: string
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.thumbsUpDown.locale-thumbs-config
thumbsUpDownCompactLayout:
type: boolean
setPref:
branch: user
pref: browser.newtabpage.activity-stream.discoverystream.thumbsUpDown.searchTopsitesCompact
description: >-
Change the layout of the sections to be more compact to account for the added card height with the thumbs up/down enabled.
saveToPocket:
description: The save to Pocket feature
owner: sdowne@mozilla.com
hasExposure: false
variables:
emailButton:
type: boolean
setPref:
branch: user
pref: extensions.pocket.refresh.emailButton.enabled
description: Just for the new Pocket panels, enables the email signup button.
hideRecentSaves:
type: boolean
setPref:
branch: user
pref: extensions.pocket.refresh.hideRecentSaves.enabled
description: Hides the recently saved section in the home panel.
bffRecentSaves:
type: boolean
setPref:
branch: user
pref: extensions.pocket.bffRecentSaves
description: Use the new BFF Proxy Service instead of the legacy Pocket Service for Recent Saves
bffApi:
type: string
setPref:
branch: user
pref: extensions.pocket.bffApi
description: BFF Proxy Service domain
oAuthConsumerKeyBff:
type: string
setPref:
branch: user
pref: extensions.pocket.oAuthConsumerKeyBff
description: BFF Proxy Service OAuth Consumer Key
password-autocomplete:
description: A special autocomplete UI for password fields.
owner: sgalich@mozilla.com
hasExposure: false
variables:
directMigrateSingleProfile:
type: boolean
description: Enable direct migration?
# Experiment for different Relay UI treatments. Variations at:
email-autocomplete-relay:
description: Relay UI for email fields.
exposureDescription: Exposure is sent each time a user sees the Relay autocomplete dropdown item
hasExposure: true
owner: lcrouch@mozilla.com
variables:
firstOfferVersion:
type: string
description: Which Relay UI treatment to show
fallbackPref: signon.firefoxRelay.firstOfferVersionFallback
showToAllBrowsers:
type: boolean
setPref:
branch: user
pref: signon.firefoxRelay.showToAllBrowsers
description: Whether to show Relay to Firefox users who are NOT signed into FXA.
# This feature flag mirrors the one used for ios
# https://github.com/mozilla-mobile/firefox-ios/blob/main/nimbus-features/addressAutofillFeature.yaml
address-autofill-feature:
description: Enabling address autofill feature
owner: issozi@mozilla.com
hasExposure: false
variables:
status:
type: boolean
setPref:
branch: default
pref: extensions.formautofill.addresses.experiments.enabled
description: If true, we will allow user to use address autofill
creditcards-autofill-enabled:
description: Credit card autofill is enabled in all regions
owner: issozi@mozilla.com
hasExposure: false
variables:
creditcardsSupported:
description: Enable credit card autofill in all regions
type: string
setPref:
branch: default
pref: extensions.formautofill.creditCards.supported
shellService:
description: "Interface with OS, e.g., pinning and set default"
owner: desktop-integrations@mozilla.com
hasExposure: false
variables:
disablePin:
type: boolean
description: Disable pin to taskbar feature
disableStartMenuPin:
type: boolean
setPref:
branch: user
pref: browser.shell.disableStartMenuPin
description: Disable pin to start menu feature
setDefaultBrowserUserChoice:
type: boolean
setPref:
branch: user
pref: browser.shell.setDefaultBrowserUserChoice
description: Should it set as default browser
setDefaultBrowserUserChoiceRegRename:
type: boolean
setPref:
branch: user
pref: browser.shell.setDefaultBrowserUserChoice.regRename
description: When setting default via UserChoice, rename the underlying registry key to prevent kennel driver registry locking.
setDefaultPDFHandler:
type: boolean
fallbackPref: browser.shell.setDefaultPDFHandler
description: Should setting it as the default browser set it as the default PDF handler.
setDefaultPDFHandlerOnlyReplaceBrowsers:
type: boolean
fallbackPref: browser.shell.setDefaultPDFHandler.onlyReplaceBrowsers
description: >-
Should setting it as the default PDF handler only replace existing PDF
handlers that are browsers, and not other PDF handlers such as Acrobat
Reader or Nitro PDF.
setDefaultGuidanceNotifications:
type: boolean
fallbackPref: browser.shell.setDefaultGuidanceNotifications
description: Whether or not the user should see the guidance notifications when setting Firefox as their default browser.
upgradeDialog:
description: The dialog shown for major upgrades
owner: omc@mozilla.com
hasExposure: false
isEarlyStartup: true
variables:
enabled:
type: boolean
fallbackPref: browser.startup.upgradeDialog.enabled
description: Is the feature enabled?
cfr:
description: "A Firefox Messaging System message for the cfr message channel"
owner: omc@mozilla.com
hasExposure: true
exposureDescription: "Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched."
schema:
uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json"
path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json"
variables: {}
"moments-page":
description: "A Firefox Messaging System message for the moments-page message channel"
owner: omc@mozilla.com
hasExposure: true
exposureDescription: >-
"Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched."
schema:
uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json"
path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json"
variables: {}
infobar:
description: "A Firefox Messaging system message for the infobar message channel"
owner: omc@mozilla.com
hasExposure: true
exposureDescription: >-
"Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched."
schema:
uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json"
path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json"
variables: {}
spotlight:
description: "A Firefox Messaging System message for the spotlight message channel"
owner: omc@mozilla.com
hasExposure: true
exposureDescription: >-
"Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched."
schema:
uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json"
path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json"
variables: {}
# Before 117, this feature only included one variable, pdfJsTourProgress. So,
# the minimum version for messaging experiments using this feature ID is 117.
featureCallout:
description: "A Firefox Messaging System message for the Feature Callout message channel"
owner: omc@mozilla.com
hasExposure: true
exposureDescription: >-
"Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched."
schema:
uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json"
path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json"
variables: {}
fullPageTranslation:
description: This feature opens a popup panel to offer to translate a page.
owner: gtatum@mozilla.com
hasExposure: false
variables:
boolean:
description: Set to true to enable the translations feature
type: boolean
setPref:
branch: user
pref: browser.translations.enable
fullPageTranslationAutomaticPopup:
description: Controls whether the popup automatically shows for translations.
owner: gtatum@mozilla.com
hasExposure: false
variables:
boolean:
description: Set to true to automatically popup, and false to only show the button.
type: boolean
setPref:
branch: user
pref: browser.translations.automaticallyPopup
selectTranslation:
description: This feature enables the option to translate selected text from the context menu.
owner: enordin@mozilla.com
hasExposure: false
variables:
enabled:
description: Set to true to enable the select-translations feature
type: boolean
setPref:
branch: user
pref: browser.translations.select.enable
pdfjs:
description: The Firefox pdf reader.
owner: pdfjs-team@mozilla.com
hasExposure: true
exposureDescription: >-
Exposure is sent each time a pdf is displayed.
variables:
enableAltText:
description: Set to true to enable alt text generation.
type: boolean
setPref:
branch: default
pref: pdfjs.enableAltText
enableUpdatedAddImage:
description: Set to true to enable updated add image with alt text flow.
type: boolean
setPref:
branch: default
pref: pdfjs.enableUpdatedAddImage
browserMlEnable:
description: Set to true to enable local inference engine
type: boolean
setPref:
branch: default
pref: browser.ml.enable
# fxms-message-* placeholder feature ids
#
# has info on using these placeholder feature ids, as well as (very short) instructions on
# checking to see if we need more (which we do once per Nightly) and how to add them.
#
# Instructions for adding a new fxms-message-* placeholder feature id
# 1) clone an existing one here
# 2) update the YAML feature id to the next unused number
# 3) update the YAML description
# 4) add the new feature id to MESSAGING_EXPERIMENTS_DEFAULT_FEATURES list in MessagingExperimentConstants.sys.mjs
# 5) add the new feature id and the version it landed to the spreadsheet tab linked to above
fxms-message-1:
description: "A Firefox Messaging System message"
owner: omc@mozilla.com
hasExposure: true
exposureDescription: >-
"Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched."
schema:
uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json"
path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json"
variables: {}
fxms-message-2:
description: "Firefox Messaging System message 2"
owner: omc@mozilla.com
hasExposure: true
exposureDescription: >-
"Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched."
schema:
uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json"
path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json"
variables: {}
fxms-message-3:
description: "Firefox Messaging System message 3"
owner: omc@mozilla.com
hasExposure: true
exposureDescription: >-
"Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched."
schema:
uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json"
path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json"
variables: {}
fxms-message-4:
description: "Firefox Messaging System message 4"
owner: omc@mozilla.com
hasExposure: true
exposureDescription: >-
"Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched."
schema:
uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json"
path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json"
variables: {}
fxms-message-5:
description: "Firefox Messaging System message 5"
owner: omc@mozilla.com
hasExposure: true
exposureDescription: >-
"Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched."
schema:
uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json"
path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json"
variables: {}
fxms-message-6:
description: "Firefox Messaging System message 6"
owner: omc@mozilla.com
hasExposure: true
exposureDescription: >-
"Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched."
schema:
uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json"
path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json"
variables: {}
fxms-message-7:
description: "Firefox Messaging System message 7"
owner: omc@mozilla.com
hasExposure: true
exposureDescription: >-
"Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched."
schema:
uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json"
path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json"
variables: {}
fxms-message-8:
description: "Firefox Messaging System message 8"
owner: omc@mozilla.com
hasExposure: true
exposureDescription: >-
"Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched."
schema:
uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json"
path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json"
variables: {}
fxms-message-9:
description: "Firefox Messaging System message 9"
owner: omc@mozilla.com
hasExposure: true
exposureDescription: >-
"Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched."
schema:
uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json"
path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json"
variables: {}
fxms-message-10:
description: "Firefox Messaging System message 10"
owner: omc@mozilla.com
hasExposure: true
exposureDescription: >-
"Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched."
schema:
uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json"
path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json"
variables: {}
fxms-message-11:
description: "Firefox Messaging System message 11"
owner: omc@mozilla.com
hasExposure: true
exposureDescription: >-
"Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched."
schema:
uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json"
path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json"
variables: {}
fxms-message-12:
description: "Firefox Messaging System message 12"
owner: omc@mozilla.com
hasExposure: true
exposureDescription: >-
"Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched."
schema:
uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json"
path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json"
variables: {}
fxms-message-13:
description: "Firefox Messaging System message 13"
owner: omc@mozilla.com
hasExposure: true
exposureDescription: >-
"Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched."
schema:
uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json"
path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json"
variables: {}
fxms-message-14:
description: "Firefox Messaging System message 14"
owner: omc@mozilla.com
hasExposure: true
exposureDescription: >-
"Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched."
schema:
uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json"
path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json"
variables: {}
fxms-message-15:
description: "Firefox Messaging System message 15"
owner: omc@mozilla.com
hasExposure: true
exposureDescription: >-
"Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched."
schema:
uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json"
path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json"
variables: {}
whatsNewPage:
description: "A Firefox Messaging System message for the What's new page channel"
owner: omc@mozilla.com
hasExposure: true
exposureDescription: >-
"Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched."
variables:
overrideUrl:
description: URL of the What's new page
type: string
setPref:
branch: user
pref: startup.homepage_override_url_nimbus
maxVersion:
description: Maximum Firefox update version
type: string
setPref:
branch: user
pref: startup.homepage_override_nimbus_maxVersion
minVersion:
description: Minimum Firefox update version
type: string
setPref:
branch: user
pref: startup.homepage_override_nimbus_minVersion
disableWNP:
description: >-
Block all What's New Pages. Used to compare no-WNP control branches to
WNP treatment branches.
type: boolean
setPref:
branch: user
pref: startup.homepage_override_nimbus_disable_wnp
pbNewtab:
description: "A Firefox Messaging System message for the pbNewtab message channel"
owner: omc@mozilla.com
hasExposure: true
exposureDescription: >-
Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched.
schema:
uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json"
path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json"
variables: {}
backgroundTaskMessage:
description: "A Firefox Messaging System message for the background task message channel"
owner: nalexander@mozilla.com
applications:
- firefox-desktop-background-task
hasExposure: true
exposureDescription: >-
Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched.
schema:
uri: "chrome://browser/content/asrouter/schemas/BackgroundTaskMessagingExperiment.schema.json"
path: "browser/components/asrouter/content-src/schemas/BackgroundTaskMessagingExperiment.schema.json"
variables: {}
backgroundUpdateAutomaticRestart:
description: "Whether to automatically restart when the background update task could make more progress."
owner: nalexander@mozilla.com
applications:
- firefox-desktop-background-task
hasExposure: false
variables:
enabled:
type: boolean
fallbackPref: app.update.background.automaticRestartEnabled
description: >-
When true, make the background update task restart when the final update state is `READY_FOR_RESTART`.
Generally, this will finish applying a staged update, completing the update earlier than it
otherwise would have been completed.
pictureinpicture:
description: Message for first time Picture-in-Picture users
owner: nbaumgardner@mozilla.com
hasExposure: true
exposureDescription: Exposure is sent when a user hovers over a video and Picture-in-Picture has not been used before
variables:
title:
type: string
description: The title to be used for the PiP toggle
message:
type: string
description: The message to be used in the PiP toggle
showIconOnly:
type: boolean
description: Whether to show the first time PiP toggle or show the PiP icon only
oldToggle:
type: boolean
description: Whether to show the control style (true) or variant style (false) for the first time PiP toggle
displayDuration:
type: int
description: Duration of PiP first time toggle display in days before switching to PiP icon toggle
glean:
description: "The Glean data-control-plane feature within Firefox Desktop for controlling metric configuration"
owner: glean-team@mozilla.com
hasExposure: false
variables:
newtabPingEnabled:
type: "boolean"
fallbackPref: "browser.newtabpage.ping.enabled"
description: "Whether to submit the 'newtab' ping"
gleanMetricConfiguration:
type: json
description: |
A map of metric base-identifiers to booleans representing the state of the 'enabled' flag for that metric.
This variable is intended for interacting with the Glean data-control-plane via the Server Knobs functionality
to remotely configure metrics to be enabled or disabled.
gleanInternalSdk:
description: "The Glean internal SDK feature intended only for internal Glean Team use"
owner: glean-team@mozilla.com
hasExposure: false
variables:
finalInactive:
type: "boolean"
description: "Enables FOG early shutdown pings when true"
setPref:
branch: user
pref: telemetry.glean.internal.finalInactive
gleanMetricConfiguration:
type: json
description: |
A map of metric base-identifiers to booleans representing the state of the 'enabled' flag for that metric.
This is not for public use! For data-control-plane use, please refer to the Glean documentation and use the
`gleanMetricConfiguration` found in the `glean` feature for this.
gleanMaxPingsPerMinute:
type: int
description: >-
Maximum number of pings that can be sent in a 60 second interval
setPref:
branch: user
pref: telemetry.glean.internal.maxPingsPerMinute
browserLowMemoryPrefs:
description: Prefs which control the browser's behaviour under low memory.
owner: haftandilian@mozilla.com
hasExposure: false
variables:
lowMemoryResponseMask:
description: Control the response on macOS when under memory pressure.
type: int
setPref:
branch: default
pref: "browser.lowMemoryResponseMask"
lowMemoryResponseOnWarn:
description: Controls which macOS memory-pressure levels trigger the browser low memory response.
type: boolean
setPref:
branch: default
pref: "browser.lowMemoryResponseOnWarn"
tabsUnloadOnLowMemory:
description: Whether to unload tabs when available memory is running low.
type: boolean
setPref:
branch: default
pref: "browser.tabs.unloadOnLowMemory"
scriptLoaderPrefs:
description: Prefs that control the script loader.
owner: npierron@mozilla.com
hasExposure: false
variables:
delazificationStrategy:
description: >-
Selects which parsing/delazification strategy should be used while
parsing scripts off-main-thread. See DelazificationOption in
CompileOptions.h for values.
type: int
setPref:
branch: default
pref: "dom.script_loader.delazification.strategy"
echPrefs:
description: Prefs that control Encrypted Client Hello.
owner: djackson@mozilla.com
hasExposure: false
variables:
tlsEnabled:
description: Whether to enable ECH for connections using TLS
type: boolean
setPref:
branch: default
pref: "network.dns.echconfig.enabled"
h3Enabled:
description: Whether to enable ECH for connections using H3/QUIC
type: boolean
setPref:
branch: default
pref: "network.dns.http3_echconfig.enabled"
forceWaitHttpsRR:
description: Whether to force waiting for HTTPS DNS records, which ECH requires.
type: boolean
setPref:
branch: default
pref: "network.dns.force_waiting_https_rr"
insecureFallback:
description: Whether to fallback to non-ECH connections if all ECH RRs fail.
type: boolean
setPref:
branch: default
pref: "network.dns.echconfig.fallback_to_origin_when_all_failed"
tlsGreaseProb:
description: Probability of GREASEing a TLS connection with ECH (0-100).
type: int
setPref:
branch: default
pref: "security.tls.ech.grease_probability"
h3GreaseEnabled:
description: Whether to apply GREASE settings to H3/QUIC connections.
type: boolean
setPref:
branch: default
pref: "security.tls.ech.grease_http3"
disableGreaseOnFallback:
description: Whether to disable GREASE when retrying a connection.
type: boolean
setPref:
branch: default
pref: "security.tls.ech.disable_grease_on_fallback"
greasePaddingSize:
description: Assumed echConfig padding length for GREASE extensions (1-255).
type: int
setPref:
branch: default
pref: "security.tls.ech.grease_size"
dohPrefs:
description: Prefs that control DNS over HTTPS.
owner: vgosu@mozilla.com
hasExposure: false
variables:
trrMode:
description: Has a value of 2 for TRR first, 3 for TRR only, 0 for off.
type: int
setPref:
branch: default
pref: "network.trr.mode"
trrUri:
description: The URL of the DNS over HTTPS endpoint
type: string
setPref:
branch: default
pref: "network.trr.uri"
dohMode:
description: Same as trrMode, but set by the DoHController module.
type: int
setPref:
branch: default
pref: "doh-rollout.mode"
dohUri:
description: Same as trrUri, but set by the DoHController module.
type: string
setPref: