Skip to content

Clean up definition lists #179

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

Merged
merged 2 commits into from
May 28, 2025
Merged

Clean up definition lists #179

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b740aeb
Use definition list for impression construction
apasel422 May 27, 2025
0624437
Use definitions with HTTP API fields
apasel422 May 27, 2025
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
34 changes: 19 additions & 15 deletions api.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1247,17 +1247,21 @@ The <dfn method for=PrivateAttribution>saveImpression(|options|)</dfn> method st
1. If any result in |conversionSites| is failure, return {{SyntaxError}}.
1. If the Private Attribution API is [[#opt-out|disabled]], return.
1. Construct |impression| as a [=impression|saved impression=] comprising:
* [=impression/Match Value=] set to
|options|.{{PrivateAttributionImpressionOptions/matchValue}}.
* [=impression/Impression Site=] set to |site|.
* [=impression/Intermediary Site=] set to |intermediarySite|.
* [=impression/Conversion Sites=] set to |conversionSites|.
* [=impression/Timestamp=] set to |timestamp|.
* [=impression/Lifetime=] set to
|options|.{{PrivateAttributionImpressionOptions/lifetimeDays}},
multiplied by a [=duration=] of one day.
* [=impression/Histogram Index=] set to
|options|.{{PrivateAttributionImpressionOptions/histogramIndex}}.
: [=impression/Match Value=]
:: |options|.{{PrivateAttributionImpressionOptions/matchValue}}
: [=impression/Impression Site=]
:: |site|
: [=impression/Intermediary Site=]
:: |intermediarySite|
: [=impression/Conversion Sites=]
:: |conversionSites|
: [=impression/Timestamp=]
:: |timestamp|
: [=impression/Lifetime=]
:: |options|.{{PrivateAttributionImpressionOptions/lifetimeDays}},
multiplied by a [=duration=] of one day
: [=impression/Histogram Index=]
:: |options|.{{PrivateAttributionImpressionOptions/histogramIndex}}
1. Save |impression| to the [=impression store=].

<p class=advisement><a method for=PrivateAttribution>saveImpression()</a>
Expand Down Expand Up @@ -1493,26 +1497,26 @@ the {{PrivateAttributionImpressionOptions}} dictionary passed to
<a method for=PrivateAttribution>saveImpression()</a>.

<dl dfn-for=save-impression>
<dt><code>conversion-sites</code></dt>
<dt><dfn noexport><code>conversion-sites</code></dfn></dt>
<dd>
Value of <a dict-member for=PrivateAttributionImpressionOptions>conversionSites</a>,
a [=structured header/inner list=] containing [=structured header/string|strings=].
Each string value includes a domain name using A-labels only;
[[RFC5890|Internationalized Domain Names]] therefore need to use [[RFC3492|punycode]].
This key is optional. If not supplied, an empty set is saved for [=impression/Conversion Sites=].
</dd>
<dt><code>histogram-index</code></dt>
<dt><dfn noexport><code>histogram-index</code></dfn></dt>
<dd>
Value of <a dict-member for=PrivateAttributionImpressionOptions>histogramIndex</a>,
a non-negative [=structured header/integer=]. This key is required.
</dd>
<dt><code>match-value</code></dt>
<dt><dfn noexport><code>match-value</code></dfn></dt>
<dd>
Value of <a dict-member for=PrivateAttributionImpressionOptions>matchValue</a>,
a non-negative [=structured header/integer=]. This key is optional.
If not supplied, a value of 0 is saved for [=impression/Match Value=].
</dd>
<dt><code>lifetime-days</code></dt>
<dt><dfn noexport><code>lifetime-days</code></dfn></dt>
<dd>
Value of <a dict-member for=PrivateAttributionImpressionOptions>lifetimeDays</a>,
a positive [=structured header/integer=]. This key is optional.
Expand Down
Loading