Technical Review: Documentation for the Attribution Reporting API

[chrisdavidmills]

Note: This technical review is now completed and approved. For the follow-on editorial review, see #33172.

---

Description

The Attribution Reporting API is an integral part of Google's privacy sandbox technologies. Many parts of this set are being made available by default in Chrome 115 (depending on a gradual ramp-up to 100% of userbase over the 115 release period).

This PR provides documentation for the Attribution Reporting API and its related HTTP headers and other features.

See my research document for more details of exactly what changes are expected in the PR.

Motivation

Additional details

Related issues and pull requests

[github-actions]

Preview URLs (25 pages)

• /en-US/docs/Web/API/Attribution_Reporting_API/Generating_reports
• /en-US/docs/Web/API/Attribution_Reporting_API/Registering_sources
• /en-US/docs/Web/API/Attribution_Reporting_API/Registering_triggers
• /en-US/docs/Web/API/Attribution_Reporting_API
• /en-US/docs/Web/API/HTMLAnchorElement/attributionSrc
• /en-US/docs/Web/API/HTMLAnchorElement
• /en-US/docs/Web/API/HTMLImageElement/attributionSrc
• /en-US/docs/Web/API/HTMLImageElement
• /en-US/docs/Web/API/HTMLScriptElement/attributionSrc
• /en-US/docs/Web/API/HTMLScriptElement
• /en-US/docs/Web/API/Request/Request
• /en-US/docs/Web/API/Window/open
• /en-US/docs/Web/API/XMLHttpRequest/setAttributionReporting
• /en-US/docs/Web/API/XMLHttpRequest
• /en-US/docs/Web/API/fetch
• /en-US/docs/Web/HTML/Element/a
• /en-US/docs/Web/HTML/Element/img
• /en-US/docs/Web/HTML/Element/script
• /en-US/docs/Web/HTTP/Headers/Attribution-Reporting-Eligible
• /en-US/docs/Web/HTTP/Headers/Attribution-Reporting-Register-Source
• /en-US/docs/Web/HTTP/Headers/Attribution-Reporting-Register-Trigger
• /en-US/docs/Web/HTTP/Headers/Permissions-Policy/attribution-reporting
• /en-US/docs/Web/HTTP/Headers/Permissions-Policy
• /en-US/docs/Web/Privacy/Privacy_sandbox/Enrollment
• /en-US/docs/Web/Privacy/Privacy_sandbox

Flaws (15)

Note! 22 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/HTMLScriptElement
Title: HTMLScriptElement
Flaw count: 9

• macros:
  • /en-US/docs/Web/API/HTMLScriptElement/type does not exist
  • /en-US/docs/Web/API/HTMLScriptElement/src does not exist
  • /en-US/docs/Web/API/HTMLScriptElement/event does not exist
  • /en-US/docs/Web/API/HTMLScriptElement/charset does not exist
  • /en-US/docs/Web/API/HTMLScriptElement/async does not exist
  • and 4 more flaws omitted

---

URL: /en-US/docs/Web/API/Attribution_Reporting_API/Generating_reports
Title: Generating attribution reports
Flaw count: 1

• broken_links:
  • Can't resolve /en-US/docs/Web/Privacy/Third-party_cookies

---

URL: /en-US/docs/Web/API/HTMLAnchorElement
Title: HTMLAnchorElement
Flaw count: 5

• macros:
  • /en-US/docs/Web/API/HTMLAnchorElement/charset does not exist
  • /en-US/docs/Web/API/HTMLAnchorElement/coords does not exist
  • /en-US/docs/Web/API/HTMLAnchorElement/name does not exist
  • /en-US/docs/Web/API/HTMLAnchorElement/rev does not exist
  • /en-US/docs/Web/API/HTMLAnchorElement/shape does not exist

External URLs (24)

URL: /en-US/docs/Web/API/Attribution_Reporting_API
Title: Attribution Reporting API

• https://arapi-home.web.app/ (1 time) (Note! This may be a new URL 👀)
• https://developer.chrome.com/docs/privacy-sandbox/ (1 time) (Note! This may be a new URL 👀)
• https://developer.chrome.com/docs/privacy-sandbox/attribution-reporting/ (1 time) (Note! This may be a new URL 👀)
• https://developer.chrome.com/docs/privacy-sandbox/attribution-reporting/multiple-reporters/ (1 time) (Note! This may be a new URL 👀)
• https://github.com/GoogleChromeLabs/trust-safety-demo/tree/main/attribution-reporting (1 time) (Note! This may be a new URL 👀)
• https://github.com/privacysandbox/aggregation-service (1 time) (Note! This may be a new URL 👀)
• https://web.dev/same-site-same-origin/ (1 time) (Note! This may be a new URL 👀)
• https://wicg.github.io/attribution-reporting-api/validate-headers (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/Attribution_Reporting_API/Registering_sources
Title: Registering attribution sources

