Use Case: Sending Emails or HEMs to Spherical

OVERVIEW

Deliver a file with your Email or HEM related data, to map behaviors (segments) against. This process will create behaviors on the Spherical platform. 

---

Below is the description of the details needed for the segmentmembership.json.gz file to successfully transmit your Email and/or HEM Mappings to Spherical. Combine this with the 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.

Supported Transfer Mechanisms

For Emails and HEMs, only Lotame hosted AWS S3 buckets are available which allows us to properly secure your identifiable customer data.

Email/HEM-based files must be uploaded into one of the 3 specific regions:

• Americas (North America + South America)
• EU
• APAC

If you have emails sourced from multiple regions, then you will need to split them out into separate uploads. The emails will only be stored and actionable within those specified regions.

• Please inform your Lotame representative which region(s) you need configured.
• Lotame will provide a bucket for each region you need supported.

Lotame requires clients to provide the following:

• ARN of the AWS IAM role that will be used to access the bucket.

Lotame will return:

• AWS S3 bucket name (a different bucket for each region needed)

• A directory structure under that bucket that looks like the following

  • <clientDir1>/<clientDir2> Your Technical Account Manager will coordinate the naming of these two directories. Once created, they are static.
  • <clientDir1>/<clientDir2>/YYYYMMDD: This directory should be created daily by the process on your side that deposits the day's files.
• During processing, Lotame will populate the following directories.
  • <clientDir1>/<clientDir2>/archive: Once processed, the data files are moved to this static folder.
  • <clientDir1>/<clientDir2>/error: Files that are over the size limitations or are 100% error rows are placed here instead of the archive directory.

File Specification

Core JSON Object

Key	Data Type	Required?	Description
userid	String	Yes	The id of the user. (Email or HEM) 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 (EMAIL or EMAIL_SHA256)
segments	Array of Objects	Yes	Behaviors that you want to associate with the Email or HEM.
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":"test@example.com","idtype":"EMAIL","segments":["behavior1", "behavior2","consent":true}
{"userid":"973dfe463ec85785f5f95af5ba3906eedb2d931c24e69824a89ea65dba4e813b","idtype":"EMAIL_SHA256","segments":["behavior1", "behavior3","consent":true}

Consent

• In countries where consent IS REQUIRED under the applicable law to collect and process personal data, the party sending data is required to obtain end-user consent and communicate that consent was obtained by setting "consent" = true. 

  • Note - Alternatively, the IAB Transparency and Consent Framework (TCF) can used for GDPR Countries 

• In countries where consent IS NOT REQUIRED under the applicable law to collect and process the personal data being provided to Lotame, the party sending data is required to indicate that consent is not required by setting "consent" = true.