SharedStorageRunOperation

实验性:这是一个实验性技术
在生产环境中使用此功能之前,请仔细检查浏览器兼容性表格

SharedStorageRunOperation 接口是 Shared Storage API 的一部分,它表示 运行输出门 操作。

实例方法

run() 实验性

定义了在运行输出门操作内部定义的 run() 方法应符合的结构。

示例

在此示例中,名为 ReachMeasurementOperation 的类在工作线程中定义,并使用 SharedStorageWorkletGlobalScope.register() 以名称 reach-measurement 注册。SharedStorageRunOperation 定义了此类必须符合的结构,本质上定义了 run() 方法所需的参数。除了此要求之外,类的功能可以灵活地定义。

js
// reach-measurement-worklet.js
const SCALE_FACTOR = 65536;

function convertContentIdToBucket(contentId) {
  return BigInt(contentId);
}

class ReachMeasurementOperation {
  async run(data) {
    const { contentId } = data;

    // Read from Shared Storage
    const key = "has-reported-content";
    const hasReportedContent = (await this.sharedStorage.get(key)) === "true";

    // Do not report if a report has been sent already
    if (hasReportedContent) {
      return;
    }

    // Generate the aggregation key and the aggregatable value
    const bucket = convertContentIdToBucket(contentId);
    const value = 1 * SCALE_FACTOR;

    // Send an aggregatable report via the Private Aggregation API
    privateAggregation.sendHistogramReport({ bucket, value });

    // Set the report submission status flag
    await this.sharedStorage.set(key, true);
  }
}

// Register the operation
register("reach-measurement", ReachMeasurementOperation);

注意:可以在同一个共享存储工作线程模块脚本中以不同的名称定义和注册多个操作。有关示例,请参阅 SharedStorageOperation

在主浏览器上下文中,reach-measurement 操作使用 WindowSharedStorage.run() 方法调用。

js
async function measureUniqueReach() {
  // Load the Shared Storage worklet
  await window.sharedStorage.worklet.addModule("reach-measurement-worklet.js");

  // Run the reach measurement operation
  await window.sharedStorage.run("reach-measurement", {
    data: { contentId: "1234" },
  });
}

measureUniqueReach();

有关此示例的更多详细信息,请参阅 唯一覆盖范围测量。有关更多示例,请参阅 Shared Storage API

规范

规范
Shared Storage API
# sharedstoragerunoperation

浏览器兼容性

BCD 表格仅在启用 JavaScript 的浏览器中加载。

另请参阅