Format user data

The Data Manager API supports uploading multiple types of user data. Follow the formatting, hashing, and encoding requirements for each data element so that your data is received and processed successfully.

UserData requirements

A UserData object is a collection of UserIdentifier objects. Each UserIdentifier has exactly one of the attributes in the following table.

UserIdentifier
email_address
Format
string
Convert to lowercase.
Whitespace Trim leading, trailing and intermediate whitespace.
Hashing Hash using the SHA-256 algorithm. Encode the hash bytes using hex or Base64 encoding.
phone_number
Format
string
Include the plus sign (+) and the country code.
Whitespace Trim leading and trailing whitespace.
Hashing Hash using the SHA-256 algorithm. Encode the hash bytes using hex or Base64 encoding.
address

AddressInfo format

Use the following formatting guidelines to construct the address attribute of a UserIdentifier.

AddressInfo
given_name
Format
string
Convert to lowercase.
Don't include prefixes such as Mrs.
Whitespace Trim leading and trailing whitespace.
Hashing Hash using the SHA-256 algorithm. Encode the hash bytes using hex or Base64 encoding.
family_name
Format
string
Convert to lowercase.
Don't include suffixes such as Jr.
Whitespace Trim leading and trailing whitespace.
Hashing Hash using the SHA-256 algorithm. Encode the hash bytes using hex or Base64 encoding.
region_code
Format
string
A two-character ISO-3166-1 alpha-2 code.
Whitespace Trim leading and trailing whitespace.
Hashing Don't hash region_code.
postal_code
Format
string
Both US and international zip and postal codes are allowed.
For US addresses, use either 5 digits or 5 digits followed by a 4-digit extension. Using a 4-digit extension may improve your match rate.
For all other countries, don't use postal code extensions.
Whitespace Trim leading and trailing whitespace.
Hashing Don't hash postal_code.

PairData requirements

Populate the pair_ids field of a PairData object with a list of IDs. Format each element in the list using the following steps:

  1. Hash the cleanroom-provided PII data using the SHA-256 algorithm.
  2. Encrypt the hash bytes with an EC commutative cipher using the publisher key for the PAIR user list.
  3. Encode the encrypted data using hex or Base64 encoding.

MobileData requirements

Populate the mobile_ids field of a MobileData object with a list of mobile IDs. Don't hash mobile IDs.

Timestamp format

If using the JSON format for Timestamp fields, like timestamp and last_updated_timestamp of Event, use the RFC 3339 format.

If using the protocol buffer format, set the seconds and, optionally, the nanos when constructing the Timestamp.

Next steps