Continue work on API #10
Conversation
api.bs
Outdated
| <pre> | ||
| navigator.privateAttribution.saveImpression({ | ||
| aggregator: "aggregator.example", // the name of the aggregation system | ||
| index: 3, // the histogram index for counting this impression | ||
| aggregator: "aggregator.example", | ||
| histogramIndex: 3, | ||
| ad: "sample-campaign-eijb", // a unique identifier for the ad placement | ||
| target: "advertiser.example", // the advertiser site where a conversion will occur | ||
| conversionSite: "advertiser.example", // the advertiser site where a conversion will occur | ||
| }); | ||
| </pre> |
There was a problem hiding this comment.
We should probably wrap this in a <div class=example> and put some words in.
There was a problem hiding this comment.
I was considering getting rid of the examples entirely, given that the detailed descriptions of the parameters will include the information that is in the comments here. Do you think it's worth keeping them?
There was a problem hiding this comment.
I'm a fan of using examples to illustrate how things work. Maybe I can suggest removing them from here and then adding an examples section at the top of the API section, so that you can give a bit of an overview of how things fit together.
As for the rules... we're not doing an explainer so we should have that sort of explainy stuff in there somewhere.
api.bs
Outdated
| <xmp class=idl> | ||
| dictionary PrivateAttributionImpressionOptions { | ||
| required DOMString aggregator; | ||
| required unsigned long histogramIndex; | ||
| required DOMString ad; | ||
| required DOMString target; | ||
| required DOMString conversionSite; | ||
| unsigned long expiration; |
There was a problem hiding this comment.
JavaScript uses long for dates as well. So this might be confused.
It might pay to call this keepFor or lifetime or duration or something like that so that it isn't mistaken for an absolute time.
api.bs
Outdated
| </dd> | ||
| <dt><dfn>expiration</dfn></dt> | ||
| <dd> | ||
| A "time to live" (in seconds) after which the [=impression=] can no longer |
There was a problem hiding this comment.
JavaScript does times in milliseconds by default, but I think that even seconds is a bit silly for this. If our lookback is in days, what do you think about making this a duration in days as well?
There was a problem hiding this comment.
I think days makes sense. I got seconds from the google doc.
api.bs
Outdated
| Expiration: The number of seconds an [=/impression=] remains eligible for attribution, | ||
| Expiration: either from the call to <a>saveImpression()</a>, or a [=/user agent=]-defined limit. |
There was a problem hiding this comment.
Oh, that's how you do line continuations? Gross.
Co-authored-by: Martin Thomson <[email protected]>
* Updates for not passing `aggregator` to `saveImpression`. * Change `expiration` to `lifetimeDays`.
No description provided.