Navigator: deprecatedReplaceInURN() メソッド

構文

deprecatedReplaceInURN(UrnOrConfig, replacements)

引数

UrnOrConfig

対応する内部 URL の一部を置換したい FencedFrameConfig オブジェクトまたは不透明な URN。

replacements

内部 URL で置き換えたい内容を表す 1 つ以上のプロパティを持つオブジェクトです。それぞれのプロパティキーは、置き換えたい URL の一部、それぞれのプロパティ値は置き換え後の文字列です。以下の点に注意してください。

• 置き換える URL の一部は、以下のいずれかの形式に従う必要があります。
  • ${string}
  • %%string%%
• URL の一部が正しい形式で記述されているものの、その部分が URL から探し出せない場合、返されたプロミスは履行されますが、置換は行われません。

返値

undefined で履行されるプロミス (Promise) です。

例外

TypeError DOMException

次の場合に発生します。

• UrnOrConfig は有効な FencedFrameConfig オブジェクトまたは不明な URN ではない場合。
• 指定した交換キーのいずれも、許可された形式と一致しない場合。

例

次の呼び出しを使用して、不透明な URN を返すことができます。

const exampleURN = await navigator.runAdAuction({
  ...auctionConfig,
  resolveToConfig: false,
});

次のように deprecatedReplaceInURN() を呼び出すことで、URL の一部を置き換えることができます。

await navigator.deprecatedReplaceInURN(exampleURN, {
  "${foo}": "1",
  "${bar}": "2",
  "%%baz%%": "3",
});

URN に結び付けられた内部 URL が最初は次のようになっていた場合、

https://example.com/a=${foo}&b=${bar}&c=%%baz%%

置換の後は次のようになります。

https://example.com/a=1&b=2&c=3

仕様書

ブラウザーの互換性

関連情報

• フェンス付きフレーム API