HTMLFencedFrameElement: Eigenschaft config

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

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

Wert

Der Wert von config ist anfänglich null.

Wenn der Wert auf eine Instanz eines FencedFrameConfig-Objekts gesetzt wird, bestimmen die internen Eigenschaften des FencedFrameConfig (z. B. mappedURL), was innerhalb des zugehörigen <fencedframe> geladen wird. Zusätzlich gilt:

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

Beispiele

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

Im folgenden Beispiel wird ein FencedFrameConfig von einer Anzeigenauktion der Protected Audience API erhalten, das dann verwendet wird, um die gewonnene 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 Aufruf von runAdAuction() übergeben werden, um ein FencedFrameConfig-Objekt zu erhalten. Wenn dies nicht gesetzt ist, wird das 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

Siehe auch