feat: proposed changes

Correct documentation in the README. Remove `OptableTraits` and use simple data structures. Fix sending GAID when limited tracking. Fix regexp. Remove unused `OptableResponse`.

Author: ValentinPostindustria

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

@@ -8,7 +8,10 @@
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import androidx.fragment.app.Fragment;
-import co.optable.android_sdk.*;
+import co.optable.android_sdk.OptableIdentifier;
+import co.optable.android_sdk.OptableResult;
+import co.optable.android_sdk.OptableSDK;
+import co.optable.android_sdk.OptableTargeting;
 import co.optable.demoappjava.R;
 import co.optable.demoappjava.TheApplication;
 import com.google.android.gms.ads.admanager.AdManagerAdRequest;
@@ -121,8 +124,7 @@ private void profile() {
         traits.put("hasAccount", true);
         traits.put("sampleFloat", 0.75);
 
-        OptableTraits traitsRequest = new OptableTraits(traits, "c:12", Set.of("c:id1", "c:id2"));
-        optable.profile(traitsRequest, result -> {
+        optable.profile(traits, "c:12", Set.of("c:id1", "c:id2"), result -> {
             if (result instanceof OptableResult.Success) {
                 appendStatusText("Profile success");
             } else if (result instanceof OptableResult.Error<OptableTargeting> error) {
@@ -154,4 +156,4 @@ private void appendStatusText(@NonNull String message) {
         statusTextView.append("\n\n" + message);
     }
 
-}
+}

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

@@ -8,7 +8,10 @@
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import androidx.fragment.app.Fragment;
-import co.optable.android_sdk.*;
+import co.optable.android_sdk.OptableIdentifier;
+import co.optable.android_sdk.OptableResult;
+import co.optable.android_sdk.OptableSDK;
+import co.optable.android_sdk.OptableTargeting;
 import co.optable.demoappjava.R;
 import co.optable.demoappjava.TheApplication;
 import com.google.android.gms.ads.AdListener;
@@ -175,8 +178,7 @@ private void profile() {
         traits.put("hasAccount", true);
         traits.put("sampleFloat", 0.75);
 
-        OptableTraits traitsRequest = new OptableTraits(traits, "c:12", Set.of("c:id1", "c:id2"));
-        optable.profile(traitsRequest, result -> {
+        optable.profile(traits, "c:12", Set.of("c:id1", "c:id2"), result -> {
             if (result instanceof OptableResult.Success) {
                 appendStatusText("Profile Success");
             } else if (result instanceof OptableResult.Error<OptableTargeting> error) {
@@ -208,4 +210,4 @@ private void appendStatusText(@NonNull String message) {
         statusTextView.append("\n\n" + message);
     }
 
-}
+}

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

@@ -7,7 +7,10 @@ import android.view.ViewGroup
 import android.widget.Button
 import android.widget.TextView
 import androidx.fragment.app.Fragment
-import co.optable.android_sdk.*
+import co.optable.android_sdk.OptableIdentifier
+import co.optable.android_sdk.OptableResult
+import co.optable.android_sdk.OptableSDK
+import co.optable.android_sdk.OptableTargeting
 import co.optable.androidsdkdemo.R
 import co.optable.androidsdkdemo.TheApplication
 import com.google.android.gms.ads.admanager.AdManagerAdRequest
@@ -126,8 +129,7 @@ class GamBannerFragment : Fragment() {
             "sampleFloat" to 0.75,
         )
 
-        val traitsRequest = OptableTraits(traits, "c:12", setOf("c:id1", "c:id2"))
-        optable.profile(traitsRequest) { result ->
+        optable.profile(traits, "c:12", setOf("c:id1", "c:id2")) { result ->
             when (result) {
                 is OptableResult.Success<*> -> {
                     appendStatusText("Profile success")
@@ -166,4 +168,4 @@ class GamBannerFragment : Fragment() {
         statusTextView.append("\n\n$message")
     }
 
-}
+}

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

@@ -11,7 +11,10 @@ import android.view.ViewGroup
 import android.widget.Button
 import android.widget.TextView
 import androidx.fragment.app.Fragment
-import co.optable.android_sdk.*
+import co.optable.android_sdk.OptableIdentifier
+import co.optable.android_sdk.OptableResult
+import co.optable.android_sdk.OptableSDK
+import co.optable.android_sdk.OptableTargeting
 import co.optable.androidsdkdemo.R
 import co.optable.androidsdkdemo.TheApplication
 import com.google.android.gms.ads.AdListener
@@ -187,8 +190,7 @@ class PrebidBannerFragment : Fragment() {
             "sampleFloat" to 0.75,
         )
 
-        val traitsRequest = OptableTraits(traits, "c:12", setOf("c:id1", "c:id2"))
-        optable.profile(traitsRequest) { result ->
+        optable.profile(traits, "c:12", setOf("c:id1", "c:id2")) { result ->
             when (result) {
                 is OptableResult.Success -> {
                     appendStatusText("Profile success")
@@ -225,4 +227,4 @@ class PrebidBannerFragment : Fragment() {
         statusTextView.append("\n\n$message")
     }
 
-}
+}

README.md

@@ -159,58 +159,49 @@ Sensitive data as email and phone number encrypted using SHA256.
 #### Kotlin
 
 ```kotlin
-val ids = OptableIdentifiers(
-    email = "john.doe+test@example.com",
-    phoneNumber = "+1(555)1234567",
-    postalCode = "12345",
-    ipv4Address = "192.168.0.1",
-    ipv6Address = "2001:db8::1",
-    appleIdfa = "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
-    googleGaid = "38400000-8cf0-11bd-b23e-10b96e40000d",
-    rokuRida = "roku-rida-123",
-    samsungTifa = "tifaabc",
-    amazonFireAfai = "afaixyz",
-    netId = "netid123",
-    id5 = "id5token",
-    utiq = "utiqvalue",
-    custom = mapOf(
-        "v" to "vidvalue",
-        "c1" to "custom one"
-    ),
-    raw = listOf("raw:alreadyEncoded", "ultra:someRawValue")
+val ids = listOf(
+  OptableIdentifier.Email("john.doe+test@example.com"),
+  OptableIdentifier.PhoneNumber("+1(555)1234567"),
+  OptableIdentifier.PostalCode("12345"),
+  OptableIdentifier.IPv4("192.168.0.1"),
+  OptableIdentifier.IPv6("2001:db8::1"),
+  OptableIdentifier.AppleIdfa("a1b2c3d4-e5f6-7890-abcd-ef0123456789"),
+  OptableIdentifier.GoogleGaid("38400000-8cf0-11bd-b23e-10b96e40000d"),
+  OptableIdentifier.RokuRida("roku-rida-123"),
+  OptableIdentifier.SamsungTifa("tifaabc"),
+  OptableIdentifier.AmazonFireAfai("afaixyz"),
+  OptableIdentifier.NetId("netid123"),
+  OptableIdentifier.ID5("id5token"),
+  OptableIdentifier.Utiq("utiqvalue"),
+  OptableIdentifier.Custom("v", "vidvalue"),
+  OptableIdentifier.Custom("c1", "custom one"),
+  OptableIdentifier.Raw("raw:alreadyEncoded"),
+  OptableIdentifier.Raw("ultra:someRawValue")
 )
 ```
 
 #### Java
 
-You can use the Builder pattern for Java implementation. 
-
 ```java
-OptableIdentifiers ids = new OptableIdentifiers.Builder()
-        .email("john.doe+test@example.com")
-        .phoneNumber("+1(555)1234567")
-        .postalCode("12345")
-        .ipv4Address("192.168.0.1")
-        .ipv6Address("2001:db8::1")
-        .appleIdfa("a1b2c3d4-e5f6-7890-abcd-ef0123456789")
-        .googleGaid("38400000-8cf0-11bd-b23e-10b96e40000d")
-        .rokuRida("roku-rida-123")
-        .samsungTifa("tifaabc")
-        .amazonFireAfai("afaixyz")
-        .netId("netid123")
-        .id5("id5token")
-        .utiq("utiqvalue")
-        .custom(Map.of("v", "vidvalue", "c1", "custom one"))
-        .raw(List.of("raw:alreadyEncoded", "ultra:someRawValue"))
-        .build();
-```
-
-Additionally, you can set automatic fetching GAID if it is available. It will be ignored if `googleGaid` is set. 
-
-```kotlin
-val ids = OptableIdentifiers(
-    receiveGaidAutomatically = true
-)
+ArrayList<OptableIdentifier> ids = Lists.newArrayList(
+  new OptableIdentifier.Email("john.doe+test@example.com"),
+  new OptableIdentifier.PhoneNumber("+1(555)1234567"),
+  new OptableIdentifier.PostalCode("12345"),
+  new OptableIdentifier.IPv4("192.168.0.1"),
+  new OptableIdentifier.IPv6("2001:db8::1"),
+  new OptableIdentifier.AppleIdfa("a1b2c3d4-e5f6-7890-abcd-ef0123456789"),
+  new OptableIdentifier.GoogleGaid("38400000-8cf0-11bd-b23e-10b96e40000d"),
+  new OptableIdentifier.RokuRida("roku-rida-123"),
+  new OptableIdentifier.SamsungTifa("tifaabc"),
+  new OptableIdentifier.AmazonFireAfai("afaixyz"),
+  new OptableIdentifier.NetId("netid123"),
+  new OptableIdentifier.ID5("id5token"),
+  new OptableIdentifier.Utiq("utiqvalue"),
+  new OptableIdentifier.Custom("v", "vidvalue"),
+  new OptableIdentifier.Custom("c1", "custom one"),
+  new OptableIdentifier.Raw("raw:alreadyEncoded"),
+  new OptableIdentifier.Raw("ultra:someRawValue")
+);
 ```
 
 ### Identify API
@@ -221,9 +212,9 @@ the Google Advertising ID, or even your own vendor or app level `PPID`, you can
 #### Kotlin
 
 ```kotlin
-val ids = OptableIdentifiers(
-  email = "some.email@address.com",
-  raw = listOf("c:my-id-123")
+val ids = listOf(
+  OptableIdentifier.Email("john.doe+test@example.com"),
+  OptableIdentifier.PhoneNumber("+1(555)1234567")
 )
 optable.identify(ids) { result ->
   val msg = when (result) {
@@ -237,10 +228,10 @@ optable.identify(ids) { result ->
 #### Java
 
 ```java
-OptableIdentifiers ids = new OptableIdentifiers.Builder()
-        .email("some.email@address.com")
-        .raw(Lists.newArrayList("c:my-id-123"))
-        .build();
+ArrayList<OptableIdentifier> ids = Lists.newArrayList(
+    new OptableIdentifier.Email("john.doe+test@example.com"),
+    new OptableIdentifier.PhoneNumber("+1(555)1234567")
+);
 optable.identify(ids, result -> {
     if (result instanceof OptableResult.Success) {
         Log.d(TAG, "Identify success");
@@ -258,18 +249,6 @@ the `identify()` method on your SDK instance every time you authenticate a user,
 example once every 15 to 60 minutes while the application is being actively used and an internet connection is
 available.
 
-Alternatively, you can use simplified identify: 
-
-```kotlin
-optable.identify(email, true, "ppid") { result ->
-    ...
-}
-```
-
-The second (`sendGoogleAdIDBoolean`) and third (`ppid`) arguments to `identify()` are optional. Since the `gaid` value provided to `identify()` is `true`, the SDK will fetch and send the Google
-Advertising ID in the call to `identify` too, unless the user has turned on "Limit ad tracking" in their Google device
-advertising settings.
-
 
 ### Profile API
 
@@ -314,6 +293,12 @@ The specified traits are associated with the user's device and can be used for m
 traits are of type `HashMap<String, Any>`, and should consist only of key-value pairs where the key is a string and the value is either a string, number, or
 boolean.
 
+Additionally you can provide `id` and `neighbors` to associate the profile with other identifiers. The `id` parameter takes precedence over the passport if provided.
+
+```kotlin
+optable.profile(traits, "c:12", setOf("c:id1", "c:id2")) { ... }
+```
+
 ### Targeting API
 
 To get the targeting key values associated by the configured DCN with the device in real-time, you can call the
@@ -322,7 +307,9 @@ To get the targeting key values associated by the configured DCN with the device
 #### Kotlin
 
 ```kotlin
-val ids = OptableIdentifiers(email = "test@test.com")
+val ids = listOf(
+  OptableIdentifier.Email("test@test.com"),
+)
 optable.targeting(ids) { result ->
     val requestBuilder = AdManagerAdRequest.Builder()
 
@@ -344,7 +331,9 @@ optable.targeting(ids) { result ->
 #### Java
 
 ```java
-OptableIdentifiers ids = new OptableIdentifiers.Builder().email("test@test.com").build();
+ArrayList<OptableIdentifier> ids = Lists.newArrayList(
+        new OptableIdentifier.Email("test@test.com")
+)
 optable.targeting(ids, result -> {
     if (result instanceof OptableResult.Success<OptableTargeting> success) {
         Map<String, List<String>> audiences = success.getData().getAudiences();
@@ -469,7 +458,7 @@ private fun onClickLoadAd() {
 private fun applyOptableToGam(builder: AdManagerAdRequest.Builder, targeting: OptableTargeting?) {
   if (targeting == null) return
 
-  val audiences = targeting.audiences
+  val audiences = targeting.gamTargetingKeywords
   if (audiences != null) {
     for (entry in audiences.entries) {
       builder.addCustomTargeting(entry.key, entry.value)
@@ -500,7 +489,7 @@ private fun applyOptableToGam(builder: AdManagerAdRequest.Builder, targeting: Op
     private void applyOptableToGam(AdManagerAdRequest.Builder builder, @Nullable OptableTargeting targeting) {
       if (targeting == null) return;
 
-      Map<String, List<String>> audiences = targeting.getAudiences();
+      Map<String, List<String>> audiences = targeting.getGamTargetingKeywords();
       if (audiences != null) {
         for (Map.Entry<String, List<String>> entry : audiences.entrySet()) {
           builder.addCustomTargeting(entry.getKey(), entry.getValue());

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

@@ -1,5 +1,10 @@
 package co.optable.android_sdk
 
+/**
+ *  A generic wrapper for various OptableSDK result types.
+ *  `Success` represents a successful API call with a result.
+ *  `Error` represents an error result with a message.
+ */
 sealed class OptableResult<T> {
 
     data class Success<T>(
@@ -10,4 +15,4 @@ sealed class OptableResult<T> {
         val message: String,
     ) : OptableResult<T>()
 
-}
+}

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

@@ -91,10 +91,22 @@ class OptableSDK(
      * Calls the Optable Sandbox "profile" API to associate the
      * specified key-value traits, which can be subsequently used for
      * audience assembly.
+     *
+     * @param traits Contains an object composed of key / values to be associated with the profile.
+     * Values must be of simple types (String, Int, Boolean, Double) or they will be stringified with `toString`.
+     * @param id The identifier that traits and neighbors will be linked to. This value takes precedence over the passport if provided.
+     * @param neighbors An array of identifiers to link to the id or passport
+     *
      */
-    fun profile(traits: OptableTraits, listener: OptableResultListener<OptableTargeting>) {
+    @JvmOverloads
+    fun profile(
+        traits: Map<String, Any>,
+        id: String? = null,
+        neighbors: Set<String> = emptySet(),
+        listener: OptableResultListener<OptableTargeting>
+    ) {
         scope.launch {
-            val response = networkClient.profile(traits)
+            val response = networkClient.profile(traits, id, neighbors)
 
             MainScope().launch {
                 val optableResult = when (response) {