New module: optable-targeting by zapo · Pull Request #3815 · prebid/prebid-server-java

zapo · 2025-03-07T15:30:22Z

🔧 Type of changes

new module

✨ What's the context?

The optable-targeting module enriches an incoming OpenRTB request by adding to the user.ext.eids and user.ext.data objects. Under the hood the module extracts PPIDs (publisher provided IDs) from the incoming request's user.ext.eids, and also if provided sha256-hashed email, sha256-hashed phone, zip or Optable Visitor ID provided correspondingly in the user.ext.optable.email, .phone, .zip, .vid fields. These IDs are sent as input to the Targeting API. The received response data is used to enrich the OpenRTB request and response. Targeting API endpoint is configurable per publisher.

prebid/prebid.github.io#5931

🧪 Test plan

The documentation PR describes how to run a demo and this PR also contains a sample config and sample request to test. The only thing necessary will be the Optable api endpoint URL to add to the sample configuration of the module.

🏎 Quality check

Are your changes following our code style guidelines?
Are there any breaking changes in your code?
Does your test coverage exceed 90%?
Are there any erroneous console logs, debuggers or leftover code in your changes?

justadreamer · 2025-03-25T08:58:08Z

Hi guys, @And1sS @CTMBNara, just checking: any ETA to get a review? Thanks.

And1sS

First take ;)

extra/modules/optable-targeting/README.md

...in/java/org/prebid/server/hooks/modules/optable/targeting/config/OptableTargetingConfig.java

.../src/main/java/org/prebid/server/hooks/modules/optable/targeting/model/EnrichmentStatus.java

...able-targeting/src/main/java/org/prebid/server/hooks/modules/optable/targeting/model/Id.java

...ain/java/org/prebid/server/hooks/modules/optable/targeting/v1/net/OptableResponseParser.java

sample/stored/optable-stored-response.json

And1sS · 2025-03-26T00:50:41Z

sample/configs/sample-app-settings-optable.yaml

Merge it to your sample config please.

I can't merge them into one sample config because it contains account settings. I need this change to enable AnalyticsTags.

According to the documentation, account settings should be placed in a separate file: Prebid Server Java - Application Settings.

When I try to move the account settings to the sample config file, the account doesn't work.

sample/configs/prebid-config-optable.yaml

extra/modules/optable-targeting/pom.xml

justadreamer · 2025-03-31T10:19:22Z

Hi @And1sS, thanks for the first pass. @softcoder594 has addressed the review comments. Could you please take another look?

…nd account-level settings

…ds list

justadreamer · 2025-04-17T19:48:57Z

Hi guys! 2 new features were added per Bret's suggestion:

Optable Targeting API endpoint is now added to the host-level config with tenant and origin parameters at the account-level config
Prebid Cache Storage is now used to cache Optable Targeting API results

Would you mind doing another review pass, please?

...in/java/org/prebid/server/hooks/modules/optable/targeting/config/OptableTargetingConfig.java

...geting/src/main/java/org/prebid/server/hooks/modules/optable/targeting/model/CachingKey.java

.../src/main/java/org/prebid/server/hooks/modules/optable/targeting/model/EnrichmentStatus.java

...ain/java/org/prebid/server/hooks/modules/optable/targeting/model/config/CacheProperties.java

...g/prebid/server/hooks/modules/optable/targeting/model/config/OptableTargetingProperties.java

.../src/main/java/org/prebid/server/hooks/modules/optable/targeting/model/net/OptableError.java

...rg/prebid/server/hooks/modules/optable/targeting/v1/OptableTargetingAuctionResponseHook.java

...d/server/hooks/modules/optable/targeting/v1/OptableTargetingProcessedAuctionRequestHook.java

...in/java/org/prebid/server/hooks/modules/optable/targeting/config/OptableTargetingConfig.java

...g/src/main/java/org/prebid/server/hooks/modules/optable/targeting/model/net/OptableCall.java

...rg/prebid/server/hooks/modules/optable/targeting/v1/OptableTargetingAuctionResponseHook.java

...d/server/hooks/modules/optable/targeting/v1/OptableTargetingProcessedAuctionRequestHook.java

...ain/java/org/prebid/server/hooks/modules/optable/targeting/v1/core/AnalyticTagsResolver.java

...c/main/java/org/prebid/server/hooks/modules/optable/targeting/v1/core/BidRequestCleaner.java

.../main/java/org/prebid/server/hooks/modules/optable/targeting/v1/core/BidRequestEnricher.java

...g/src/main/java/org/prebid/server/hooks/modules/optable/targeting/model/net/OptableCall.java

.../main/java/org/prebid/server/hooks/modules/optable/targeting/v1/core/BidRequestEnricher.java

...main/java/org/prebid/server/hooks/modules/optable/targeting/v1/core/BidResponseEnricher.java

.../src/main/java/org/prebid/server/hooks/modules/optable/targeting/v1/net/CachedAPIClient.java

...ava/org/prebid/server/hooks/modules/optable/targeting/v1/core/OptableAttributesResolver.java

...geting/src/main/java/org/prebid/server/hooks/modules/optable/targeting/v1/net/APIClient.java

...ng/src/main/java/org/prebid/server/hooks/modules/optable/targeting/v1/net/APIClientImpl.java

...ain/java/org/prebid/server/hooks/modules/optable/targeting/v1/net/OptableResponseMapper.java

...in/java/org/prebid/server/hooks/modules/optable/targeting/config/OptableTargetingConfig.java

...rg/prebid/server/hooks/modules/optable/targeting/v1/OptableTargetingAuctionResponseHook.java

