chrome.privacy

说明

使用 chrome.privacy API 来控制 Chrome 中可能会影响用户隐私的功能的使用。此 API 依赖于 ChromeSetting 类型 API 原型来获取和设置 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 事件添加监听器。除此之外，当最近安装的扩展程序获取了某项设置的控制权，或者企业政策覆盖了您的控制时，您可以通过此设置向用户发出警告。例如，如需监听信用卡自动填充状态的变化，以下代码足以满足需求：

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_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 会在您的请求中发送“Do Not Track”(DNT: 1) 标头。此偏好设置的值为布尔值类型，默认值为 false。

  • fledgeEnabled

    types.ChromeSetting<boolean>

    Chrome 111 及更高版本

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

  • hyperlinkAuditingEnabled

    types.ChromeSetting<boolean>

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

  • protectedContentEnabled

    types.ChromeSetting<boolean>

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

  • referrersEnabled

    types.ChromeSetting<boolean>

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

  • relatedWebsiteSetsEnabled

    types.ChromeSetting<boolean>

    Chrome 121 及更高版本

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

  • thirdPartyCookiesAllowed

    types.ChromeSetting<boolean>

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

  • topicsEnabled

    types.ChromeSetting<boolean>

    Chrome 111 及更高版本

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