HTMLFencedFrameElement: config-Eigenschaft

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig, bevor Sie diese produktiv verwenden.

Die config-Eigenschaft des HTMLFencedFrameElement enthält ein FencedFrameConfig-Objekt, das die Navigation eines <fencedframe> darstellt, d.h. welche Inhalte darin angezeigt werden. Ein FencedFrameConfig wird von einer Quelle wie der Protected Audience API zurückgegeben.

Wert

Der Wert von config ist zunächst null.

Wenn sein Wert auf eine FencedFrameConfig-Objektinstanz gesetzt wird, bestimmen die internen Eigenschaften (zum Beispiel mappedURL) des FencedFrameConfig, was im zugehörigen <fencedframe> geladen wird. Zusätzlich gilt:

  • Der Navigationstyp wird "replace" sein (siehe NavigateEvent.navigationType), was bedeutet, dass der aktuelle Verlaufs-Eintrag durch den neuen Eintrag ersetzt wird, anstatt einen neuen Verlaufs-Eintrag hinzuzufügen.
  • Die Navigations-Referrer-Policy wird auf "no-referrer" gesetzt.

Beispiele

Um festzulegen, welche Inhalte in einem <fencedframe> angezeigt werden sollen, generiert eine nutzende API (wie Protected Audience oder Shared Storage) ein FencedFrameConfig-Objekt, das dann als Wert der config-Eigenschaft des <fencedframe> gesetzt wird.

Das folgende Beispiel erhält ein FencedFrameConfig von einer Werbeauktion der Protected Audience API, das dann verwendet wird, um die gewinnende Anzeige in einem <fencedframe> anzuzeigen:

js
const frameConfig = await navigator.runAdAuction({
  // ...auction configuration
  resolveToConfig: true,
});

const frame = document.createElement("fencedframe");
frame.config = frameConfig;

Note: resolveToConfig: true muss in den runAdAuction()-Aufruf übergeben werden, um ein FencedFrameConfig-Objekt zu erhalten. Wenn dies nicht gesetzt ist, wird die resultierende Promise zu einem URN aufgelöst, der nur in einem <iframe> verwendet werden kann.

Spezifikationen

Specification
Fenced Frame
# dom-htmlfencedframeelement-config

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch