HTMLScriptElement: attributionSrc プロパティ
安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。
Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。
attributionSrc
は HTMLScriptElement
インターフェイスのプロパティで、<script>
要素の attributionsrc
属性をプログラムで取得・設定し、その属性値を反映します。attributionsrc
はブラウザーにスクリプトリソースリクエストと一緒に Attribution-Reporting-Eligible
ヘッダーを送信することを指定します。
サーバー側では、これはレスポンスで Attribution-Reporting-Register-Source
または Attribution-Reporting-Register-Trigger
ヘッダーを送信するトリガーとして用いられ、それぞれ JavaScript ベースの属性ソースまたは属性トリガーを登録します。どのレスポンスヘッダーを送り返すべきかは、登録を行った Attribution-Reporting-Eligible
ヘッダーの値に依存します。
メモ: 他にも、JavaScript の属性ソースまたはトリガーは、fetch()
リクエストに attributionReporting
オプションをつけて送信するか(fetch()
呼び出しで直接設定するか、fetch()
呼び出しに渡された Request
オブジェクトで)、XMLHttpRequest
で setAttributionReporting()
をリクエストオブジェクトについて呼び出したりすることもできます。
詳細は属性レポート API です。
値
文字列です。このプロパティには 2 つのバージョンがあり、取得したり設定したりすることができます。
-
空文字列、すなわち
scriptElem.attributionSrc=""
。これは、Attribution-Reporting-Eligible
ヘッダーを、src
属性がこの点を指すのと同じサーバーに送信することを指定します。これは、属性ソースやトリガーの登録を同じサーバーで処理している場合には問題ありません。属性トリガーを登録する場合、このプロパティはオプションであり、除外すると空文字列の値を使用します。 -
1 つ以上の URL を含む値です。例えば次のようなものです。
jsscriptElem.attributionSrc = "https://a.example/register-source https://b.example/register-source";
これは、リクエストされたリソースがあなたが制御しているサーバーにない場合や、属性ソースを別のサーバーに登録する処理だけを行いたい場合に有益です。この場合、
attributionSrc
の値として 1 つ以上の URL を指定します。リソースリクエストが発生すると、Attribution-Reporting-Eligible
ヘッダーがリソースオリジンに加えて、attributionSrc
を指定した URL にも送信されます。これらの URL はAttribution-Reporting-Register-Source
またはAttribution-Reporting-Register-Trigger
ヘッダーで応答することができます。メモ: 複数の URL を指定するということは、複数の属性ソースを同じ機能に登録できるということです。例えば、成功を測定しようとしている様々なキャンペーンがあり、異なるデータで異なるレポートを生成する必要があるかもしれません。
例
空の attributionSrc を設定
<script src="advertising-script.js"></script>
const scriptElem = document.querySelector("script");
scriptElem.attributionSrc = "";
attributionSrc に URL を設定
<script src="advertising-script.js"></script>
// URL に '=' のような特殊文字が格納されていると不適切に解釈されてしまうため、
// エンコードしてください。
const encodedUrlA = encodeURIComponent("https://a.example/register-source");
const encodedUrlB = encodeURIComponent("https://b.example/register-source");
const scriptElem = document.querySelector("script");
scriptElem.attributionSrc = `${encodedUrlA} ${encodedUrlB}`;
仕様書
Specification |
---|
Attribution Reporting # dom-htmlattributionsrcelementutils-attributionsrc |
ブラウザーの互換性
BCD tables only load in the browser