Skip to content

Add Rediads user ID submodule and docs examples#14640

Open
symplorpro wants to merge 3 commits intoprebid:masterfrom
rediads:feature/rediads-id-system-userid-module
Open

Add Rediads user ID submodule and docs examples#14640
symplorpro wants to merge 3 commits intoprebid:masterfrom
rediads:feature/rediads-id-system-userid-module

Conversation

@symplorpro
Copy link
Copy Markdown
Contributor

Type of change

  • Bugfix

  • Feature

  • New bidder adapter

  • Updated bidder adapter

  • Code style update (formatting, local variables)

  • Refactoring (no functional changes, no api changes)

  • Build related changes

  • CI related changes

  • Does this change affect user-facing APIs or examples documented on http://prebid.org?

  • Other

Description of change

This PR adds a new Prebid User ID submodule: rediadsIdSystem.

The new module:

  • registers as rediadsId
  • integrates with the Prebid userId framework
  • decodes the stored value into bidRequest.userId.rediadsId
  • maps the identifier into bidRequest.userIdAsEids with source rediads.com
  • suppresses EID output when USP or GPP opt-out signals restrict sharing
  • returns undefined when COPPA applies or when GDPR applies without a valid consent string and Purpose 1 consent

This PR also includes:

  • submodule registration in modules/.submodules.json
  • unit coverage for decode(), getId(), extendId(), and EID generation
  • module-specific documentation in modules/rediadsIdSystem.md
  • example updates in modules/userId/userId.md
  • EID example updates in modules/userId/eids.md

Files changed:

  • modules/rediadsIdSystem.js
  • test/spec/modules/rediadsIdSystem_spec.js
  • modules/.submodules.json
  • modules/rediadsIdSystem.md
  • modules/userId/userId.md
  • modules/userId/eids.md

Build example:

gulp build --modules=rediadsBidAdapter,userId,rediadsIdSystem

Example configuration:

pbjs.setConfig({
  userSync: {
    userIds: [{
      name: 'rediadsId',
      params: {
        source: 'rediads.com'
      },
      storage: {
        type: 'html5',
        name: 'rediads_id',
        expires: 30,
        refreshInSeconds: 3600
      }
    }]
  }
});

Other information

Companion docs PR: prebid/prebid.github.io#6503

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: f398162e3d

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

@github-actions
Copy link
Copy Markdown

Whoa there partner! This project is migrating to typescript. Consider changing the new JS files to TS, with well-defined types for what interacts with the prebid public API (for example: bid params and configuration). Thanks!

  • modules/rediadsIdSystem.js

@coveralls
Copy link
Copy Markdown
Collaborator

coveralls commented Mar 25, 2026

Pull Request Test Coverage Report for Build 24017714090

Details

  • 115 of 121 (95.04%) changed or added relevant lines in 2 files are covered.
  • 2 unchanged lines in 1 file lost coverage.
  • Overall coverage decreased (-0.001%) to 96.341%

Changes Missing Coverage Covered Lines Changed/Added Lines %
modules/rediadsIdSystem.js 55 61 90.16%
Files with Coverage Reduction New Missed Lines %
modules/widespaceBidAdapter.js 2 83.67%
Totals Coverage Status
Change from base Build 23950616689: -0.001%
Covered Lines: 216831
Relevant Lines: 225067

💛 - Coveralls

@github-actions
Copy link
Copy Markdown

Whoa there partner! This project is migrating to typescript. Consider changing the new JS files to TS, with well-defined types for what interacts with the prebid public API (for example: bid params and configuration). Thanks!

  • modules/rediadsIdSystem.js

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 6, 2026

Whoa there partner! This project is migrating to typescript. Consider changing the new JS files to TS, with well-defined types for what interacts with the prebid public API (for example: bid params and configuration). Thanks!

  • modules/rediadsIdSystem.js

@rediads
Copy link
Copy Markdown
Contributor

rediads commented Apr 6, 2026

@osazos @jsnellbaker can you please help us for code review and approval.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants