Protected Audience API (formerly known as FLEDGE)

This document describes an implementation for ads serving in the TURTLEDOVE family.

Chrome shipped the Protected Audience API in 2023Q3 in Chrome milestone 115 making it generally available to web developers. Chrome experimented with this API from 2022Q1-2023Q2; at that time it was known as the First "Locally-Executed Decision over Groups" Experiment (FLEDGE). The goal of the experiment was for us to gain implementer experience, and for the ads ecosystem to evaluate its usability, as soon as it is feasible to do so. We need a robust API to take flight before the removal of third-party cookies shown on Chrome's Privacy Sandbox timeline.

We hold regular meetings under the auspices of the WICG to go through the details of this proposal and quickly make any needed changes. Consult Issue #88 if you want to attend these meetings to be involved in hammering out details.

See the Protected Audience API specification.

Summary
Background
Design Elements

Summary

The Protected Audience API includes support for:

Interest Groups, stored by the browser, and associated with arbitrary metadata that can affect how these groups bid and render ads.
A mechanism for updating these interest groups. The updates are rate limited, fetched from buyers’ servers, performed off the ad serving critical-path, and contain no contextual information.
On-device bidding by buyers (DSPs or advertisers), based on interest-group metadata and on data loaded from a trusted server at the time of the on-device auction — with a temporary and untrusted "Bring Your Own Server" model, until a trusted-server framework is settled and in place.
On-device ad selection by the seller (an SSP or publisher), based on bids and metadata entered into the auction by the buyers.
Protection against showing an ad or ad component to less than some minimum number of people.
Ad rendering in a temporarily relaxed version of Fenced Frames that prevents interaction with the surrounding page — but that does allow normal network access for rendering the ad, and for logging and reporting some event-level outcomes, as a temporary model until both a trusted-server reporting framework and ad delivery via Web Bundles are settled and in place.

Most of these ideas are drawn from the previous ongoing discussion of variants on the original TURTLEDOVE idea. Interest group metadata, and applying k-anonymity thresholds only to the rendering and reporting of ads, come from Outcome-based TURTLEDOVE and Product-level TURTLEDOVE, as well as discussion here. The separation and clarification of the DSP and SSP roles are along the lines described in TERN and PARRROT. The trusted servers to support bidding, rendering, and reporting come from the SPARROW Gatekeeper and Dovekey Key-Value server.

As we approach third-party cookie deprecation in Chrome, you may be wondering about the availability of specific Protected Audience API services and features. You can find a list of the scoped Protected Audience API features and when they'll be supported here. The temporary italicized carve-outs in the above bulleted list all need privacy-safe replacements before our work is done.

But while third-party cookies are still available, the Protected Audience API offers a preview of a post-3p-cookies technique so that we can all test out this ad selection approach together.

Background

In January 2020, Chrome published an explainer for TURTLEDOVE, proposing a new way that advertisers and ad tech companies could target an ad to an audience they had built, without the browser revealing anyone's browsing habits or ad interests.

Over the course of extensive engagement and discussion with many participants in the ad tech ecosystem, we've learned many ways in which the original proposal could better meet their needs. Discussion took place over the past few years, primarily in (1) GitHub issues on the TURTLEDOVE repo, (2) the many counter-proposals that built on the original explainer (most things in this list with bird names), and (3) the weekly meetings of the W3C's Improving Web Advertising Business Group.

Of the improvements proposed, some can be accommodated through straightforward changes to APIs, some will require deeper gathering of requirements and careful design work, and some will require new server-side infrastructure with novel trust relations with multiple parties. This update focuses primarily on the first of these types.

Design Elements

Ads can be targeted at interest groups. As in the original TURTLEDOVE proposal, the browser is responsible for knowing which interest groups it has joined.

Every interest group has an owner who will act as a buyer in an on-device ad auction. The owner is ultimately responsible for the group's membership and usage, but can delegate those tasks to third parties if they so desire. Many sorts of entities might want to be owners of interest groups. Some examples include:

