chrome.privacy

说明

使用 chrome.privacy API 控制 Chrome 中可能会影响用户隐私的功能的使用情况。此 API 依赖于类型 API 的 ChromeSetting 原型来获取和设置 Chrome 的配置。

权限

privacy

您必须在扩展程序的清单中声明“隐私权”权限，才能使用该 API。例如：

{
  "name": "My extension",
  ...
  "permissions": [
    "privacy"
  ],
  ...
}

概念和用法

读取 Chrome 设置的当前值非常简单。您首先需要找到感兴趣的媒体资源，然后对该对象调用 get()，以检索其当前值和扩展程序的控制级别。例如，若要确定 Chrome 的信用卡自动填充功能是否已启用，您可以编写以下代码：

chrome.privacy.services.autofillCreditCardEnabled.get({}, function(details) {
  if (details.value) {
    console.log('Autofill is on!');
  } else {
    console.log('Autofill is off!');
  }
});

更改设置的值稍微复杂一些，因为您必须先验证您的扩展程序是否可以控制该设置。如果您的扩展程序切换的设置已被企业政策锁定为特定值（levelOfControl 将设为“not_controllable”），或者另一个扩展程序正在控制该值（levelOfControl 将设为“controlled_by_other_extensions”），用户将不会看到其设置发生任何变化。set() 调用将成功，但设置将立即被替换。由于这可能会造成混淆，因此建议在用户选择的设置实际上未应用时向用户发出警告。

这意味着，您应使用 get() 方法来确定自己的访问权限级别，然后仅在您的扩展程序可以控制相应设置时调用 set()（事实上，如果您的扩展程序无法控制相应设置，最好在视觉上停用该功能，以免用户感到困惑）：

chrome.privacy.services.autofillCreditCardEnabled.get({}, function(details) {
  if (details.levelOfControl === 'controllable_by_this_extension') {
    chrome.privacy.services.autofillCreditCardEnabled.set({ value: true }, function() {
      if (chrome.runtime.lastError === undefined) {
        console.log("Hooray, it worked!");
      } else {
        console.log("Sadness!", chrome.runtime.lastError);
      }
    });
  }
});

如果您对设置值的更改感兴趣，请向其 onChange 事件添加监听器。除此之外，您还可以通过此 API 在最近安装的扩展程序控制某项设置或企业政策替换您的控制设置时，向用户发出警告。例如，如需监听信用卡自动填充状态的更改，只需使用以下代码即可：

chrome.privacy.services.autofillCreditCardEnabled.onChange.addListener(
  function (details) {
    // The new value is stored in `details.value`, the new level of control
    // in `details.levelOfControl`, and `details.incognitoSpecific` will be
    // `true` if the value is specific to Incognito mode.
  }
);

示例

如需试用此 API，请从 chrome-extension-samples 代码库安装隐私权 API 示例。

类型

IPHandlingPolicy

Chrome 48 及更高版本

WebRTC 的 IP 处理政策。

枚举

“default”

"default_public_and_private_interfaces"

"default_public_interface_only"

"disable_non_proxied_udp"

属性

network

一般会影响 Chrome 处理网络连接的设置。

类型

对象

属性

  • networkPredictionEnabled

    types.ChromeSetting<boolean>

    启用此功能后，Chrome 会尝试通过预解析 DNS 条目并预先打开与服务器的 TCP 和 SSL 连接来加快您的网络浏览体验。此偏好设置仅会影响 Chrome 内部预测服务执行的操作。这不会影响网页发起的预提取或预连接。此偏好设置的值为布尔值，默认为 true。

  • webRTCIPHandlingPolicy

    types.ChromeSetting<IPHandlingPolicy>

    Chrome 48 及更高版本

    允许用户指定媒体性能/隐私权权衡，这会影响 WebRTC 流量的路由方式和公开的本地地址信息量。此偏好设置的值的类型为 IPHandlingPolicy，默认为 default。

services

用于启用或停用需要 Google 和您的默认搜索提供商提供的第三方网络服务的功能的设置。

类型

对象

