-
Notifications
You must be signed in to change notification settings - Fork 173
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.
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
Attributes naming and terms #57
Comments
Chatted about this in person, and one way I think one way to think about this is:
In this framing "impression data" might be OK to keep around, as long as we don't call things downstream (like the click, or the data stored in the browser) as the impression data, since it's dealing with a subset of impressions. As a first idea, maybe we could have:
|
Sorry, to respond to more points:
Yes I think we should be using this to refer to the tag only and not the event (which could be a view, click, etc). That event should be called something else (e.g. the event which marks the impression eligible for attributability)
Yes let's just stick with "data". |
Great! Thanks. (1) Several entities are designated by the same termAs of now, "impression" in the explainer and the API is used:
Note: This list is a base to clarify; a distinct term for each of these may not be needed. [Opinion: I think there's value in making theses entity types clear, by adding it as a "suffix" to whatever term ends up being used: "[...] tag", "[...] event". Because "tag" and "event" are concepts web developers are already familiar with - "tag" especially so, in the ads space.] (2) "Impression" means "ad view" in the ads spaceIn theory, definition: In theory, uses of this term in the wild:
Note: this could be partly mitigated by the solutions we come up for (1) - for example, if a renaming is decided on and reduces occurrences of the term "impression" in contexts where it may be misunderstood. |
Accidentally closed by the PR. Re-opening |
After gathering ideas and feedback, together with @csharrison, @johnivdel - with input from @michaelkleber, @domenic Note that some of these new name ideas address the original concern mentioned in this issue ("
**Open question: |
Thanks so much Maud! I love the table view 👍 @johnwilander I mentioned in the last f2f that we were brainstorming some new names and terms for the API. Would you mind taking a look and sharing your thoughts? I think the new names avoid some pitfalls of ambiguous technical ads terms on our side (impression & conversion) and also avoids embedding a use case (ads measurement) into the API name in favor of making the API more generic to the underlying primitive (attributing two events on different sites). |
To follow up on the above regarding the web exposed names specifically. Integrating some of the discussion on [privacycg/private-click-measurement#56](privacycg/private-click-measurement#56, here is a finalized set of proposed name change: HTML
URLS
Query params
The report param names would follow the results of the discussions on privacycg/private-click-measurement#30, which I have copied here for brevity: { |
attributeon :) |
Thank you John! Remaining open questions at this point: For reference and cross-repo linking: All naming-related issues: |
This updates the proposed API with the naming changes discussed on #57. This includes updating the reporting format to a JSON body with the new names
* Remove "impression"/"conversion" from API surfaces This updates the proposed API with the naming changes discussed on #57. This includes updating the reporting format to a JSON body with the new names * Update README.md * Update README.md Co-authored-by: Maud <[email protected]> * Update README.md * Update README.md Co-authored-by: Maud <[email protected]> * Update README.md Co-authored-by: Maud <[email protected]> * Update README.md Co-authored-by: Maud <[email protected]> * Update README.md Co-authored-by: Maud <[email protected]> * Update README.md Co-authored-by: Maud <[email protected]> * Update README.md Co-authored-by: Maud <[email protected]> * Resolve PR review comments * Update README.md * Fix typos * Update README.md * Update bad x-link Co-authored-by: Maud <[email protected]>
Renaming is complete, closing this issue. |
A few terms and attribute names in the API and explainer may (or may not) create confusion.
"Impression" (term) refers to both the tag and the event.
impression...
(attribute) may refer to both click and view in this spec. But in adtech lingo, "impression" usually means "view" as opposed to "click" (see the definition from the IAB: "Each time an advertisement loads onto a user’s screen, the ad server may count that loading as one impression" and this one). This means thatimpression...
does not reflect the duality of "click or view" and that the API may be misunderstood as a view-through measurement API only.Both the terms "data" and "metadata" are used; similarly, we have
impression-data
andconversion-metadata
attributes. This may be hard to remember and confusing for API users; it's not necessarily clear why one qualifies as data while the other as metadata. Note: I think the API already reflects this, and this is just about updating the explainer.=> Ideas to solve these / proposals:
In the explainer, clarify with "... tag" when referring to the tag - and stick to "..." when referring to the event.
Rename
impression
(@johnivdel suggests: "naming needs to be agnostic to click, since some API variants may support viewed impressions").Ideas:
impression
->event
,conversion
->conversion
// may be confusing to differentiate betweeneventdata
andconversiondata
.impression
->impact
,conversion
->conversion
measurement-data
click-measurement-data
/view-measurement-data
link-measurement-data
click-data
/view-data
click-event-data
/view-event-data
click-view-event-data
click-view-data
impression
->trigger
,conversion
->conversion
.trigger-data
,conversion-data
.impression
->trigger-event
,conversion
->conversion
.trigger-event-data
,conversion-data
.The text was updated successfully, but these errors were encountered: