XMLHttpRequest: setAttributionReporting() method
Attribution Reporting API
Attribution Reporting API
The setAttributionReporting() method of the
XMLHttpRequest interface indicates that you want the request's response to be able to register a JavaScript-based attribution source or attribution trigger.
See the Attribution Reporting API for more details.
Syntax
setAttributionReporting(options)
Parameters
options- : An object providing attribution reporting options, which includes the following properties:
eventSourceEligible- : A boolean. If set to
true, the request's response is eligible to register an attribution source. If set tofalse, it isn't. triggerEligible- : A boolean. If set to
true, the request's response is eligible to register an attribution trigger. If set tofalse, it isn't.
Return value
None (undefined).
Exceptions
InvalidStateErrorDOMException- : Thrown if the associated XMLHttpRequest has not yet been opened, or has already been sent.
- TypeError
- : Thrown if use of the Attribution Reporting API is blocked by an
attribution-reportingPermissions-Policy.
Examples
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);