Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

[spec] Add Bidding and auction payload customization support #1274

Merged
merged 11 commits into from
Sep 30, 2024
Merged

[spec] Add Bidding and auction payload customization support #1274

Changes from 8 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
8341eed
Add payload optimization
brusshamilton Sep 9, 2024
b71d3bf
Add missing =
brusshamilton Sep 9, 2024
301c989
Add constraint on request size
brusshamilton Sep 11, 2024
25b26c4
Apply suggestions from code review
brusshamilton Sep 24, 2024
cf727df
Address comments
brusshamilton Sep 24, 2024
39dc5ee
Address comments
brusshamilton Sep 26, 2024
8520661
Add domintro for AdAuctionDataConfig
brusshamilton Sep 27, 2024
a3c1fc1
Fix missing description
brusshamilton Sep 27, 2024
6efdfb5
Apply suggestions from code review
brusshamilton Sep 27, 2024
d921d5a
Describe values of {{AdAuctionDataConfig/perBuyerConfig}}
brusshamilton Sep 27, 2024
22cb44a
Fix filtering logic
brusshamilton Sep 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 118 additions & 4 deletions spec.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2862,17 +2862,52 @@ partial interface Navigator {
Promise<AdAuctionData> getInterestGroupAdAuctionData(AdAuctionDataConfig config);
};

dictionary AdAuctionData {
required Uint8Array request;
required USVString requestId;
};
</xmp>

<xmp class="idl">
dictionary AdAuctionDataConfig {
required USVString seller;
required USVString coordinatorOrigin;
unsigned long requestSize;
record<USVString, AdAuctionDataBuyerConfig> perBuyerConfig;
};
</xmp>

