add initPrebidAnalytics to prebid analytics addon#305
Open
etiennelatendresse-optable wants to merge 2 commits into
Open
add initPrebidAnalytics to prebid analytics addon#305etiennelatendresse-optable wants to merge 2 commits into
etiennelatendresse-optable wants to merge 2 commits into
Conversation
etiennelatendresse-optable
force-pushed
the
add-prebidanalytics
branch
from
July 17, 2026 19:47
9a61218 to
73803e0
Compare
etiennelatendresse-optable
changed the title
etiennelatendresse-optable
changed the title
mosherBT
force-pushed
the
add-prebidanalytics
branch
from
July 21, 2026 17:26
73803e0 to
a51d386
Compare
jplaroche
reviewed
Jul 21, 2026
| * the Witness payload, overriding any value already present on the bid. Use this | ||
| * to attach A/B assignment without mutating Prebid events yourself. | ||
| */ | ||
| getSplitTestAssignment?: () => string | undefined; |
Contributor
There was a problem hiding this comment.
Why is this name "get" and why is this a function instead of a string ? Would be simpler if it was splitTestAssignment and accept a string, no ?
jplaroche
reviewed
Jul 21, 2026
| SDK: OptableSDK, | ||
| instance: { host: "na.edge.optable.co", node: "my-tenant", site: "my-site" }, | ||
| analytics: { | ||
| tenant: "my-tenant", |
Contributor
There was a problem hiding this comment.
I believe this could be remove and just use the value in instance.node, since it needs to match anyway (unless I am mistaken)
jplaroche
reviewed
Jul 21, 2026
| | -------------- | ------------------------------- | ---------- | ---------------------------------------------------------------------------------------------------- | | ||
| | `SDK` | `new (config) => OptableSDK` | required | The Optable SDK constructor. Passed in so this module keeps a type-only SDK import. | | ||
| | `instance` | `InitConfig` | required | Config for the read-only analytics SDK (`host`/`node`/`site`/…). `readOnly`/`cookies` default false. | | ||
| | `pbjs` | `object` | — | Prebid.js instance to hook into. When omitted, `window[prebidGlobal]` is used. | |
Contributor
There was a problem hiding this comment.
I'd rename this prebidInstanceObject, or pbjsInstanceObject
jplaroche
reviewed
Jul 21, 2026
| | `SDK` | `new (config) => OptableSDK` | required | The Optable SDK constructor. Passed in so this module keeps a type-only SDK import. | | ||
| | `instance` | `InitConfig` | required | Config for the read-only analytics SDK (`host`/`node`/`site`/…). `readOnly`/`cookies` default false. | | ||
| | `pbjs` | `object` | — | Prebid.js instance to hook into. When omitted, `window[prebidGlobal]` is used. | | ||
| | `prebidGlobal` | `string` | `"pbjs"` | Window key used to find Prebid when `pbjs` is not passed. | |
Contributor
There was a problem hiding this comment.
I'd rename this prebidInstanceName, or pbjsInstanceName, but have both align, either both pbjs or both prebid
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Why
Using the prebid analytics addon would previously require some boilerplate code in order to initialize it.
What Changed
initPrebidAnalyticsto the prebid analytics addon (lib/addons/prebid/analytics.ts)analyticsconfig straight to theOptablePrebidAnalyticsconstructor, so options such asgetSplitTestAssignment(Get splitTestAssignment from SDK bundle, if provided #304) flow through without extra plumbing.Notes
Composes with #304 (splitTestAssignment) rather than duplicating it.
How to Test