normalize-id-types-to-match-public-documentation

Author: adithyasamavedhi-ttd

ttd_databricks_python/ttd_databricks/handlers/advertiser.py

@@ -6,6 +6,7 @@
 
 from ttd_databricks_python.ttd_databricks.constants import TTD_DATABRICKS_SDK_ORIGIN_ID
 from ttd_databricks_python.ttd_databricks.contexts import AdvertiserContext
+from ttd_databricks_python.ttd_databricks.id_types import normalize_id_type
 
 if TYPE_CHECKING:
     from ttd_data import DataClient
@@ -26,7 +27,7 @@ def build_items(items_data: list[dict[str, Any]]) -> list[AdvertiserDataItem]:
                 adv_data_kwargs[field] = d[field]
 
         adv_item_kwargs = {
-            d["id_type"]: d["id_value"],
+            normalize_id_type(d["id_type"]): d["id_value"],
             "data": [AdvertiserData(**adv_data_kwargs)],
         }
         for field in ITEM_OPTIONAL_FIELDS:

ttd_databricks_python/ttd_databricks/handlers/deletion_optout_advertiser.py

@@ -5,6 +5,7 @@
 from typing import TYPE_CHECKING, Any, Optional, cast
 
 from ttd_databricks_python.ttd_databricks.contexts import DeletionOptOutAdvertiserContext
+from ttd_databricks_python.ttd_databricks.id_types import normalize_id_type
 
 if TYPE_CHECKING:
     from ttd_data import DataClient
@@ -17,7 +18,7 @@ def build_items(items_data: list[dict[str, Any]]) -> list[PartnerDsrDataItem]:
 
     items = []
     for d in items_data:
-        items.append(PartnerDsrDataItem(**{d["id_type"]: d["id_value"]}))
+        items.append(PartnerDsrDataItem(**{normalize_id_type(d["id_type"]): d["id_value"]}))
     return items
 
 

ttd_databricks_python/ttd_databricks/handlers/deletion_optout_merchant.py

@@ -5,6 +5,7 @@
 from typing import TYPE_CHECKING, Any, Optional, cast
 
 from ttd_databricks_python.ttd_databricks.contexts import DeletionOptOutMerchantContext
+from ttd_databricks_python.ttd_databricks.id_types import normalize_id_type
 
 if TYPE_CHECKING:
     from ttd_data import DataClient
@@ -17,7 +18,7 @@ def build_items(items_data: list[dict[str, Any]]) -> list[PartnerDsrDataItem]:
 
     items = []
     for d in items_data:
-        items.append(PartnerDsrDataItem(**{d["id_type"]: d["id_value"]}))
+        items.append(PartnerDsrDataItem(**{normalize_id_type(d["id_type"]): d["id_value"]}))
     return items
 
 

ttd_databricks_python/ttd_databricks/handlers/deletion_optout_thirdparty.py

@@ -5,6 +5,7 @@
 from typing import TYPE_CHECKING, Any, Optional, cast
 
 from ttd_databricks_python.ttd_databricks.contexts import DeletionOptOutThirdPartyContext
+from ttd_databricks_python.ttd_databricks.id_types import normalize_id_type
 
 if TYPE_CHECKING:
     from ttd_data import DataClient
@@ -17,7 +18,7 @@ def build_items(items_data: list[dict[str, Any]]) -> list[PartnerDsrDataItem]:
 
     items = []
     for d in items_data:
-        items.append(PartnerDsrDataItem(**{d["id_type"]: d["id_value"]}))
+        items.append(PartnerDsrDataItem(**{normalize_id_type(d["id_type"]): d["id_value"]}))
     return items
 
 

ttd_databricks_python/ttd_databricks/handlers/third_party.py

@@ -6,6 +6,7 @@
 
 from ttd_databricks_python.ttd_databricks.constants import TTD_DATABRICKS_SDK_ORIGIN_ID
 from ttd_databricks_python.ttd_databricks.contexts import ThirdPartyContext
+from ttd_databricks_python.ttd_databricks.id_types import normalize_id_type
 
 if TYPE_CHECKING:
     from ttd_data import DataClient
@@ -26,7 +27,7 @@ def build_items(items_data: list[dict[str, Any]]) -> list[ThirdPartyDataItem]:
                 tp_data_kwargs[field] = d[field]
 
         tp_item_kwargs = {
-            d["id_type"]: d["id_value"],
+            normalize_id_type(d["id_type"]): d["id_value"],
             "data": [ThirdPartyData(**tp_data_kwargs)],
         }
         for field in ITEM_OPTIONAL_FIELDS:

