Firefox Suggest 遥测¶
本文档描述了 Firefox 为 Firefox Suggest 功能记录的遥测数据。也就是说，它描述了在客户端记录的 Firefox Suggest 遥测数据。它还讨论了 Firefox 发送到 Merino 服务的数据。
有关地址栏的其他与遥测相关的信息，请参阅常规地址栏 遥测 文档。有关 Firefox 中所有遥测的信息，请参阅工具包 遥测 文档。
直方图¶
以下直方图记录了 Firefox Suggest 的数据。有关 Firefox 中直方图遥测的一般信息，请参阅 直方图 文档。
FX_URLBAR_MERINO_LATENCY_MS¶
此直方图以毫秒为单位记录了 Merino 数据源的建议延迟，换句话说，就是从 Firefox 向 Merino 服务器发出请求到 Firefox 收到响应的时间。它是一个指数直方图，具有 50 个桶，值介于 0 到 30000（0 秒到 30 秒）之间。
- 变更日志
- Firefox 93.0
引入。[Bug 1727799]
FX_URLBAR_MERINO_LATENCY_WEATHER_MS¶
此直方图以毫秒为单位记录了 Merino 提供的天气建议的延迟。它会更新 FX_URLBAR_MERINO_LATENCY_MS，并具有相同的属性。它是一个指数直方图，具有 50 个桶，值介于 0 到 30000（0 秒到 30 秒）之间。
- 变更日志
- Firefox 110.0
引入。[Bug 1804536]
FX_URLBAR_MERINO_RESPONSE¶
此分类直方图记录了从 Merino 服务器获取的每次请求的摘要。它具有以下类别
- 0 “成功”:
获取在超时时间到期之前完成且没有任何错误，并且包含至少一个建议。（在 Firefox 110.0 之前，此类别仅表示获取在超时时间到期之前完成且没有任何错误，无论它是否包含任何建议。）
- 1 “超时”:
获取在完成或其他失败之前超时。
- 2 “网络错误”:
获取由于网络错误在超时时间到期之前失败。例如，用户的网络或 Merino 服务器已关闭。
- 3 “HTTP 错误”:
获取在超时时间到期之前完成，但服务器返回了错误。
- 4 “无建议”:
获取在超时时间到期之前完成且没有任何错误，并且未包含任何建议。
FX_URLBAR_MERINO_RESPONSE_WEATHER¶
此分类直方图记录了从 Merino 服务器获取的天气建议的每次请求的摘要。它会更新 FX_URLBAR_MERINO_RESPONSE，并具有相同的类别。
- 0 “成功”:
获取在超时时间到期之前完成且没有任何错误，并且包含至少一个建议。
- 1 “超时”:
获取在完成或其他失败之前超时。
- 2 “网络错误”:
获取由于网络错误在超时时间到期之前失败。例如，用户的网络或 Merino 服务器已关闭。
- 3 “HTTP 错误”:
获取在超时时间到期之前完成，但服务器返回了错误。
- 4 “无建议”:
获取在超时时间到期之前完成且没有任何错误，并且未包含任何建议。
- 变更日志
- Firefox 110.0
引入。[Bug 1804536]
FX_URLBAR_QUICK_SUGGEST_REMOTE_SETTINGS_LATENCY_MS¶
此直方图以毫秒为单位记录了远程设置数据源的建议延迟，换句话说，就是从 Firefox 开始从远程设置获取建议到检索建议的时间。它是一个指数直方图，具有 50 个桶，值介于 0 到 30000（0 秒到 30 秒）之间。
请注意，与 Merino 不同，从远程设置获取完全在客户端进行，因此远程设置延迟预计会比 Merino 延迟小得多。
- 变更日志
- Firefox 94.0.2
引入。[Bug 1737651]
标量¶
以下标量记录了 Firefox Suggest 的数据。有关 Firefox 中标量遥测的一般信息，请参阅 标量 文档。
browser.ui.interaction.preferences_panePrivacy¶
每次用户在偏好设置 UI 中点击 Firefox Suggest 复选框或切换开关时，此键控标量都会递增。键如下所示
- firefoxSuggestBestMatch:
点击“最佳匹配”复选框时，此键会递增。在 120 中，此 UI 已移除，因此此键不再记录。
- firefoxSuggestBestMatchLearnMore:
打开最佳匹配的了解更多链接时，此键会递增。在 120 中，此 UI 已移除，因此此键不再记录。
- firefoxSuggestDataCollectionToggle:
点击数据收集的切换开关时，此键会递增。
- firefoxSuggestNonsponsoredToggle:
点击非赞助建议的切换开关时，此键会递增。
- firefoxSuggestSponsoredToggle:
点击赞助建议的切换开关时，此键会递增。
- 变更日志
- Firefox 94.0.2
引入
firefoxSuggestDataCollectionToggle、firefoxSuggestNonsponsoredToggle和firefoxSuggestSponsoredToggle。[Bug 1735976]- Firefox 99.0
引入
firefoxSuggestBestMatch。[Bug 1755100] 引入firefoxSuggestBestMatchLearnMore。[Bug 1756917]- Firefox 120.0
移除
firefoxSuggestBestMatch和firefoxSuggestBestMatchLearnMore。[Bug 1857391]
contextual.services.quicksuggest.block_dynamic_wikipedia¶
每次用户关闭（“阻止”）动态维基百科建议时，此键控标量都会递增。每个键都是建议在结果中出现的索引（从 1 开始），相应的值是在该索引处关闭的次数。
contextual.services.quicksuggest.block_nonsponsored¶
每次用户关闭（“阻止”）非赞助建议时，此键控标量都会递增，包括最佳匹配和普通的非最佳匹配建议。每个键都是建议在结果中出现的索引（从 1 开始），相应的值是在该索引处关闭的次数。
contextual.services.quicksuggest.block_nonsponsored_bestmatch¶
此键控标量在 Firefox 120 中已移除。在此之前，每次用户关闭（“阻止”）非赞助最佳匹配时，它都会递增。每个键都是建议在结果中出现的索引（从 1 开始），相应的值是在该索引处关闭的次数。
contextual.services.quicksuggest.block_sponsored¶
每次用户关闭（“阻止”）赞助建议时，此键控标量都会递增，包括最佳匹配和普通的非最佳匹配建议。每个键都是建议在结果中出现的索引（从 1 开始），相应的值是在该索引处关闭的次数。
contextual.services.quicksuggest.block_sponsored_bestmatch¶
此键控标量在 Firefox 120 中已移除。在此之前，每次用户关闭（“阻止”）赞助最佳匹配时，它都会递增。每个键都是建议在结果中出现的索引（从 1 开始），相应的值是在该索引处关闭的次数。
contextual.services.quicksuggest.block_weather¶
每次用户关闭（“阻止”）Firefox Suggest 天气建议时，此键控标量都会递增。每个键都是建议在结果中出现的索引（从 1 开始），相应的值是在该索引处关闭的次数。
contextual.services.quicksuggest.click¶
每次用户选择建议时，此键控标量都会递增。每个键都是建议在结果中出现的索引（从 1 开始），相应的值是在该索引处点击的次数。
contextual.services.quicksuggest.click_dynamic_wikipedia¶
每次用户选择动态维基百科建议时，此键控标量都会递增。每个键都是建议在结果中出现的索引（从 1 开始），对应的值是该索引处的点击次数。
contextual.services.quicksuggest.click_nonsponsored¶
每次用户选择非赞助建议时，此键控标量都会递增。每个键都是建议在结果中出现的索引（从 1 开始），对应的值是该索引处的点击次数。
contextual.services.quicksuggest.click_nonsponsored_bestmatch¶
此键控标量已在 Firefox 120 中移除。在此之前，每次用户选择非赞助最佳匹配时，它都会递增。每个键都是建议在结果中出现的索引（从 1 开始），对应的值是该索引处的点击次数。
contextual.services.quicksuggest.click_sponsored¶
每次用户选择赞助建议时，此键控标量都会递增。每个键都是建议在结果中出现的索引（从 1 开始），对应的值是该索引处的点击次数。
contextual.services.quicksuggest.click_sponsored_bestmatch¶
此键控标量已在 Firefox 120 中移除。在此之前，每次用户选择赞助最佳匹配时，它都会递增。每个键都是建议在结果中出现的索引（从 1 开始），对应的值是该索引处的点击次数。
contextual.services.quicksuggest.click_weather¶
每次用户选择天气建议时，此键控标量都会递增。每个键都是建议在结果中出现的索引（从 1 开始），对应的值是该索引处的点击次数。
contextual.services.quicksuggest.exposure_weather¶
此键控标量记录天气建议的曝光次数。每次用户看到天气建议时，它都会递增。它可以与 urlbar.zeroprefix.exposure 标量（参见 Telemetry）进行比较，以确定包含天气建议的零前缀曝光的百分比。
每个键都是建议在结果中出现的索引（从 1 开始），对应的值是该索引处的曝光次数。
contextual.services.quicksuggest.help¶
每次用户在建议中选择帮助按钮时，此键控标量都会递增。每个键都是建议在结果中出现的索引（从 1 开始），对应的值是该索引处的帮助按钮点击次数。
contextual.services.quicksuggest.help_dynamic_wikipedia¶
每次用户在动态维基百科建议中选择帮助按钮时，此键控标量都会递增。每个键都是建议在结果中出现的索引（从 1 开始），对应的值是该索引处的帮助按钮点击次数。
contextual.services.quicksuggest.help_nonsponsored¶
每次用户在非赞助建议中选择帮助按钮时，此键控标量都会递增。每个键都是建议在结果中出现的索引（从 1 开始），对应的值是该索引处的帮助按钮点击次数。
contextual.services.quicksuggest.help_nonsponsored_bestmatch¶
此键控标量已在 Firefox 120 中移除。在此之前，每次用户在非赞助最佳匹配中选择帮助按钮时，它都会递增。每个键都是建议在结果中出现的索引（从 1 开始），对应的值是该索引处的帮助按钮点击次数。
contextual.services.quicksuggest.help_sponsored¶
每次用户在赞助建议中选择帮助按钮时，此键控标量都会递增。每个键都是建议在结果中出现的索引（从 1 开始），对应的值是该索引处的帮助按钮点击次数。
contextual.services.quicksuggest.help_sponsored_bestmatch¶
此键控标量已在 Firefox 120 中移除。在此之前，每次用户在赞助最佳匹配中选择帮助按钮时，它都会递增。每个键都是建议在结果中出现的索引（从 1 开始），对应的值是该索引处的帮助按钮点击次数。
contextual.services.quicksuggest.help_weather¶
每次用户在天气建议中选择帮助按钮时，此键控标量都会递增。每个键都是建议在结果中出现的索引（从 1 开始），对应的值是该索引处的帮助按钮点击次数。
contextual.services.quicksuggest.impression¶
此键控标量记录建议的展现次数。每次用户看到建议并满足以下两个条件时，它都会递增
用户已通过在其中选择结果或按 Enter 键来完成与地址栏的交互。
在用户完成交互时，结果中存在建议。
每个键都是建议在结果中出现的索引（从 1 开始），对应的值是该索引处的展现次数。
contextual.services.quicksuggest.impression_dynamic_wikipedia¶
此键控标量记录动态维基百科的展现次数。每次用户看到动态维基百科建议并满足以下两个条件时，它都会递增
用户已通过在其中选择结果或按 Enter 键来完成与地址栏的交互。
在用户完成交互时，结果中存在动态维基百科建议。
每个键都是建议在结果中出现的索引（从 1 开始），对应的值是该索引处的展现次数。
contextual.services.quicksuggest.impression_nonsponsored¶
此键控标量记录建议的展现次数。每次用户看到非赞助建议并满足以下两个条件时，它都会递增
用户已通过在其中选择结果或按 Enter 键来完成与地址栏的交互。
在用户完成交互时，结果中存在建议。
每个键都是建议在结果中出现的索引（从 1 开始），对应的值是该索引处的展现次数。
contextual.services.quicksuggest.impression_nonsponsored_bestmatch¶
此键控标量已在 Firefox 120 中移除。在此之前，它记录非赞助最佳匹配的展现次数。每次用户看到非赞助最佳匹配并满足以下两个条件时，它都会递增
用户已通过在其中选择结果或按 Enter 键来完成与地址栏的交互。
在用户完成交互时，结果中存在非赞助最佳匹配。
每个键都是建议在结果中出现的索引（从 1 开始），对应的值是该索引处的展现次数。
contextual.services.quicksuggest.impression_sponsored¶
此键控标量记录建议的展现次数。每次用户看到赞助建议并满足以下两个条件时，它都会递增
用户已通过在其中选择结果或按 Enter 键来完成与地址栏的交互。
在用户完成交互时，结果中存在建议。
每个键都是建议在结果中出现的索引（从 1 开始），对应的值是该索引处的展现次数。
contextual.services.quicksuggest.impression_sponsored_bestmatch¶
此键控标量已在 Firefox 120 中移除。在此之前，它记录赞助最佳匹配的展现次数。每次用户看到赞助最佳匹配并满足以下两个条件时，它都会递增
用户已通过在其中选择结果或按 Enter 键来完成与地址栏的交互。
在用户完成交互时，结果中存在赞助最佳匹配。
每个键都是建议在结果中出现的索引（从 1 开始），对应的值是该索引处的展现次数。
contextual.services.quicksuggest.impression_weather¶
此键控标量记录天气建议的展现次数。每次用户看到天气建议并满足以下两个条件时，它都会递增
用户已通过在其中选择结果或按 Enter 键来完成与地址栏的交互。
在用户完成交互时，结果中存在天气建议。
每个键都是建议在结果中出现的索引（从 1 开始），对应的值是该索引处的展现次数。
事件¶
以下 Firefox Suggest 事件记录在 contextservices.quicksuggest 类别中。有关 Firefox 中事件遥测的一般信息，请参阅 事件 文档。
contextservices.quicksuggest.data_collect_toggled¶
当 browser.urlbar.quicksuggest.dataCollection.enabled 首选项被切换时，会记录此事件。首选项可以通过以下方式切换
用户可以在首选项 UI 中切换它。
用户可以在 about:config 中切换它。
当用户选择加入在线模态对话框时，也会记录此事件，但有一个例外：如果用户已使用首选项 UI 或 about:config 启用了数据收集，则首选项的用户值已为真。选择加入不会更改用户值，因此不会记录任何事件。
事件的对象如下
- enabled:
当首选项从假切换到真时记录。
- disabled:
当首选项从真切换到假时记录。
contextservices.quicksuggest.enable_toggled¶
当 browser.urlbar.suggest.quicksuggest.nonsponsored 首选项被切换时，会记录此事件。首选项可以通过以下方式切换
用户可以在首选项 UI 中切换它。
用户可以在 about:config 中切换它。
事件的对象如下
- enabled:
当首选项从假切换到真时记录。
- disabled:
当首选项从真切换到假时记录。
- 变更日志
- Firefox 87.0
引入。此事件对应于
browser.urlbar.suggest.quicksuggest首选项。[Bug 1693126]- Firefox 94.0.2
browser.urlbar.suggest.quicksuggest被替换为browser.urlbar.suggest.quicksuggest.nonsponsored，并且此事件现在对应于后者首选项。[Bug 1735976]- Firefox 96.0
当用户与在线模式对话框交互时，不再记录此事件，因为当用户选择加入或退出时，
browser.urlbar.suggest.quicksuggest.nonsponsored首选项不再设置。[Bug 1740965]- Firefox 133.0
移除。[Bug 1921748]
contextservices.quicksuggest.engagement¶
当在地址栏中存在 Firefox Suggest 建议时发生交互时，就会记录此事件。换句话说，它在两种情况下被记录
用户选择了一个 Firefox Suggest 建议或相关的 UI 元素，例如其帮助按钮。
当地址栏中存在 Firefox Suggest 建议时，用户选择其他行。
事件的对象具有以下可能的值
- block:
用户关闭了（“阻止”）建议。
- click:
用户选择了建议。
- help:
用户选择了建议的帮助按钮。
- impression_only:
用户选择了其他行。
- other:
用户以其他方式与建议交互，例如通过在结果菜单中选择命令。这是一个万能类别，未来应优先使用 Glean 遥测。
事件的 extra 包含以下属性
- match_type:
如果建议是最匹配，则为“best-match”，如果是非最匹配建议，则为“firefox-suggest”。
- position:
建议在结果列表中的索引（从 1 开始）。
- suggestion_type:
建议的类型，以下之一：“sponsored”、“nonsponsored”、“dynamic-wikipedia”、“navigational”
- source:
建议的来源，以下之一：“remote-settings”、“merino”
contextservices.quicksuggest.impression_cap¶
当发生与展示次数上限相关的事件时，就会记录此事件。事件的对象具有以下可能的值
- hit:
当达到展示次数上限时记录。
- reset:
当上限的计数器重置，因为其间隔时间已过时记录。实现可能会将多个连续的重置事件批处理到单个遥测事件中；请参阅下面的
eventCount讨论。仅当 Firefox 正在运行时，上限的间隔时间到期才会报告重置事件。
事件的 extra 包含以下属性
- count:
上限间隔时间内的展示次数。
- eventCount:
在遥测事件中报告的展示次数上限事件的数量。这是必要的，因为实现可能会将多个连续的“重置”事件批处理到单个遥测事件中。在这种情况下，此值将大于 1，
startDate将是第一个事件的间隔时间开始的时间戳，eventDate将是最后一个事件的间隔时间结束的时间戳，而count将是第一个事件间隔时间内的展示次数。（实现保证仅当所有后续间隔时间内的展示次数为零时才会批处理重置事件。）对于“hit”事件，eventCount将始终为 1。- eventDate:
事件的时间戳，以自 Unix 纪元以来的毫秒数表示。对于“重置”事件，这是上限间隔时间结束的时间戳。如果
eventCount大于 1，则为最后一个间隔时间结束的时间戳。对于“hit”事件，这是达到上限的时间戳。- impressionDate:
最近一次展示的时间戳，以自 Unix 纪元以来的毫秒数表示。
- intervalSeconds:
上限间隔时间内的秒数。对于生命周期上限，此值将为“Infinity”。
- maxCount:
上限间隔时间内允许的最大展示次数。
- startDate:
上限间隔时间开始的时间戳，以自 Unix 纪元以来的毫秒数表示。
- type:
上限的类型，以下之一：“sponsored”、“nonsponsored”
contextservices.quicksuggest.opt_in_dialog¶
当用户与在线模式对话框交互时，就会记录此事件。事件的对象如下
- accept:
用户接受了对话框并选择加入。此对象已在 Firefox 96.0.2 中删除。
- accept_2:
用户接受了对话框并选择加入。
- close_1:
用户点击了关闭按钮或简介部分中的类似链接。在这种情况下，用户保持退出状态。
- dismiss_1:
用户通过按 Escape 键或简介部分上的某种未知方式关闭了对话框。在这种情况下，用户保持退出状态。
- dismiss_2:
用户通过按 Escape 键或主部分上的某种未知方式关闭了对话框。在这种情况下，用户保持退出状态。
- dismissed_escape_key:
用户通过按 Escape 键关闭了对话框。在这种情况下，用户保持退出状态。此对象已在 Firefox 96.0.2 中删除。
- dismissed_other:
对话框以某种未知方式关闭。这种情况可能发生在一个对话框被另一个优先级更高的对话框替换时，例如在退出应用程序时显示的对话框。在这种情况下，用户保持退出状态。此对象已在 Firefox 96.0.2 中删除。
- learn_more:
用户点击了“了解更多”。在这种情况下，用户保持退出状态。此对象已在 Firefox 96.0.2 中删除。
- learn_more_1:
用户点击了简介部分中的“了解更多”。在这种情况下，用户保持退出状态。
- learn_more_2:
用户点击了主部分中的“了解更多”。在这种情况下，用户保持退出状态。
- not_now:
对话框以某种方式关闭，未选择加入。此对象已在 Firefox 94.0 中删除。
- not_now_2:
用户点击了主部分中的“稍后再说”链接。在这种情况下，用户保持退出状态。
- not_now_link:
用户点击了“稍后再说”。在这种情况下，用户保持退出状态。此对象已在 Firefox 96.0.2 中删除。
- reject_2:
用户拒绝了对话框并选择退出。
- settings:
用户点击了“自定义”按钮。在这种情况下，用户保持退出状态。此对象已在 Firefox 96.0.2 中删除。
- 变更日志
- Firefox 92.0.1
已引入。对象为：
accept、settings、learn_more和not_now。not_now在对话框以任何其他对象未涵盖的方式关闭时记录。[Bug 1723860]- Firefox 94.0
对象已更改为：
accept、dismissed_escape_key、dismissed_other、learn_more、not_now_link和settings。[Bug 1733687]- Firefox 96.0.2
对象已更改为：
accept_2、reject_2、learn_more_2、close_1、not_now_2、dismiss_1和dismiss_2。[Bug 1745026]- Firefox 100.0
对象已更改为：
accept_2、reject_2、learn_more_1、learn_more_2、close_1、not_now_2、dismiss_1和dismiss_2。[Bug 1761171]- Firefox 133.0
移除。[Bug 1921748]
contextservices.quicksuggest.sponsored_toggled¶
当 browser.urlbar.suggest.quicksuggest.sponsored 首选项切换时，就会记录此事件。首选项可以通过以下方式切换
用户可以在首选项 UI 中切换它。
用户可以在 about:config 中切换它。
事件的对象如下
- enabled:
当首选项从假切换到真时记录。
- disabled:
当首选项从真切换到假时记录。
环境¶
以下首选项在遥测环境数据中记录。有关 Firefox 中遥测环境数据的常规信息，请参阅 环境 文档。
browser.urlbar.quicksuggest.onboardingDialogChoice¶
此首选项记录用户在在线模式对话框中的选择。如果对话框显示多次，则记录用户最近的选择。它是一个字符串值的首选项，具有以下可能的值
- <空字符串>:
用户尚未做出选择（例如，因为对话框尚未显示）。
- accept:
用户接受了对话框并选择加入。此对象已在 Firefox 96.0.2 中删除。
- accept_2:
用户接受了对话框并选择加入。
- close_1:
用户点击了关闭按钮或简介部分中的类似链接。在这种情况下，用户保持退出状态。
- dismiss_1:
用户通过按 Escape 键或简介部分上的某种未知方式关闭了对话框。在这种情况下，用户保持退出状态。
- dismiss_2:
用户通过按 Escape 键或主部分上的某种未知方式关闭了对话框。在这种情况下，用户保持退出状态。
- dismissed_escape_key:
用户通过按 Escape 键关闭了对话框。在这种情况下，用户保持退出状态。此对象已在 Firefox 96.0.2 中删除。
- dismissed_other:
对话框以某种未知方式关闭。这种情况可能发生在一个对话框被另一个优先级更高的对话框替换时，例如在退出应用程序时显示的对话框。在这种情况下，用户保持退出状态。此对象已在 Firefox 96.0.2 中删除。
- learn_more:
用户点击了“了解更多”。在这种情况下，用户保持退出状态。此对象已在 Firefox 96.0.2 中删除。
- learn_more_1:
用户点击了简介部分中的“了解更多”。在这种情况下，用户保持退出状态。
- learn_more_2:
用户点击了主部分中的“了解更多”。在这种情况下，用户保持退出状态。
- not_now_2:
用户点击了主部分中的“稍后再说”链接。在这种情况下，用户保持退出状态。
- not_now_link:
用户点击了“稍后再说”。在这种情况下，用户保持退出状态。此对象已在 Firefox 96.0.2 中删除。
- reject_2:
用户拒绝了对话框并选择退出。
- settings:
用户点击了“自定义”按钮。在这种情况下，用户保持退出状态。此对象已在 Firefox 96.0.2 中删除。
browser.urlbar.quicksuggest.dataCollection.enabled¶
此布尔首选项记录用户是否选择加入 Firefox Suggest 的数据收集。默认为 false。当用户选择加入在线模式对话框时，将其设置为 true。用户也可以在首选项 UI 和 about:config 中切换它。
- 变更日志
- Firefox 94.0.2
引入。[Bug 1735976]
browser.urlbar.suggest.quicksuggest¶
此首选项不再存在，并且未记录。在 Firefox 94.0.2 中，它被 browser.urlbar.suggest.quicksuggest.nonsponsored 替换。在 94.0.2 之前，此布尔首选项记录是否启用了常规建议。
browser.urlbar.suggest.quicksuggest.nonsponsored¶
此布尔首选项记录是否启用了非赞助建议。在脱机和联机场景中，它默认都为 true。用户也可以在首选项 UI 和 about:config 中切换它。
browser.urlbar.suggest.quicksuggest.sponsored¶
此布尔型偏好设置记录是否启用了赞助建议。在离线和在线场景中，它默认情况下都为 true。用户也可以在偏好设置 UI 和 about:config 中切换它。
“快速建议”Ping¶
Firefox 建议的建议通过 “快速建议”Ping 记录遥测数据，该数据在链接的 Glean 词典页面中进行了详细说明。
Nimbus 曝光事件¶
每次应用程序会话中，当用户首次遇到其注册的实验的 UI 时，都会记录一个 Nimbus 曝光事件。事件的时机取决于实验和分支。
有两个 Nimbus 变量决定事件的时机：experimentType 和已弃用的 isBestMatchExperiment。要确定何时为特定实验和分支记录曝光事件，请检查实验的配方并查找其中一个变量。
下面列出了 experimentType 和 isBestMatchExperiment 的支持值，以及有关何时记录其相应曝光事件的详细信息。
- experimentType = “best-match”：
如果用户位于处理分支中并且未禁用最佳匹配，则在他们第一次触发最佳匹配时记录事件；如果用户位于处理分支中并且已禁用最佳匹配，则根本不会记录事件。如果用户位于控制分支中，则在他们本应第一次触发最佳匹配时记录事件。（控制分支中的用户无法“禁用”最佳匹配，因为该功能完全对他们隐藏。）注意：“最佳选择”复选框（允许用户禁用最佳匹配）已在 120 版中移除。
- experimentType = “modal”：
如果用户位于处理分支中，则在向他们显示选择加入模态框时记录事件。如果用户位于控制分支中，则在他们本应显示模态框的每次启动时记录事件，即在每次启动时另一个非建议模态框未出现时记录事件。注意：此功能已在 Firefox 124 中移除。
- isBestMatchExperiment = true：
这是
experimentType == "best-match"的已弃用版本。- 所有其他实验：
对于上面未列出的所有其他实验，在用户第一次触发 Firefox 建议建议时记录事件。
- 变更日志
- Firefox 92.0
引入。无论用户注册了哪个实验，都会在用户第一次触发 Firefox 建议建议时始终记录事件。[Bug 1724076，1727392]
- Firefox 99.0
添加了
isBestMatchExperiment = true案例。[Bug 1752953]- Firefox 100.0
添加了
experimentType = "modal"案例。isBestMatchExperiment = true已弃用，取而代之的是experimentType = "best-match"。[Bug 1760596]- Firefox 124.0
已移除
experimentType = "modal"案例。
Merino 搜索查询¶
Merino 是一项 Mozilla 服务，提供 Firefox 建议建议。与客户端上的远程设置一起，它是 Firefox 建议的两个可能来源之一。当客户端上启用 Merino 集成且用户已选择加入 Firefox 建议数据收集时，Firefox 会将用户在地址栏中键入的所有内容发送到 Merino 服务器。作为响应，Merino 会从其搜索提供程序中查找相关的搜索结果，并将这些结果发送到 Firefox，并在地址栏中显示给用户。
当用户选择加入在线模态对话框或在偏好设置 UI 中启用 Firefox 建议数据收集时，他们会选择加入 Firefox 建议数据收集。
Merino 查询本身并非遥测数据，但我们将其包含在本文档中，因为它们必然涉及数据收集。
Merino API¶
Firefox 发送到 Merino 服务器的数据总结如下。当客户端上启用 Merino 集成且用户已选择加入 Firefox 建议数据收集时，此数据会随用户在地址栏中的每次按键一起发送。
有关 Merino API 的详细信息，请参阅 Merino 文档。
- 搜索查询
用户在地址栏中键入的搜索查询。
API 参数名称：
q- 会话 ID
一个 UUID，用于标识用户在地址栏中的当前搜索会话。此 ID 每个搜索会话唯一。当焦点离开地址栏或超时 5 分钟（以先发生者为准）时，搜索会话结束。
API 参数名称：
sid- 序列号
从 Merino 接收响应后递增的基于零的整数。它在每个搜索会话结束时与会话 ID 一起重置。
API 参数名称：
seq- 客户端变体
可选。影响 Firefox 建议用户体验的实验或推广列表。如果 Merino 识别出任何这些内容，它将相应地修改其行为。
API 参数名称：
client_variants- 提供商
可选。要用于此请求的提供商列表。如果指定，则仅返回列出提供商的建议。否则，Merino 将使用默认的提供商集。
API 参数名称：
providers