Create new sample page deferred prebid #139
There are no files selected for viewing
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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| FROM nginx:alpine | ||
|
|
||
| # Install gettext for envsubst | ||
| RUN apk add --no-cache gettext | ||
|
|
||
| # Copy static files from client-side-deferred directory | ||
| COPY client-side-deferred/app.css /usr/share/nginx/html/ | ||
| COPY prebid.js /usr/share/nginx/html/ | ||
|
|
||
| # Copy config and HTML | ||
| COPY client-side-deferred/default.conf /etc/nginx/conf.d/default.conf | ||
| COPY client-side-deferred/index.html /usr/share/nginx/html/index.template.html | ||
| COPY client-side-deferred/entrypoint.sh /entrypoint.sh | ||
|
|
||
| RUN chmod +x /entrypoint.sh | ||
|
|
||
| ENTRYPOINT ["/entrypoint.sh"] | ||
| CMD ["nginx", "-g", "daemon off;"] | ||
|
|
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| # Deferred UID2/EUID Integration with Prebid.js (using mergeConfig) | ||
|
|
||
| This example demonstrates how to integrate UID2 or EUID with Prebid.js using **deferred configuration**. Unlike the standard integration where UID2/EUID is configured on page load, this pattern uses `mergeConfig()` and `refreshUserIds()` to add the identity module *after* the page has already loaded. | ||
|
|
||
| ## Use Cases | ||
|
|
||
| This pattern is useful for: | ||
|
|
||
| - **Async Login**: User logs in after the page has loaded | ||
| - **Delayed Consent**: Consent is given asynchronously (e.g., via a consent management platform) | ||
| - **Single Page Applications (SPAs)**: Dynamic login/logout without full page reloads | ||
| - **Lazy Loading**: Only load UID2/EUID when actually needed | ||
| - **User State Changes**: Handle logout and re-login scenarios | ||
|
|
||
| ## How It Works | ||
|
|
||
| ### Standard Flow (for comparison) | ||
| ```javascript | ||
| // Page load: UID2 configured immediately | ||
| pbjs.setConfig({ | ||
| userSync: { | ||
| userIds: [{ name: 'uid2', params: {...} }] | ||
| } | ||
| }); | ||
| ``` | ||
|
|
||
| ### Deferred Flow (this example) | ||
| ```javascript | ||
| // Step 1: Page load - Prebid configured WITHOUT UID2 | ||
| pbjs.setConfig({ | ||
| userSync: { | ||
| syncDelay: 5000, | ||
| auctionDelay: 1000, | ||
| // Note: NO userIds configured here! | ||
| } | ||
| }); | ||
|
|
||
| // Step 2: Later (after login, consent, etc.) - Add UID2 via mergeConfig | ||
| pbjs.mergeConfig({ | ||
| userSync: { | ||
| userIds: [{ | ||
| name: 'uid2', | ||
| params: { | ||
| uid2ApiBase: 'https://operator-integ.uidapi.com', | ||
| email: '[email protected]', | ||
| subscriptionId: 'your-subscription-id', | ||
| serverPublicKey: 'your-server-public-key' | ||
| } | ||
| }] | ||
| } | ||
| }); | ||
|
|
||
| // Step 3: Trigger user ID refresh to generate the token | ||
| await pbjs.refreshUserIds(); | ||
| ``` | ||
|
|
||
| ## Key Prebid.js APIs | ||
|
|
||
| | API | Purpose | | ||
| |-----|---------| | ||
| | `pbjs.setConfig()` | Initial configuration (without UID2) | | ||
| | `pbjs.mergeConfig()` | Add/update configuration without replacing existing config | | ||
| | `pbjs.refreshUserIds()` | Trigger user ID module to fetch/generate new IDs | | ||
| | `pbjs.getUserIds()` | Get current user IDs (check if token was generated) | | ||
|
|
||
| ## Live Examples | ||
|
|
||
| - **UID2**: [https://unifiedid.com/examples/cstg-prebid-deferred-example/](https://unifiedid.com/examples/cstg-prebid-deferred-example/) | ||
| - **EUID**: [https://euid.eu/examples/cstg-prebid-deferred-example/](https://euid.eu/examples/cstg-prebid-deferred-example/) | ||
|
Contributor
There was a problem hiding this comment. i dont think these URLs would be where the examples will live |
||
|
|
||
| ## Running Locally | ||
|
|
||
| ### Using Docker Compose (recommended) | ||
|
|
||
| From the repository root: | ||
|
|
||
| ```bash | ||
| docker compose up prebid-client-side-deferred | ||
| ``` | ||
|
|
||
| Access at: http://localhost:3053 | ||
|
|
||
| ### Using the Reverse Proxy | ||
|
|
||
| ```bash | ||
| docker compose up | ||
| ``` | ||
|
|
||
| Access at: http://prebid-deferred.sample-dev.com (requires hosts file configuration) | ||
|
|
||
| ## Environment Variables | ||
|
|
||
| | Variable | Description | Default | | ||
| |----------|-------------|---------| | ||
| | `UID_CLIENT_BASE_URL` | API base URL for client-side calls | `https://operator-integ.uidapi.com` | | ||
| | `UID_CSTG_SUBSCRIPTION_ID` | Your CSTG subscription ID | Test value provided | | ||
| | `UID_CSTG_SERVER_PUBLIC_KEY` | Your CSTG server public key | Test value provided | | ||
| | `UID_STORAGE_KEY` | localStorage key for token storage | `__uid2_advertising_token` | | ||
| | `IDENTITY_NAME` | Display name (UID2 or EUID) | `UID2` | | ||
| | `DOCS_BASE_URL` | Base URL for documentation links | `https://unifiedid.com/docs` | | ||
|
|
||
| ## Testing Flow | ||
|
|
||
| 1. **Page loads** - Observe that Prebid is loaded but UID2 shows "Not yet configured (deferred)" | ||
| 2. **Enter email** - Type an email address in the input field | ||
| 3. **Click "Configure UID2 with mergeConfig()"** - This triggers: | ||
| - `pbjs.mergeConfig()` to add UID2 configuration | ||
| - `pbjs.refreshUserIds()` to generate the token | ||
| 4. **Observe results** - Token appears in the status tables | ||
| 5. **Test opt-out** - Use `[email protected]` to see opt-out behavior | ||
|
|
||
| ## Documentation | ||
|
|
||
| - [UID2 Client-Side Integration Guide for Prebid.js](https://unifiedid.com/docs/guides/integration-prebid-client-side) | ||
| - [EUID Client-Side Integration Guide for Prebid.js](https://euid.eu/docs/guides/integration-prebid-client-side) | ||
| - [Prebid.js User ID Module](https://docs.prebid.org/dev-docs/modules/userId.html) | ||
| - [Prebid.js setConfig/mergeConfig](https://docs.prebid.org/dev-docs/publisher-api-reference/setConfig.html) | ||
|
Contributor
There was a problem hiding this comment. setConfig and mergeConfig have different prebid docs references, merge config would be here https://docs.prebid.org/dev-docs/publisher-api-reference/mergeConfig.html |
||
|
|
||
| ## Related Examples | ||
|
|
||
| - [client-side](../client-side/) - Standard Prebid + UID2 (configured on page load) | ||
| - [client-server](../client-server/) - Server-side token generation with Prebid | ||
|
|
||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.