HTMLImageElement: attributionSrc プロパティ

安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。

Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。

attributionSrc は HTMLImageElement インターフェイスのプロパティで、 <img> 要素の attributionsrc 属性をプログラムで取得および設定し、その属性の値を反映します。attributionsrc は、ブラウザーに画像リクエストとともに Attribution-Reporting-Eligible ヘッダーを送信するように指示します。

サーバー側では、Attribution-Reporting-Register-Source または Attribution-Reporting-Register-Trigger ヘッダーをレスポンスで送信し，それぞれ画像ベースの帰属ソースまたは帰属トリガーを登録します。どのレスポンスヘッダーを送り返すべきかは、登録をトリガーした Attribution-Reporting-Eligible ヘッダーの値によって異なります。

ブラウザーが画像ファイルを含む応答を受信すると、ソース/トリガーが登録されます。

メモ: ユーザーが必ずしもその画像を認識できるとは限らないことに留意してください。それは、帰属レポートのみに使用される 1x1 の透明トラッキングピクセルである可能性があります。

詳しくは帰属レポート API を参照してください。

値

文字列。このプロパティには、取得および設定できる 2 つのバージョンがあります。

空文字列、すなわち imgElem.attributionSrc=""。これは、Attribution-Reporting-Eligible ヘッダーを、src 属性が指し示すのと同じサーバーに送信することを指定します。帰属元やトリガー登録を同じサーバーで処理する場合は、これで問題ありません。帰属トリガーを登録する際には、このプロパティはオプションであり、省略した場合は空文字列の値が使用されます。
1 つ以上の URL を含む値、例えば次のようなものです。

js
imgElem.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 を設定

html

js
const imgElem = document.querySelector("img");
imgElem.attributionSrc = "";

URL を含む attributionSrc の設定

html

js
// `=` などの特殊文字が含まれている場合、正しく解析されない
// 可能性があるため、URLをエンコードします。
const encodedUrlA = encodeURIComponent("https://a.example/register-source");
const encodedUrlB = encodeURIComponent("https://b.example/register-source");

const imgElem = document.querySelector("img");
imgElem.attributionSrc = `${encodedUrlA} ${encodedUrlB}`;