Rework Optable API configuration and request forming #35

ValentinPostindustria · 2025-11-17T13:57:23Z

Closes #33.

Breaking changes:

Remove app path parameter.
Add tenant and originSlug query parameters.
Make host dynamic and apply path v2.

Other features:

Support apiKey.
Move all configuration parameters in Config class and reuse it everywhere.
Separate GoogleAdIdManager and LocalStorage logic from the network client.
Rename Client to NetworkClient.
Move hash logic to separate TypeHasher class.
Separate network interceptors.
Demo apps are built using local SDK.
Unit tests with mock web server.
Build WebView for user agent only once and cache the result.
Apply automatic IDEA aligning.

Remove `app` path parameter. Add `tenant` and `originSlug` parameters. Make host dynamic and apply path `v2`. Move all configuration parameters in Config class and reuse it everywhere. Separate `GoogleAdIdManager` and `LocalStorage` logic from the network client. Rename `Client` to `NetworkClient`. Move hash logic to separate `TypeHasher` class. Separate network interceptors. Refactor SDK code.

Support secret api keys. Fetch user agent only once. Write unit tests with the mock web server.

android_sdk/src/main/java/co/optable/android_sdk/OptableSDK.kt

android_sdk/src/main/java/co/optable/android_sdk/core/UserAgentHolder.kt

android_sdk/src/main/java/co/optable/android_sdk/OptableSDK.kt

Remove custom network Adapter. Use native Retrofit adapter. Add Kotlin suspension.

Migrate from TypeHasher to IdentifiersEncoder. Add all identifier types. Cover with unit tests.

Use callbacks API. Rewrite demo apps to make the examples more readable. Use shorter logs. Create Optable SDK instance once during application creation and reuse everywhere. Move fragments to one folder.

Add missed "reg" query param. Make Consents mutable. Provide `receiveGaidAutomatically` property. Refactor main methods javadoc.

justadreamer · 2026-01-08T18:53:11Z

DemoApp/DemoAppJava/app/src/main/java/co/optable/demoappjava/TheApplication.java

