Define intermediary interactions with the API #208
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This doesn't look like a lot, but there's a whole bunch here. 1. There is a discussion of the rule of intermediaries in the API. This is pretty brief for now, but we can expand it over time. 2. There is a longer discussion about what it means to construct a histogram. There's a new concept here that is introduced, of histogram definition. This allows me to explain that the semantics of each of the histogram indices used by impressions that are selected by the same `measureConversion()` call need to be consistent. This section describes the set of tools that the API provides for ensuring that this is possible. 3. Those tools are then defined. The various `intermediarySites` options are renamed. I've named these `impressionCallers` (on the conversion site) and `conversionCallers` (on the impression side; this is new). This reflects the fact that these will select either a top-level site (impression site or conversion site respectively) OR an intermediary site on that side. I'm not wed to this name, but it's the best I could come up with on short notice. 4. `impressionCallers` allows `measureConversion()` to only select impressions saved by specific intermediaries OR impression sites. We discussed this defaulting to just the intermediary site when the API is invoked by an intermediary, but I decided not to do this. This is logically simpler and I think that intemediaries are more likely to be technically competent enough to get this part right, especially with the new explanation. 5. `conversionCallers` is a new restriction, with new attributes for saved impressions. This exists to avoid accidental bleed over of impressions, as we discussed at the recent meeting.
apasel422
requested changes
Jun 20, 2025
api.bs
Outdated
| both [=impression sites=] and [=intermediary sites=], | ||
| that might have called the <a method for=Attribution>saveImpression()</a> API. | ||
| If specified, | ||
| only [=impressions=] recorded by scripts originating from one of the listed sites |
There was a problem hiding this comment.
Maybe we can avoid the recorded by scripts phrasing, given the presence of the HTTP API for Save-Impression.
api.bs
Outdated
Comment on lines
873
to
877
| * Use of an [=impression=] for [=conversion=] can be restricted | ||
| to a [=impression/Conversion Sites|set of conversion sites=]. | ||
|
|
||
| * Use of an [=impression=] for [=conversion=] can be restricted | ||
| to use by a [=impression/Conversion Callers|set of sites=]. |
There was a problem hiding this comment.
Is there a distinction between restricted to a and restricted to use by a here? If not, let's use the same phrasing.
There was a problem hiding this comment.
I was trying (and failing) to distinguish between the two concepts:
- The impression is only visible when the top-level site is in this set.
- The impression is only visible when the caller of
measureConversion()is in this set.
Co-authored-by: Andrew Paseltiner <apaseltiner@google.com>
apasel422
approved these changes
Jun 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This doesn't look like a lot, but there's a whole bunch here.
There is a discussion of the rule of intermediaries in the API. This is pretty brief for now, but we can expand it over time.
There is a longer discussion about what it means to construct a histogram. There's a new concept here that is introduced, of histogram definition. This allows me to explain that the semantics of each of the histogram indices used by impressions that are selected by the same
measureConversion()call need to be consistent. This section describes the set of tools that the API provides for ensuring that this is possible.Those tools are then defined. The various
intermediarySitesoptions are renamed. I've named theseimpressionCallers(on the conversion site) andconversionCallers(on the impression side; this is new). This reflects the fact that these will select either a top-level site (impression site or conversion site respectively) OR an intermediary site on that side. I'm not wed to this name, but it's the best I could come up with on short notice.impressionCallersallowsmeasureConversion()to only select impressions saved by specific intermediaries OR impression sites. We discussed this defaulting to just the intermediary site when the API is invoked by an intermediary, but I decided not to do this. This is logically simpler and I think that intemediaries are more likely to be technically competent enough to get this part right, especially with the new explanation.conversionCallersis a new restriction, with new attributes for saved impressions. This exists to avoid accidental bleed over of impressions, as we discussed at the recent meeting.This does not implement the delegation API proposed in #34. That's a bigger lift that can come afterwards.
Closes #55.
Closes #102.
Preview | Diff