XMLHttpRequest: setAttributionReporting()-Methode
Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.
Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig, bevor Sie diese produktiv verwenden.
Die setAttributionReporting()
-Methode der
XMLHttpRequest
-Schnittstelle zeigt an, dass die Antwort auf die Anfrage in der Lage sein soll, eine JavaScript-basierte Attributionsquelle oder einen Attributionstrigger zu registrieren.
Weitere Details finden Sie in der Attribution Reporting API.
Syntax
setAttributionReporting(options)
Parameter
options
-
Ein Objekt, das Optionen zur Attributionsberichterstattung bereitstellt, einschließlich der folgenden Eigenschaften:
eventSourceEligible
-
Ein boolescher Wert. Wenn auf
true
gesetzt, ist die Antwort auf die Anfrage berechtigt, eine Attributionsquelle zu registrieren. Wenn auffalse
gesetzt, ist sie es nicht. triggerEligible
-
Ein boolescher Wert. Wenn auf
true
gesetzt, ist die Antwort auf die Anfrage berechtigt, einen Attributionstrigger zu registrieren. Wenn auffalse
gesetzt, ist sie es nicht.
Rückgabewert
Keiner (undefined
).
Ausnahmen
InvalidStateError
DOMException
-
Wird ausgelöst, wenn das zugehörige
XMLHttpRequest
noch nicht geöffnet oder bereits gesendet wurde. TypeError
DOMException
-
Wird ausgelöst, wenn die Nutzung der Attribution Reporting API durch eine
attribution-reporting
Permissions-Policy
blockiert wird.
Beispiele
const attributionReporting = {
eventSourceEligible: true,
triggerEligible: false,
};
function triggerSourceInteraction() {
const req = new XMLHttpRequest();
req.open("GET", "https://shop.example/endpoint");
// Check availability of setAttributionReporting() before calling
if (typeof req.setAttributionReporting === "function") {
req.setAttributionReporting(attributionReporting);
req.send();
} else {
throw new Error("Attribution reporting not available");
// Include recovery code here as appropriate
}
}
// Associate the interaction trigger with whatever
// element and event makes sense for your code
elem.addEventListener("click", triggerSourceInteraction);
Spezifikationen
Specification |
---|
Attribution Reporting # dom-xmlhttprequest-setattributionreporting |
Browser-Kompatibilität
BCD tables only load in the browser