forked from WICG/turtledove
-
Notifications
You must be signed in to change notification settings - Fork 0
/
spec.bs
1359 lines (1215 loc) · 73.4 KB
/
spec.bs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<pre class="metadata">
Title: FLEDGE
Shortname: fledge
Repository: WICG/turtledove
Inline Github Issues: true
Group: WICG
Status: CG-DRAFT
Level: 1
URL: https://wicg.github.io/turtledove/
Boilerplate: omit conformance, omit feedback-header
Editor: Paul Jensen, Google https://www.google.com/, pauljensen@google.com
Abstract: Provides a privacy advancing API to facilitate interest group based advertising.
!Participate: <a href="https://github.com/WICG/turtledove">GitHub WICG/turtledove</a> (<a href="https://github.com/WICG/turtledove/issues/new">new issue</a>, <a href="https://github.com/WICG/turtledove/issues?state=open">open issues</a>)
!Commits: <a href="https://github.com/WICG/turtledove/commits/main/spec.bs">GitHub spec.bs commits</a>
Complain About: accidental-2119 yes, missing-example-ids yes
Indent: 2
Default Biblio Status: current
Markup Shorthands: markdown yes
Assume Explicit For: yes
</pre>
<pre class="anchors">
urlPrefix: https://www.ietf.org/rfc/rfc4122.txt
type: dfn; text: urn uuid
</pre>
# Introduction # {#intro}
<em>This section is non-normative</em>
The FLEDGE API facilitates selecting an advertisement to display to a user based on a previous
interaction with the advertiser or advertising network.
When a user's interactions with an advertiser indicate an interest in something, the advertiser can
ask the browser to record this interest on-device by calling
{{Window/navigator}}.{{Navigator/joinAdInterestGroup()}}. Later, when a website wants to select an
advertisement to show to the user, the website can call
{{Window/navigator}}.{{Navigator/runAdAuction()}} to ask the browser to conduct an auction where
each of these on-device recorded interests are given the chance to calculate a bid to display their
advertisement.
<h2 id="joining-interest-groups">Joining Interest Groups</h2>
When a user's interactions with a website indicate that the user may have a particular interest, an
advertiser or someone working on behalf of the advertiser (e.g. a demand side platform, DSP) can ask
the user's browser to record this interest on-device by calling
{{Window/navigator}}.{{Navigator/joinAdInterestGroup()}}. This indicates an intent to display an
advertisement relevant to this interest to this user in the future. The user agent has an
<dfn>interest group set</dfn>, a [=list=] of [=interest groups=] in which
[=interest group/owner=] / [=interest group/name=] pairs are unique.
<xmp class="idl">
[SecureContext]
partial interface Navigator {
Promise<undefined> joinAdInterestGroup(AuctionAdInterestGroup group, double durationSeconds);
};
dictionary AuctionAd {
required USVString renderUrl;
any metadata;
};
dictionary AuctionAdInterestGroup {
required USVString owner;
required USVString name;
double priority = 0.0;
boolean enableBiddingSignalsPrioritization = false;
record<DOMString, double> priorityVector;
record<DOMString, double> prioritySignalsOverrides;
DOMString executionMode = "compatibility";
USVString biddingLogicUrl;
USVString biddingWasmHelperUrl;
USVString dailyUpdateUrl;
USVString trustedBiddingSignalsUrl;
sequence<USVString> trustedBiddingSignalsKeys;
any userBiddingSignals;
sequence<AuctionAd> ads;
sequence<AuctionAd> adComponents;
};
</xmp>
<div algorithm="joinAdInterestGroup()">
The <dfn for=Navigator method>joinAdInterestGroup(|group|, |durationSeconds|)</dfn> method steps
are:
1. If [=this=]'s [=relevant global object=]'s [=associated Document=] is not [=allowed to use=] the
"[=join-ad-interest-group=]" [=policy-controlled feature=], then [=exception/throw=] a
"{{NotAllowedError}}" {{DOMException}}.
1. Let |interestGroup| be a new [=interest group=].
1. Validate the given |group| and set |interestGroup|'s fields accordingly.
1. Set |interestGroup|'s [=interest group/expiry=] to now plus |durationSeconds|.
1. Let |ownerUrl| be the result of running the [=URL parser=] on
|group|["{{AuctionAdInterestGroup/owner}}"].
1. If |ownerUrl| is an error, or its [=url/scheme=] is not "`https`", [=exception/throw=] a
{{TypeError}}.
1. Set |interestGroup|'s [=interest group/owner=] to |ownerUrl|'s [=url/origin=].
1. Set |interestGroup|'s [=interest group/name=] to |group|["{{AuctionAdInterestGroup/name}}"].
1. Set |interestGroup|'s [=interest group/priority=] to
|group|["{{AuctionAdInterestGroup/priority}}"].
1. Set |interestGroup|'s [=interest group/enable bidding signals prioritization=] to
|group|["{{AuctionAdInterestGroup/enableBiddingSignalsPrioritization}}"].
1. If |group|["{{AuctionAdInterestGroup/priorityVector}}"] [=map/exists=], then set
|interestGroup|'s [=interest group/priority vector=] to
|group|["{{AuctionAdInterestGroup/priorityVector}}"].
1. If |group|["{{AuctionAdInterestGroup/prioritySignalsOverrides}}"] [=map/exists=], then set
|interestGroup|'s [=interest group/priority signals overrides=] to
|group|["{{AuctionAdInterestGroup/prioritySignalsOverrides}}"].
1. Set |interestGroup|'s [=interest group/execution mode=] to
|group|["{{AuctionAdInterestGroup/executionMode}}"].
1. For each |groupMember| and |interestGroupField| in the following table <table class="data">
<thead><tr><th>Group member</th><th>Interest group field</th></tr></thead>
<tr>
<td>"{{AuctionAdInterestGroup/biddingLogicUrl}}"</td>
<td>[=interest group/bidding url=]</td>
</tr>
<tr>
<td>"{{AuctionAdInterestGroup/biddingWasmHelperUrl}}"</td>
<td>[=interest group/bidding wasm helper url=]</td>
</tr>
<tr>
<td>"{{AuctionAdInterestGroup/dailyUpdateUrl}}"</td>
<td>[=interest group/daily update url=]</td>
</tr>
<tr>
<td>"{{AuctionAdInterestGroup/trustedBiddingSignalsUrl}}"</td>
<td>[=interest group/trusted bidding signals url=]</td>
</tr>
</table>
1. If |group| [=map/contains=] |groupMember|:
1. Let |parsedUrl| be the result of running the [=URL parser=] on |group|[|groupMember|].
1. [=exception/Throw=] a {{TypeError}} if any of the following conditions hold:
* |parsedUrl| is an error;
* |parsedUrl| is not [=same origin=] with |interestGroup|'s [=interest group/owner=];
* |parsedUrl| [=includes credentials=];
* |parsedUrl| [=url/fragment=] is not null.
1. Set |interestGroup|'s |interestGroupField| to |parsedUrl|.
1. If |interestGroup|'s [=interest group/trusted bidding signals url=]'s [=url/query=] is not
null, then [=exception/throw=] a {{TypeError}}.
1. If |group|["{{AuctionAdInterestGroup/trustedBiddingSignalsKeys}}"] [=map/exists=], then set
|interestGroup|'s [=interest group/trusted bidding signals keys=] to
|group|["{{AuctionAdInterestGroup/trustedBiddingSignalsKeys}}"].
1. If |group|["{{AuctionAdInterestGroup/userBiddingSignals}}"] [=map/exists=]:
1. Let |interestGroup|'s [=interest group/user bidding signals=] be the result of
[=serializing a JavaScript value to a JSON string=], given
|group|["{{AuctionAdInterestGroup/userBiddingSignals}}"]. This can [=exception/throw=] a
{{TypeError}}.
1. For each |groupMember| and |interestGroupField| in the following table <table class="data">
<thead><tr><th>Group member</th><th>Interest group field</th></tr></thead>
<tr>
<td>"{{AuctionAdInterestGroup/ads}}"</td>
<td>[=interest group/ads=]</td>
</tr>
<tr>
<td>"{{AuctionAdInterestGroup/adComponents}}"</td>
<td>[=interest group/ad components=]</td>
</tr>
</table>
1. [=list/For each=] |ad| of |group|[|groupMember|]:
1. Let |igAd| be a new [=interest group ad=].
1. Let |renderUrl| be the result of running the [=URL parser=] on
|ad|["{{AuctionAd/renderUrl}}"].
1. [=exception/Throw=] a {{TypeError}} if any of the following conditions hold:
* |renderUrl| is an error;
* |renderUrl| [=url/scheme=] is not "`https`";
* |renderUrl| [=includes credentials=].
1. Set |igAd|'s [=interest group ad/render url=] to |renderUrl|.
1. If |ad|["{{AuctionAd/metadata}}"] [=map/exists=], then let
|igAd|'s [=interest group ad/metadata=] be the result of
[=serializing a JavaScript value to a JSON string=], given |ad|["{{AuctionAd/metadata}}"].
This can [=exception/throw=] a {{TypeError}}.
1. [=list/Append=] |igAd| to |interestGroup|'s |interestGroupField|.
1. If |interestGroup|'s [=interest group/estimated size=] is greater than 50 KB, then
[=exception/throw=] a {{TypeError}}.
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|:
1. TODO: document .well-known fetches for cross-origin joins.
1. [=Queue a task=] to [=resolve=] |p| with `undefined`.
1. If the browser is currently storing an interest group with `owner` and `name` that matches
|interestGroup|, then set the [=interest group/bid counts=],
[=interest group/join counts=], and [=interest group/previous wins=] of
|interestGroup| to the values of the currently stored one and remove
the currently stored one from the browser.
1. Set |interestGroup|'s [=interest group/joining origin=] to [=this=]'s
[=relevant settings object=]'s [=environment/top-level origin=].
1. If the most recent entry in [=interest group/join counts=] corresponds to
the current local day, increment its count. If not, insert a new entry with
the time set to the current local day and a count of 1.
1. Store |interestGroup| in the browser’s [=interest group set=].
1. Return |p|.
</div>
The <dfn for="interest group">estimated size</dfn> of an [=interest group=] |ig| is the sum of:
1. The [=string/length=] of the [=serialization of an origin|serialization=] of |ig|'s
[=interest group/owner=].
1. The [=string/length=] of |ig|'s [=interest group/name=].
1. 8 bytes, which is the size of |ig|'s [=interest group/priority=].
1. The [=string/length=] of |ig|'s [=interest group/execution mode=].
1. 2 bytes, which is the size of |ig|'s [=interest group/enable bidding signals prioritization=].
1. If |ig|'s [=interest group/priority vector=] is not null, [=map/for each=] |key| → |value| of
[=interest group/priority vector=]:
1. The [=string/length=] of |key|.
1. 8 bytes, which is the size of |value|.
1. If |ig|'s [=interest group/priority signals overrides=] is not null, [=map/for each=] |key| →
|value| of [=interest group/priority signals overrides=]:
1. The [=string/length=] of |key|.
1. 8 bytes, which is the size of |value|.
1. The size of [=interest group/execution mode=].
1. The [=string/length=] of the [=URL serializer|serialization=] of |ig|'s
[=interest group/bidding url=], if the field is not null.
1. The [=string/length=] of the [=URL serializer|serialization=] of |ig|'s
[=interest group/bidding wasm helper url=], if the field is not null.
1. The [=string/length=] of the [=URL serializer|serialization=] of |ig|'s
[=interest group/daily update url=], if the field is not null.
1. The [=string/length=] of the [=URL serializer|serialization=] of |ig|'s
[=interest group/trusted bidding signals url=], if the field is not null.
1. [=list/For each=] |key| of |ig|'s [=interest group/trusted bidding signals keys=]:
1. The [=string/length=] of |key|.
1. The [=string/length=] of |ig|'s [=interest group/user bidding signals=].
1. If |ig|'s [=interest group/ads=] is not null, [=list/for each=] |ad| of it:
1. The [=string/length=] of the [=URL serializer|serialization=] of |ad|'s
[=interest group ad/render url=].
1. The [=string/length=] of |ad|'s [=interest group ad/metadata=] if the field is not null.
1. If |ig|'s [=interest group/ad components=] is not null, [=list/for each=] |ad| of it:
1. The [=string/length=] of the [=URL serializer|serialization=] of |ad|'s
[=interest group ad/render url=].
1. The [=string/length=] of |ad|'s [=interest group ad/metadata=] if the field is not null.
<h2 id="leaving-interest-groups">Leaving Interest Groups</h2>
In order to remove a user from a particular interest group,
{{Window/navigator}}.{{Navigator/leaveAdInterestGroup()}} can be called.
TODO: Edit the following from the explainer. 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 isn't supported inside a component ad
frame.
<xmp class="idl">
[SecureContext]
partial interface Navigator {
Promise<undefined> leaveAdInterestGroup(AuctionAdInterestGroupKey group);
};
dictionary AuctionAdInterestGroupKey {
required USVString owner;
required USVString name;
};
</xmp>
The <dfn for=Navigator method>leaveAdInterestGroup(group)</dfn> method steps
are:
1. If [=this=]'s [=relevant global object=]'s [=associated Document=] is not [=allowed to use=] the
"[=join-ad-interest-group=]" [=policy-controlled feature=], then [=exception/throw=] a
"{{NotAllowedError}}" {{DOMException}}.
1. Let |ownerUrl| be the result of running the [=URL parser=] on
|group|["{{AuctionAdInterestGroupKey/owner}}"].
1. If |ownerUrl| is failure, [=exception/throw=] a {{TypeError}}.
1. Let |owner| be |ownerUrl|'s [=url/origin=].
1. Let |name| be |group|["{{AuctionAdInterestGroupKey/name}}"].
1. Let |p| be [=a new promise=].
1. Run these steps [=in parallel=]:
1. TODO: document .well-known fetches for cross-origin leaves.
1. [=Queue a task=] to [=resolve=] |p| with `undefined`.
1. [=list/Remove=] [=interest groups=] from the user agent's [=interest group set=] whose
[=interest group/owner=] is |owner| and [=interest group/name=] is |name|.
1. Return |p|.
<h2 id="running-ad-auctions">Running Ad Auctions</h2>
When a website or someone working on behalf of the website (e.g. a supply side platform, SSP) wants
to conduct an auction to select an advertisement to display to the user, they can call the
{{Window/navigator}}.{{Navigator/runAdAuction()}} function, providing an auction configuration that
tells the browser how to conduct the auction and which on-device recorded interests are allowed to
bid in the auction for the chance to display their advertisement.
<h3 id="script-runners">Script Runners</h3>
An additional requirement to the interest group script runner globals defined in this specification
is that they must not expose any interfaces from other specifications whose own exposure set is the
special value "*". The only interfaces that can be exposed inside of the globals defined in this
specification are those that explicitly list the global names provided here.
<pre class="idl">
[Exposed=InterestGroupBiddingScriptRunnerGlobalScope,
Global=InterestGroupBiddingScriptRunnerGlobalScope]
interface InterestGroupBiddingScriptRunnerGlobalScope {
boolean setBid();
boolean setBid(GenerateBidOutput generateBidOutput);
undefined setPriority(double priority);
undefined setPrioritySignalsOverride(DOMString key, double priority);
};
[Exposed=InterestGroupScoringScriptRunnerGlobalScope,
Global=InterestGroupScoringScriptRunnerGlobalScope]
interface InterestGroupScoringScriptRunnerGlobalScope {
};
[Exposed=InterestGroupReportingScriptRunnerGlobalScope,
Global=InterestGroupReportingScriptRunnerGlobalScope]
interface InterestGroupReportingScriptRunnerGlobalScope {
undefined sendReportTo(DOMString url);
};
dictionary AdRender {
required DOMString url;
required DOMString width;
required DOMString height;
};
dictionary GenerateBidOutput {
required double bid;
required (DOMString or AdRender) adRender;
DOMString ad;
sequence<(DOMString or AdRender)> adComponents;
double adCost;
double modelingSignals;
boolean allowComponentAuction = false;
};
</pre>
Issue: Finish specifying the following algorithms.
<div algorithm>
The <dfn method for="InterestGroupBiddingScriptRunnerGlobalScope">setBid()</dfn> method steps are:
1. Clear the bid. TODO: figure out how to integrate this with runAdAuction.
1. Return true.
</div>
<div algorithm>
The <dfn method for="InterestGroupBiddingScriptRunnerGlobalScope">setBid(|generateBidOutput|)</dfn>
method steps are:
1. Clear the bid. TODO: expand.
1. If |generateBidOutput|["{{GenerateBidOutput/bid}}"] is less than or equal to 0, return true.
1. If it's a component auction (TODO: how to integrate with runAdAuction), but
|generateBidOutput|["{{GenerateBidOutput/allowComponentAuction}}"] is false, return false.
1. Let |bidToSet| be a new [=generated bid=].
1. Set |bidToSet|'s [=generated bid/bid=] to |generateBidOutput|["{{GenerateBidOutput/bid}}"].
1. If |generateBidOutput|["{{GenerateBidOutput/ad}}"] [=map/exists=]:
1. Let |adJson| be the result of [=serializing a JavaScript value to a JSON string=], given
|generateBidOutput|["{{GenerateBidOutput/ad}}"].
1. If |adJson| is failure, return failure.
1. Set |bidToSet|'s [=generated bid/ad=] to |adJson|.
1. Let |adDescriptor| be a new [=ad descriptor=].
1. If |generateBidOutput|["{{GenerateBidOutput/adRender}}"] is a {{DOMString}}:
1. Let |adUrl| be the result of running the [=URL parser=] on
|generateBidOutput|["{{GenerateBidOutput/adRender}}"].
1. If |adUrl| is an error, return false.
1. If [=validating an ad url=] given |adUrl| returns false, return false.
1. Set |adDescriptor|'s [=ad descriptor/url=] to |adUrl|.
1. Otherwise:
1. Set |adDescriptor| to the result of [=converting an ad render=] given
|generateBidOutput|["{{GenerateBidOutput/adRender}}"].
1. If |adDescriptor| is failure, return false.
1. Set |bidToSet|'s [=generated bid/ad descriptor=] to |adDescriptor|.
1. If |generateBidOutput|["{{GenerateBidOutput/adComponents}}"] [=map/exists=]:
1. Let |adComponents| be |generateBidOutput|["{{GenerateBidOutput/adComponents}}"].
1. Return false if any of the following conditions hold:
* biddingScriptRunner's adComponents parameter does not exist; TODO: rewrite.
* |adComponents| is not an array;
* |adComponents|'s size is greater than 20 (MaxAdAuctionAdComponents, TODO: define this as a
vendor specific value?).
1. Let |adComponentDescriptors| be a new [=list=] of [=ad descriptors=].
1. For |component| in |adComponents|:
1. Let |componentDescriptor| be a new [=ad descriptor=].
1. If |component| is {{DOMString}}:
1. Let |componentUrl| be the result of running the [=URL parser=] on |component|.
1. If |componentUrl| is an error, return false.
1. If [=validating an ad url=] given |componentUrl| returns false, return false.
1. Set |componentDescriptor|'s [=ad descriptor/url=] to |componentUrl|.
1. Otherwise:
1. Set |componentDescriptor| to the result of [=converting an ad render=] given |component|.
1. If |componentDescriptor| is failure, return false.
1. [=list/Append] |componentDescriptor| to |adComponentDescriptors|.
1. Set |bidToSet|'s [=generated bid/ad component descriptors=] to |adComponentDescriptors|.
1. If |generateBidOutput|["{{GenerateBidOutput/adCost}}"] [=map/exists=]:
1. Set |bidToSet|'s [=generated bid/ad cost=] to
|generateBidOutput|["{{GenerateBidOutput/adCost}}"].
1. If |generateBidOutput|["{{GenerateBidOutput/modelingSignals}}"] [=map/exists=]:
1. Let |modelingSignals| be |generateBidOutput|["{{GenerateBidOutput/modelingSignals}}"].
1. If |modelingSignals| is greater than or equal to 0 and less than 4096:
1. Set |bidToSet|'s [=generated bid/modeling signals=] to |modelingSignals|
1. Set bid to |bidToSet|.
1. Return true.
</div>
<div algorithm>
To <dfn>convert an ad render</dfn> given an {{AdRender}} |adRender|:
1. If |adRender|["{{AdRender/url}}"] does not [=map/exist=], return false.
1. Let |adUrl| be the result of running the [=URL parser=] on |adRender|["{{AdRender/url}}"].
1. If |adUrl| is an error, return failure.
1. If [=validating an ad url=] given |adUrl| returns false, return failure.
1. Let |adDescriptor| be a new [=ad descriptor=].
1. Set |adDescriptor|'s [=ad descriptor/url=] to |adUrl|.
1. If |adRender|["{{AdRender/width}}"] [=map/exists=]:
1. If |adRender|["{{AdRender/height}}"] does not [=map/exist=], return failure.
1. Let |width| and |widthUnit| be the result of parsing (TODO) |adRender|["{{AdRender/width}}"].
1. Let |height| and |heightUnit| be the result of parsing (TODO)
|adRender|["{{AdRender/height}}"].
1. Return failure if any of the following conditions hold:
* |width| is non-positive, or non-finite;
* |height| is non-positive, or non-finite;
* |widthUnit| is not "px" or "sw";
* |heightUnit| is not "px" or "sw".
1. Let |adSize| be a new [=ad size=].
1. Set |adSize|'s [=ad size/width=] to |width|, [=ad size/width units=] to |widthUnit|,
[=ad size/height=] to |height|, [=ad size/height units=] to |heightUnit|.
1. Set |adDescriptor|'s [=ad descriptor/size=] to |adSize|.
1. Return |adDescriptor|.
</div>
<div algorithm>
To <dfn>validate an ad url</dfn> given a [=URL=] |adUrl|:
1. If |adUrl|'s [=url/scheme=] is not "`https`", return false.
1. TODO: If it's not in the related interest group's ads, or is excluded, return false.
1. Return true.
</div>
<div algorithm>
The <dfn method for="InterestGroupBiddingScriptRunnerGlobalScope">setPriority(|priority|)</dfn>
method steps are:
1. If not first time calling this method:
1. Reset priority and return.
1. Set priority to |priority|. TODO: figure out how to integrate this into generateBid().
</div>
<div algorithm>
The <dfn method for="InterestGroupBiddingScriptRunnerGlobalScope">setPrioritySignalsOverride(|key|, |priority|)</dfn>
method steps are:
1. Update (insert or assign) prioritySignals[|key|] to |priority|. TODO: figure out how to
integrate this into generateBid().
</div>
<div algorithm>
The <dfn method for="InterestGroupReportingScriptRunnerGlobalScope">sendReportTo(|url|)</dfn>
method steps are:
1. [=exception/Throw=] a {{TypeError}} and clears report url if any of the following conditions hold:
* The API is called more than once;
* |url|'s [=url/scheme=] is not "`https`".
1. If called in reportWin(), set reportWinURL to url.
1. If called in reportResult(), set reportResultURL to url.
</div>
<h3 id="runadauction">runAdAuction()</h3>
<xmp class="idl">
[SecureContext]
partial interface Navigator {
Promise<USVString?> runAdAuction(AuctionAdConfig config);
};
dictionary AuctionAdConfig {
required USVString seller;
required USVString decisionLogicUrl;
USVString trustedScoringSignalsUrl;
sequence<USVString> interestGroupBuyers;
any auctionSignals;
any sellerSignals;
USVString directFromSellerSignals;
unsigned long long sellerTimeout;
unsigned short sellerExperimentGroupId;
record<USVString, any> perBuyerSignals;
record<USVString, unsigned long long> perBuyerTimeouts;
record<USVString, unsigned short> perBuyerGroupLimits;
record<USVString, unsigned short> perBuyerExperimentGroupIds;
record<USVString, record<USVString, double>> perBuyerPrioritySignals;
sequence<AuctionAdConfig> componentAuctions = [];
AbortSignal? signal;
};
</xmp>
<div algorithm="runAdAuction()">
The <dfn for=Navigator method>runAdAuction(|config|)</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 |auctionConfig| be the result of running [=validate and convert auction ad config=] with
|config| and [=validate and convert auction ad config/isTopLevel=] set to true.
1. If |auctionConfig| is failure, then [=exception/throw=] a {{TypeError}}.
1. Let |p| be [=a new promise=].
1. If |config|["{{AuctionAdConfig/signal}}"] [=map/exists=], then:
1. Let |signal| be |config|["{{AuctionAdConfig/signal}}"].
1. If |signal| is [=AbortSignal/aborted=], then [=reject=] |p| with |signal|'s
[=AbortSignal/abort reason=] and return |p|.
1. [=AbortSignal/Add|Add the following abort steps=] to |signal|:
1. TODO: Specify. Abort the auction. If the auction has already completed, this has no
effect. Otherwise, stop running new worklet functions, and do not cause side-effects, like
reporting and updating bid statistics.
1. [=Reject=] |p| with |signal|’s [=AbortSignal/abort reason=].
1. Let |queue| be the result of [=starting a new parallel queue=].
1. [=parallel queue/enqueue steps|Enqueue the following steps=] to |queue|:
1. Let |winner| be the result of running [=generate and score bids=] with |auctionConfig|,
null, and |global|.
1. TODO: If |winner| is failure, fail the auction with manually_aborted set to true.
1. TODO: If |winner| is null, fail the auction with manually_aborted set to false.
1. [=Queue a global task=] on [=DOM manipulation task source=], given |global|, to resolve |p|
with |winner|'s [=generated bid/ad descriptor=]. TODO: resolve |p| with urn-uuid, instead of a
URL.
1. Run [=generate reporting URLs=] with |auctionConfig| and |winner|.
1. Update interest groups post-auction. Execute the algorithm [=interest group update=] using
|config|["{{AuctionAdConfig/interestGroupBuyers}}"] as `owners`.
1. TODO: Update bidCount and prevWins for interest groups that participated in the auction.
1. Return |p|.
</div>
<div algorithm="validate and convert auction ad config">
To <dfn>validate and convert auction ad config</dfn> given an {{AuctionAdConfig}} |config| and a
[=boolean=] <dfn for="validate and convert auction ad config">|isTopLevel|</dfn>:
1. Let |auctionConfig| be a new [=auction config=].
1. Let |seller| be the result of running the [=URL parser=] on
|config|["{{AuctionAdConfig/seller}}"].
1. [=exception/Throw=] a {{TypeError}} if |seller| is an error, or its [=url/scheme=] is not
"`https`".
1. Set |auctionConfig|'s [=auction config/seller=] to |seller|.
1. Let |decisionLogicUrl| be the result of running the [=URL parser=] on
|config|["{{AuctionAdConfig/decisionLogicUrl}}"].
1. [=exception/Throw=] a {{TypeError}} if |decisionLogicUrl| is an error, or it is not
[=same origin=] with |auctionConfig|'s [=auction config/seller=].
1. [=Assert=]: |decisionLogicUrl|'s [=url/scheme=] is "`https`".
1. Set |auctionConfig|'s [=auction config/decision logic url=] to |decisionLogicUrl|.
1. If |config|["{{AuctionAdConfig/trustedScoringSignalsUrl}}"] [=map/exists=]:
1. Let |trustedScoringSignalsUrl| be the result of running the [=URL parser=] on
|config|["{{AuctionAdConfig/trustedScoringSignalsUrl}}"].
1. [=exception/Throw=] a {{TypeError}} if |trustedScoringSignalsUrl| is an error,
or it is not [=same origin=] with |auctionConfig|'s [=auction config/seller=].
1. [=Assert=]: |trustedScoringSignalsUrl|'s [=url/scheme=] is "`https`".
1. Set |auctionConfig|'s [=auction config/trusted scoring signals url=] to
|trustedScoringSignalsUrl|.
1. If |config|["{{AuctionAdConfig/interestGroupBuyers}}"] [=map/exists=], let |buyers| be a new
[=list/is empty|empty=] [=list=].
1. [=list/For each=] |buyerString| in |config|["{{AuctionAdConfig/interestGroupBuyers}}"]:
1. Let |buyer| be the result of [=parsing an origin=] with |buyerString|. If |buyer| is an
error, or |buyer|'s [=url/scheme=] is not "`https`", then [=exception/throw=] a {{TypeError}}.
Otherwise, [=list/append=] |buyer| to |buyers|.
1. Set |auctionConfig|'s [=auction config/interest group buyers=] to |buyers|.
1. If |config|["{{AuctionAdConfig/auctionSignals}}"] [=map/exists=], let |auctionConfig|'s
[=auction config/auction signals=] be the result of
[=serializing a JavaScript value to a JSON string=], given
|config|["{{AuctionAdConfig/auctionSignals}}"].
1. If |config|["{{AuctionAdConfig/sellerSignals}}"] [=map/exists=], let |auctionConfig|'s
[=auction config/seller signals=] of be the result of
[=serializing a JavaScript value to a JSON string=], given
|config|["{{AuctionAdConfig/sellerSignals}}"].
1. If |config|["{{AuctionAdConfig/directFromSellerSignals}}"] [=map/exists=], let
|directFromSellerSignalsPrefix| be the result of running the [=URL parser=] on
|config|["{{AuctionAdConfig/directFromSellerSignals}}"].
1. [=exception/Throw=] a {{TypeError}} if any of the following conditions hold:
* |directFromSellerSignalsPrefix| is an error;
* |directFromSellerSignalsPrefix| is not [=same origin=] with |auctionConfig|'s
[=auction config/seller=];
* |directFromSellerSignalsPrefix|'s [=url/query=] is not null.
1. [=Assert=]: |directFromSellerSignalsPrefix|'s [=url/scheme=] is "`https`".
1. TODO: Figure out how to deal with DirectFromSellerSignals.
1. If |config|["{{AuctionAdConfig/sellerTimeout}}"] [=map/exists=], set |auctionConfig|'s
[=auction config/seller timeout=] to min(|config|["{{AuctionAdConfig/sellerTimeout}}"], 500)
milliseconds.
1. If |config|["{{AuctionAdConfig/sellerExperimentGroupId}}"] [=map/exists=]:
1. Set |auctionConfig|'s [=auction config/seller experiment group id=] to
|config|["{{AuctionAdConfig/sellerExperimentGroupId}}"].
1. If |config|["{{AuctionAdConfig/perBuyerSignals}}"] [=map/exists=], [=map/for each=] |key| →
|value| of |config|["{{AuctionAdConfig/perBuyerSignals}}"]:
1. Let |buyer| be the result of [=parsing an origin=] with |key|. If |buyer| is an error,
[=exception/throw=] a {{TypeError}}.
1. Let |signalsString| be the result of [=serializing a JavaScript value to a JSON string=], given
|value|.
1. [=map/Set=] |auctionConfig|'s [=auction config/per buyer signals=][|buyer|] to
|signalsString|.
1. If |config|["{{AuctionAdConfig/perBuyerTimeouts}}"] [=map/exists=], [=map/for each=] |key| →
|value| of |config|["{{AuctionAdConfig/perBuyerTimeouts}}"]:
1. If |key| equals to "*", then set |auctionConfig|'s [=auction config/all buyers timeout=]
to min(|value|, 500) milliseconds, and [=iteration/continue=].
1. Let |buyer| the result of [=parsing an origin=] with |key|. If |buyer| is an error,
[=exception/throw=] a {{TypeError}}.
1. [=map/Set=] |auctionConfig|'s [=auction config/per buyer timeouts=][|buyer|] to
min(|value|, 500) milliseconds.
1. If |config|["{{AuctionAdConfig/perBuyerGroupLimits}}"] [=map/exists=], [=map/for each=]
|key| → |value| of |config|["{{AuctionAdConfig/perBuyerGroupLimits}}"]:
1. If |value| is 0, [=exception/throw=] a {{TypeError}}.
1. If |key| equals to "*", then set |auctionConfig|'s [=auction config/all buyers group limit=]
to |value|, and [=iteration/continue=].
1. Let |buyer| be the result of [=parsing an origin=] with |key|. If |buyer| is an error,
[=exception/throw=] a {{TypeError}}.
1. [=map/Set=] |auctionConfig|'s [=auction config/per buyer group limits=][|buyer|] to |value|.
1. If |config|["{{AuctionAdConfig/perBuyerExperimentGroupIds}}"] [=map/exists=], [=map/for each=]
|key| → |value| of |config|["{{AuctionAdConfig/perBuyerExperimentGroupIds}}"]:
1. If |key| equals to "*", then set |auctionConfig|'s
[=auction config/all buyer experiment group id=] to |value|, and [=iteration/continue=].
1. Let |buyer| the result of [=parsing an origin=] with |key|. If |buyer| is an error,
[=exception/throw=] a {{TypeError}}.
1. [=map/Set=] |auctionConfig|'s [=auction config/per buyer experiment group ids=][|buyer|] to
|value|.
1. If |config|["{{AuctionAdConfig/perBuyerPrioritySignals}}"] [=map/exists=], [=map/for each=]
|key| → |value| of |config|["{{AuctionAdConfig/perBuyerPrioritySignals}}"]:
1. Let |signals| be an [=ordered map=] whose [=map/keys=] are [=strings=] and whose [=map/values=]
are {{double}}.
1. [=map/for each=] |k| → |v| of |value|:
1. If |k| [=string/starts with=] "browserSignals.", [=exception/throw=] a {{TypeError}}.
1. Set |signals|[|k|] to |v|.
1. If |key| equals to "*", then set |auctionConfig|'s
[=auction config/all buyers priority signals=] to |value|, and [=iteration/continue=].
1. Let |buyer| be the result of [=parsing an origin=] with |key|. If it fails, [=exception/throw=]
a {{TypeError}}.
1. [=map/Set=] |auctionConfig|'s [=auction config/per buyer priority signals=][|buyer|] to
|signals|.
1. [=list/For each=] |component| in |config|["{{AuctionAdConfig/componentAuctions}}"]:
1. If |isTopLevel| is false, [=exception/throw=] a {{TypeError}}.
1. Let |componentAuction| be the result of running [=validate and convert auction ad config=] with
|component| and [=validate and convert auction ad config/isTopLevel=] set to false.
1. [=list/Append=] |componentAuction| to |auctionConfig|'s [=auction config/component auctions=].
1. Return |auctionConfig|.
</div>
To <dfn>parse an origin</dfn> given a [=string=] |input|:
1. Let |url| be the result of running the [=URL parser=] on |input|.
1. If |url| is an error, then return failure.
1. Return |url|'s [=url/origin=].
<div algorithm>
To <dfn>build bid generators map</dfn> given an [=auction config=] |auctionConfig|:
1. Let |bidGenerators| be a new [=ordered map=] whose [=map/keys=] are [=url/origins=] and whose
[=map/values=] are [=per buyer bid generators=].
1. [=list/For each=] |buyer| in |auctionConfig|'s [=auction config/interest group buyers=]:
1. [=list/For each=] |ig| of the user agent's [=interest group set=] whose
[=interest group/owner=] is |buyer|:
1. Let |signalsUrl| be |ig|'s [=interest group/trusted bidding signals url=].
1. Let |joiningOrigin| be |ig|'s [=interest group/joining origin=].
1. If |bidGenerators| does not [=map/contain=] |buyer|:
1. Let |perBuyerGenerator| be a new [=per buyer bid generator=].
1. Let |perSignalsUrlGenerator| be a new [=per signals url bid generator=].
1. [=map/Set=] |perSignalsUrlGenerator|[|joiningOrigin|] to « |ig| ».
1. [=map/Set=] |perBuyerGenerator|[|signalsUrl|] to |perSignalsUrlGenerator|.
1. [=map/Set=] |bidGenerators|[|buyer|] to |perBuyerGenerator|.
1. TODO: add a perBiddingScriptUrlGenerator layer that replaces the list of IGs with a map
from biddingScriptUrl to a list of IGs.
1. Otherwise:
1. Let |perBuyerGenerator| be |bidGenerators|[|buyer|].
1. If |perBuyerGenerator| does not [=map/contain=] |signalsUrl|:
1. Let |perSignalsUrlGenerator| be a new [=per signals url bid generator=].
1. [=map/Set=] |perSignalsUrlGenerator|[|joiningOrigin|] to « |ig| ».
1. [=map/Set=] |perBuyerGenerator|[|signalsUrl|] to |perSignalsUrlGenerator|.
1. Otherwise:
1. Let |perSignalsUrlGenerator| be |perBuyerGenerator|[|signalsUrl|].
1. If |perSignalsUrlGenerator| does not [=map/contain=] |joiningOrigin|:
1. [=map/Set=] |perSignalsUrlGenerator|[|joiningOrigin|] to « |ig| ».
1. Otherwise:
1. [=list/Append=] |ig| to |perSignalsUrlGenerator|[|joiningOrigin|].
1. Return |bidGenerators|.
</div>
<div algorithm>
To <dfn>generate and score bids</dfn> given an [=auction config=] |auctionConfig|, an
[=auction config=]-or-null |topLevelAuctionConfig|, and a [=global object=] |global|:
1. [=Assert=] that these steps are running [=in parallel=].
1. Let |decisionLogicScript| be the result of [=creating a seller script runner=] with
|auctionConfig|'s [=auction config/decision logic url=].
1. If |decisionLogicScript| is failure, return null.
1. Let |bidGenerators| be the result of running [=build bid generators map=] with |auctionConfig|.
1. Let |leadingBidInfo| be a new [=leading bid info=].
1. Let |queue| be the result of [=starting a new parallel queue=].
1. If |auctionConfig|'s [=auction config/component auctions=] are not [=list/is empty|empty=]:
1. [=Assert=] |topLevelAuctionConfig| is null.
1. Let |pendingComponentAuctions| be the [=list/size=] of |auctionConfig|'s
[=auction config/component auctions=].
1. [=list/For each=] |component| in |auctionConfig|'s [=auction config/component auctions=],
[=parallel queue/enqueue steps|enqueue the following steps=] to |queue|:
1. Let |compWinner| be the result of [=generate and score bids=] with |component|,
|auctionConfig|, and |global|.
1. If |compWinner| is not failure or null, [=score and rank a bid=] with |auctionConfig|,
|compWinner|, |leadingBidInfo|, |desisionLogicScript|, and true.
1. Decrement |pendingComponentAuctions| by 1.
1. Wait until |pendingComponentAuctions| is 0.
1. Return |leadingBidInfo|'s [=leading bid info/leading bid=].
1. Let |allBuyersExperimentGroupId| be |auctionConfig|'s
[=auction config/all buyer experiment group id=].
1. Let |auctionSignals| be |auctionConfig|'s [=auction config/auction signals=].
1. Let |browserSignals| be an [=ordered map=] whose [=map/keys=] are [=strings=] and whose
[=map/values=] are {{any}}.
1. TODO: Set |browserSignals|'s "topWindowHostname" to hostname of top window
1. [=map/Set=] |browserSignals|["seller"] to |auctionConfig|'s [=auction config/seller=].
1. If |topLevelAuctionConfig| is not null:
1. [=map/Set=] |browserSignals|["topLevelSeller"] to the [=serialization of an origin|serialization=] of |topLevelAuctionConfig|'s [=auction config/seller=].
1. Let |pendingBuyers| be the [=map/size=] of |bidGenerators|.
1. [=map/For each=] |buyer| → |perBuyerGenerator| of |bidGenerators|,
[=parallel queue/enqueue steps|enqueue the following steps=] to |queue|:
1. Let |buyerExperimentGroupId| be |allBuyersExperimentGroupId|.
1. Let |perBuyerExperimentGroupIds| be |auctionConfig|'s
[=auction config/per buyer experiment group ids=].
1. If |perBuyerExperimentGroupIds| is not null and |perBuyerExperimentGroupIds|[|buyer|] exists:
1. Set |buyerExperimentGroupId| to |perBuyerExperimentGroupIds|[|buyer|].
1. Let |perBuyerSignals| be |auctionConfig|'s [=auction config/per buyer signals=][|buyer|] if that
member [=map/exists=], and null otherwise.
1. If |auctionConfig|'s [=auction config/per buyer signals=] is not null and [=auction config/per buyer signals=][|buyer|] [=map/exists=]:
1. Let |perBuyerSignals| be |auctionConfig|'s [=auction config/per buyer signals=][|buyer|].
1. Otherwise:
1. Let |perBuyerSignals| be null.
1. [=map/For each=] |signalsUrl| -> |perSignalsUrlGenerator| of |perBuyerGenerator|:
1. Let |keys| be a new [=ordered set=].
1. Let |igNames| be a new [=ordered set=].
1. [=map/For each=] joiningOrigin -> |groups| of |perSignalsUrlGenerator|:
1. [=list/For each=] |ig| of |groups|:
1. [=set/Append=] |ig|'s [=interest group/trusted bidding signals keys=] to |keys|.
1. [=set/Append=] |ig|'s [=interest group/name=] to |igNames|.
1. Let |fullSignalsUrl| be the result of [=building trusted bidding signals url=] with
|signalsUrl|, |keys|, |igNames|, |buyerExperimentGroupId|.
1. Let |trustedBiddingSignals| be the result of [=fetching resource=] with |fullSignalsUrl|
and "application/json".
1. TODO: If |trustedBiddingSignals| is failure, fail the auction with manually_aborted set to
true.
1. [=map/For each=] joiningOrigin -> |groups| of |perSignalsUrlGenerator|:
1. [=list/For each=] |ig| of |groups|:
1. TODO: create bidder script runner. If failed, [=iteration/continue=].
1. TODO: Let |interestGroup| be ... from |ig| ... minus priority and prioritySignalsOverrides and any browser-defined pieces
1. Set |browserSignals|'s "joinCount" to the sum of |ig|'s
[=interest group/join counts=] for all days within the last 30 days.
1. Set |browserSignals|'s "bidCount" to the sum of |ig|'s
[=interest group/bid counts=] for all days within the last 30 days.
1. Set |browserSignals|'s "prevWins" to a [=list=] containing
[=tuple=]s of the time and the corresponding winning
[=interest group ad=] from |ig|'s [=interest group/previous wins=]
field with a data within the last 30 days. The time field is
specified in seconds relative to the start of the auction.
1. TODO: Set |browserSignals|'s "wasmHelper" ...need to fetch and prepare WebAssembly.Module object based on |ig|'s [=interest group/bidding wasm helper url=]
1. TODO: Set |browserSignals|'s "dataVersion" ...to Data-Version value from the trusted bidding signals server's response(s)
1. Let |biddingScript| be the result of [=fetching resource=] with |ig|'s
[=interest group/bidding url=], and "text/javascript". If |biddingScript| is an error,
[=iteration/continue=].
1. TODO: Let |generatedBid| be the result of [=evaluating script=] with
[=evaluate script/script=] set to |biddingScript|, [=evaluate script/functionName=] set
to "generateBid", and [=evaluate script/arguments=] set to « |interestGroup|, |auctionSignals|, |perBuyerSignals|, |trustedBiddingSignals|, |browserSignals| ».
1. If |generatedBid|'s [=generated bid/bid=] is negative or 0, [=iteration/continue=].
1. Set |generatedBid|'s [=generated bid/interest group=] to |ig|.
1. TODO: Validate other fields of |generatedBid|.
1. [=Score and rank a bid=] with |auctionConfig|, |generatedBid|, |leadingBidInfo|,
|desisionLogicScript| and false.
1. Decrement |pendingBuyers| by 1.
1. Wait until |pendingBuyers| is 0.
1. Return |leadingBidInfo|'s [=leading bid info/leading bid=].
</div>
<div algorithm>
To <dfn>score and rank a bid</dfn> given an [=auction config=] |auctionConfig|, a [=generated bid=]
|generatedBid|, a [=leading bid info=] |leadingBidInfo|, a [=string=] |decisionLogicScript|, and a
[=boolean=] |hasComponentAuction|:
1. TODO: Assemble and fetch trusted scoring signals
1. TODO: Let |adMetadata| be ... maybe include in [=generated bid=]
1. Let |bid| be |generatedBid|'s [=generated bid/bid=].
1. TODO: Let |trustedScoringSignals| ... need to assemble and fetch these
1. Let |browserSignals| be an [=ordered map=] whose [=map/keys=] are [=strings=] and whose
[=map/values=] are {{any}}.
1. TODO: Set |browserSignals|'s "topWindowHostname" to hostname of top window
1. [=map/Set=] |browserSignals|["interestGroupOwner"] to |generatedBid|'s
[=generated bid/interest group]'s [=interest group/owner=].
1. [=map/Set=] |browserSignals|["renderUrl"] to |generatedBid|'s [=generated bid/ad descriptor=]'s
[=ad descriptor/url=].
1. TODO: Set |browserSignals|'s "adComponents" to ...need to pass in as part of |generatedBid|
1. TODO: Set |browserSignals|'s "biddingDurationMsec" to ...need to calculate and pass in
1. TODO: Set |browserSignals|'s "dataVersion" ...to Data-Version value from the trusted scoring
signals server's response.
1. TODO: Remove fields of |auctionConfig| that don't pass through.
1. TODO: Let |scoreAdOutput| be the result of [=evaluating script=] with
[=evaluate script/script=] set to |decisionLogicScript|,
[=evaluate script/functionName=] set to "scoreAd", and [=evaluate script/arguments=] set to
« |adMetadata|, |bid|, |auctionConfig|, |trustedScoringSignals|, |browserSignals| ».
1. If |hasComponentAuction| is true, and |scoreAdOutput|'s
[=score ad output/allow component auction=] is false, return.
1. Let |score| be |scoreAdOutput|'s [=score ad output/desirability=].
1. If |score| is negative or 0, return.
1. Let |maybeModifiedBid| be |generatedBid|.
1. If |hasComponentAuction| is true and |scoreAdOutput|'s [=score ad output/bid=] is not null:
1. Set |maybeModifiedBid|'s [=generated bid/bid=] to |scoreAdOutput|'s [=score ad output/bid=].
1. If |score| is greater than |leadingBidInfo|'s [=leading bid info/top score=]:
1. Set |leadingBidInfo|'s [=leading bid info/top score=] to |score|.
1. Set |leadingBidInfo|'s [=leading bid info/leading bid=] to |maybeModifiedBid|.
1. Set |leadingBidInfo|'s [=leading bid info/top bids count=] to 1.
1. Otherwise if |score| equals to |leadingBidInfo|'s [=leading bid info/top score=]:
1. Increment |leadingBidInfo|'s [=leading bid info/top bids count=] by 1.
1. Set |leadingBidInfo|'s [=leading bid info/leading bid=] to |maybeModifiedBid| with 1 in
|leadingBidInfo|'s [=leading bid info/top bids count=] chance.
</div>
To <dfn>create a seller script runner</dfn> given a [=URL=] |decisionLogicUrl|:
1. TODO: create the script runner and set up environment.
1. Let |decisionLogicScript| be the result of [=fetching resource=] with |decisionLogicUrl|, and
"text/javascript".
1. Return |decisionLogicScript|.
To <dfn>create a request</dfn> given a [=URL=] |url|, and a [=string=] <dfn for="create a request">
|accept|</dfn>:
1. Let |request| be a new [=request=] with the following properties:
: [=request/URL=]
:: |url|
: [=request/header list=]
:: A new [=header list=] containing a [=header=] named "`Accept`" whose value is |accept|
: [=request/client=]
:: `null`
: [=request/window=]
:: "`no-window`" TODO: verify
: [=request/service-workers mode=]
:: "`none`"
: [=request/origin=]
:: [=opaque origin=]
: [=request/referrer=]
:: "`no-referrer`"
: [=request/credentials mode=]
:: "`omit`"
: [=request/cache mode=]
:: "`no-store`"
: [=request/redirect mode=]
:: "`error`"
1. Return |request|.
<div algorithm>
To <dfn>fetch resource</dfn> given a [=URL=] |url|, and a [=string=] |mimeType|:
1. Let |request| be the result of [=creating a request=] with |url|, and [=create a request/accept=]
set to |mimeType|.
1. Let |resource| be null.
1. [=Fetch=] |request| with [=fetch/processResponseConsumeBody=] set to the following steps given a
[=response=] |response| and |responseBody|:
1. If |responseBody| is null or failure, set |resource| to failure and return.
1. Let |headers| be |response|'s [=response/header list=].
1. If [=header list/getting a structured field value=] "X-Allow-FLEDGE" from |headers| does not
return true, set |resource| to failure and return.
1. Let |headerMimeType| be the result of [=header list/extracting a MIME type=] from |headers|.
1. Set |resource| to failure and return, if any of the following conditions hold:
* |headerMimeType| is failure;
* |mimeType| is "`text/javascript`" and |headerMimeType| is not a [=JavaScript MIME type=];
* |mimeType| is "`application/json`" and |headerMimeType| is not a [=JSON MIME type=].
1. Let |mimeTypeCharset| be |headerMimeType|'s [=MIME type/parameters=]["`charset`"].
1. Set |resource| to failure and return if any of the following conditions hold:
* If |mimeTypeCharset| does not [=map/exist=], or |mimeTypeCharset| is "utf-8", and
|responseBody| is not [=UTF-8=] encoded;
* If |mimeTypeCharset| is "us-ascii", and |responseBody| is not [=ascii string=].
1. Set |resource| to |responseBody|.
1. Wait for |resource| to be set.
1. Return |resource|.
</div>
<div algorithm>
To <dfn>build trusted bidding signals url</dfn> given a [=URL=] |signalsUrl|, an [=ordered set=] of
[=strings=] |keys|, an [=ordered set=] of [=strings=] |igNames|, and a {{unsigned short}}
|experimentGroupId|:
1. Let |queryParamsList| be a new [=list/is empty|empty=] [=list=].
1. [=list/Append=] "hostname=" to |queryParamsList|.
1. [=list/Append=] the result of [=string/UTF-8 percent-encoding=] [=this=]'s
[=relevant settings object=]'s [=environment/top-level origin=] using
[=component percent-encode set=] to |queryParamsList|.
1. If |keys| is not [=set/is empty|empty=]:
1. [=list/Append=] "&keys=" to |queryParamsList|.
1. Let |keysStr| be the result of [=string/concatenating=] |keys| with separator set to ",".
1. [=list/Append=] the result of [=string/UTF-8 percent-encoding=] |keysStr| using
[=component percent-encode set=] to |queryParamsList|.
1. If |igNames| is not [=set/is empty|empty=]:
1. [=list/Append=] "&interestGroupNames=" to |queryParamsList|.
1. Let |igNamesStr| be the result of [=string/concatenating=] |igNames| with separator set to ",".
1. [=list/Append=] the result of [=string/UTF-8 percent-encoding=] |igNamesStr| using
[=component percent-encode set=] to |queryParamsList|.
1. If |experimentGroupId| is not null:
1. [=list/Append=] "&experimentGroupId=" to |queryParamsList|.
1. [=list/Append=] [=serialize an integer|serialized=] |experimentGroupId| to |queryParamsList|.
1. Let |fullSignalsUrl| be |signalsUrl|.
1. Set |fullSignalsUrl|'s [=url/query=] to the result of [=string/concatenating=] |queryParamsList|.
1. return |fullSignalsUrl|.
</div>
To <dfn>serialize an integer</dfn>, represent it as a string of the shortest possible decimal
number.
Issue: This would ideally be replaced by a more descriptive algorithm in Infra. See
<a href="https://github.com/whatwg/infra/issues/201">infra/201</a>
To <dfn>evaluate script</dfn> with given [=string=] <dfn for="evaluate script">|script|</dfn>,
[=string=] <dfn for="evaluate script">|functionName|</dfn>, and a [=list=]
<dfn for="evaluate script">|arguments|</dfn>:
1. TODO: Return an object or null, which is the result of evaluating |script|'s |functionName| with
|arguments|.
TODO: something like the steps below that need spec-ifying, though some pieces like fetching the
script should likely be pulled out:
1. Allocate the right process/thread (these are called agent clusters/agents respectively, in ES
land) that's going to host the script. That's basically one of the algorithms in:
https://html.spec.whatwg.org/multipage/webappapis.html#integration-with-the-javascript-agent-cluster-formalism.
Might actually literally be able to re-use
https://html.spec.whatwg.org/multipage/webappapis.html#obtaining-a-worker/worklet-agent, but not
sure; otherwise make a new one. This is done in step 6 of [1]
1. Create a new realm and execution
context. Realms are basically ES environments that run script. This is where the global object in
the environment is defined, so something like FledgeScriptRunner IDL interface that has to create
and define (non-user-supplied) methods on. See step 7 of [1], but step 8 substep 5 of [2] is maybe
better:
https://html.spec.whatwg.org/multipage/document-lifecycle.html#shared-document-creation-infrastructure:creating-a-new-javascript-realm.
1. Setup the environment or environment settings object. So in HTML an "environment settings
object" is-a "environment". It is used to set a special internal slot on the ES "realm" so that ES
can call back up into the HTML Standard when it needs things that aren't defined in HTML. May not
need this at all — assuming script doesn't resolve URLs, fetch things from within the worklet, or
access anything time-related. A realm's default "\[\[HostDefined\]\]" slot is undefined
(https://tc39.es/ecma262/#table-realm-record-fields) which is likely valid for this use-case.
1. Fetch the script resource. Everything under step 5 of
https://html.spec.whatwg.org/multipage/webappapis.html#fetch-a-classic-script can give some idea of
how to do this and extract the string body appropriately etc
1. Create the "script". This basically
means parsing the source text inside the ES realm that was created earlier. See this step for more
information, though it won't need much of the rest of that algorithm:
https://html.spec.whatwg.org/multipage/webappapis.html#creating-a-classic-script:~:text=Let%20result%20be%20ParseScript(source%2C%20settings%27s%20realm%2C%20script),
since this spec wants to create "a classic script" as defined by HTML.
1. Run the script: basically call ES's ScriptEvaluation(), like
https://html.spec.whatwg.org/multipage/webappapis.html#run-a-classic-script does), although it'll
probably need to do some of what that algorithm's step 3 ("Prepare to run a script") does (pushing
the current realm's execution context on the stack). This will produce something called a
CompletionRecord which will contain any value that the script contained
(https://tc39.es/ecma262/#sec-completion-record-specification-type).
1. Run user-provided function.
I think just "running the script" isn't probably appropriate here though. This step will want to
actually run a specific function inside the script. In that case, an example of doing this is the
last 3 steps of:
https://html.spec.whatwg.org/multipage/worklets.html#fakeworkletglobalscope-process. Not clear how
to pluck the generateBid() function off the global though. Maybe something like "Let function be
Get(realm.\[\[Global\]\], "generateBid"). Rethrow any exceptions." and then either invoke it
directly or covert it to a WebIDL function and use WebIDL to "invoke" that.
[1]: https://html.spec.whatwg.org/multipage/workers.html#run-a-worker
[2]:
https://html.spec.whatwg.org/multipage/document-lifecycle.html#shared-document-creation-infrastructure
<div algorithm>
To <dfn>generate reporting URLs</dfn> given an {{AuctionAdConfig}} |config| and a [=generated bid=]
|bid|:
1. Let |sellerReportingScript| be the result of [=fetching resource=] with |config|'s
[=auction config/decision logic url=], and "text/javascript".
1. Let |auctionSignals| be |auctionConfig|'s [=auction config/auction signals=].
1. Let |browserSignals| be an [=ordered map=] whose [=map/keys=] are [=strings=] and whose
[=map/values=] are {{any}}.
1. TODO: [=map/Set=] |browserSignals|["topWindowHostname"] to hostname of top window.
1. TODO: [=map/Set=] |browserSignals|["topLevelSeller"] to the top level seller.
1. TODO: [=map/Set=] |browserSignals|["componentSeller"] to the component seller.
1. [=map/Set=] |browserSignals|["interestGroupOwner"] to |bid|'s [=generated bid/interest group=]'s
[=interest group/owner=].
1. [=map/Set=] |browserSignals|["renderUrl"] to |bid|'s [=generated bid/ad descriptor=]'s
[=ad descriptor/url=].
1. [=map/Set=] |browserSignals|["bid"] to |bid|'s [=generated bid/bid=].
1. TODO: [=map/Set=] |browserSignals|["desirability"] to the desirability score.
1. TODO: [=map/Set=] |browserSignals|["topLevelSellerSignals] to the top level sellers signals.
1. TODO: [=map/Set=] |browserSignals|["dataVersion"] to the version from the key value response.
1. TODO: [=map/Set=] |browserSignals|["modifiedBid"] to the modified bid value.
1. TODO: [=map/Set=] |browserSignals|["highestScoringOtherBid"] to the highest scoring other bid
value.
1. TODO: Let |sellerSignals| be the result of [=evaluating script=] with
[=evaluate script/script=] set to |sellerReportingScript|, [=evaluate script/functionName=] set
to "reportResult", and [=evaluate script/arguments=] set to « |auctionSignals|, |browserSignals| ».
1. Let |buyerReportingScript| be the result of [=fetching resource=] with |bid|'s
[=generated bid/interest group=|'s [=interest group/bidding url=], and "text/javascript".
1. Let |perBuyerSignals| be |auctionConfig|'s
[=auction config/per buyer signals=][|browserSignals|["interestGroupOwner"]] if that member
[=map/exists=], and null otherwise.
1. [=map/Remove=] |browserSignals|["desirability"].
1. TODO: [=map/Set=] |browserSignals|["interestGroupName"] to |bid|'s
[=generated bid/interest group=]'s [=interest group/name=] if the tuple of interest group owner,
name, bidding script URL and ad creative URL were jointly k-anonymous.
1. TODO: [=map/Set=] |browserSignals|["madeHighestScoringOtherBid"] to true if the interest group
owner was the only bidder that made bids with the second highest score.
1. TODO: [=map/Set=] |browserSignals|["highestScoringOtherBid"] and [=map/Set=]
|browserSignals|["madeHighestScoringOtherBid"] 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.
1. TODO: [=map/Set=] |browserSignals|["dataVersion"] to contain the Data-Version from the trusted