...ava/org/prebid/server/hooks/modules/optable/targeting/v1/core/OptableAttributesResolver.java

...ng/src/main/java/org/prebid/server/hooks/modules/optable/targeting/v1/net/APIClientImpl.java

.../src/main/java/org/prebid/server/hooks/modules/optable/targeting/v1/net/CachedAPIClient.java

...ting/src/test/java/org/prebid/server/hooks/modules/optable/targeting/v1/BaseOptableTest.java

...rebid/server/hooks/modules/optable/targeting/v1/OptableTargetingAuctionResponseHookTest.java

...ng/src/test/java/org/prebid/server/hooks/modules/optable/targeting/v1/net/APIClientTest.java

.../test/java/org/prebid/server/hooks/modules/optable/targeting/v1/net/CachedAPIClientTest.java

...rc/test/java/org/prebid/server/hooks/modules/optable/targeting/v1/core/QueryBuilderTest.java

...g/src/test/java/org/prebid/server/hooks/modules/optable/targeting/v1/core/IdsMapperTest.java

zapo mentioned this pull request Mar 7, 2025

New PBS-Java module: optable-targeting prebid/prebid.github.io#5931

Merged

2 tasks

zapo marked this pull request as ready for review March 7, 2025 16:56

osulzhenko requested a review from CTMBNara March 10, 2025 09:36

osulzhenko assigned zapo Mar 10, 2025

softcoder594 force-pushed the optable-targeting-module branch from b2cb2bf to afaae43 Compare March 10, 2025 20:58

osulzhenko requested a review from And1sS March 18, 2025 10:42

And1sS requested changes Mar 26, 2025

View reviewed changes

softcoder594 added 13 commits April 17, 2025 14:59

New module: optable-targeting

cb94b68

optable-targeting: remove reg attribute from targeting query

db44556

optable-targeting: rename gdpr query attribute

ca8e227

optable-targeting: Increased modules version

b3776e6

optable-targeting: update README.MD

e2b5adc

optable-targeting: Code cleanup

9cc83df

optable-targeting: Code cleanup

4c6708b

optable-targeting: Remove logs

a809dff

optable-targeting: Implement caching for targeting responses

75fbd32

optable-targeting: Add account-level configuration

b669837

optable-targeting: Split API endpoint configuration into host-level a…

c91eea7

…nd account-level settings

optable-targeting: Code cleanup

eff725f

optable-targeting: Update caching key generation

7df560b

softcoder594 force-pushed the optable-targeting-module branch from ef0f7f2 to 7df560b Compare April 17, 2025 13:00

softcoder594 added 3 commits April 17, 2025 15:05

optable-targeting: Increase module version

ffdf319

optable-targeting: Implement targeting invocation with IP and empty i…

9c8ee59

…ds list

optable-targeting: Return targeting result even when caching fails

eaf738d

zapo requested a review from And1sS April 28, 2025 20:36

CTMBNara requested changes May 7, 2025

View reviewed changes

optable-targeting: Code cleanup

6e10e0e

softcoder594 added 2 commits June 14, 2025 00:09

Merge branch 'master' into optable-targeting-module

764039c

optable-targeting: up pbs version

10eeb11

zapo requested review from CTMBNara and softcoder594 June 16, 2025 14:24

CTMBNara requested changes Jun 24, 2025

View reviewed changes

softcoder594 added 3 commits June 24, 2025 23:03

optable-targeting: Code cleanup

a24f0cc

optable-targeting: replace custom Data object by existing one

917ef61

optable-targeting: Update user data and eids merging algorithms

d8fcbc5

zapo requested a review from CTMBNara June 27, 2025 17:17

CTMBNara requested changes Jul 3, 2025

View reviewed changes

softcoder594 added 4 commits July 5, 2025 11:48

optable-targeting: Code cleanup

ee51258

optable-targeting: Remove custom Http client

01423ec

Merge branch 'master' into optable-targeting-module

44eb177

optable-targeting: Code cleanup

320a952

zapo requested a review from CTMBNara July 7, 2025 15:10

CTMBNara requested changes Jul 14, 2025

View reviewed changes

softcoder594 added 4 commits July 14, 2025 14:23

optable-targeting: Code cleanup

43974a5

Merge branch 'master' into optable-targeting-module

39bd5f1

optable-targeting: Up PBS version

f21dddb

optable-targeting: Remove redundant test

c2c2ab8

zapo requested a review from CTMBNara July 14, 2025 13:38

CTMBNara requested changes Jul 15, 2025

View reviewed changes

optable-targeting: Code cleanup

10f9d34

CTMBNara approved these changes Jul 15, 2025

View reviewed changes

osulzhenko added do not port and removed do not port labels Jul 25, 2025

And1sS approved these changes Jul 30, 2025

View reviewed changes

CTMBNara merged commit 3bdbe21 into prebid:master Jul 30, 2025
8 of 9 checks passed

cross-repo-issue-creation bot mentioned this pull request Jul 30, 2025

Port PR from PBS-Java: New module: optable-targeting prebid/prebid-server#4464

Open

Comments

Conversation

zapo commented Mar 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔧 Type of changes

✨ What's the context?

🧪 Test plan

🏎 Quality check

Uh oh!

justadreamer commented Mar 25, 2025

Uh oh!

And1sS left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

And1sS Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

softcoder594 Mar 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

justadreamer commented Mar 31, 2025

Uh oh!

justadreamer commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

zapo commented Mar 7, 2025 •

edited

Loading

softcoder594 Mar 27, 2025 •

edited

Loading

justadreamer commented Apr 17, 2025 •

edited

Loading