dictionary AdAuctionData {
required Uint8Array request;
required USVString requestId;
<dl class=domintro>
<dt>{{AdAuctionDataConfig/seller}}
<dd>The seller that will be used as the {{AuctionAdConfig/seller}} in the
following {{AuctionAdConfig}} passed to {{Window/navigator}}.{{Navigator/runAdAuction()}}.
<dt>{{AdAuctionDataConfig/coordinatorOrigin}}
<dd>The origin of the coordinator hosting public encryption keys for the server
running the ad auction. The [=origin/scheme=] must be "`https`". An implementation
may select which coordinators are acceptable.
brusshamilton marked this conversation as resolved.
Show resolved Hide resolved
<dt>{{AdAuctionDataConfig/requestSize}}
<dd>The desired size for the returned response. If any buyers are specified in
brusshamilton marked this conversation as resolved.
Show resolved Hide resolved
the per-buyer config, this will be the exact size of the returned request.
brusshamilton marked this conversation as resolved.
Show resolved Hide resolved
Otherwise the returned request will be at most the
brusshamilton marked this conversation as resolved.
Show resolved Hide resolved
{{AdAuctionDataConfig/requestSize}}.
<dt>{{AdAuctionDataConfig/perBuyerConfig}}
<dd>A [=map=] whose [=map/keys=] are [=origins=] are the buyers that should
qingxinwu marked this conversation as resolved.
Show resolved Hide resolved
be included in the returned request.
brusshamilton marked this conversation as resolved.
Show resolved Hide resolved
</dl>

<xmp class="idl">
dictionary AdAuctionDataBuyerConfig {
unsigned long targetSize;
};
</xmp>

<dl class=domintro>
<dt>{{AdAuctionDataBuyerConfig/targetSize}}
<dd>The size of the request to allocate for this buyer. Required when
{{AdAuctionDataConfig}}'s {{AdAuctionDataConfig/requestSize}} is not
specified.
</dl>

A <dfn>server auction interest group</dfn> is a [=struct=] with the following [=struct/items=]:
<dl dfn-for="server auction interest group">
: <dfn>name</dfn>
Expand All @@ -2889,6 +2924,9 @@ A <dfn>server auction interest group</dfn> is a [=struct=] with the following [=
from the [=interest group/ad components=] field.
: <dfn>browser signals</dfn>
:: A [=server auction browser signals=].
: <dfn>priority</dfn>
:: A {{double}}. Used to select which interest groups for a given buyer are excluded
from the serialized request due to space limitations.
</dl>

A <dfn>server auction browser signals</dfn> is a [=struct=] with the following [=struct/items=]:
Expand Down Expand Up @@ -2931,11 +2969,12 @@ A <dfn>server auction request context</dfn> is a [=struct=] with the following [

<div algorithm="getInterestGroupAdAuctionData()">

The <dfn for=Navigator method>getInterestGroupAdAuctionData(|config|)</dfn> method steps are:
The <dfn for=Navigator method>getInterestGroupAdAuctionData(|configIDL|)</dfn> method steps are:

1. Let |global| be [=this=]'s [=relevant global object=].
1. If |global|'s [=associated Document=] is not [=allowed to use=] the "[=run-ad-auction=]"
[=policy-controlled feature=], then [=exception/throw=] a "{{NotAllowedError}}" {{DOMException}}.
1. Let |config| be the result of running [=parse and verify ad auction data config=] on |configIDL|.
1. Let |p| be [=a new promise=].
1. Let |queue| be the result of [=starting a new parallel queue=].
1. [=parallel queue/enqueue steps|Enqueue the following steps=] to |queue|:
Expand All @@ -2944,6 +2983,9 @@ The <dfn for=Navigator method>getInterestGroupAdAuctionData(|config|)</dfn> meth
1. [=list/For each=] |ig| of the [=user agent=]'s [=interest group set=]:
1. If |ig|'s [=interest group/ads=] is null or [=list/is empty=], [=iteration/continue=].
1. Let |owner| be |ig|'s [=interest group/owner=].
1. If |config|'s [=auction data config/per buyer config=] [=map/is empty=] or
brusshamilton marked this conversation as resolved.
Show resolved Hide resolved
|config|'s [=auction data config/per buyer config=][|owner|] does not
[=map/exist=], then [=iteration/continue=].
1. If |igMap|[|owner|] does not [=map/exist=], then [=map/set=] |igMap|[|owner|] to a new [=list=].
1. Let |ads| be a new [=list=].
1. [=list/For each=] |ad| in |ig|'s [=interest group/ads=], [=list/append=] |ad|'s [=interest group ad/ad render ID=] to |ads|.
Expand Down Expand Up @@ -2983,6 +3025,8 @@ The <dfn for=Navigator method>getInterestGroupAdAuctionData(|config|)</dfn> meth
:: |components|
: [=server auction interest group/browser signals=]
:: |browserSignals|
: [=server auction interest group/priority=]
:: |ig|'s [=interest group/priority=]
1. [=list/Append=] |serverIg| to |igMap|[|owner|].
1. Let |result| be a new {{AdAuctionData}}.
1. Let |requestId| be the [=string representation=] of a [=version 4 UUID=].
Expand All @@ -3003,6 +3047,51 @@ The <dfn for=Navigator method>getInterestGroupAdAuctionData(|config|)</dfn> meth

</div>

<div algorithm>
To <dfn>parse and verify ad auction data config</dfn> given an {{AdAuctionDataConfig}} |configIDL|:

1. Let |seller| be the result of running [=parse an https origin=] on
|configIDL|["{{AdAuctionDataConfig/seller}}"].
1. Let |coordinator| be the result of running [=parse an https origin=] on
|configIDL|["{{AdAuctionDataConfig/coordinatorOrigin}}"].
1. If |seller| or |coordinator| are failure, then [=exception/throw=] a {{TypeError}}.
1. Let |config| be a new [=auction data config=] with the following [=struct/items=]:
: [=auction data config/seller=]
:: |seller|
: [=auction data config/coordinator=]
:: |coordinator|
: [=auction data config/request size=]
:: |configIDL|["{{AdAuctionDataConfig/requestSize}}"] if it [=map/exists=], null otherwise
: [=auction data config/per buyer config=]
:: The result of running [=parse per buyer auction data configs=] on
|configIDL|["{{AdAuctionDataConfig/perBuyerConfig}}"]
1. If |config|'s [=auction data config/per buyer config=] [=map/is not empty=]
and |config|'s [=auction data config/request size=] is null:
1. Let |requestSize| be 0.
1. [=list/For each=] |buyerConfig| of |config|'s [=auction data config/per buyer config=]'s [=map/values=]:
1. If |buyerConfig|'s [=auction data buyer config/size=] is null,
brusshamilton marked this conversation as resolved.
Show resolved Hide resolved
then [=exception/throw=] a {{TypeError}}.
1. Set |requestSize| to |requestSize| + |buyerConfig|'s [=auction data buyer config/size=].
1. Set |config|'s [=auction data config/request size=] to |requestSize|.
1. Return |config|.
</div>

<div algorithm>
To <dfn>parse per buyer auction data configs</dfn> given an
{{AdAuctionDataBuyerConfig}} |perBuyerConfigIDL|:
1. Let |configs| be a new [=ordered map=] whose [=map/keys=] are [=origins=]
and whose [=map/values=] are [=auction data configs=].
1. [=map/For each=] |buyerIDL| → |buyerConfigIDL| of |perBuyerConfigIDL|:
1. Let |buyerConfig| be a new [=auction data buyer config=].
1. Set |buyerConfig|'s [=auction data buyer config/size=] to
|buyerConfigIDL|["{{AdAuctionDataBuyerConfig/targetSize}}"] if it
[=map/exists=], null otherwise.
qingxinwu marked this conversation as resolved.
Show resolved Hide resolved
1. Let |buyer| be the result of running [=parse an https origin=] on |buyerIDL|.
1. If |buyer| is failure, then [=exception/throw=] a {{TypeError}}.
1. [=map/Set=] |configs|[|buyer|] to |buyerConfig|.
1. Return |configs|.
</div>

# Reporting # {#reporting}

## {{InterestGroupBiddingAndScoringScriptRunnerGlobalScope/forDebuggingOnly}} ## {#for-debugging-only-header}
Expand Down Expand Up @@ -7284,6 +7373,31 @@ for a given [=k-anonymity key=]. These records are stored in the [=user agent=].
:: The [=moment=] when the k-anonymity status in this record was last fetched.
</dl>

<h3 id=auction-data-config-header>auction data config</h3>

An <dfn>auction data config</dfn> is a [=struct=] with the following [=struct/items=]:

<dl dfn-for="auction data config">
: <dfn>seller</dfn>
:: An [=origin=].
The origin of the seller running the ad auction. The [=origin/scheme=] must be "`https`".
: <dfn>coordinator</dfn>
:: The origin of the coordinator hosting public encryption keys for the server
running the ad auction. The [=origin/scheme=] must be "`https`".
: <dfn>request size</dfn>
qingxinwu marked this conversation as resolved.
Show resolved Hide resolved
:: {{unsigned long}} or null. An optional field, containing the desired size
for the returned encrypted request blob.
: <dfn>per buyer config</dfn>
:: A [=map=] whose [=map/keys=] are [=origins=] and [=map/values=] are [=auction data buyer config=].
</dl>

An <dfn>auction data buyer config</dfn> is a [=struct=] with the following [=struct/items=]:
<dl dfn-for="auction data buyer config">
: <dfn>size</dfn>
:: {{unsigned long}} or null. An optional field, initially null, containing the
brusshamilton marked this conversation as resolved.
Show resolved Hide resolved
size of the request to allocate to this buyer.
</dl>

# Privacy Considerations # {#privacy-considerations}

Protected Audience aims to advance the privacy of remarketing and custom audience
Expand Down
Loading