Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Python SDK for integrating Databricks with The Trade Desk Data API. Supports Fir
- [SDK Example Usage](#sdk-example-usage)
- [Authentication](#authentication)
- [Supported Data API Endpoints](#supported-data-api-endpoints)
- [UID2 Support](#uid2-support)
- [Error Handling](#error-handling)
- [Server Selection](#server-selection)
- [Custom HTTP Client](#custom-http-client)
Expand Down Expand Up @@ -365,6 +366,16 @@ validate_ttd_schema(df=input_df, endpoint=TTDEndpoint.ADVERTISER)

---

## UID2 Support

The SDK supports both submitting UID2s directly as identifiers as well as automatically resolving raw email addresses and phone numbers (including pre-hashed variants) to UID2s before sending to The Trade Desk Data API. To enable automatic resolution, pass a `uid2_config` to `TtdDatabricksClient.from_params()`.

Email addresses and phone numbers can be submitted similar to other data types and are resolved to UID2s using the provided UID2 operator before calling The Trade Desk Data API. The Trade Desk Data API only receives resolved UID2s, never raw emails or phone numbers. Resolution happens per row in both `push_data` and `batch_process`, with UID2 mapping returned in a `uid2_resolutions` column on the output.

To submit email addresses or phone numbers, set the `id_type` column in your input data to `Email`, `Phone`, `HashedEmail`, or `HashedPhone`, with the corresponding value in `id_value`.

---

## Error Handling

All SDK exceptions inherit from `TTDError`.
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "ttd-databricks"
version = "0.3.5"
version = "0.3.6"
description = "Client implementation and helper functions for integrating with the TTD Databricks services."
readme = "README.md"
requires-python = ">=3.10"
Expand Down
Loading