+    public void onCreate() {
+        super.onCreate();
+
+        OptableConfig config = new OptableConfig(this, "prebidtest", "js-sdk", "ca.edge.optable.co");


I wonder if host is obligatory to provide? can it work using with a default na.edge.optable.co host?

justadreamer · 2026-01-08T19:18:14Z

DemoApp/DemoAppJava/app/src/main/java/co/optable/demoappjava/ui/GamBannerFragment.java

+
+        Map<String, List<String>> audiences = targeting.getAudiences();
+        if (audiences != null) {
+            for (Map.Entry<String, List<String>> entry : audiences.entrySet()) {


Here is how audience object is converted into GAM key-value pairs:

https://github.com/Optable/optable-web-sdk/blob/b1beb3e995e8bd5edad6987fe5c048fe359d80b3/lib/edge/targeting.ts#L148-L165

function TargetingKeyValues(tdata: TargetingResponse | null): TargetingKeyValues { const result: TargetingKeyValues = {}; if (!tdata) { return result; } for (const identifiers of tdata.audience ?? []) { if (identifiers.keyspace) { if (!(identifiers.keyspace in result)) { result[identifiers.keyspace] = []; } result[identifiers.keyspace].push(...identifiers.ids.map((el) => el.id)); } } return result; }

audience is an array of objects:

"audience": [ { "provider": "optable.co", "ids": [ { "id": "15f30409" } ], "keyspace": "optable", "rtb_segtax": 5001 } ],

each of these objects becomes a single key-value pair.

justadreamer · 2026-01-08T19:25:47Z

DemoApp/DemoAppJava/app/src/main/java/co/optable/demoappjava/ui/PrebidBannerFragment.java

+    private void applyOptableToGam(AdManagerAdRequest.Builder builder, @Nullable OptableTargeting targeting) {
+        if (targeting == null) return;
+
+        Map<String, List<String>> audiences = targeting.getAudiences();


this (incorrect) code of generating a GAM kv pair is repeated - perhaps it should become part of the Optable SDK library gamTargeting() function?

justadreamer · 2026-01-08T19:35:31Z

DemoApp/DemoAppKotlin/app/src/main/java/co/optable/androidsdkdemo/ui/GamBannerFragment.kt

+        val audiences = targeting.audiences
+        if (audiences != null) {
+            for (entry in audiences.entries) {
+                builder.addCustomTargeting(entry.key, entry.value)


please see above comment re: custom in the Java sample - let's make a library function on OptableTargeting gamTargetingKeywords() or getGAMTargetingKeywords()

justadreamer · 2026-01-08T19:44:17Z

android_sdk/src/main/java/co/optable/android_sdk/OptableSDK.kt

+            return
        }
+
+        val ids = OptableIdentifiers.Builder().raw(listOf(id)).build()


please make sure we don't double hash the email as oeid is already sha256-hashed email. but looks like you pass it raw here, which should be correct.

justadreamer · 2026-01-11T18:16:39Z

android_sdk/src/main/java/co/optable/android_sdk/core/IdentifiersEncoder.kt

+        result.addIfNotNull(IPV4, ids.ipv4Address, ::removeWhitespaces)
+        result.addIfNotNull(IPV6, ids.ipv6Address, ::normalize)
+        result.addIfNotNull(IDFA, ids.appleIdfa, ::normalize)
+        result.addIfNotNull(GAID, ids.googleGaid, ::normalize)


do we need to normalize GAID - maybe it is worth passing it as is, as system returns it?

justadreamer · 2026-01-11T18:17:07Z

android_sdk/src/main/java/co/optable/android_sdk/core/IdentifiersEncoder.kt

+        result.addIfNotNull(POSTAL, ids.postalCode, ::normalize)
+        result.addIfNotNull(IPV4, ids.ipv4Address, ::removeWhitespaces)
+        result.addIfNotNull(IPV6, ids.ipv6Address, ::normalize)
+        result.addIfNotNull(IDFA, ids.appleIdfa, ::normalize)


this is kinda funny to have on Android :) but let it be

justadreamer · 2026-01-11T18:22:28Z

android_sdk/src/main/java/co/optable/android_sdk/core/IdentifiersEncoder.kt

+     * We first convert the Uri to a lowercase string then re-parse it so that we are
+     * not dependent on case-sensitivity of the "oeid" query parameter
+     */
+    fun eidFromUrl(urlString: String): String? {


this name is a bit confusing, as eid is an extended id in OpenRTB, here we talk rather about a prefixed ID param

justadreamer · 2026-01-11T18:43:51Z

android_sdk/src/main/java/co/optable/android_sdk/OptableIdentifiers.kt

+    /**
+     * Generates a list of encoded Enriched Identifiers (EIDs) based on the current contents of the dictionary.
+     */
+    fun generateEnrichedIds(): List<String> {


EIDs are Extended Identifiers, not EnrichedIds: https://github.com/InteractiveAdvertisingBureau/openrtb2.x/blob/main/2.6.md#3227---object-eid-
Please correct to generateEIDs - also please verify what's the function name in iOS if it is meant to be a public API - need to make sure we call it the same

justadreamer · 2026-01-11T18:44:43Z

android_sdk/src/test/java/co/optable/android_sdk/OptableIdentifiersTest.kt

+class OptableIdentifiersTest {
+
+    @Test
+    fun `generateEnrichedIds empty`() {


see a comment about naming in the OptableIdentifiers, that EID means "extended identifier", not "enriched identifier"

ValentinPostindustria added 5 commits November 17, 2025 14:53

fix: unit tests

8d6e1de

feat: new unique suffix

7efd435

feat: use local SDK sources by default

dc6b91f

feat: api key and testing

71fe63a

Support secret api keys. Fetch user agent only once. Write unit tests with the mock web server.

ValentinPostindustria marked this pull request as ready for review November 21, 2025 09:07

ValentinPostindustria requested a review from zapo November 21, 2025 09:08

justadreamer requested changes Dec 15, 2025

View reviewed changes

ValentinPostindustria added 2 commits December 15, 2025 13:47

feat: introduce OptableConfig

ad8359b

fix: unit tests

5ae14c5

ValentinPostindustria requested a review from justadreamer December 15, 2025 13:01

ValentinPostindustria and others added 15 commits December 18, 2025 12:35

Introduce Optable demo cases with Prebid (#32)

ec71ba5

feat: refactor network layer

c6381b3

feat: introduce callbacks for identify and targeting methods

dd4ad43

feat: rewrite demo apps to use callbacks

63ba731

refactor: examples

674a426

feat: rewrite network logic

bbb6638

Remove custom network Adapter. Use native Retrofit adapter. Add Kotlin suspension.

feat: introduce OptableIdentifiers

0ee30b3

Migrate from TypeHasher to IdentifiersEncoder. Add all identifier types. Cover with unit tests.

feat: Rx LiveData to traditional callbacks

ff2bbcf

feat: targeting keywords for GAM

ade2a26

feat: refactor demo apps

fd0300d

Use callbacks API. Rewrite demo apps to make the examples more readable. Use shorter logs. Create Optable SDK instance once during application creation and reuse everywhere. Move fragments to one folder.

feat: support consents

07c7ff4

refactor: some methods

8e464dc

docs: rewrite README file

3aff74c

test: consent query params

2b8c7eb

feat: corrections

bf7a416

Add missed "reg" query param. Make Consents mutable. Provide `receiveGaidAutomatically` property. Refactor main methods javadoc.

justadreamer requested changes Jan 11, 2026

View reviewed changes

Rework Optable API configuration and request forming #35

Are you sure you want to change the base?

Rework Optable API configuration and request forming #35

Uh oh!

Conversation

ValentinPostindustria commented Nov 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ValentinPostindustria commented Nov 17, 2025 •

edited

Loading