Use Case: ID Mapping

OVERVIEW

Send a mapping file server-side to allow for mapping your TPID to a Lotame ID (PID, MAIDs (IDFA, GAID), CTV IDs (RIDA, TVOS, etc)).  This allows Spherical to connect their userIDs to your TPID for user linking and server-side data transfer.


Below is the description of the details needed for the segmentmembership.json.gz file to successfully transmit your ID Mappings to Spherical. Combine this with the Transfer Mechanisms and File specifications pages to complete the integration.

When sending your ID Mappings to Spherical, Lotame supports the below fields to pass the appropriate information to the userID you pass.

File Specification

Core JSON Object

Key Data Type Required? Description
userid String Yes The id of the user. (This would be Lotame userIDs - PIDs, MAIDs or CTV IDs. NOT TPIDs)
Note
- A userID, should only appear once (one row) in a given file
- IDs must only contain alphanumeric characters.
idtype String Yes Allows Spherical to identify the id type of the userid (PID, IDFA, RIDA, etc)
Refer to the User ID Type section for the full list of supported ID types.

Note The idtype value is case-insensitive.
tpid String Yes The Third Party ID (TPID) to sync with the UserID.
consent Boolean Yes, unless tcfconsent key is passed Instructs Lotame as to whether you have obtained consent for the user/record. 
- true = yes, consent has been provided
- false = no, consent has not be provided

Note
- If blank, false, or set to anything other than true, Lotame will skip the user record.  
- Alternatively, you can use the tcfconsent key for EMEA users.
tcfconsent String Yes, unless consent key is passed For EMEA users, you can provide the TCF consent string that was obtained along with the collected data included in the record
Note
- If blank or Lotame’s vender ID (95) does not have proper consent, Lotame will ignore the user record
- Alternatively, you can use the consent key

Example

{"userid":"e1ec57335975afb3eb81c898d09cf9b9","idtype":"PID","tpid": "abcdefghijklmnop123456789","consent":true}