属性

  • alternateErrorPagesEnabled

    types.ChromeSetting<boolean>

    如果启用此功能，Chrome 会使用网络服务来帮助解决导航错误。此偏好设置的值为布尔值，默认为 true。

  • autofillAddressEnabled

    types.ChromeSetting<boolean>

    Chrome 70 及更高版本

    如果启用此功能，Chrome 会提供自动填写地址和其他表单数据的选项。此偏好设置的值为布尔值，默认为 true。

  • autofillCreditCardEnabled

    types.ChromeSetting<boolean>

    Chrome 70 及更高版本

    启用后，Chrome 会提供自动填写信用卡表单的功能。此偏好设置的值为布尔值，默认为 true。

  • autofillEnabled

    types.ChromeSetting<boolean>

    从 Chrome 70 开始已废弃

    请使用 privacy.services.autofillAddressEnabled 和 privacy.services.autofillCreditCardEnabled。此方法在本版本中保留是为了向后兼容，未来将被移除。

    启用后，Chrome 会提供自动填写表单的功能。此偏好设置的值为布尔值，默认为 true。

  • passwordSavingEnabled

    types.ChromeSetting<boolean>

    如果启用此设置，密码管理工具会询问您是否要保存密码。此偏好设置的值为布尔值，默认为 true。

  • safeBrowsingEnabled

    types.ChromeSetting<boolean>

    启用此功能后，Chrome 会尽最大努力保护您免受钓鱼式攻击和恶意软件的侵害。此偏好设置的值为布尔值，默认为 true。

  • safeBrowsingExtendedReportingEnabled

    types.ChromeSetting<boolean>

    如果此政策处于启用状态，当安全浏览功能屏蔽某个网页时，Chrome 会向 Google 发送其他信息，例如被屏蔽网页的内容。此偏好设置的值为布尔值，默认为 false。

  • searchSuggestEnabled

    types.ChromeSetting<boolean>

    如果启用此功能，Chrome 会将您在多功能框中输入的文字发送给您的默认搜索引擎，以便该引擎根据您输入的内容提供可能的补全选项，包括网站和搜索内容。此偏好设置的值为布尔值，默认为 true。

  • spellingServiceEnabled

    types.ChromeSetting<boolean>

    如果启用此政策，Chrome 会使用网络服务来帮助更正拼写错误。此偏好设置的值为布尔值，默认为 false。

  • translationServiceEnabled

    types.ChromeSetting<boolean>

    如果启用此功能，Chrome 会询问是否翻译非您所用语言的网页。此偏好设置的值为布尔值，默认为 true。

websites

用于确定 Chrome 向网站提供哪些信息的设置。

类型

对象

属性

  • adMeasurementEnabled

    types.ChromeSetting<boolean>

    Chrome 111 及更高版本

    如果停用，系统会停用 Attribution Reporting API 和 Private Aggregation API。此偏好设置的值的类型为布尔值，默认值为 true。扩展程序只能通过将此值设置为 false 来停用这些 API。如果您尝试将这些 API 设置为 true，系统会抛出错误。

  • doNotTrackEnabled

    types.ChromeSetting<boolean>

    Chrome 65 版以上

    如果启用，Chrome 会在请求中发送“不跟踪”(DNT: 1) 标头。此偏好设置的值的类型为布尔值，默认值为 false。

  • fledgeEnabled

    types.ChromeSetting<boolean>

    Chrome 111 及更高版本

    如果停用，Fledge API 将停用。此偏好设置的值为布尔类型，默认值为 true。扩展程序只能通过将值设置为 false 来停用此 API。如果您尝试将此 API 设置为 true，则会抛出错误。

  • hyperlinkAuditingEnabled

    types.ChromeSetting<boolean>

    如果启用，Chrome 会在网站请求时发送审核 ping (<a ping>)。此偏好设置的值为布尔类型，默认值为 true。

  • protectedContentEnabled

    types.ChromeSetting<boolean>

    仅适用于 Windows 和 ChromeOS：启用后，Chrome 会向插件提供唯一 ID，以便运行受保护的内容。此偏好设置的值的类型为布尔值，默认值为 true。

  • referrersEnabled

    types.ChromeSetting<boolean>

    启用此功能后，Chrome 会在请求中发送 referer 标头。是的，此偏好设置的名称与拼写有误的标头不符。不会，我们不会更改。此偏好设置的值的类型为布尔值，默认值为 true。

  • relatedWebsiteSetsEnabled

    types.ChromeSetting<boolean>

    Chrome 121 及更高版本

    如果停用，相关网站集将停用。此偏好设置的值为布尔类型，默认值为 true。扩展程序只能通过将值设置为 false 来停用此 API。如果您尝试将此 API 设置为 true，则会抛出错误。

  • thirdPartyCookiesAllowed

    types.ChromeSetting<boolean>

    如果停用此设置，Chrome 会阻止第三方网站设置 Cookie。此偏好设置的值的类型为布尔值，默认值为 true。

    **注意：**如果此 API 返回 false，个别网站可能仍能访问第三方 Cookie，前提是它们拥有有效的豁免或改用 Storage Access API。

  • topicsEnabled

    types.ChromeSetting<boolean>

    Chrome 111 及更高版本

    如果停用，Topics API 将停用。此偏好设置的值为布尔类型，默认值为 true。扩展程序只能通过将值设置为 false 来停用此 API。如果您尝试将此 API 设置为 true，则会抛出错误。