• https://wicg.github.io/attribution-reporting-api/validate-headers (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/Attribution_Reporting_API/Registering_triggers
Title: Registering attribution triggers

• https://developer.chrome.com/docs/privacy-sandbox/attribution-reporting/prevent-duplication/ (1 time) (Note! This may be a new URL 👀)
• https://wicg.github.io/attribution-reporting-api/validate-headers (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/Attribution_Reporting_API/Generating_reports
Title: Generating attribution reports

• https://cbor.io/ (1 time) (Note! This may be a new URL 👀)
• https://datatracker.ietf.org/doc/rfc9180/ (1 time) (Note! This may be a new URL 👀)
• https://developer.chrome.com/docs/privacy-sandbox/aggregation-service/ (1 time) (Note! This may be a new URL 👀)
• https://developer.chrome.com/docs/privacy-sandbox/attribution-reporting-debugging/part-1/ (1 time) (Note! This may be a new URL 👀)
• https://developer.chrome.com/docs/privacy-sandbox/attribution-reporting-debugging/part-2/ (1 time) (Note! This may be a new URL 👀)
• https://developer.chrome.com/docs/privacy-sandbox/attribution-reporting-debugging/part-3/ (1 time) (Note! This may be a new URL 👀)
• https://developer.chrome.com/docs/privacy-sandbox/attribution-reporting/custom-report-windows (2 times) (Note! This may be a new URL 👀)
• https://developer.chrome.com/docs/privacy-sandbox/attribution-reporting/understanding-noise/ (1 time) (Note! This may be a new URL 👀)
• https://developer.chrome.com/docs/privacy-sandbox/attribution-reporting/working-with-noise/ (1 time) (Note! This may be a new URL 👀)
• https://developer.chrome.com/docs/privacy-sandbox/summary-reports/ (1 time) (Note! This may be a new URL 👀)
• https://en.wikipedia.org/wiki/Authenticated_encryption (1 time) (Note! This may be a new URL 👀)
• https://github.com/WICG/attribution-reporting-api/blob/main/EVENT.md (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/HTTP/Headers/Attribution-Reporting-Register-Trigger
Title: Attribution-Reporting-Register-Trigger

• https://developer.chrome.com/docs/privacy-sandbox/attribution-reporting/prevent-duplication/ (1 time) (Note! This may be a new URL 👀)

(comment last updated: 2024-04-18 07:51:18)

[github-actions]

This pull request has merge conflicts that must be resolved before it can be merged.

[chrisdavidmills]

Thanks again @apasel422. When comment threads get this big, I appreciate that it becomes easy to miss comments. I've therefore compiled a list of the exact links to comments where I still need your input:

• Technical Review: Documentation for the Attribution Reporting API #28471 (comment)
• Technical Review: Documentation for the Attribution Reporting API #28471 (comment)
• Technical Review: Documentation for the Attribution Reporting API #28471 (comment)
• Technical Review: Documentation for the Attribution Reporting API #28471 (comment)
• Technical Review: Documentation for the Attribution Reporting API #28471 (comment)
• Technical Review: Documentation for the Attribution Reporting API #28471 (comment)
• Technical Review: Documentation for the Attribution Reporting API #28471 (comment)

[chrisdavidmills]

Thanks again for all the review work, @apasel422. Let me know if there are any more bits you think need updating.

In addition, there are a couple more existing comments I just wanted to check that you had seen and had no further responses to:

• Technical Review: Documentation for the Attribution Reporting API #28471 (comment)
• Technical Review: Documentation for the Attribution Reporting API #28471 (comment)

We've got this outstanding still, as well: #28471 (comment)

[apasel422]

@chrisdavidmills Looks good to me. Given how complex this feature is, I'm sure we'll have future edits and enhancements, but this is an excellent start.

[chrisdavidmills]

@chrisdavidmills Looks good to me. Given how complex this feature is, I'm sure we'll have future edits and enhancements, but this is an excellent start.

@apasel422 Agreed. Thanks again for the superhuman reviewing effort to help get it to this state. I understand this API now much better than when you first started it, and the docs make more sense now.

So, the next stage is to close this PR, and then open a new one based on the same branch to contain the editorial review.