SharedStorageRunOperation

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

SharedStorageRunOperation 接口是 Shared Storage API 的一部分,代表一个 Run 输出门 操作。

实例方法

run() 实验性

定义了在 Run 输出门操作中定义的 run() 方法应遵循的结构。

示例

在此示例中,一个名为 ReachMeasurementOperation 的类在 worklet 中定义,并使用 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);

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

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

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();

有关此示例的更多详细信息,请参阅 Unique reach measurement。有关更多示例,请参阅 Shared Storage API

规范

此特性似乎未在任何规范中定义。

浏览器兼容性

另见