MDN self-hosted library · e01.org

Fence

Fenced Frame API

Fenced Frame API

The Fence interface of the Fenced Frame API contains several functions relevant to fencedframe functionality.

Fence objects are accessed through the Window.fence property, but they are only available to documents embedded inside fencedframes (loaded via FencedFrameConfigs) or iframes (loaded via opaque URNs).

[!NOTE] See How do <fencedframe>s work? for some description around FencedFrameConfigs and opaque URNs.

Instance methods

  • getNestedConfigs()
  • : Returns the FencedFrameConfigs loaded into <fencedframe>s embedded inside the current <fencedframe>.
  • reportEvent()
  • : Triggers the submission of report data via a beacon to one or more specific URLs registered via the registerAdBeacon() method of the Protected Audience API, for the purpose of collecting ad auction results.
  • setReportEventDataForAutomaticBeacons()
  • : Specifies event data that will be sent when a navigation occurs inside a <fencedframe>. This data will be sent via an automatic beacon to one or more specific URLs registered via the registerAdBeacon() method of the Protected Audience API, for the purpose of collecting reporting data for ad auction results.

Examples

window.fence.reportEvent({
  eventType: "click",
  eventData: JSON.stringify({ clickX: "123", clickY: "456" }),
  destination: ["buyer", "seller"],
});

Specifications

Browser compatibility

See also