An advertiser (or a third party working on the advertiser's behalf) might create and own an interest group of people whom they believe are interested in that advertiser's product. Classical remarketing/retargeting use cases fall under this example.
A publisher (or a third party working on the publisher's behalf) might create and own an interest group of people who have read a certain type of content on their site. Publishers can already use first-party data to let advertisers target their readers on the publisher site. A publisher-owned interest group could let publishers do the same even when those people are browsing other sites. Publishers would presumably charge for the ability to target this list.
A third-party ad tech company might create and own an interest group of people whom they believe are in the market for some category of item. They could use that group to serve ads for advertisers who work with that ad tech company and sell things in that category.

All the logic of the on-device auctions will execute inside a collection of dedicated worklets. Each worklet is associated with a single domain, and runs code written by either a buyer or a seller. The code in the worklets cannot access or communicate with the publisher page or the network. The browser is responsible for creating those worklets, loading the relevant buyer or seller logic from the provided URLs, fetching real-time data from a trusted server, calling the appropriate functions with specified input, and passing on the output. We will publish a separate explainer on dedicated worklets.

The on-device bidding flow includes a way that the worklets can use some data loaded from a trusted server. The browser is willing to ask this server questions which might reveal sensitive information, like the set of all interest groups it has joined. This requires a server that performs no event-level logging and has no other side effects based on these requests. One can imagine a wide range of ways that a server might earn the trust of a browser, including both policy approaches (trusted third party, audited code, etc) and technical guarantees (secure multi-party computation, secure enclaves, etc). We began robust discussions in early 2021 on what sorts of server-trust models seem feasible to browsers and buyers, with the expectation that initially productionization speed is essential, but trust requirements may increase over time.

In addition to these technical privacy guardrails, Privacy Sandbox includes a developer enrollment process which will verify companies before they can use the Protected Audience API, as an additional layer of protection for user privacy. Part of this process includes an attestation model, which requires developers to agree to restrictions around the usage of the API to prevent re-identification of users across sites. Please see the Privacy Sandbox enrollment attestation model.

1. Browsers Record Interest Groups

1.1 Joining Interest Groups

Browsers keep track of the set of interest groups that they have joined. For each interest group, the browser stores information about who owns the group, what ads the group might choose to show, various JavaScript functions and metadata used in bidding and rendering, and what servers to contact to update or supplement that information.

const myGroup = {
  'owner': 'https://www.example-dsp.com',
  'name': 'womens-running-shoes',
  'lifetimeMs': 30 * kMillisecsPerDay,
  'priority': 0.0,
  'priorityVector': {
    'signal1': 2,
    'signal2': -3.5,
    ...
  }
  'prioritySignalsOverrides': {
    'signal1': 4.5,
    'signal2': 0,
    ...
  }
  'enableBiddingSignalsPrioritization' : true,
  'biddingLogicURL': ...,
  'biddingWasmHelperURL': ...,
  'updateURL': ...,
  'executionMode': ...,
  'trustedBiddingSignalsURL': ...,
  'trustedBiddingSignalsKeys': ['key1', 'key2'],
  'trustedBiddingSignalsSlotSizeMode': 'slot-size',
  'maxTrustedBiddingSignalsURLLength': 10000,
  'trustedBiddingSignalsCoordinator': 'https://www.publickeyservice.com',
  'userBiddingSignals': {...},
  'ads': [{renderUrl: shoesAd1, sizeGroup: 'group1', ...},
          {renderUrl: shoesAd2, sizeGroup: 'group2',
           selectableBuyerAndSellerReportingIds: ['deal1', 'deal2', 'deal3'],
           buyerReportingId: 'buyerSpecificInfo1',
           buyerAndSellerReportingId: 'seatId', ...}],
  'adComponents': [{renderUrl: runningShoes1, sizeGroup: 'group2', ...},
                   {renderUrl: runningShoes2, sizeGroup: 'group2', ...},
                   {renderUrl: gymShoes, sizeGroup; 'group2', ...}],
  'adSizes': {'size1': {width: '100', height: '100'},
              'size2': {width: '100', height: '200'},
              'size3': {width: '75', height: '25'},
              'size4': {width: '100', height: '25'}},
  'sizeGroups:' {'group1': ['size1', 'size2', 'size3'],
                 'group2': ['size3', 'size4']},
  'auctionServerRequestFlags': ['omit-ads', 'omit-user-bidding-signals'],
};
const joinPromise = navigator.joinAdInterestGroup(myGroup);

The browser will only allow the joinAdInterestGroup() operation with the permission of both the site being visited and the group's owner. The site can allow or deny permission to any or all third parties via a Permissions-Policy (directive named "join-ad-interest-group"), where the default policy is to allow all in the top-level page and to deny all in cross-domain iframes. The group's owner can indicate permission by joinAdInterestGroup() running in a page or iframe in the owner's domain, and can delegate that permission to any other domains via a list at a .well-known URL (see 1.3 Permission Delegation). These can be combined, to allow a DSP to add a person to one of its interest groups based on publisher context, as discussed in TERN — provided the publisher's Permissions-Policy permits interest group additions by its SSP, and the DSP gives this SSP this ability.

The returned joinPromise is resolved if the group is successfully joined, and rejected with an error if the join operation fails. The error message and the resolution time must not depend on what interest groups a user is in, or any cross-origin browser state, apart from the results of the .well-known fetch, to avoid leaking any data across sites.

There is a complementary API navigator.leaveAdInterestGroup(myGroup) which looks only at myGroup.name and myGroup.owner. As with join calls, leaveAdInterestGroup() also returns a promise. As a special case to support in-ad UIs, invoking navigator.leaveAdInterestGroup() from inside an ad that is being targeted at a particular interest group will cause the browser to leave that group, irrespective of permission policies. Note that calling navigator.leaveAdInterestGroup() without arguments inside a component ad frame isn't supported until Chrome M120. Starting from Chrome M120, calling navigator.leaveAdInterestGroup() without arguments inside a component ad frame is supported. The ad component frame is required to be same-origin with the interest group owner for the leave to succeed, same as calling leaveAdInterestGroup() without arguments in a non-ad-component frame.

There is a related API navigator.clearOriginJoinedAdInterestGroups(owner, [<groupNamesToKeep>]) that leaves all interest groups owned by owner that were joined on the current top-level frame's origin, and also returns a Promise. The [<groupNamesToKeep>] argument is an optional list of interest group names that will not be left, and if not present, it will act as if an empty array was passed. This method has no effect on joined interest groups owned by owner that were most recently joined on different top-level origins.

The interest group owner passed to joinAdInterestGroup(), leaveAdInterestGroup(), and clearOriginJoinedAdInterestGroups() is required to have its site (scheme, eTLD+1) attested for Protected Audience API. Please see the Privacy Sandbox enrollment attestation model.

The browser will remain in an interest group for only a limited amount of time. The duration, in milliseconds, is specified in the lifetimeMs attribute of the interest group, and will be capped at 30 days. This can be extended by calling joinAdInterestGroup() again later, with the same group name and owner. Successive calls to joinAdInterestGroup() will overwrite the previously-stored values for any interest group properties, like the group's userBiddingSignal or list of ads. A duration <= 0 will leave the interest group.

1.2 Interest Group Attributes

The priority is used to select which interest groups participate in an auction when the number of interest groups are limited by the perBuyerGroupLimits attribute of the auction config. If not specified, a priority of 0.0 is assigned. There is no special meaning to these values. These values are only used to select interest groups to participate in an auction such that if there is an interest group participating in the auction with priority x, all interest groups with the same owner having a priority y where y > x should also participate (i.e. generateBid will be called). In the case where some but not all interest groups with equal priority can participate in an auction due to perBuyerGroupLimits, the participating interest groups will be uniformly randomly chosen from the set of interest groups with that priority.

priorityVector, prioritySignalsOverrides, and enableBiddingSignalsPrioritization are optional values used to dynamically calculate a priority used in place of priority. priorityVector and prioritySignalsOverrides are mappings of strings to JavaScript numbers, while enableBiddingSignalsPrioritization is a bool that defaults to false. See Filtering and Prioritizing Interest Groups for a description of how these fields are used.

The userBiddingSignals is for storage of additional metadata that the owner can use during on-device bidding, and the trustedBiddingSignals attributes provide another mechanism for making real-time data available for use at bidding time.

The biddingWasmHelperURL field is optional, and lets the bidder provide computationally-expensive subroutines in WebAssembly, rather than JavaScript, to be driven from the JavaScript function provided by biddingLogicURL. If provided, it must point to a WebAssembly binary, delivered with an application/wasm mimetype. The corresponding WebAssembly.Module will be made available by the browser to the generateBid function.

The updateURL provides a mechanism for the group's owner to update the attributes of the interest group: any new values returned in this way overwrite the values previously stored (except that the name and owner cannot be changed, and prioritySignalsOverrides will be merged with the previous value, with null meaning a value should be removed from the interest group's old dictionary). The HTTP request will not include any metadata, so data such as the interest group name should be included within the URL. Note that the lifetime of an Interest Group is not affected by the update mechanism — ad targeting based on a person's activity on a site remains limited to 30 days after the most recent site visit.

The updates are done after auctions so as not to slow down the auctions themselves. The updates are rate limited to running at most daily to conserve resources, and timeout after 30 seconds; however, the updateIfOlderThanMs field of the trusted bidding signals response can be used to trigger a single more timely update that will run even if the last update was less than a day ago. An update request only contains information from the single site where the user was added to the interest group. At a later date we can consider potential side channel mitigations (e.g. IP address privacy or a trusted update server as mentioned in #333 to mitigate timing attacks) when the related technologies are more developed, deployed and adopted. K-anonymity requirements on updateURL were originally considered to improve the privacy of interest group updates, but they were not a particularly strong privacy protection, mostly because the cost to add a user to an interest group (and increase the chance of passing the k-anonymity requirement on updating) is not high. K-anonymity requirements on updateURL were also found to cause a proliferation of interest groups which degraded auction performance significantly, and degrade the usefulness of interest group updates, as further discussed in #333 and #361. Updating interest groups after the auction does not suffer from these problems, and because each interest group update only contains information from a single site, the cross-site identity join risks occur from side channels like IP address and timing correlation. The k-anonymity protection for the auction winning ad creative URL is still important as the URL potentially contains information from two sites, the joining and auction sites. A navigator.updateAdInterestGroups() API is available to trigger updating interest groups owned by the calling origin. Similar to after-auction-updates, at a later date we may apply additional privacy enhancements, like IP address privacy or delays, to updates triggered by updateAdInterestGroups(). The calling origin is required to have its site (scheme, eTLD+1) attested for Protected Audience API. Please see the Privacy Sandbox enrollment attestation model.

The executionMode attribute is optional, and may contain one of the following supported values:

The default value ("compatibility") will run each invocation of generateBid in a totally fresh execution environment, which prevents one invocation from directly passing data to a subsequent invocation, but has non-trivial execution costs as each execution environment must be initialized from scratch.
The "group-by-origin" mode will attempt to re-use the execution environment for interest groups with the same script that were joined on the same top-level origin, which saves a lot of these initialization costs. However, to avoid cross-site information leaking into generateBid, attempts to join or leave an interest group in "group-by-origin" mode from more than one top-level origin will result in all "group-by-origin" interest groups that were joined from the same top-level origin being removed. When the execution environment is re-used the script top-level will not be re-executed, with only the generateBid function being run the subsequent times. This mode is intended for interest groups that are extremely likely to be joined or left from a single top-level origin only, with the probability high enough that the penalty of removal if the requirement doesn't hold to be low enough for the performance gains to be a worthwhile trade-off. Note that the name "groupByOrigin" is deprecated -- "group-by-origin" should be used instead.
The "frozen-context" mode will attempt to freeze the JavaScript context after the top-level script has been run, but before calling generateBid(). Essentially the browser calls Object.freeze() on every JavaScript object that is still reachable and checks for data types or variable bindings that could carry state between runs. If these checks fail then the bid execution will also fail. This execution mode has similar performance to the `"group-by-origin" execution mode with the addition of the additional overhead from freezing the context (roughly equal to the cost of context creation). This execution mode does not have the same limitations on what top-level sites can join or leave the interest group.

trustedBiddingSignalsSlotSizeMode, maxTrustedBiddingSignalsURLLength, and trustedBiddingSignalsCoordinator are three optional fields related to fetching trusted bidding signals.

trustedBiddingSignalsSlotSizeMode has three modes: none (default), slot-size, and all-slots-requested-sizes. These modes are used to attach the size information of ad slots. See 3.1 Fetching Real-Time Data from a Trusted Server for more information.
maxTrustedBiddingSignalsURLLength is used to set the maximum URL length when constructing the URL for the trusted signals server in the BYOS (Bring Your Own Server) model. If set to 0 or not specified, the URL length is considered unlimited. See 3.1 Fetching Real-Time Data from a Trusted Server for more information.
trustedBiddingSignalsCoordinator is used to specify where to obtain the public key used for encryption and decryption in communication with a trusted bidding signal server running in a Trust Execution Environment (TEE). When this field is specified, the request will be sent to a trusted bidding signals server running in a TEE, and the value of maxTrustedBiddingSignalsURLLength is ignored.

The ads list contains the various ads that the interest group might show. Each entry is an object that must contain a renderURL property with the URL for the ad that would be shown. An ad may also have the following optional properties:

adRenderId: A short DOMString up to 12 characters long serving as an identifier for this ad in this interest group. When this field is specified it will be sent instead of the full ad object for B&A server auctions.
selectableBuyerAndSellerReportingIds: An array of USVStrings, one of which may be selected by generateBid() to be reported to reportWin() and reportResult() along with buyerAndSellerReportingId and buyerReportingId. When generateBid() selects a value from selectablebuyerAndSellerReportingIds, the resulting bid may only win the auction if the selected value is jointly k-anonymous along with buyerAndSellerReportingId, buyerReportingId, the interest group owner, bidding script URL, and render URL. See Reporting IDs for more details.
buyerAndSellerReportingId: A USVString, no character limit. If set and selectableBuyerAndSellerReportingIds is unset or not selected, the value is used instead of the interest group name or buyerReportingId for reporting in reportWin() and reportResult(). Note that this field needs to be jointly k-anonymous with the interest group owner, bidding script URL, and render URL to be provided to these reporting functions (in the same way that the interest group name would have needed to be). If set and a value from selectableBuyerAndSellerReportingIds is selected by generateBid(), the value of this is reported to reportWin() and reportResult() along with the selected selectablebuyerAndSellerReportingIds and buyerReportingId. When generateBid() selects a value from selectablebuyerAndSellerReportingIds, the resulting bid may only win the auction if the selected value is jointly k-anonymous along with buyerAndSellerReportingId, buyerReportingId, the interest group owner, bidding script URL, and render URL. See Reporting IDs for more details.
buyerReportingId: A USVString, no character limit. If set, buyerAndSellerReportingId is unset, and selectableBuyerAndSellerReportingIds is unset or not selected, the value is used instead of the interest group name for reporting in reportWin. Note that this field needs to be jointly k-anonymous with the interest group owner, bidding script URL, and render URL to be provided to these reporting functions (in the same way that the interest group name would have needed to be). If set and a value from selectableBuyerAndSellerReportingIds is selected by generateBid(), the value of this is reported to reportWin() along with the selected selectablebuyerAndSellerReportingIds and buyerAndSellerReportingId. When generateBid() selects a value from selectablebuyerAndSellerReportingIds, the resulting bid may only win the auction if the selected value is jointly k-anonymous along with buyerAndSellerReportingId, buyerReportingId, the interest group owner, bidding script URL, and render URL. See Reporting IDs for more details.
metadata: Arbitrary metadata that can be used at bidding time.
allowedReportingOrigins: A list of up to 10 destination origins allowed to receive registered macro values in reporting. All origins must be HTTPS and attested for Protected Audience API. Entries are USVString, no character limit. Invalid URL, non HTTPS, or list size greater than 10, will result in failure to join the interest group.

The adComponents field contains the various ad components (or "products") that can be used to construct "Ads Composed of Multiple Pieces"). Similar to the ads field, each entry is an object that includes a renderURL and optional adRenderId, and metadata fields. Thanks to ads and adComponents being separate fields, the buyer is able to update the ads field via the updateURL without losing adComponents stored in the interest group.

The adSizes field (optionally) contains a dictionary of named ad sizes. Each size has the format {width: widthVal, height: heightVal}, where the values can have either pixel units (e.g. 100 or '100px') or screen dimension coordinates (e.g. 100sw or 100sh). For example, the size {width: '100sw', height: 50} describes an ad that is the width of the screen and 50 pixels tall. The size {width: '100sw', height: '200sw'} describes an ad that is the width of the screen and has a 1:2 aspect ratio. Sizes with screen dimension coordinates are primarily intended for screen-width ads on mobile devices, and may be restricted in certain contexts (to be determined) for privacy reasons.

The sizeGroups field (optionally) contains a dictionary of named lists of ad sizes. Each ad declared above must specify a size group, saying which sizes it might be loaded at. Each named ad size could in the future also be considered a size group, so you don't need to manually define singleton size groups.

At some point in the future - no earlier than Q1 2025 - when the sizes are declared, the URL-size pairings will be used to prefetch k-anonymity checks to limit the configurations that can win an auction, please see this doc. In the present implementation, only the URL is used for k-anonymity checks, not the size. When an ad with a particular size wins the auction (including in the current implementation), the size will be substituted into any macros in the URL (through {%AD_WIDTH%} and {%AD_HEIGHT%}, or ${AD_WIDTH} and ${AD_HEIGHT}), and once loaded into a fenced frame, the size will be used by the browser to freeze the fenced frame's inner dimensions. We therefore recommend using ad size declarations, but they are not required at this time.

The auctionServerRequestFlags field is optional and is only used for auctions run on an auction server. This field contains a list of enumerated values that change what data is sent in the auction blob:

The omit-ads enumeration causes the request to omit the ads and adComponents fields for this interest group from the auction blob.
The omit-user-bidding-signals enumeration causes the request to omit the userBiddingSignals field for this interest group from the auction blob.
The include-full-ads enumeration causes the request to include the full ad object in place of anywhere in the request where a plain adRenderId would have been sent (such as in the ads and adComponents fields as well as prevWins). Note that include-full-ads is not compatible with the auction server, so this mode is only for debugging.

All fields that accept arbitrary metadata (userBiddingSignals and metadata field of ads) must be JSON-serializable values (i.e. supported by JSON.stringify()). See here.

All fields that specify URLs for loading scripts or JSON (biddingLogicURL, biddingWasmHelperURL, trustedBiddingSignalsURL, and updateURL) must: be valid HTTPS URLs, contain no credentials, have no fragment, and be same-origin with owner. Additionally, to be used in an auction, the HTTP response headers of these URLs, when requested, must include the header Ad-Auction-Allowed: true to ensure they are allowed to be used for loading Protected Audience resources. The trustedBiddingSignalsURL must also not have a query. (See 6.13 here).

The renderURL property of an ad must be also be a valid and credentialless HTTPS URL, but does not have the same origin, response header, fragment, or query requirements.

(You can find detailed error conditions for all fields in step 6 of the joinAdInterestGroup() section of the spec).

The browser will only render an ad if the same rendering URL is being shown to a sufficiently large number of people (e.g. at least 50 people would have seen the ad, if it were allowed to show). While in the Outcome-Based TURTLEDOVE proposal this threshold applied only to the rendered creative, Protected Audience has the additional requirement that the tuple of the interest group owner, bidding script URL, and rendered creative (URL, and no earlier than Q1 2025 the size if specified by generateBid) must be k-anonymous for an ad to be shown (this is necessary to ensure the current event-level reporting for interest group win reporting is sufficiently private). For interest groups that have component ads, all of the component ads must also separately meet this threshold for the ad to be shown. Since a single interest group can carry multiple possible ads that it might show, the group will have an opportunity to re-bid another one of its ads to act as a "fallback ad" any time its most-preferred choice is below threshold. This means that a small, specialized ad that is still below the k-anonymity threshold could still choose to participate in auctions, and its interest group has a way to fall back to a more generic ad until the more specialized one has a large enough audience.

Similar to the key-value server, the server keeping track of which ad URLs are k-anonymous is publicly queryable. The ad URLs are not supposed to target small groups of users (less than k users). For these reasons, and also in the interest of passing the k-anonymity check, the ad URLs should not contain PII, or sensitive information.

Interest groups are subject to limits needed to bound resource utilization on the user's device. The browser limits the byte size of interest groups in order to safeguard browser storage used to hold the interest groups. Each interest group is individually limited to 1MB, and calls to navigator.joinAdInterestGroup will return an error when called with an interest group that exceeds this limit. To safeguard browser compute resources, the most effective strategy is for sellers to set perBuyerCumulativeTimeouts on the auction config. As an added measure, the browser also limits the number of interest groups to which a user may be joined.

Each owner is limited to:

a 10MB limit combined across all interest groups,
a maximum of 2,000 stored regular interest groups, and
a maximum of 20,000 stored negative targeting interest groups.

If any of these per-owner limits are exceeded, the interest group(s) that would expire soonest are removed until that owner is back within its limits.

1.3 Permission Delegation

When a frame navigated to one domain calls joinAdInterestGroup(), leaveAdInterestGroup(), or clearOriginJoinedAdInterestGroups() for an interest group with a different owner, the browser will fetch the URL https://owner.domain/.well-known/interest-group/permissions/?origin=frame.origin, where owner.domain is domain that owns the interest group and frame.origin is the origin of the frame. The fetch uses the omit credentials mode, using the Network Partition Key of the frame that invoked the method. To avoid leaking cross-origin data through the returned Promise unexpectedly, the fetch uses the cors mode. The fetched response should have a JSON MIME type, have a Access-Control-Allow-Origin that allows it to load from the calling origin, and be of the format:

{ "joinAdInterestGroup": true/false,
  "leaveAdInterestGroup": true/false
}

Indicating whether the origin in the path has permissions to join and/or leave interest groups owned by the domain the request is sent to. Missing permissions are assumed to be false. Since calling navigator.joinAdInterestGroup() with a lifetimeMs of 0 effectively leaves an interest group, joinAdInterestGroup: true also allows an origin to call navigator.leaveAdInterestGroup(), even if leaveadInterestGroup is missing or is set to false. Note that both leaveAdInterestGroup() and clearOriginJoinedAdInterestGroups() check the "leaveAdInterestGroup" permission.

Since joining or leaving a group may depend on a network request, browsers may delay these requests, or run them out of order. Each frame must, however, run all pending joins and leaves for a single owner in the order in which they were made. Same-origin operations should be applied immediately. When a page or frame is navigated, the browser should make a best-effort attempt to complete pending join and leave operations that are blocked on a network fetch, but may choose to drop them if there are more than 20 for a single top-level frame. This is intended to allow joining or leaving a cross-origin interest group at the same time as starting a navigation in response to a user gesture, though previous join/leave calls may still cause such an operation to be dropped.

In order to prevent leaking data, join and leave calls must request the .well-known file, regardless of whether the user is in the group or not, as otherwise, whether or not a fetch is made can potentially leak data. Browsers may cache .well-known fetch results that share a network partition key.

1.4 Buyer Security Considerations

As buyers construct interest groups there are some things they should consider to protect themselves:

Buyers should join interest groups in an origin that is not also used for ad rendering. In other words, the ads renderURLs should not be same-origin with the interest group’s owner. This can help prevent ad creatives from performing same-origin operations from the interest group owner’s origin.
Buyers should only place bids in auctions with sellers that they trust and have existing business relationships with, otherwise placing a bid may share information the buyer learned about the user with an unknown seller.

2. Sellers Run On-Device Auctions

Interest groups are used to bid in on-device auctions on sites selling ad space. We refer to the party running the auction as the seller. Many parties might act as sellers: a site might run its own ad auction, or might include a third-party script to run the auction for it, or might use an SSP that combines running an on-device auction with other server-side ad auction activities.

Sellers have three basic jobs in the on-device ad auction:

Sellers decide (a) which buyers may participate, and (b) which of the bids from those buyers' interest groups are eligible to enter the auction. This lets the seller enforce the site's rules for what ads are allowed to appear on the page.
Sellers are responsible for the business logic of the auction: JavaScript code which considers each bid's price and metadata, and calculates a "desirability" score. The bid with the highest desirability score wins the auction.
Sellers perform reporting on the auction outcome, including information about clearing price and any other pay-outs. (The winning and losing buyers also get to do their own reporting; see below for buyer jobs.)

2.1 Initiating an On-Device Auction

A seller initiates an auction by invoking a JavaScript API inside the publisher's page:

const myAuctionConfig = {
  'seller': 'https://www.example-ssp.com',
  'decisionLogicURL': ...,
  'trustedScoringSignalsURL': ...,
  'maxTrustedScoringSignalsURLLength': 10000,
  'trustedScoringSignalsCoordinator': 'https://www.publickeyservice.com',
  'interestGroupBuyers': ['https://www.example-dsp.com', 'https://buyer2.com', ...],
  'auctionSignals': {...},
  'requestedSize': {'width': '100sw', 'height': '200px'},
  'allSlotsRequestedSizes': [{'width': '100sw', 'height': '200px'}, {'width': '200px', 'height': '300px'}, ...],
  'directFromSellerSignalsHeaderAdSlot': 'adSlot/1',
  'sellerSignals': {...},
  'sellerTimeout': 100,
  'sellerExperimentGroupId': 12345,
  'perBuyerSignals': {'https://www.example-dsp.com': ...,
                      'https://www.another-buyer.com': ...,
                      ...},
  'perBuyerTimeouts': {'https://www.example-dsp.com': 50,
                       'https://www.another-buyer.com': 200,
                       '*': 150,
                       ...},
  'perBuyerCumulativeTimeouts': {'https://www.example-dsp.com': 500,
                                        'https://www.another-buyer.com': 600,
                                        '*': 450,
                                        ...},
  'perBuyerGroupLimits': {'https://www.example-dsp.com': 2,
                          'https://www.another-buyer.com': 1000,
                          '*': 15,
                          ...},
  'perBuyerPrioritySignals': {'https://www.example-dsp.com': {'signal1': 2.5,
                                                              'signal2': 2.5,
                                                              ...},
                              'https://www.another-buyer.com': {...},
                              '*': {...},
                              ...},
  'perBuyerExperimentGroupIds': {'https://www.example-dsp.com': 234,
                                 'https://www.another-buyer.com': 345,
                                 '*': 456,
                                 ...},
  'perBuyerCurrencies': {'https://example.co.uk': 'GBP',
                         'https://example.fr': 'EUR',
                         '*': 'USD'},
  'perBuyerMultiBidLimits': {'https://example.com': 10, '*': 5},
  'sellerCurrency:' : 'CAD',
  'reportingTimeout' : 200,
  'deprecatedRenderURLReplacements':{'${SELLER}':'exampleSSP',
                                    '%%SELLER_ALT%%':'exampleSSP'},
  'componentAuctions': [
    {'seller': 'https://www.some-other-ssp.com',
      'decisionLogicURL': ...,
      ...},
    ...
  ],
  'signal': /* optionally, an AbortSignal */...,
  'resolveToConfig': /* optionally, a boolean */...,
};
const result = await navigator.runAdAuction(myAuctionConfig);

// If `result` is a `FencedFrameConfig` object, it must be used with a fenced frame
// element via its `config` attribute. Otherwise, it's a `urn:uuid` for an iframe.
if (window.FencedFrameConfig && result instanceof FencedFrameConfig)
  fencedFrame.config = result;
else
  iframe.src = result;

This will cause the browser to execute the appropriate bidding and auction logic inside a collection of dedicated worklets associated with the buyer and seller domains. The auctionSignals, sellerSignals, and perBuyerSignals values will be passed as arguments to the appropriate functions that run inside those worklets — the auctionSignals are made available to everyone, while the other signals are given only to one party.

maxTrustedScoringSignalsURLLength and trustedScoringSignalsCoordinator have the same functionality as maxTrustedBiddingSignalsURLLength and trustedBiddingSignalsCoordinator, as described in 1.2 Interest Group Attributes, but affect the seller's trusted scoring signals fetch as opposed to the trusted bidding signals fetch.

The optional requestedSize field recommends a frame size for the auction, which will be available to bidders in browser signals. This size should be specified in the same format as the sizes in the adSizes field of joinAdInterestGroup. For convenience, the returned fenced frame config will automatically populate a <fencedframe>'s width and height attributes with the requestedSize when loaded, though the element's size attributes can still be modified if you want to change the element's container size. Bidders inside the auction may pick a different content size for the ad, and that resulting size will be visually scaled to fit inside the element's container size.

allSlotsRequestedSizes may optionally be used to specify the size of all ad slots on the page, to be passed to each interest group's trustedBuyerSignalsURL, for interest groups that request it. All sizes in the list must be distinct.

The optional directFromSellerSignalsHeaderAdSlot field can also be used to coordinate passing signals into the auction, similar to sellerSignals, perBuyerSignals, and auctionSignals. The difference is that signals from directFromSellerSignalsHeaderAdSlot are trusted to come from the seller because the content loads from response headers from an https fetch request made to the seller's origin, ensuring the authenticity and integrity of the signals. For more details, see 2.5 directFromSellerSignals and 2.5.1 directFromSellerSignalsHeaderAdSlot.

In some cases, multiple SSPs may want to participate in an auction, with the winners of separate auctions being passed up to another auction, run by another SSP. To facilitate these "component auctions", componentAuctions can optionally contain additional auction configurations for each seller's "component auction". The winning bid of each of these "component auctions" will be passed to the "top-level" auction. How bids are scored in this case is further described in 2.4 Scoring Bids in Component Auctions. The AuctionConfig of component auctions may not have their own componentAuctions. When componentAuctions is non-empty, interestGroupBuyers must be empty. That is, for any particular Protected Audience auction, either there is a single seller and no component auctions, or else all bids come from component auctions and the top-level auction can only choose among the component auctions' winners.

The promise returned from runAdAuction() is opaque. Specifically, it resolves to a FencedFrameConfig object or a urn:uuid string, depending on the resolveToConfig boolean is passed into runAdAuction(). It is not possible for any code on the publisher page to inspect the winning ad or otherwise learn about its contents from this config or urn:uuid, but a FencedFrameConfig can be passed to a fenced frame element via its config attribute for rendering. The Fenced Frame Opaque-ads explainer describes this in more detail. Similarly, a urn:uuid can be passed to an iframe element via its src attribute for rendering. If the auction produces no winning ad, the return value can also be null, although this non-opaque return value leaks one bit of information to the surrounding page. In this case, for example, the seller might choose to render a contextually-targeted ad.

Optionally, sellerTimeout can be specified to restrict the runtime (in milliseconds) of the seller's scoreAd() script, and perBuyerTimeouts can be specified to restrict the runtime (in milliseconds) of particular buyer's generateBid() scripts. If no value is specified for the seller or a particular buyer, a default timeout of 50 ms will be selected. Any timeout higher than 500 ms will be clamped to 500 ms. A key of '*' in perBuyerTimeouts is used to change the default of unspecified buyers.

Optionally, perBuyerCumulativeTimeouts is structured like perBuyerTimeouts, but the values cover the entirety of the time it takes to generate bids for all interest groups for each buyer, including downloading resources, starting processes, and all generate bid calls. The single limit applies collectively across all interest groups with the same owner. It's measured as wall clock time starting when dedicated tasks needed to generate a bid for a particular buyer start. Timers may be running for multiple bidders simultaneously. It does not include time taken by the seller to score the buyer's bids. Once the timer expires, the affected buyer's interest groups may no longer generate any bids. Scripts may be unloaded, fetches cancelled, etc. All bids generated before the timeout will continue to participate in the auction. Protected Audience implementations should attempt, on a best-effort basis, to generate bids for each buyer in priority order, so lower priority interest groups are the ones more likely to be timed out. If promises are passed in to the auction config for fields that support them, the timer for a buyer only starts once all promises blocking that buyer's bidding scripts from running have been resolved.

Optionally, reportingTimeout can be specified to restrict the runtime (in milliseconds) of the seller's reportResult() and winning buyer’s reportWin() scripts. If no value is specified, a default timeout of 50 ms will be selected. Any timeout higher than 5000 ms will be clamped to 5000 ms.

For all timeouts above, each auction config’s timeouts only control its own auction’s scripts, in other words, top level auction’s timeouts will not affect component auctions.

Optionally, the signal field can be set to an AbortSignal object (generally from an AbortController's signal field) to permit aborting the execution of the auction. When the abort() method on the associated AbortController is called, an attempt to interrupt the auction will be made. Since the auction executes in parallel to the page, it's possible for this call to happen after the auction actually completed (perhaps unsuccessfully) but before this has been noticed by the caller of runAdAuction. In that case, the cancellation attempt is ignored. If the cancellation is successful, the promise is rejected, and no side effects of the whole auction (like reporting and bid statistics) occur, though priority adjustments still take place. Calling abort() after the promise from runAdAuction has resolved has no effect.

Optionally, perBuyerGroupLimits can be specified to limit the number of interest groups from a particular buyer that participate in the auction. A key of '*' in perBuyerGroupLimits is used to set a limit for unspecified buyers. For each buyer, interest groups will be selected to participate in the auction in order of decreasing priority (larger priorities are selected first) up to the specfied limit. The selection of interest groups occurs independently for each buyer, so the priorities do not need to be comparable between buyers and could have a buyer-specific meaning. The value of the limits provided should be representable by a 16 bit unsigned integer.

Optionally, sellerExperimentGroupId can be specified by the seller to support coordinated experiments with the seller's trusted server. If specified, this must be an integer between zero and 65535 (16 bits). Optionally,perBuyerExperimentGroupIds can be specified to support coordinated experiments with buyers' trusted servers. If specified, this must also be an integer between zero and 65535 (16 bits).

Optionally, perBuyerPrioritySignals is an object mapping string keys to Javascript numbers that can be used to dynamically compute interest group priorities before perBuyerGroupLimits are applied. See Filtering and Prioritizing Interest Groups for more information.

Optionally, perBuyerCurrencies and sellerCurrency are used for currency-checking. sellerCurrency also affects how currencies behave in reporting.

Optionally, deprecatedRenderURLReplacements can be specified to allow replacing macros within the URN or src of the FencedFrameConfig returned by runAdAuction. These replacements must be in the format of ${...} or %%...%%. The mapping specified here works similar to the second parameter of navigator.deprecatedReplaceInURN(), but within the auction config. This allows for replacements within top level seller auction configs where there are no component seller auction configs, or within component auction configs.

Optionally, resolveToConfig is a boolean directing the promise returned from runAdAuction() to resolve to a FencedFrameConfig if true, for use in a <fencedframe>, or if false to an opaque urn:uuid URL, for use in an <iframe>. If resolveToConfig is not set, it defaults to false. If the window.FencedFrameConfig interface is not exposed (because e.g., the script is running in an older version of Chrome that does not yet implement FencedFrameConfig, then the auction will always yield a URN. Therefore, when requesting a FencedFrameConfig for use in a fenced frame element, you have two options:

Only pass resolveToConfig: true in if you detect that window.FencedFrameConfig != undefined, or
Unconditionally pass in resolveToConfig: true and check whether the auction result is a config or a URN.

All fields that accept arbitrary metadata (auctionSignals, sellerSignals, and perBuyerSignals dictionary values) must be JSON-serializable values (i.e. supported by JSON.stringify()). See here. All fields that specify URLs for loading scripts or JSON (decisionLogicURL and trustedScoringSignalsURL) must: be valid HTTPS URLs, contain no credentials, have no fragment, and be same-origin with seller. Additionally, to be used in an auction, the HTTP response headers of these URLs, when requested, must include the header Ad-Auction-Allowed: true to ensure they are allowed to be used for loading Protected Audience resources. The trustedScoringSignalsURL must also not have a query.

A Permissions-Policy directive named "run-ad-auction" controls access to the navigator.runAdAuction() API.

The seller is required to have its site (scheme, eTLD+1) attested for Protected Audience API. Please see the Privacy Sandbox enrollment attestation model.

In the case of a component auction, all AuctionConfig parameters for that component auction are only scoped to buyer and seller scripts run as part of that auction component. Similarly, all values specified by the top-level auction are not applied to the component auctions. When the top-level auction has component auctions, fields that affect bidder scripts have no effect, since the top-level auction has no bidders in it (e.g, perBuyerSignals, perBuyerTimeouts, perBuyerGroupLimits, etc).

2.1.1 Providing Signals Asynchronously

The values of some signals (those configured by fields auctionSignals, sellerSignals, perBuyerSignals, perBuyerTimeouts, deprecatedRenderURLReplacements, and directFromSellerSignalsHeaderAdSlot) can optionally be provided not as concrete values, but as Promises. This permits some parts of the auction, such as loading of scripts and trusted signals, and launching of isolated worklet processes, to overlap the computation (or network retrieval) of those values. The worklet scripts will only see the resolved values; if any such Promise rejects the auction will be aborted (unless it managed to fail already or get otherwise aborted anyway).

2.1.2 Seller Security Considerations

While joinAdInterestGroup() has strict requirements about the calling origin matching the interest group’s owner (or a prescribed delegate), runAdAuction() does not require the calling origin matches the seller’s origin. This means there can be times when runAdAuction() is not called from the seller’s origin, for example:

when a top-level seller calls runAdAuction() from the publisher’s site context, or
when a component seller passes their auction config to a top-level seller to pass to runAdAuction().

In these instances sellers should be aware that other JavaScript running on the page may modify the auction config and should take one of these steps to ensure this isn’t happening in unexpected ways:

Passing signals via directFromSellerSignals ensures that they come directly from the seller and are not modified.
Verifying the auction config, passed as the third parameter to scoreAd(), matches their expectations and is unmodified. If scoreAd() determines some part of the auction config appears to have been modified unexpectedly, they may want to avoid participating in the auction, for example by scoring all bids zero. Any creative URL replacements, from deprecatedRenderURLReplacements, are especially worth verifying as they can affect the ad rendered.

It should go without saying that sellers should already be verifying the buyer submitting bids is someone the seller knows and works with if they are to give the bid a positive score.

2.2 Auction Participants

Each interest group the browser has joined with:

owner in the list of interestGroupBuyers.
Non null biddingLogicURL. The fetch of biddingLogicURL and biddingWasmHelperURL (if specified) must succeed to bid.
At least one registered creative in the ads element. This implies that negative interest groups cannot bid as they cannot contain ads.
Priority, as stated by priority or calculated via priorityVector, is greater than or equal to 0.

will have an opportunity to bid in the auction. See the "Buyers Provide Ads and Bidding Functions" section, below, for how interest groups bid.

2.3 Scoring Bids

Once the bids are known, the seller runs code inside an auction worklet. Within this worklet, the seller's auction script has an opportunity to consider each individual ad one at a time, with its associated bid and metadata, and then assign a numerical desirability score. The seller's JavaScript is loaded from the auction configuration's decisionLogicURL, which must expose a scoreAd() function:

scoreAd(adMetadata, bid, auctionConfig, trustedScoringSignals, browserSignals,
    directFromSellerSignals, crossOriginTrustedSignals) {
  ...
  return {desirability: desirabilityScoreForThisAd,
          incomingBidInSellerCurrency:
              convertToEuros(bid, browserSignals.bidCurrency),
          allowComponentAuction: componentAuctionsAllowed};
}

The function gets called once for each candidate ad in the auction. The arguments to scoreAd() are:

adMetadata: Arbitrary metadata provided by the buyer.
bid: A numerical bid value.
auctionConfig: The auction configuration object passed to navigator.runAdAuction().
trustedScoringSignals: A value retrieved from a real-time trusted server chosen by the seller and reflecting the seller's opinion of this particular creative, as further described in 3.1 Fetching Real-Time Data from a Trusted Server below. This is used when the server is same-origin to the seller; crossOriginTrustedSignals is used otherwise.

browserSignals: An object constructed by the browser, containing information that the browser knows and which the seller's auction script might want to verify:

{ 'topWindowHostname': 'www.example-publisher.com',
  'interestGroupOwner': 'https://www.example-dsp.com',
  'renderURL': 'https://cdn.com/render_url_of_bid',
  'renderSize': {'width': '100sw', 'height': '200px'}, /* if specified in the bid */
  'adComponents': ['https://cdn.com/ad_component_of_bid',
                   'https://cdn.com/next_ad_component_of_bid',
                   ...],
  'biddingDurationMsec': 12,
  'bidCurrency': 'USD', /* bidCurrency returned by generateBid, or '???' if none */
  'dataVersion': 1, /* Data-Version value from the trusted scoring signals server's response */
  'selectedBuyerAndSellerReportingId': 'deal2', /* Value returned by generateBid. */
  'buyerAndSellerReportingId': 'seatId'
}

directFromSellerSignals is an object that may contain the following fields:
- sellerSignals: Like auctionConfig.sellerSignals, but passed via the directFromSellerSignals mechanism.
- auctionSignals: Like auctionConfig.auctionSignals, but passed via the directFromSellerSignals mechanism.
crossOriginTrustedSignals: like trustedScoringSignals, but used when the server is cross-origin to the seller script. The value is an object that has as a key the trusted server's origin, e.g. "https://example.org", and as value an object in format trustedScoringSignals uses. See 3.1.3 Cross-Origin Trusted Server Signals for more details.

The output of scoreAd() is an object with the following fields:

desirability: Number indicating how desirable this ad is. Any value that is zero or negative indicates that the ad cannot win the auction. (This could be used, for example, to eliminate any interest-group-targeted ad that would not beat a contextually-targeted candidate.) The winner of the auction is the ad object which was given the highest score.
allowComponentAuction: (optional) If the bid being scored is from a component auction and this value is not true, the bid is ignored. If not present, this value is considered false. This field must be present and true both when the component seller scores a bid, and when that bid is being scored by the top-level auction.
incomingBidInSellerCurrency: (optional) Provides a conversion of a bid in a multi-currency auction to seller's own currency. Please see the section on this functionality for more details.

If scoreAd() returns only a numeric value, it's equivalent to returning {desirability: numericValue, allowComponentAuction: false}.

The logic in scoreAd() has access to the full auction configuration object, which means the seller can pass in arbitrary information from the publisher page. In particular, the configuration object's sellerSignals field is exclusively for passing information into scoreAd(). This field can include information based on looking up publisher settings, based on making a contextual ad request, and so on. Examples of logic that could live in the scoreAd() function include:

Calculation of a publisher pay-out, based on the ad bid along with arbitrary seller data and arbitrary metadata included in the adObject. This pay-out could influence both the ad's desirability and the post-auction reporting used for moving money around.
Honoring publisher deals that promote certain ads over others irrespective of a per-page auction price.
Disqualifying some ads, by returning a desirability score of 0 (which means the ad will not win). This could, for example, be based on comparing ad metadata (e.g. advertiser or topic) to the publisher site's rules for what ads are allowed to appear on the page, or based on the bidder being slow (as revealed by biddingDurationMsec).
Checking whether the creative contents have been pre-approved by the seller. This could be implemented by an out-of-band creative review process leading to the seller handing the buyer a cryptographically-signed token, which the buyer then includes in the ad's metadata. See TERN's Section 0 for more discussion of this possibility.

Note that scoreAd() does not have any way to store information for use later on a different page. In particular, if the ad scoring logic on day 1 observes a bid from a particular interest group, and then on day 2 the browser interest group membership expires, there is no way for the ad scoring logic on day 3 to "remember" the pre-expiration membership information.

2.4 Scoring Bids in Component Auctions

Seller scripts in component auctions behave a little differently. They still expose a scoreAd() function to score each bid from the component auction's buyers, however all of its arguments come from the component auction, including auctionConfig. browserSignals has an additional topLevelSeller field, which contains the seller of the top-level auction. Instead of returning just a desirability score, the component seller's scoreAd() returns an object with the following fields:

ad: (optional) Arbitrary metadata to pass to the top-level seller. Defaults to null, if not present.
desirability: Numeric score of the bid. Must be positive or the ad will be rejected.
allowComponentAuction: If this field is not true, the bid will be rejected.
bid: (optional) Modified bid value to provide to the top-level seller script. If present, this will be passed to the top-level seller's scoreAd() and reportResult() methods instead of the original bid, if the ad wins the component auction and top-level auction, respectively.
bidCurrency: (optional) Annotates the currency of the modified bid provided by bid. Please see the Currency Checking section

Once all of a component auction's bids have been scored by the component auction's seller script, the bid with the highest score is passed to the top-level seller to score. For that bid, the top-level seller's scoreAd() method is passed the ad value from the component auction seller's scoreAd() method, and there is an additional componentSeller field in the browserSignals, which is the seller for the component auction. All other values are the same as if the bid had come from an interest group participating directly in the top-level auction. In the case of a tie, one of the highest scoring bids will be chosen randomly and only that bid will be passed to the top-level seller to score. The seller of a component auction may reject all bids by giving them scores <= 0. In that case, no bid from that component auction will be passed to the top-level auction.

The ultimate winner of the top-level auction is the single bid the top-level seller script gives the highest score, of the winning bids of the component auctions.

2.5 Additional Trusted Signals (directFromSellerSignals)

While the browser ensures (using TLS) that information stored in a buyer's interest group and coming from a buyer's trusted bidding signals server comes from the buyer, information passed into runAdAuction() is not known to come from the seller unless the seller calls runAdAuction() from its own iframe. In a multi-seller auction it becomes impossible to have all sellers create the frame calling runAdAuction(). directFromSellerSignals allows the browser to ensure the authenticity and integrity of information passed into an auction from the seller.

2.5.1 Using Response Headers

The optional directFromSellerSignalsHeaderAdSlot field can be used to coordinate passing signals into the auction, similar to auctionSignals, sellerSignals and perBuyerSignals. The difference is that signals coordinated by directFromSellerSignalsHeaderAdSlot are trusted to come from a seller because the content loads from an HTTP header served by the seller’s origin over HTTPS. We refer to signals passed in via this mechanism as directFromSellerSignals. DirectFromSellerSignals are passed via the Ad-Auction-Signals response header of some fetch() request or iframe navigation, together with the directFromSellerSignalsHeaderAdSlot field on navigator.runAdAuction().

To pass DirectFromSellerSignals using a fetch() call made by some script on the page (including in a subframe), specify an extra option, {adAuctionHeaders: true}:

let fetchResponse = await fetch("https://seller.com/signals", {adAuctionHeaders: true});

The script must resolve the directFromSellerSignalsHeaderAdSlot Promise only after the response for this call has been received. If the script chooses to call runAdAuction() after this response is received, directFromSellerSignalsHeaderAdSlot can be specified directly without a Promise.

To pass DirectFromSellerSignals using an iframe navigation, specify the adAuctionHeaders attribute on the iframe element:

<iframe src="https://seller.com/signals" adAuctionHeaders></iframe>

If script that invokes runAdAuction() is part of the response to that iframe navigation, directFromSellerSignalsHeaderAdSlot can be specified directly without a Promise because runAdAuction() cannot be called until after the response - with its DirectFromSellerSignals headers - has been received.

The browser will make the request for either the fetch() or the iframe navigation that it otherwise would, with the exception that the request will also include a request header, Sec-Ad-Auction-Fetch: ?1. This header indicates to the server that any Ad-Auction-Signals response header from the server will only be loaded in auctions via directFromSellerSignalsHeaderAdSlot (scripts on the page cannot set the Sec-Ad-Auction-Fetch: ?1 request header without using the {adAuctionHeaders: true} option).

The value of the Ad-Auction-Signals header must be JSON formatted, with the following schema:

Ad-Auction-Signals=[{
  "adSlot": "adSlot/1",
  "sellerSignals": ...,
  "auctionSignals": ...,
  "perBuyerSignals": {"https://buyer1.example": ..., ...}
},
{
  "adSlot": "adSlot/2",
  "sellerSignals": ...,
  "auctionSignals": ...,
  "perBuyerSignals": {"https://buyer1.example": ..., ...}
},
...
]

When invoking navigator.runAdAuction(), directFromSellerSignalsHeaderAdSlot is used to lookup the signals intended for that auction:

navigator.runAdAuction({
  ...
  directFromSellerSignalsHeaderAdSlot: "adSlot/1",
  ...
});

directFromSellerSignalsHeaderAdSlot is a string that should match the adSlot value contained in some Ad-Auction-Signals response served from the origin of that auction's seller. Note that for multi-seller or component auctions, each top-level / component auction can specify its own directFromSellerSignalsHeaderAdSlot, and the response should be served from that component / top-level auction's seller's origin. Different sellers may safely use the same adSlot names without conflict. If directFromSellerSignalsHeaderAdSlot matches multiple adSlots from header responses, signals from the most recently-received response will be sent to worklet functions. Furthermore, if a response is received for an adSlot whose name matches that for existing captured signals, memory from the old signals will be released and the new signals will be stored. A response that specifices the same adSlot name in multiple dictionaries is invalid.

The JSON will be parsed by the browser, and passed as the directFromSellerSignals parameter on generateBid(), scoreAd(), reportWin(), and reportResult(), with sellerSignals only being delivered to the seller, perBuyerSignals only being delivered to the buyer for each buyer origin key, and auctionSignals being delivered to all parties. Since the top-level JSON value is an array, multiple adSlot responses may be set for a given Ad-Auction-Signals header. In the dictionary with the adSlot, the sellerSignals, auctionSignals, and perBuyerSignals fields are optional -- they will be passed as null if not specified.

It's valid if only some component auctions / the top-level auction use DirectFromSellerSignals and some don't.

Failure to find a matching adSlot results in the fields of the directFromSellerSignals object passed to worklet functions being set to null.

Note that only the Ad-Auction-Signals response header from the server will only be loaded via directFromSellerSignalsHeaderAdSlot -- the payload of the request will be available to scripts running in that frame.

directFromSellerSignalsHeaderAdSlot may be passed as a promise that resolves to the ad slot string -- the auction perform loading, but delays execution until the promise is resolved.

The signals are only guaranteed to be available to navigator.runAdAuction() after the fetch() promise has resolved. Therefore, to avoid races, either runAdAuction() should be called after resolving the fetch() promise, or directFromSellerSignalsHeaderAdSlot should be passed a promise that only resolves after the fetch() promise resolves.

3. Buyers Provide Ads and Bidding Functions

Interest groups are used by their owners to bid in on-device auctions. We refer to each party bidding in an auction as a buyer. The buyer might be an advertiser who is also an interest group owner themselves, or a DSP that owns an interest group and acts on an advertiser's behalf.

Alternatively, the interest group owner might be a party whose responsibility is focused on building audiences and letting many different advertisers use them for targeting. In this case, the owner of the interest group is still the buyer, for the purposes of the seller's on-device auction. The interest group owner's choice of which advertiser's ad to display might be made via some server-side decision process, or might be made on a case-by-case basis on-device as part of the bidding process.

Buyers have three basic jobs in the on-device ad auction:

Buyers choose whether or not they want to participate in an auction.
Buyers pick a specific ad, and enter it in the auction along with a bid price and whatever metadata the seller expects.
Buyers perform reporting on the auction outcome. All buyers have a mechanism for aggregate reporting. As a temporary mechanism, the buyer who wins the auction has a way to do event-level reporting alongside their ad rendering; see the "Event-Level Reporting (for now)" section.

3.1 Fetching Real-Time Data from a Trusted Server

Buyers may want to make on-device decisions that take into account real-time data (for example, the remaining budget of an ad campaign). This need can be met using the interest group's trustedBiddingSignalsURL, trustedBiddingSignalsKeys, and, optionally, trustedBiddingSignalsSlotSizeMode, maxTrustedBiddingSignalsURLLength and trustedBiddingSignalsCoordinator fields. Once a seller initiates an on-device auction on a publisher page, the browser checks each participating interest group for these fields, and makes an uncredentialed (cookieless) HTTP fetch to a Key-Value server.

As a temporary mechanism during the First Experiment timeframe, the buyer and seller can fetch these bidding signals from any server, including one they operate themselves (a "Bring Your Own Server" model). However, in the final version after the removal of third-party cookies, the request will only be sent to a trusted key-value-type server. Because the server is trusted, there is no k-anonymity constraint on this request. The trusted key-value-type server follows this trust model and uses this protocol.

As noted in the key value trust model, the key value service is publicly queryable, so to prevent potentially leaking user information, keys should be either: not individually identifying (e.g. applying to many people, perhaps to all people who visited an advertiser page and that an ad campaign might show to) or unguessable (e.g. using random identifiers that are assigned at interest group join time and known only to the caller of joinAdInterestGroup). They should not be uniquely identifying and use guessable keys (e.g. hashed email address, name, or phone number).

3.1.1 Trusted Signals Server with BYOS Model

If trustedBiddingSignalsCoordinator is not present in the interest group, the bidding signals will be fetched from a BYOS server. The fetched URL will be of the form:

https://www.kv-server.example/getvalues?hostname=publisher.com&keys=key1,key2&interestGroupNames=name1,name2&experimentGroupId=12345&slotSize=100,200

The base URL https://www.kv-server.example/getvalues comes from the interest group's trustedBiddingSignalsURL, the hostname of the top-level webpage where the ad will appear publisher.com is provided by the browser, experimentGroupId comes from perBuyerExperimentGroupIds if provided, keys is a list of trustedBiddingSignalsKeys strings, and interestGroupNames is a list of the names of the interest groups that data is being fetched for. trustedBiddingSignalsSlotSizeMode is one of none (which is the default), slot-size, and all-slots-requested-sizes. In the second case, &slotSize=<width>,<height> is appended to the URL, where width and height are the normalized width and height from the requestedSize of the (component) auction's AuctionConfig. "Normalized" means units are always appended, and trailing zeros are removed, so {width: "62.50sw", height: "10.0"} becomes "62.5sw,10px". In the all-slots-requested-sizes case, &allSlotsRequestedSizes=<width1>,<height1>,<width2>,<height2>,... is appended, where all sizes are taken from the (component) auction's allSlotsRequestedSizes value. If the corresponding value is not present in the auction configuration, no value is appended.

The requests may automatically be coalesced (for efficiency) across a certain number of interest groups that share a trustedBiddingSignalsURL and trustedBiddingSignalsSlotSizeMode (which means they share an owner). Chrome coalesces requests for all interest groups that share an executor. The number of interest groups coalesced into a single request is limited by their maxTrustedBiddingSignalsURLLength fields. For instance, if an interest group has a maxTrustedBiddingSignalsURLLength of 1000, it means that the length of the trusted bidding signals request URL for this interest group cannot exceed 1000 characters. This prevents requests from being dropped by trusted signals servers due to oversized URLs. If an interest group wants an infinite length for the request URL, it can specify 0 for the maxTrustedBiddingSignalsURLLength.

The response from the server should be a JSON object of the form:

{ "keys": {
      "key1": arbitrary_json,
      "key2": arbitrary_json,
      ...},
  "perInterestGroupData": {
      "name1": {
          "priorityVector": {
              "signal1": number,
              "signal2": number,
              ...},
          "updateIfOlderThanMs": 360000
      },
      ...
  }
}

and the server must include the HTTP response header X-fledge-bidding-signals-format-version: 2. If the server does not include the header, the response will assumed to be an in older format, where the response is only the contents of the keys dictionary.

The value of each key that an interest group has in its trustedBiddingSignalsKeys list will be passed from the keys dictionary to the interest group's generateBid() function as the trustedBiddingSignals parameter. Values missing from the JSON object will be set to null. If the JSON download fails, or there are no trustedBiddingSignalsKeys or trustedBiddingSignalsURL in the interest group, then the trustedBiddingSignals argument to generateBid() will be null.

The perInterestGroupData dictionary contains optional data for interest groups whose names were included in the request URL. The priorityVector will be used to calculate the final priority for an interest group, if that interest group has enableBiddingSignalsPrioritization set to true in its definition. Otherwise, it's only used to filter out interest groups, if the dot product with prioritySignals is negative. See Filtering and Prioritizing Interest Groups for more information.

The updateIfOlderThanMs optional field specifies that the interest group should be updated via the updateURL mechanism (see the interest group attributes section) if the interest group hasn't been joined or updated in a duration of time exceeding updateIfOlderThanMs milliseconds. Updates that ended in failure, either parse or network failure, are not considered to increment the last update or join time. An updateIfOlderThanMs that's less than 10 minutes will be clamped to 10 minutes.

Similarly, sellers may want to fetch information about a specific creative, e.g. the results of some out-of-band ad scanning system. This works in much the same way as trustedBiddingSignalsURL. If trustedScoringSignalsCoordinator is not present in the auction config, it will send the scoring signals fetch request to a BYOS server. The request base URL is set from the trustedScoringSignalsURL property of the seller's auction configuration object. The parameter experimentGroupId comes from sellerExperimentGroupId in the auction configuration if provided. However, the URL has two sets of keys: "renderUrls=url1,url2,..." and "adComponentRenderUrls=url1,url2,..." for the main and adComponent renderURLs bids offered in the auction. Note that the query params use "Urls" instead of "URLs". It is up to the client how and whether to aggregate the fetches with the URLs of multiple bidders.

Similarly to trustedBiddingSignalsURL, scoring signals requests may also be coalesced across a certain number of bids that share a trustedScoringSignalsURL. The number of bids in a single request is limited by the auction configuration's maxTrustedScoringSignalsURLLength field. For example, if an auction configuration has a maxTrustedScoringSignalsURLLength of 1000, it means that the length of each trusted scoring signals request URL for this auction cannot exceed 1000 characters. If an auction configuration wants an infinite length for the request URL, it can specify 0 for the maxTrustedScoringSignalsURLLength.

The response to this request should be in the form:

{ "renderURLs": {
      "https://cdn.com/render_url_of_some_bid": arbitrary_json,
      "https://cdn.com/render_url_of_some_other_bid": arbitrary_json,
      ...},
  "adComponentRenderURLs": {
      "https://cdn.com/ad_component_of_a_bid": arbitrary_json,
      "https://cdn.com/another_ad_component_of_a_bid": arbitrary_json,
      ...}
}

The value of trustedScoringSignals passed to the seller's scoreAd() function is an object of the form:

{ "renderURL": {'https://cdn.com/render_url_of_bidder': arbitrary_value_from_signals},
  "adComponentRenderURLs": {
      "https://cdn.com/ad_component_of_a_bid": arbitrary_value_from_signals,
      "https://cdn.com/another_ad_component_of_a_bid": arbitrary_value_from_signals,
      ...}
}

Either trusted server may optionally include a numeric Data-Version header on the response to indicate the state of the data that generated this response, which will then be available in bid generation/scoring and reporting. This version number should not depend on any properties of the request, only the state of the server. Ideally, the number would only increment and at any time would be identical across all servers in a fleet. In practice a small amount of skew is permitted for operational reasons, including propagation delays, staged rollouts, and emergency rollbacks. The version number should be formatted with only the digits [0-9] with no leading 0s and fit in a 32-bit unsigned integer.

For detailed specification and explainers of the trusted key-value server, see also the following:

FLEDGE Key/Value Server APIs Explainer
FLEDGE Key/Value Server Trust Model Explainer

3.1.2 Trusted Signals Server in TEE

If trustedBiddingSignalsCoordinator or trustedScoringSignalsCoordinator is specified, the bidding or scoring signals request will be sent to a trusted key-value-type server running in a TEE using the version 2 protocol.

Once an on-device auction is initiated, the browser will make an HTTP POST request to a base URL such as https://www.kv-server.example/getvalues, which comes from the interest group's trustedBiddingSignalsURL or auction config's trustedScoringSignalsURL. The other information for the trusted signals request will be put into the request body, with CBOR encoding and HPKE encryption as described in FLEDGE Key/Value Server APIs Explainer.

3.1.3 Cross-Origin Trusted Server Signals

If the key-value server is on a different origin than the corresponding script, additional steps are needed to ensure that sensitive information is not inappropriately leaked to, or is manipulated by, a third party.

In the case of bidder signals, the following changes occur:

The fetch is a cross-origin CORS fetch with Origin: set to the buyer script's origin.
The value is passed to crossOriginTrustedSignals parameter, not the trustedBiddingSignals parameter, and there is one more level of nesting denoting the server's origin, e.g:

{
  'https://www.kv-server.example': {
    'keys': {
        'key1': arbitrary_json,
        'key2': arbitrary_json,
        ...},
    'perInterestGroupData': {
        'name1': {
            'priorityVector': {
                'signal1': number,
                'signal2': number,
                ...}
        },
        ...
    }
  }
}

The data version is passed in browserSignals.crossOriginDataVersion, not browserSignals.dataVersion.

Seller signals have additional requirements, as the trustedScoringSignalsURL is provided by a context that is not required to be same-origin with the seller:

The seller script must provide an Ad-Auction-Allow-Trusted-Scoring-Signals-From response header, a structured headers list of strings describing origins from which fetching trusted signals is permitted. The trusted scoring signals fetch may not begin until this header is received, in order to avoid leaking bid information to a third party. This means using a cross-origin trusted server for seller information may carry a peformance penalty.
The fetch is a cross-origin CORS fetch with Origin: set to the seller script's origin.
The value is passed to crossOriginTrustedSignals parameter, not the trustedScoringSignals parameter, and there is one more level of nesting denoting the server's origin, e.g:

{
  'https://www.kv-server.example': {
    'renderURL': {'https://cdn.com/render_url_of_bidder': arbitrary_value_from_signals},
    'adComponentRenderURLs': {
        'https://cdn.com/ad_component_of_a_bid': arbitrary_value_from_signals,
        'https://cdn.com/another_ad_component_of_a_bid': arbitrary_value_from_signals,
        ...}
  }
}

The data version is passed in browserSignals.crossOriginDataVersion, not browserSignals.dataVersion.

Note that older versions of Chrome did not support cross-origin trusted signals. You can query whether support is available as:

navigator.protectedAudience && navigator.protectedAudience.queryFeatureSupport(
    "permitCrossOriginTrustedSignals")

3.2 On-Device Bidding

Once the trusted bidding signals are fetched, each interest group's bidding function will run, inside a bidding worklet associated with the interest group owner's domain. The buyer's JavaScript is loaded from the interest group's biddingLogicURL, which must expose a generateBid() function:

generateBid(interestGroup, auctionSignals, perBuyerSignals,
    trustedBiddingSignals, browserSignals, directFromSellerSignals,
    crossOriginTrustedSignals) {
  ...
  return {'ad': adObject,
          'adCost': optionalAdCost,
          'bid': bidValue,
          'bidCurrency': 'USD',
          'render': {url: renderURL, width: renderWidth, height: renderHeight},
          'adComponents': [{url: adComponent1, width: componentWidth1, height: componentHeight1},
                           {url: adComponent2, width: componentWidth2, height: componentHeight2}, ...],
          'allowComponentAuction': false,
          'targetNumAdComponents': 3,
          'numMandatoryAdComponents': 1,
          'modelingSignals': 123,
          'selectedBuyerAndSellerReportingId': 'deal2'};
}

The arguments to generateBid() are:

interestGroup: The interest group object, as saved during joinAdInterestGroup() and perhaps updated via the updateURL.
- priority and prioritySignalsOverrides are not included. They can be modified by generatedBid() calls, so could theoretically be used to create a cross-site profile of a user accessible to generateBid() methods, otherwise.
- lifetimeMs is not included. It's ambiguous what should be passed: the lifetime when the group was joined, or the remaining lifetime. Providing the remaining lifetime would also potentially give access to more granular timing information than the API would otherwise allow, when state is shared across interest groups.
auctionSignals: As provided by the seller in the call to runAdAuction(). This is the opportunity for the seller to provide information about the page context (ad size, publisher ID, etc), the type of auction (first-price vs second-price), and so on.
perBuyerSignals: The value for this specific buyer as taken from the auction config passed to runAdAuction(). This can include contextual signals about the page that come from the buyer's server, if the seller is an SSP which performs a real-time bidding call to buyer servers and pipes the response back, or if the publisher page contacts the buyer's server directly. If so, the buyer may wish to check a cryptographic signature of those signals inside generateBid() as protection against tampering.
trustedBiddingSignals: An object whose keys are the trustedBiddingSignalsKeys for the interest group, and whose values are those returned in the trustedBiddingSignals request. This used when the trusted server is same-origin with the buyer's script.

browserSignals: An object constructed by the browser, containing information that the browser knows, and which the buyer's auction script might want to use or verify. The dataVersion field will only be present if the Data-Version header was provided and had a consistent value for all of the trusted bidding signals server responses used to construct the trustedBiddingSignals. topLevelSeller is only present if generateBid() is running as part of a component auction. Additional fields can include information about both the context (e.g. the true hostname of the current page, which the seller could otherwise lie about) and about the interest group itself (e.g. times when it previously won the auction, to allow on-device frequency capping). Note that unlike for reportWin() the joinCount and recency in generateBid()'s browser signals isn't subject to the noising and bucketing scheme. Furthermore, recency in generateBid()'s browser signals is specified in milliseconds, rounded to the nearest 100 milliseconds.

{ 'topWindowHostname': 'www.example-publisher.com',
  'seller': 'https://www.example-ssp.com',
  'topLevelSeller': 'https://www.another-ssp.com',
  'requestedSize': {'width': '100sw', 'height': '200px'}, /* if specified in auction config */
  'joinCount': 3,
  'recency': 3600000,
  'bidCount': 17,
  'prevWinsMs': [[timeDeltaMs1,ad1],[timeDeltaMs2,ad2],...], /* List of this interest group's previous wins. */
      /* Each element is milliseconds since win and the entry from the interest group's 'ads' list
         corresponding to the ad that won though with only the 'renderURL' and 'metadata' fields. */
  'wasmHelper': ..., /* a WebAssembly.Module object based on interest group's biddingWasmHelperURL */
  'dataVersion': 1, /* Data-Version value from the trusted bidding signals server's response(s) */
  'adComponentsLimit': 40, /* Maximum number of ad components generateBid() may return */
  'multiBidLimit': 5, /* If set, maximum number of bids that can be returned at once;
                         see perBuyerMultiBidLimits */
}

directFromSellerSignals is an object that may contain the following fields:
- perBuyerSignals: Like auctionConfig.perBuyerSignals, but passed via the directFromSellerSignals mechanism.
- auctionSignals: Like auctionConfig.auctionSignals, but passed via the directFromSellerSignals mechanism.
crossOriginTrustedSignals: Like trustedBiddingSignals, but used when the trusted-server is cross-origin to the buyer's script. The value is an object that has as a key the trusted server's origin, e.g. "https://www.kv-server.example", and as value an object in format trustedBiddingSignals uses. See 3.1.3 Cross-Origin Trusted Server Signals for more details.

In the case of component auctions, an interest group's generateBid() function will be invoked in all component auctions for which it qualifies, though the bidCount value passed to future auctions will only be incremented by one for participation in that auction as a whole.

The output of generateBid() contains the following fields:

ad: (optional) Arbitrary metadata about the ad which this interest group wants to show. The seller uses this information in its auction and decision logic. If not present, it's treated as if the value were null.
adCost: (optional) A numerical value used to pass reporting advertiser click or conversion cost from generateBid to reportWin. The precision of this number is limited to an 8-bit mantissa and 8-bit exponent, with any rounding performed stochastically.
bid: A numerical bid that will enter the auction. The seller must be in a position to compare bids from different buyers, therefore bids must be in some seller-chosen unit (e.g. "USD per thousand"). If the bid is zero or negative, then this interest group will not participate in the seller's auction at all. With this mechanism, the buyer can implement any advertiser rules for where their ads may or may not appear. While this returned value is expected to be a JavaScript Number, internal calculations dealing with currencies should be done with integer math that more accurately represent powers of ten.
bidCurrency: (optional) The currency for the bid, used for currency-checking.
render: A dictionary describing the creative that should be rendered if this bid wins the auction. This includes:
- url: The creative's URL. This must match the renderURL of an ad in the interest group's ads list, otherwise the bid is ignored.
- width: The creative's width. This size will be matched against the declaration in the interest group and substituted into any ad size macros present in the ad creative URL. When the ad is loaded in a fenced frame, the fenced frame's inner frame (i.e. the size visible to the ad creative) will be frozen to this size, and it will be unable to see changes to the frame size made by the embedder.
- height: The creative's height. See elaboration in width above.
Optionally, if you don't want to hook into interest group size declarations (e.g., if you don't want to use size macros), you can have render be just the URL, rather than a dictionary with url, width and height.
adComponents: (optional) A list of up to 20 (in process of being increased to 40 starting from M122) adComponent strings from the InterestGroup's adComponents field. Each value must match one of interestGroup's adComponent's renderURL and sizes exactly. This field must not be present if interestGroup has no adComponent field. It is valid for this field not to be present even when adComponents is present. (See "Ads Composed of Multiple Pieces" below.)
allowComponentAuction: If this buyer is taking part of a component auction, this value must be present and true, or the bid is ignored. This value is ignored (and may be absent) if the buyer is part of a top-level auction.
modelingSignals (optional): A 0-4095 integer (12-bits) passed to reportWin(), with noising, as described in the noising and bucketing scheme. Invalid values, such as negative, infinite, and NaN values, will be ignored and not passed. Only the lowest 12 bits will be passed.
targetNumAdComponents and numMandatoryAdComponents (both optional): Permits the browser to select only some of the returned adComponents in order to help make the ad k-anonymous. See Flexible Component Ad Selection Considering k-Anonymity for more details.
selectedBuyerAndSellerReportingId: (optional) A string from the interest group's ad's selectableBuyerAndSellerReportingIds array; if it's not in the array, the bid is ignored. If present, this is reported to reportWin() and reportResult() along with buyerAndSellerReportingId and buyerReportingId; the resulting bid may only win the auction if the selected value is jointly k-anonymous along with buyerAndSellerReportingId, buyerReportingId, the interest group owner, bidding script URL, and render URL. If present, it indicates the reporting of this bid would not operate correctly were the selectedBuyerAndSellerReportingId not presented to reportWin() and reportResult(). See Reporting IDs for more details.

In case returning multiple bids is supported by the implementation in use, generateBid may also return up to browserSignals.multiBidLimit valid bid objects of the format above in an array.

Note: Chrome currently imposes an internal limit of 100 for the length of returned bids sequences.

If none of the produced bids pass the k-anonymity checks (the check that includes the render url and, when selectedBuyerAndSellerReportingId is returned, the check that includes its value also), generateBid will be re-run with the input interestGroup filtered to contain only k-anonymous ads and component ads and selectableBuyerAndSellerReportingIds. Such re-runs are limited to returning only a single bid, even if multiple bid support is otherwise on, so they will have browserSignals.multiBidLimit === 1, regardless of the value of perBuyerMultiBidLimits.

generateBid() has access to the setPrioritySignalsOverride(key, value) method. This adds an entry to the current interest group's prioritySignalsOverrides dictionary with the specified key and value, overwriting the previous value, if there was already an entry with key. If value is null, the entry with the specified key is deleted, if it exists.

generateBid() has access to the setBid(bids) method. That takes the exact same types as the return values do, and is used as a fallback value in case generateBid() throws an exception or times out. Each call will overwrite the previously set value; if there is something wrong with the provided bids it will throw an exception and clear the fallback bid. In implementations supporting returning multiple bids, an array can be passed here as well.

3.3 Metadata with the Ad Bid

The metadata accompanying the returned ad is not specified in this document, because sellers and buyers are free to establish whatever protocols they want here.

Sellers can ask buyers to provide whatever information they feel is necessary for their ad scoring job. Sellers have an opportunity to enforce requirements in their scoreAd() function, rejecting bids whose metadata they find lacking.

If generateBid() picks an ad whose rendering URL is not yet above the browser-enforced k-anonymity threshold, then the function will be called a second time, this time with a modified interestGroup argument that includes only the subset of the group's ads that are over threshold. (The under-threshold ad will, however, be counted towards the k-anonymity thresholding for future auctions for this and other users.)

3.4 Ads Composed of Multiple Pieces

The Product-level TURTLEDOVE proposal describes a use case in which the rendered ad is composed of multiple pieces — a top-level ad template "container" which includes some slots that can be filled in with specific "products". This is useful because the browser-enforced k-anonymity threshold can be applied to each individual component of the ad without compromising on tracking protections.

Initially, the limit on the number of components was 20, but it's in process of being increased to 40 starting from Chrome M122. Implementations of generateBid can determine the currently active limit as follows:

const maxAdComponents = browserSignals.adComponentsLimit ?
                        browserSignals.adComponentsLimit : 20;

In the web page, the limit can also be queried:

const maxAdComponents = navigator.protectedAudience ?
    navigator.protectedAudience.queryFeatureSupport("adComponentsLimit") : 20;

The output of generateBid() can use the on-device ad composition flow through an optional adComponents field, listing additional URLs made available to the fenced frame the container URL is loaded in. The fenced frame configs for the winning ads may be retrieved be calling window.fence.getNestedConfigs(), which will always return an Array of 40 fenced frame configs. Alternatively, URNs for the component ad URLs may be retrieved by calling navigator.adAuctionComponents(numComponents), where numComponents will be capped to the maximum permitted value. To prevent bidder worklets from using this as a side channel to leak additional data to the fenced frame, both APIs will pad their result with fenced frame configs or URNs that map to about:blank, so the requested number of values will be returned, regardless of how many adComponent URLs were actually provided by the bid.

3.4.1 Flexible Component Ad Selection Considering k-anonymity

Since a bid containing multiple components requires every component to be k-anonymous to display, it may be difficult to make such bids successfully. To make this easier, generateBid() can permit the browser to select a subset of returned component ads that pass the k-anonymity threshold.

Note that feature detection for this in Chrome is the same as for multiple bid support --- presence of browserSignals.multiBidLimit; but if supported it can be used on single-bid returns as well; multiple-bid returns are affected per-bid.

To use this functionality, set the targetNumAdComponents field of a returned bid to the desired number of component ads, and order them by decreasing desirability. The browser will scan the component ad list and use the first targetNumAdComponents that meet the k-anonymity requirements for the bid in the auction, if possible. A bid with the first targetNumAdComponents from those provided will also be considered for k-anonymity updates. It's an error to provide less component ads than a set targetNumAdComponents.

When targetNumAdComponents is in use, the adComponents list in the bid can exceed the normal global limit (of 20 or 40, exposed via browserSignals.adComponentsLimit), but targetNumAdComponents must still follow that limit. Chrome also currently has a limitation of 100 entries per sequence that still applies.

If particular ad components are especially critical, you can further set numMandatoryAdComponents to denote that the first numMandatoryAdComponents entries of adComponents must be included for the bid to be made. When that requirement is not met, the k-anonymity update candidate is still generated.

3.5 Filtering and Prioritizing Interest Groups

When an interest group has a non-empty priorityVector, its priority is dynamically calculated before applying perBuyerGroupLimits. To do this, the browser computes the sparse dot product of the interest group's priorityVector and a prioritySignals vector. The sparse dot product of two vectors V and W is the sum of the products V[key] * W[key] for each key in both V and W. For example, the sparse dot product of {'x':3, 'y':7, 'z':12} with {'x':-2, 'y':1.7, 'teapot':418} is 3*(-2) + 7*1.7 = 5.9. The prioritySignals vector is the result of merging the following objects, which all have strings as keys and numbers as values, with entries in objects earlier in the list taking priority over entries later in the list:

The interest group's prioritySignalsOverrides field.
A browser-generated prioritySignals object, defined below.
The auctionConfig's perBuyerPrioritySignals entry for the interest group owner.
The auctionConfig's perBuyerPrioritySignals "*" entry.

Additionally, keys starting with "browserSignals." are reserved, and may only appear in prioritySignalsOverrides and the browser-generated prioritySignals object.

The browser-generated prioritySignals object contains the following values:

browserSignals.one: This is always 1. It's useful for adding a constant to the dot product.
browserSignals.basePriority: The priority field in the interest group, which may have been modified by a setPriority() call.
browserSignals.firstDotProductPriority: The sparse dot product of the interest group's priorityVector and prioritySignals. Only non-zero when using a priorityVector from a trusted bidding signals fetch, and the interest group also has a prioritySignals field. See below for more details.
browserSignals.ageInMinutes: How long since the interest group was most recently joined, in minutes, as an integer. Guaranteed to be between 0 and 43200 (the number of minutes in 30 days, the maximum lifetime of an interest group), inclusive.
browserSignals.ageInMinutesMax60: Same as browserSignals.ageInMinutes, but with a maximum value of 60. 60 is returned if the group is more than an hour old.
browserSignals.ageInHoursMax24: The interest group's age in hours, as an integer, with a maximum value of 24. Always non-negative.
browserSignals.ageInDaysMax30: The interest group's age in days, as an integer, with a maximum value of 30. Always non-negative.

If the resulting sparse dot product is negative, the interest group is immediately removed from the auction (note that if there's no priorityVector, interest groups with negative priority values currently are not filtered from auctions). After calculating new priorities as needed, and filtering out interest groups with negative calculated priorities, the perBuyerGroupLimits value is applied to all interest groups of a given owner, unless the interest group's enableBiddingSignalsPrioritization field is present and true.

If enableBiddingSignalsPrioritization is true, then rather than applying perBuyerGroupLimits immediately after calculating the sparse dot product as described above, group limit enforcement is delayed until after fetching the trusted bidding signals. In this case, if the trusted bidding signals specify a per-interest-group priorityVector for an interest group, the sparse dot product of that priorityVector and the prioritySignals vector is calculated. The prioritySignals vector is the same as in the first calculation, except that there's an additional browserSignals.firstDotProductPriority value, which is the result of multiplying the interest group's priorityVector, if present, with the prioritySignals of the auction. If this new dot product is negative, the interest group is removed from the auction. If there is no priorityVector for an interest group, the priority from earlier in the auction is used instead. Once all priorities have been calculated, then perBuyerGroupLimits is applied, and the auction continues as normal.

if enableBiddingSignalsPrioritization is false, then the priorityVector from the trusted bidding signals will still be multiplied by the prioritySignals as above, but it will only be used to skip the interest group if the result is less than 0. This parameter exists to improve performance - when it's false for all interest groups for a particular bidder in an auction, that bidder's interest groups can be filtered out before any bidding signals are fetched, reducing network usage and server load.

For example, with the following interest groups and auction config:

auctionConfig = {
  ...,
  'interestGroupBuyers': ['https://buyer1.com/'],
  'perBuyerPrioritySignals': {
    '*': {'politics': 1},
  }
}

interestGroup1 = {
  'owner': 'https://buyer1.com/',
  'name': 'NoPolitics',
  'priorityVector': {'politics': -1},
  ...
}

interestGroup2 = {
  'owner': 'https://buyer1.com/',
  'name': 'BidFor240Minutes',
  'priorityVector': {'browserSignals.ageInMinutes': -1, 'browserSignals.one': 240},
  ...
}

interestGroup3 = {
  'owner': 'https://buyer1.com/',
  'name': 'FilterOnDataFromServer',
  'trustedBiddingSignalsURL': 'https://buyer1.com/bidder_signals',
  ...
}

The NoPolitics interest group will not get a chance to bid, since the AuctionConfig has politics set to 1, and NoPolitics multiplies that by -1, giving it a priority of -1.

The BidFor240Minutes interest group will have a positive priority if it was joined during the first 240 minutes, starting with 240 right after being joined, and working its way down to 0 at the 240 minute mark, after which it will have a negative priority and so will not bid.

The FilterOnDataFromServer interest group will result in fetching https://buyer1.com/bidder_signals?publisher=<...>&interest_groups=FilterOnDataFromServer,<...>, and then if that result has a perInterestGroupData.FilterOnDataFromServer.priorityVector object, then that is used just like the priorityVector field from the other two examples, except that it's only used for filtering, not to set the priority (unless the group has a true enableBiddingSignalsPrioritization field). A user defined function could be used on the Protected Audience Key-Value server to calculate that priorityVector value, and hence to decide if FilterOnDataFromServer's generateBid() method is invoked or if it's filtered out.

3.6 Currency Checking

If participants in the auction need to deal with multiple currencies, they can optionally take advantage of automated currency checking. All of it operates on currency tags, which are required to contain 3 upper-case ASCII letters.

If the generateBid() method returns a bidCurrency, and the perBuyerCurrencies for that buyer is specified, their consistency will be checked, and if there is a mismatch, the bid will be dropped. Both the perBuyerCurrencies for that buyer and returned bidCurrency must be present for checking to take place; if one or both are missing the currency check does not take place and the bid is passed on as-is. The returned bidCurrency will be passed to scoreAd()'s browserSignals.bidCurrency, with unspecified currency rendered as '???'.

Currency checking after scoreAd() happens only inside component auctions. If the component seller's scoreAd() modifies the bid value, the modified bid's currency will be checked; if not, the passed-through bid from the original buyer's currency will be. In either case, the currency will be checked both against the component auction's sellerCurrency and top-level auction's perBuyerCurrencies as applied to the component auction's seller. As before, both the bid currency and the configured currency in question must be specified for the checking to take place; if one or both are missing that particular currency check does not take place. If there is a mismatch, the bid will not take part in the top-level auction.

sellerCurrency also has an extensive effect on how reporting behaves. Please see the section on Currencies in Reporting for more details.

4. Browsers Render the Winning Ad

The winning ad will be rendered in a Fenced Frame: a mechanism under development for rendering a document in an embedded context which is unable to communicate with the surrounding page. This communication blockage is necessary to meet the privacy goal that sites cannot learn about their visitors' ad interests. (Note that the k-anonymity rendering threshold alone is not enough to address this threat: the threshold prevents ads which could identify a single person, but it allows ads which identify a group of people that share a single interest.)

Fenced Frames are designed to be able to provide a second type of protection as well: they will not use the network to load any data from a server, instead only rendering content that was previously downloaded (e.g. as a Web Bundle). This restriction is focused on preventing information leakage based on server-side joins via timing attacks.

As a temporary mechanism, we will still allow network access, rendering the winning ad in a Fenced Frame that is able to load resources from servers.

The TURTLEDOVE privacy goals mean that this cannot be the long-term solution. Rendering ads from previously-downloaded Web Bundles, as originally proposed, is one way to mitigate this leakage. Another possibility is ad rendering in which all network-loaded resources come from a trusted CDN that does not keep logs of the resources it serves. As with servers involved in providing the trusted bidding signals, the privacy model and browser trust mechanism for such a CDN would require further work.

Reports are only sent and most interest group state changes (e.g. updating prevWins and bidCount, updating k-anonymity information) are only applied if and when the winning renderURL is loaded in a fenced frame, in the case there is a winner, or when there is no winner. Priorities and priorityOverrides are updated immediately upon completion of the generateBid() call that invoked their respective update functions, since how the information from those are used is not expected to depend on whether the current auction was completed or not.

5. Event-Level Reporting (for now)

Once the winning ad has rendered in its Fenced Frame, the seller(s) and the winning buyer each have an opportunity to perform logging and reporting on the auction outcome. The browser will call one reporting function in the seller's auction worklet and one in the winning buyer's bidding worklet; in the case of a multi-seller auction both the top-level and winning component seller's reporting function will be invoked.

As a temporary mechanism, these reporting functions will be able to send event-level reports to their servers. These reports can include contextual information, and can include information about the winning interest group if it is over an anonymity threshold. This reporting will happen synchronously, while the page with the ad is still open in the browser.

In the long term, we need a mechanism to ensure that the after-the-fact reporting cannot be used to learn the advertising interest group of individual visitors to the publisher's site — the same privacy goal that led to Fenced Frame rendering. The Private Aggregation API proposal aims to satisfy this use case. Therefore event-level reporting is just a temporary model until an adequate reporting framework is settled and in place.

5.1 Seller Reporting on Render

A seller's JavaScript (i.e. the same script, loaded from decisionLogicURL, that provided the scoreAd() function) can also expose a reportResult() function. This is called with the bid that won the auction, if applicable.

reportResult(auctionConfig, browserSignals, directFromSellerSignals) {
  ...
  return signalsForWinner;
}

In a multi-seller auction reportResult will be called for both the top-level-seller and winning component seller. For the component auction sellers, reportResult() is only invoked if the bid that won their component auction also went on to win the top-level auction. The signalsForWinner passed to reportWin will come from the output of the winning component seller's reportResult.

The arguments to this function are:

auctionConfig: The auction configuration object passed to navigator.runAdAuction()
- reportingTimeout is capped to 5000 ms. Set to default 50 ms if the auctionConfig passed to navigator.runAdAuction() does not provide one.
browserSignals: An object constructed by the browser, containing information it knows about what happened in the auction.
- topLevelSeller, topLevelSellerSignals, and modifiedBid are only present for component auctions, while componentSeller is only present for top-level auctions when the winner came from a component auction.
- modifiedBid is the bid value a component auction's scoreAd() script passed to the top-level auction.
- topLevelSellerSignals is the output of the top-level seller's reportResult() method.
- highestScoringOtherBid is the value of a bid with the second highest score in the auction. It may be greater than bid since it's a bid instead of a score, and a higher bid value may get a lower score. Rejected bids are excluded when calculating this signal. If there was only one bid, it will be 0. In the case of a tie, it will be randomly chosen from all bids with the second highest score, excluding the winning bid if the winning bid had the same score. A component seller's reportResult() function will be passed a bid with the second highest score in the component auction, not the top-level auction. It is not reported to top-level sellers in a multi-SSP case because we expect a top-level auction in this case to be first-price auction only:
```
{ 'topWindowHostname': 'www.example-publisher.com',
  'topLevelSeller': 'https://www.example-ssp.com',
  'componentSeller': 'https://www.some-other-ssp.com',
  'interestGroupOwner': 'https://www.example-dsp.com/',
  'renderURL': 'https://cdn.com/url-of-winning-creative.wbn',
  'bid': bidValue,
  'bidCurrency': 'USD',
  'desirability': desirabilityScoreForWinningAd,
  'topLevelSellerSignals': outputOfTopLevelSellersReportResult,
  'dataVersion': versionFromKeyValueResponse,
  'modifiedBid': modifiedBidValue,
  'highestScoringOtherBid': highestScoringOtherBidValue,
  'highestScoringOtherBidCurrency': 'EUR'
  'buyerAndSellerReportingId': 'seatId',
  'selectedBuyerAndSellerReportingId': 'deal2',
}
```
- bidCurrency and highestScoringOtherBidCurrency provide (highly redacted) information on what currency the corresponding numbers are in. Please refer to the section on Currencies in Reporting for more details.
directFromSellerSignals is an object that may contain the following fields:
- sellerSignals: Like auctionConfig.sellerSignals, but passed via the directFromSellerSignals mechanism.
- auctionSignals: Like auctionConfig.auctionSignals, but passed via the directFromSellerSignals mechanism.

The browserSignals argument must be handled carefully to avoid tracking. It certainly cannot include anything like the full list of interest groups, which would be too identifiable as a tracking signal. The renderURL can be included since it has passed a k-anonymity check. Because renderSize will not be included in the k-anonymity check initially, it is not included in the browser signals. The browser may limit the precision of the bid and desirability values by stochastically rounding them so that they fit into a floating point number with an 8 bit mantissa and 8 bit exponent to avoid these numbers exfiltrating information from the interest group's userBiddingSignals. On the upside, this set of signals can be expanded to include useful additional summary data about the wider range of bids that participated in the auction, e.g. the number of bids. Additionally, the dataVersion will only be present if the Data-Version header was provided in the response headers from the Trusted Scoring server.

In the short-term, the reportResult() function's reporting happens by calling a sendReportTo() API which takes a single string argument representing a URL. The sendReportTo() function can be called at most once during a worklet function's execution. The URL is fetched when the frame displaying the ad begins navigating to the ad. Callers of sendReportTo() should avoid assembling URLs longer than browser's URL length limits (e.g. 2MB for Chrome) as these may not be reported. The URL is required to have its site (scheme, eTLD+1) attested for Protected Audience API. Please see the Privacy Sandbox enrollment attestation model. Eventually reporting will go through the Private Aggregation API once it has been developed.

The output of reportResult() is not used for reporting, but rather as an input to the buyer's reporting function. If there is no output or the output is not JSON-serializable (i.e. supported by JSON.stringify()), it will be null in reportWin()'s sellerSignals.

5.2 Buyer Reporting on Render and Ad Events

The buyer's JavaScript (i.e. the same script, loaded from biddingLogicURL, that provided the generateBid() function) can also expose a reportWin() function:

reportWin(auctionSignals, perBuyerSignals, sellerSignals, browserSignals,
    directFromSellerSignals) {
  ...
}

The arguments to this function are:

auctionSignals and perBuyerSignals: As in the call to generateBid() for the winning interest group.
sellerSignals: The output of reportResult() above, giving the seller an opportunity to pass information to the buyer. In the case where the winning buyer won a component auction and then went on to win the top-level auction, this is the output of component auction's seller's reportResult() method.
browserSignals: Similar to the argument to reportResult() above, though without the seller's desirability score, but with additional adCost, seller, madeHighestScoringOtherBid and potentially buyerReportingId or interestGroupName fields:
- The adCost field contains the value that was returned by generateBid(), stochastically rounded to fit into a floating point number with an 8 bit mantissa and 8 bit exponent. This field is only present if adCost was returned by generateBid().
- The buyerReportingId may be included if selected (see Reporting IDs for selection details) and the tuple of buyerReportingId, interest group owner, bidding script URL, ad creative URL, and ad creative size (if specified by generateBid) were jointly k-anonymous. (Note: until at least Q1 2025, in the implementation, the ad creative size is excluded from this check.)
- The interestGroupName may be included if selected (see Reporting IDs for selection details) and the tuple of interest group owner, name, bidding script URL, ad creative URL, and ad creative size (if specified by generateBid) were jointly k-anonymous. (Note: until at least Q1 2025, in the implementation, the ad creative size is excluded from this check.)
- The madeHighestScoringOtherBid field is true if the interest group owner was the only bidder that made bids with the second highest score.
- The highestScoringOtherBid and madeHighestScoringOtherBid fields are based on the auction the interest group was directly part of. If that was a component auction, they're from the component auction. If that was the top-level auction, then they're from the top-level auction. Component bidders do not get these signals from top-level auctions since it is the auction seller joining the top-level auction, instead of winning component bidders joining the top-level auction directly.
- The dataVersion field will contain the Data-Version from the trusted bidding signals response headers if they were provided by the trusted bidding signals server response and the version was consistent for all keys requested by this interest group, otherwise the field will be absent.
- If the winning bid was from a component auction, then seller will be the seller in the component auction, a topLevelSeller field will contain the seller of the top-level auction.
- The joinCount field is the number of times this device has joined this interest group in the last 30 days while the interest group has been continuously stored (that is, there are no gaps in the storage of the interest group on the device due to leaving or membership expiring), using the noising and bucketing scheme.
- The recency field is duration of time (in minutes) from when this device joined this interest group until now, using the noising and bucketing scheme.
- modelingSignals is the modelingSignals returned from generateBid(), using the noising scheme. This field is only present if modelingSignals was returned by generateBid().
- kAnonStatus indicates the k-anonymity status of the ad. When k-anonymity is calculated but not enforced, this field can help bidders understand the impact of k-anonymity enforcement.
  - passedAndEnforced The ad was k-anonymous and k-anonymity was required to win the auction.
  - passedNotEnforced The ad was k-anonymous though k-anonymity was not required to win the auction.
  - belowThreshold The ad was not k-anonymous but k-anonymity was not required to win the auction.
  - notCalculated The browser did not calculate the k-anonymity status of the ad, and k-anonymity was not required to win the auction.
- The reportingTimeout field is navigator.runAdAuction() auctionConfig’s reportingTimeout capped to 5000 ms if provided, or a default timeout of 50 ms otherwise.
directFromSellerSignals is an object that may contain the following fields:
- perBuyerSignals: Like auctionConfig.perBuyerSignals, but passed via the directFromSellerSignals mechanism.
- auctionSignals: Like auctionConfig.auctionSignals, but passed via the directFromSellerSignals mechanism.

The reportWin() function's reporting happens by calling sendReportTo(), same as for reportResult(), in the short-term, but will eventually go through the Private Aggregation API. Once the Private Aggregation API is the only allowed reporting mechanism available in Protected Audience, the interestGroup object passed to generateBid() will be available to reportWin().

Ads often need to report on events that happen once the ad is rendered. One common example is reporting on whether an ad became viewable on-screen. The Fenced Frame Ads Reporting API offers an event-level way to do this, in the short-term, while the Extended Private Aggregaton reporting API offers an aggregate method of doing so.

5.2.1 Noised and Bucketed Signals

Some privacy-sensitive information (browser signals joinCount, recency, and the field modelingSignals passed from generateBid() to reportWin()) are made available to reportWin() under a special noising and bucketing scheme.

All such fields use a noising scheme where, in a randomly-selected 1% of reportWin() calls, a uniformly-generated random value in the range of the field's bucketing scheme is returned instead of the true value.

For bucketing, the browser signal joinCount has 16 buckets (4 bits), and the browser signal recency has 32 buckets (5 bits), as described in this spreadsheet. The modelingSignals field only sends the lower 12 bits to reportWin(), resulting in 4096 distinct possible values of that field.

When joinCount is passed to generateBid(), no noising or bucketing is applied.

These signals were requested in issue 435. The signals are intented to ship in Chrome M114, they will no longer be available for event level reporting when event level reporting is retired.

5.3 Currencies in Reporting

In auctions that involve multiple currencies, there may be values with different units floating around, which makes aggregated information incomprehensible, and event-level information hard to process, potentially requiring participants to interpret currencies of jurisdictions they do no business in.

To help deal with this scenario, an optional mode is available that converts all bid-related information to seller's preferred currency (in component auctions, reporting for it is for that component's seller). This is configured via the sellerCurrency setting in each auction configuration.

If sellerCurrency is set, scoreAd() for an auction is responsible for converting bids not already in sellerCurrency to sellerCurrency, via the incomingBidInSellerCurrency field of its return value. A bid already explicitly in the seller's currency cannot be changed by incomingBidInSellerCurrency (passing an identical value is a no-op; passing a different one rejects the bid). If neither the original bid is explicitly in sellerCurrency nor an incomingBidInSellerCurrency is specified, a value of 0 is used as the converted value.

Note that incomingBidInSellerCurrency is different from the modified bid returned by a component auction: it represents a mechanical currency translation of the original buyer's bid, rather than the bid the component auction is making in a top-level auction (which could, perhaps, be reduced by the intermediate seller's fee or the like). It can also be specified in top-level auctions, unlike the modified bid.

The following table summarizes which APIs get original and which get converted bid values, and how redaction for currency tags works, depending on whether sellerCurrency is set or not:

API	when `sellerCurrency` unset	when `sellerCurrency` set
`reportWin()` `browserSignals.bid`	Original value	Original value
`reportWin()` `browserSignals.bidCurrency`	Currency required by auction configuration, or `'???'`	Currency required by auction configuration, or `'???'`
`reportResult()` `browserSignals.bid`	Original value of bid at that auction level (for top-level auction this includes any modification by component auction)	Original value of bid at that auction level (for top-level auction this includes any modification by component auction) (in Chrome since M116)
`reportResult()` `browserSignals.bidCurrency`	Currency required by auction configuration, or `'???'`	Currency required by auction configuration, or `'???'` (in Chrome since M116)
`reportWin()` `browserSignals.highestScoringOtherBid`	Original value	Converted value
`reportWin()` `browserSignals.highestScoringOtherBidCurrency`	`'???'`	`sellerCurrency`
`reportResult()` `browserSignals.highestScoringOtherBid`	Original value	Converted value
`reportResult()` `browserSignals.highestScoringOtherBidCurrency`	`'???'`	`sellerCurrency`
`forDebuggingOnly.report...` keyword `${winningBid}`	Original value	Converted value
`forDebuggingOnly.report...` keyword `${winningBidCurrency}`	`'???'`	`sellerCurrency`
`forDebuggingOnly.report...` keyword `${highestScoringOtherBid}`	Original value	Converted value
`forDebuggingOnly.report...` keyword `${highestScoringOtherBidCurrency}`	`'???'`	`sellerCurrency`
`forDebuggingOnly.report...` keyword `${topLevelWinningBid}`	Original value	Converted value (as converted by top-level `scoreAd()`)
`forDebuggingOnly.report...` keyword `${topLevelWinningBidCurrency}`	`'???'`	`sellerCurrency` of top-level auction
Private Aggregation `winning-bid`	Original value	Converted value
Private Aggregation `highest-scoring-other-bid`	Original value	Converted value

5.4 Reporting IDs

Protected Audience provides several interest group fields that can be used to report details about a bid. These fields needs to be jointly k-anonymous with the interest group owner, bidding script URL, and render URL to be provided to the reporting functions. Which of selectableBuyerAndSellerReportingIds, buyerAndSellerReportingId, buyerReportingId, and the interest group name gets passed to reportWin() and reportResult() is determined by the browser with the following logic:

If selectedBuyerAndSellerReportingId in bid:
- Then selectedBuyerAndSellerReportingId, buyerAndSellerReportingId (if present in interest group), and buyerReportingId (if present in interest group) will all be available to reporting.
Otherwise, if buyerAndSellerReportingId defined in interest group: buyerAndSellerReportingId available to reporting.
Otherwise, if buyerReportingId defined in interest group: buyerReportingId available to reporting.
Otherwise, interest group name available to reporting.

Here's a table representation of the above logic: (selectableBuyerAndSellerReportingIds abbreviated to selectableBASRI, buyerAndSellerReportingId abbreviated to BASRI, buyerReportingId abbreviated to BRI)

When interest group contains:			then reports get:
selectableBASRI	BASRI	BRI	reportWin()	reportResult()
yes and in bid	optional	optional	selectableBASRI, BASRI, BRI	selectableBASRI, BASRI
no or not in bid	yes	ignored	BASRI	BASRI
no or not in bid	no	yes	BRI
no or not in bid	no	no	interest group name

When selectableBuyerAndSellerReportingIds is set, generateBid() is passed all reporting IDs in each entry in the interest group's ads list, though in cases where generateBid() is re-run, after the first invocation didn't produce any bids with ads that passed the k-anonymity checks, selectableBuyerAndSellerReportingIds that don't pass the k-anonymity check will not be present in the interest group.

For bids with a value for selectedbuyerAndSellerReportingId, scoreAd is passed the same reporting IDs as would be passed to reportResult() (selectedBuyerAndSellerReportingId and buyerAndSellerReportingId). To ensure accurate reporting, a bid with a value for selectedbuyerAndSellerReportingId may only win the auction if the value of selectedbuyerAndSellerReportingId is jointly k-anonymous along with buyerAndSellerReportingId, buyerReportingId, the interest group owner, bidding script URL, and render URL, so that reportResult() will always receive the value of selectedbuyerAndSellerReportingId for bids that provided a value.

One use for these reporting IDs is to facilitate deals (private marketplace) in Protected Audience auctions. Here's a couple examples of using the reporting IDs to convey deals used in bids. In these examples, the 's' prefix might be used to connote seat ID and the 'd' prefix might connote deal ID.

If the same seat ID is always presented for bids on an ad:

joinAdInterestGroup({...
  'ads': [{renderURL: Ad1URL, 
           buyerReportingId: 'buyerInfo123',
           buyerAndSellerReportingId: 's456',
           selectableBuyerAndSellerReportingIds: [ 'd123', 'd234', 'd345' ],
  ...})

If different seat IDs are presented for bids on an ad:

joinAdInterestGroup({...
  'ads': [{renderURL: Ad1URL, 
           buyerReportingId: 'buyerInfo123',
           selectableBuyerAndSellerReportingIds: [ 'd123s456', 'd234s567', 'd345s567' ],
  ...})

5.5 Losing Bidder Reporting

We also need to provide a mechanism for the losing bidders in the auction to learn aggregate outcomes. Certainly they should be able to count the number of times they bid, and losing ads should also be able to learn (in aggregate) some seller-provided information about e.g. the auction clearing price. Likewise, a reporting mechanism should be available to buyers who attempted to bid with a creative that had not yet reached the k-anonymity threshold.

This could be handled by a reportLoss() function running in the worklet. Alternatively, the model of SPURFOWL (an append-only datastore and later aggregate log processing) could be a good fit for this use case. The details here are yet to be determined.

6. Additional Bids

In addition to bids generated by interest groups, sellers can enable buyers to introduce bids generated outside of the auction. We refer to these as additional bids. Additional bids are commonly triggered using contextual signals. By having more contextual bids participate in the auction, we're reducing the leakage that's learned by detecting whether or not an auction produced an interest-group-based winning ad.

Buyers compute the additional bids, likely as part of a contextual auction. Buyers need to package up each additional bid using a new data structure that encapsulates all of the information needed for the additional bid to compete against other bids in a Protected Audience auction. Sellers are responsible for passing additional bids to the browser at Protected Audience auction time.

Each additional bid is expressed using the following JSON data structure:

const additionalBid = {
  "bid": {
    "ad": 'ad-metadata',
    "adCost": 2.99,
    "bid": 1.99,
    "bidCurrency": "USD",
    "render": "https://www.example-dsp.com/ad/123.jpg",
    "adComponents": [adComponent1, adComponent2],
    "allowComponentAuction": true,
    "modelingSignals": 123,
  },

  "interestGroup": {
    "owner": "https://www.example-dsp.com"
    "name": "campaign123",
    "biddingLogicURL": "https://www.example-dsp.com/bid_logic.js"
  },


  // Valid additional bids may have at most one of
  // negativeInterestGroup or negativeInterestGroups.
  "negativeInterestGroup": "campaign123_negative_interest_group",
  "negativeInterestGroups": {
    joiningOrigin: "https://www.example-advertiser.com",
    interestGroupNames: [
      "example_advertiser_negative_interest_group_a",
      "example_advertiser_negative_interest_group_b",
    ]
  },

  // Valid additional bids must have exactly one of auctionNonce or bidNonce.
  "auctionNonce": "5358e36b-741a-4619-8915-6cd5f6e4755f",
  "bidNonce": "NcMr5MCj8gB1oE4iObgFXlNgkzywbiTssxE/KdGA5YQ=",
  "seller": "https://www.example-ssp.com",
  "topLevelSeller": "https://www.another-ssp.com"
}

The fields in bid intentionally mimic those returned by generateBid(), as described in section 3.2 On-Device Bidding. These fields in the additional bid have the same semantic meaning as those returned from generateBid(), except that render and adComponents are not limited to values from a corresponding stored interest group because the additional bid is not generated from a stored interest group.

The fields in interestGroup facilitate running reportAdditionalBidWin() for an additional bid that wins an auction, as described below in section 6.4 Reporting Additional Bid Wins. biddingLogicURL is used for its definition of reportAdditionalBidWin(), while owner and name are passed to the call to that function.

Each additional bid may provide a value for at most one of the negativeInterestGroup and negativeInterestGroups fields. These fields are described below in section 6.2.2 How Additional Bids Specify their Negative Interest Groups.

The auctionNonce, bidNonce, seller, and topLevelSeller fields are used to prevent replay of this additional bid. Each additional bid must provide a value for exactly one of the auctionNonce or bidNonce fields. The auctionNonce and bidNonce fields are described below in section 6.1 Auction and Bid Nonces. The seller and topLevelSeller fields echo those present in the browserSignals argument to generateBid() as described in section 3.2 On-Device Bidding. In generateBid(), these are meant to ensure that the buyer acknowledges and accepts that their bid can participate in an auction with those parties. Additional bids don't have a corresponding call to generateBid(), and so the seller and topLevelSeller fields in an additional bid are intended to allow for the same acknowledgement as those in browserSignals.

Additional bids are not provided through the auction config passed to runAdAuction(), but rather through the response headers of a Fetch request or iframe navigation, as described below in section 6.3 HTTP Response Headers. However, the auction config still has an additionalBids field, which is a Promise with no value, used only to signal to the auction that the additional bids have arrived and are ready to be accepted in the auction. For each additional bid, its owner must be included in interestGroupBuyers for that additional bid to participate in the auction.

navigator.runAdAuction({
  // ...
  'interestGroupBuyers': ['https://www.example-dsp.com', 'https://buyer2.com', ...],
  'additionalBids': promiseFulfilledWhenTheFetchRequestCompletes,
});

6.1 Auction and Bid Nonces

To prevent unintended replaying of additional bids, any auction config, whether top-level or component auction config, must include an auction nonce value if it includes additional bids. The auction nonce is created and provided like so:

const auctionNonce = navigator.createAuctionNonce();
navigator.runAdAuction({
  // ...
  'auctionNonce':  auctionNonce,
  'additionalBids': ...,
});

The auction nonce returned by the browser will be a string representation of a UUIDv4. A seller may optionally create a second UUIDv4, referred to as the seller nonce. The seller can then combine the auction and seller nonces to produce a bid nonce, which it will need to send to each buyer that may provide additional bids. That bid nonce would then need to appear in the bidNonce field of each additional bid returned from the buyer to seller, and then from the seller to the browser's runAdAuction() invocation.

The seller must combine the auction and seller nonces to construct a bid nonce by concatenating the standard UUIDv4 string representation - 32 lower-case hexadecimal characters with blocks of 8, 4, 4, 4, and 12 separated by dashes - of the auction and seller nonces, and computing the SHA-256 hash of the resulting string. The bid nonce would be the result of this hash function expressed as a base64 string.

For backwards compatibility, the seller may instead send the auction nonce as-is to buyers, and buyers may include the auction nonce in their additional bid using the auctionNonce field.

Auctions that don't use additional bids don't need to create or provide auction, seller, or bid nonces.

6.2 Negative Targeting

In online ad auctions for ad space, it’s sometimes useful to prevent showing an ad to certain audiences, a concept known as negative targeting. For example, you might not want to show a new customer advertisement to existing customers. New customer acquisition campaigns most often have this as a critical requirement.

To facilitate negative targeting in Protected Audience auctions, each additional bid is allowed to identify one or more negative interest groups. If the user has been joined to any of the identified negative interest groups, the additional bid is dropped; otherwise it participates in the auction, competing alongside bids created by calls to generateBid(). An additional bid that specifies no negative interest groups is always accepted into the auction.

6.2.1 Negative Interest Groups

Though negative interest groups are joined using the same joinAdInterestGroup API as regular interest groups, they remain distinct from one another. Only negative interest groups can provide an additionalBidKey, and only regular interest groups can provide ads; no interest group may provide both. Relatedly, because the subset of fields used by a negative interest group cannot be meaningfully updated, any interest group that provides an additionalBidKey - a negative interest group - may not provide an updateURL. The additionalBidKey field is described in more detail in section 6.2.3 Additional Bid Keys.

const myGroup = {
  'owner': 'https://www.example-dsp.com',
  'name': 'womens-running-shoes',
  'lifetimeMs': 30 * kSecsPerDay,
  'additionalBidKey': 'EA/fR/uU8VNqT3w/2ic4P6Azdaj1J8U35vFwPEf5T4Y='
};
navigator.joinAdInterestGroup(myGroup);

6.2.2 How Additional Bids Specify their Negative Interest Groups

Additional bids specify the negative interest groups they're negatively targeting against using one of two fields in their JSON data structure - negativeInterestGroup or negativeInterestGroups.

If an additional bid only needs to specify a single negative interest group, it can do so as follows:

const additionalBid = {
  // ...
  "negativeInterestGroup": "example_advertiser_negative_interest_group",
  // ...
}

If an additional bid needs to specify two or more negative interest groups, all of those negative interest groups must be joined from the same origin, and that origin must be identified ahead of time in the additional bid using the joiningOrigin field:

const additionalBid = {
  // ...
  "negativeInterestGroups": {
    joiningOrigin: "https://example-advertiser.com",
    interestGroupNames: [
      "example_advertiser_negative_interest_group_a",
      "example_advertiser_negative_interest_group_b",
    ]
  },
  // ...
}

If a negative targeting group was joined from a different origin than that specified, the additional bid proceeds as if the negative interest group is not present. This "failing open" ensures that negative targeting can only use targeting data from a single origin. Because this origin check "fails open", buyers should make sure that negative interest groups used this way are joined from a consistent origin. An additional bid that only specifies one negative interest group is not subject to any restriction on joining origin.

6.2.3 Additional Bid Keys

We use a cryptographic signature mechanism to ensure that only the owner of a negative interest group can use it with additional bids. Each buyer will need to create a Ed25519 public/secret key pair to sign their additional bids to prove their authenticity, and to rotate their key pairs every 30 days for security.

When a buyer joins a user into a negative interest group, they must provide their current 32-byte Ed25519 public key, expressed as a base64-encoded string, via the negative interest group's additionalBidKey field. This can be seen in the example above in section 6.2.1 Negative Interest Groups.

When the buyer issues an additional bid, that bid needs to be signed using their current and previous Ed25519 secret keys. It's for this reason that additional bids may have more than one signature provided alongside the bid. The use of these two keys here supports the 30-day key rotation: the previous key is used to verify negative interest groups stored on the user's device prior to most recent key rotation, the current key is used to verify negative interest groups stored on the user's device since the most recent key rotation. Only these two keys are needed, because all previous keys will only have been used to join negative interest groups more than 30 days prior, and all of those negative interest groups are guaranteed to have expired.

If the signature doesn't verify successfully, the additional bid proceeds as if the negative interest group is not present. This "failing open" ensures that only the owner of the negative interest group, who created the additonalBidKey, is allowed to negatively target the interest group, and that nobody else can learn whether the interest group is present on the device. Because the signature check "fails open", buyers should make sure they're using the right keys; for example it might be prudent to verify a bid signature before submitting the additional bid.

To ensure a consistent binary payload is signed, the buyer first needs to stringify their additional bid - the JSON data structure seen above. The buyer then generates the necessary signatures and then bundles these together in a JSON structure we'll call the signed additional bid.

const signedAdditionalBid = {
  // "bid" is the result of JSON.stringify(additionalBid)
  "bid": "{\"interestGroup\":{\"name\":\"campaign123\"...},...}"
  "signatures": [
    {
       "key": "9TCI6ZvHsCqMvhGN0+zv67Vx3/l9Z+//mq3hY4atV14=",
       "signature": "SdEnASmeyDTjEkag+hczHtJ7wGN9f2P2E...=="
     },
     {
       "key": "eTQOmfYCmLL2gqraPJX6YjryU6hW6yHEwmdsXeNL2qA=",
       "signature": "kSz0go9iax9KNBuMTLjWoUHQvcxnus8I5...=="
     },
   ]
}

Note that the key fields are used by the browser both to verify the signature, and then to authorize the use of those negative interest groups whose additionalBidKey matched keys associated with valid signatures.

6.3 HTTP Response Headers

The browser ensures, using TLS, the authenticity and integrity of information provided to the auction through calls made directly to an ad tech's servers. This guarantee is not provided for data passed in runAdAuction(). To account for this, additional bids use the same HTTP response header interception mechanism that's already in use for the Bidding & Auction response blob and directFromSellerSignals.

Servers return additional bids to the browser using the Ad-Auction-Additional-Bid response header of some fetch() request or iframe navigation, together with the additionalBids field on navigator.runAdAuction(). This uses the same syntax as that used to convey directFromSellerSignals using response headers.

To request additional bids using a fetch() call made by some script on the page (including in a subframe), specify an extra option, {adAuctionHeaders: true}:

let fetchResponse = await fetch("https://...", {adAuctionHeaders: true});

The script must resolve the additionalBids Promise only after the response for this call has been received. If the script chooses to call runAdAuction() after this response is received, the additionalBids Promise may be immediately resolved.

To request additional bids using an iframe navigation, specify the adAuctionHeaders attribute on the iframe element:

<iframe src="https://..." adAuctionHeaders></iframe>

If script that invokes runAdAuction() is part of the response to that iframe navigation, the adAuctionHeaders Promise may be immediately resolved from within the iframe because runAdAuction() cannot be called until after the response - with its additional bid headers - has been received.

The browser will make the request for either the Fetch or the iframe navigation that it otherwise would, with the exception that the request will also include a request header, Sec-Ad-Auction-Fetch: ?1. This header indicates to the server that each Ad-Auction-Additional-Bid response header from the server will be decoded as an additional bid and loaded into the auction. Each instance of the Ad-Auction-Additional-Bid response header will correspond to a single additional bid. The response may include more than one additional bid by specifying multiple instances of the Ad-Auction-Additional-Bid response header. The structure of each instance of the Ad-Auction-Additional-Bid header must be as follows:

Ad-Auction-Additional-Bid:
    <auction nonce>:<seller nonce>:<base64-encoding of the signed additional bid>

The browser uses the auction nonce from each response header to associate each additional bid to its corresponding auction. For single-seller auctions, this maps to a particular call to runAdAuction(), whereas for multi-seller auctions, this maps to a particular component auction. The browser uses the seller nonce from each response header to compute the bid nonce used to prevent replay of this additional bid. For information on constructing a bid nonce, see 6.1 Auction and Bid Nonces.

For backwards compatibility, a seller that is passing auction nonce as-is to buyers may return an Ad-Auction-Additional-Bid header that includes only the auction nonce and not a seller nonce:

Ad-Auction-Additional-Bid:
    <auction nonce>:<base64-encoding of the signed additional bid>

Additional bids that are returned with a seller nonce in the response header must include the bidNonce field but not the auctionNonce field. Additional bids that are returned without a seller nonce in the response header must include the auctionNonce field but not the bidNonce field.

The browser uses the auction nonce prefix from each response header to associate each additional bid to its corresponding auction. For single-seller auctions, this maps to a particular call to runAdAuction(), whereas for multi-seller auctions, this maps to a particular component auction.

All Ad-Auction-Additional-Bid response headers are intercepted by the browser and diverted to participate in the auction without passing through the JavaScript context. When all of the additional bids for an auction have been received this way, the seller should resolve the additionalBids Promise passed as described above. The browser will use this as the signal that it has all of the additional bids intended for this auction.

6.4 Reporting Additional Bid Wins

For additional bids that win the auction, event-level win reporting is supported, just as it is for bids generated from stored interest groups. However, additional bids have distinct security concerns. The browser can guarantee that bids generated from stored interest groups were, in fact, generated by the buyer's origin, but it cannot provide this same guarantee for additional bids. An additional bid can only win if none of the negative interest groups specified by the additional bid are present on the user's device, and so the signature validation described above in section 6.2.3 Additional Bid Keys also can't help with this. To ensure that buyers understand that they're being asked to report on an additional bid, which cannot be verified having been generated by the buyer's origin, the reporting for additional bids is done by calling reporting functions with a slightly different name. Instead of reportWin(), the browser instead calls a function named reportAdditionalBidWin()to report a winning additional bid.

7. Debugging Extensions

7.1 forDebuggingOnly (fDO) APIs

generateBid() and scoreAd() may call a forDebuggingOnly.reportAdAuctionLoss() API for event-level reporting for losing bids, which takes a single string argument representing a URL. If the bid being generated or scored loses the auction, the URL will be fetched. These worklets may also call a forDebuggingOnly.reportAdAuctionWin() API which operates similarly to forDebuggingOnly.reportAdAuctionLoss() API but only fetches the URL after a winning bid or score. The forDebuggingOnly APIs support text placeholders ${} in the reporting URL's query parameters, which will be replaced with the corresponding value from the auction (see 7.1.1 Post Auction Signals). Callers of these APIs should avoid assembling URLs longer than browser's URL length limits (e.g. 2MB for Chrome) as these may not be reported.

generateBid(interestGroup, auctionSignals, perBuyerSignals,
    trustedBiddingSignals, browserSignals, directFromSellerSignals) {
  …
  forDebuggingOnly.reportAdAuctionLoss("https://buyer.com/debug_loss_report");
  forDebuggingOnly.reportAdAuctionWin("https://buyer.com/debug_win_report?winningBid={winningBid}");

In a multi-seller auction, the following forDebuggingOnly win reports may be sent:

forDebuggingOnly win report from generateBid() of the buyer that wins the whole auction (both the component auction and top level auction).
forDebuggingOnly win report from scoreAd() of the component seller when scoring the bid that wins the whole auction.
forDebuggingOnly win report from scoreAd() of the top-level seller when scoring the bid from the component auction that wins the whole auction.
forDebuggingOnly loss report from all other generateBid() and scoreAd() invocations.

In order to accomplish our dual goals of helping with adoption and preserving user privacy, we plan to keep the forDebuggingOnly APIs available post third-party cookie deprecation, albeit in a heavily downsampled fashion (as described in section 7.1.2) to address the re-identification risk. While third-party cookies are available, they will remain unsampled to help with adoption, and instead will have a label, exposed in generateBid()'s browserSignals.forDebuggingOnlyInCooldownOrLockout, to indicate whether the particular report would have been downsampled.

The URL passed to forDebuggingOnly.reportAdAuctionLoss() or forDebuggingOnly.reportAdAuctionWin() is required to have its site (scheme, eTLD+1) attested for Protected Audience API. Please see the Privacy Sandbox enrollment attestation model.

7.1.1 Post Auction Signals

A post auction signal is a signal which is only available after the auction completes, such as the highest scoring other bid. The forDebuggingOnly APIs support the text placeholders below, which will be replaced with the corresponding value from the auction when found in the reporting URL's query parameters.

"${winningBid}" - The value of the winning bid. In component auctions, this value comes from the component auction and not the top-level auction.
"${winningBidCurrency}" - If the auction has a sellerCurrency configured, this will be its currency tag; otherwise it is '???' to denote that it's in the bidder's original currency.
"${madeWinningBid}" - A Boolean value representing whether the owner of this interest group made the winning bid, either via this interest group, or another interest group with the same owner. In component auctions, this value comes from the component auction and not the top-level auction.
"${highestScoringOtherBid}" - The value of the bid that was scored as second highest by the seller’s scoreAd script. Note that this may not be the second highest bid value, since scores and bids may be independent. This value comes from and is only reported in component auctions but not top-level auctions, and is not reported to losing bidders.
"${highestScoringOtherBidCurrency}" - The currency highestScoringOtherBid is in. If the auction has a sellerCurrency configured, this will be its currency tag; otherwise it is '???' to denote that it's in the bidder's original currency.
"${madeHighestScoringOtherBid}" - A Boolean value representing whether the owner of this interest group made the ${highestScoringOtherBid} bid, either via this interest group, or another interest group with the same owner. This value comes from and is only reported in component auctions but not top-level auctions, and is not reported to losing bidders. If there’s a tie for ${highestScoringOtherBid} from more than one owner, this is false for all.
"${topLevelWinningBid}" - The value of the bid that won the top-level auction. This value is only reported to component sellers.
"${topLevelWinningBidCurrency}" - The currency topLevelWinningBid is in. If the top-level auction has a sellerCurrency configured, this will be its currency tag; otherwise it is '???' to denote that it's in whatever currency the component auction made the bid in.
${rejectReason} - The seller can optionally add a rejectReason field to its scoreAd() return object to convey to the bidder a more detailed reason why the bid was rejected. A component auction's bidders only get reject reasons from its component seller, but not reject reasons from the top-level seller. The reject reason returned by scoreAd() must be one of:
- "not-available", which is the default value, when a bid
  - was not rejected
  - was rejected but the seller didn’t provide a reject reason
  - the reason provided wasn't one of the above values
- "invalid-bid"
- "bid-below-auction-floor"
- "pending-approval-by-exchange"
- "disapproved-by-exchange"
- "blocked-by-publisher"
- "language-exclusions"
- "category-exclusions"
Some rejection reasons are generated automatically (and may not be set manually):
- "below-kanon-threshold"
- "wrong-generate-bid-currency"
- "wrong-score-ad-currency"
- "multi-bid-limit-exceeded"

7.1.2 Downsampling

This design has three main goals:

Prevent sending fDO reports very often to protect user privacy:
- Only sending reports 1/1000 times the forDebuggingOnly API is called, and
- If a report is sent, "lock-out" all adtechs out of sending a report for 3 years, and
- If an adtech calls the API, put them in a "cool-down" period where calls to the API by that given adtech are not able to send reports.
Prevent one adtech from substantially compromising a different adtech's access to debugging information. The "cooldown" period means that any particular adtech can only cause a very small fraction of people to send debug reports and be removed from the potential debugging pool.
Prevent adtechs who accidentally (e.g. due to a bug in their code) call the API repeatedly for all users, from locking themselves out of sending any more reports for years. This is accomplished by 90% of the time putting that adtech in a 2 week cooldown period, and only 10% of the time putting that adtech in a 1 year cooldown period.

See issue 632 for more information.

Both generateBid() and scoreAd()’s browserSignals have a new boolean field forDebuggingOnlyInCooldownOrLockout. It’s true when the API is in the global "lock-out" period, or when this particular buyer or seller, respectively, is in "cool-down" period.

7.2 navigator.deprecatedReplaceInURN()

To help with ease of adoption, until at least 2026 Protected Audience will support the navigator.deprecatedReplaceInURN() API. It takes two parameters:

The return value from runAdAuction(), which is either a urn:uuid string, or a FencedFrameConfig object.
A mapping from strings to strings. The keys are strings to be replaced, which must start and end with either "${" and "}" or "%%" and "%%". The values are strings to substitute the keys.

It modifies the true URL from a URN returned from runAdAuction() by replacing substrings specified as pairs in the replacements list. The true URLs for any component ads associated with this URN will also have substrings substituted.


const result = await navigator.runAdAuction(myAuctionConfig);
await navigator.deprecatedReplaceInURN(
   result, {'${INTEREST_GROUP_NAME}': 'render_cars', '%%echo%%': 'echo'});

Files

FLEDGE.md

Latest commit

History