ttd_databricks_python/ttd_databricks/id_types.py

@@ -0,0 +1,34 @@
+"""User-facing id_type names and normalization to ttd-data Pydantic field names."""
+
+from __future__ import annotations
+
+# TTD public documentation specifies id_type values in PascalCase/ALLCAPS.
+# This dict maps those user-facing id_type values to the corresponding Python
+# field names on the ttd-data Pydantic models, which use snake_case field names
+# with PascalCase/ALLCAPS aliases for the wire format.
+_NORMALIZATION: dict[str, str] = {
+    "TDID": "tdid",
+    "DAID": "daid",
+    "UID2": "uid2",
+    "UID2Token": "uid2_token",
+    "EUID": "euid",
+    "EUIDToken": "euid_token",
+    "RampID": "ramp_id",
+    "ID5": "id5",
+    "netID": "net_id",
+    "FirstId": "first_id"
+}
+
+VALID_ID_TYPES: frozenset[str] = frozenset(_NORMALIZATION)
+
+
+def normalize_id_type(id_type: str) -> str:
+    """Map a user-facing id_type to the Python field name expected by ttd-data models.
+
+    Raises ValueError for unrecognized values.
+    """
+    try:
+        return _NORMALIZATION[id_type]
+    except KeyError:
+        valid = ", ".join(sorted(_NORMALIZATION))
+        raise ValueError(f"Unknown id_type {id_type!r}. Must be one of: {valid}.")

ttd_databricks_python/ttd_databricks/schemas/advertiser.py

@@ -34,8 +34,8 @@ def input_schema() -> StructType:
 
     Mandatory columns (not nullable):
       id_type      → which AdvertiserDataItem identity field this row uses.
-                     Must be one of: tdid, daid, uid2, uid2_token, ramp_id, core_id,
-                     euid, euid_token, id5, net_id, first_id, merkury_id, iqvia_ppid.
+                     Must be one of: TDID, DAID, UID2, UID2Token, EUID, EUIDToken,
+                     RampID, ID5, netID, FirstId, CoreID, MerkuryID, IqviaPPID.
       id_value     → the identifier value for the given id_type.
       segment_name → AdvertiserData.name (audience segment / data element name).
 

ttd_databricks_python/ttd_databricks/schemas/deletion_optout_advertiser.py

@@ -17,8 +17,8 @@ def input_schema() -> StructType:
 
     Mandatory columns (not nullable):
       id_type  → which PartnerDsrDataItem identity field this row uses.
-                 Must be one of: tdid, daid, uid2, uid2_token, ramp_id, core_id,
-                 euid, euid_token, id5, net_id, first_id, merkury_id, iqvia_ppid.
+                 Must be one of: TDID, DAID, UID2, UID2Token, EUID, EUIDToken,
+                 RampID, ID5, netID, FirstId, CoreID, MerkuryID, IqviaPPID.
       id_value → the identifier value for the given id_type.
     """
     from pyspark.sql.types import StringType, StructField, StructType

ttd_databricks_python/ttd_databricks/schemas/deletion_optout_merchant.py

@@ -17,8 +17,8 @@ def input_schema() -> StructType:
 
     Mandatory columns (not nullable):
       id_type  → which PartnerDsrDataItem identity field this row uses.
-                 Must be one of: tdid, daid, uid2, uid2_token, ramp_id, core_id,
-                 euid, euid_token, id5, net_id, first_id, merkury_id, iqvia_ppid.
+                 Must be one of: TDID, DAID, UID2, UID2Token, EUID, EUIDToken,
+                 RampID, ID5, netID, FirstId, CoreID, MerkuryID, IqviaPPID.
       id_value → the identifier value for the given id_type.
     """
     from pyspark.sql.types import StringType, StructField, StructType

ttd_databricks_python/ttd_databricks/schemas/deletion_optout_thirdparty.py

@@ -17,8 +17,8 @@ def input_schema() -> StructType:
 
     Mandatory columns (not nullable):
       id_type  → which PartnerDsrDataItem identity field this row uses.
-                 Must be one of: tdid, daid, uid2, uid2_token, ramp_id, core_id,
-                 euid, euid_token, id5, net_id, first_id, merkury_id, iqvia_ppid.
+                 Must be one of: TDID, DAID, UID2, UID2Token, EUID, EUIDToken,
+                 RampID, ID5, netID, FirstId, CoreID, MerkuryID, IqviaPPID.
       id_value → the identifier value for the given id_type.
     """
     from pyspark.sql.types import StringType, StructField, StructType