Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new fetch option to suppress enrollment warning. #289

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add new fetch option to suppress enrollment warning. #289

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ The topics will be inferred by the browser. The browser will leverage a classifi

* Topics can also be retrieved via request headers, and marked as observed and eligible for topics calculation via response headers.
* This is likely to be considerably more performant than using the JavaScript API.
* The request header can be sent along with fetch requests via specifying an option: `fetch(<url>, {browsingTopics: true})`.
* The request header can be sent along with fetch requests via specifying an option: `fetch(<url>, {browsingTopics: true})`. By default, if the requested [site](https://html.spec.whatwg.org/multipage/browsers.html#obtain-a-site) (scheme, eTLD+1) does not meet the [enrollment requirement](https://github.com/privacysandbox/attestation#the-privacy-sandbox-enrollment-attestation-model) for Topics API, a warning will be reported to the console. This can be suppressed by specifying the `suppressTopicsEnrollmentWarning` option: `fetch(<url>, {browsingTopics: true, suppressTopicsEnrollmentWarning: true})`.
* The request header will be sent on document requests via specifying an attribute: `<iframe src=[url] browsingtopics></iframe>`, or via the equivalent IDL attribute: `iframe.browsingTopics = true`.
* Redirects will be followed, and the topics sent in the redirect request will be specific to the redirect url.
* The request header will not modify state for the caller unless there is a corresponding response header. That is, the topic of the page won't be considered observed, nor will it affect the user's topic calculation for the next epoch.
Expand Down