Fence

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

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 <fencedframe>s (loaded via FencedFrameConfigs) or <iframe>s (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 ore 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

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

Specifications

Specification
Fenced Frame
# fence-interface

Browser compatibility

BCD tables only load in the browser

See also