Server to Server Technical Specs - Outbound from Spherical - Batch File Processing
OVERVIEW
This article contains the technical specs for sending data out of the Spherical platform using supported file transfer mechanisms.
AWS S3 Transfer
Lotame supports delivering files to your AWS S3 bucket using our Lotame External ARN. To support, please implement a bucket policy on your s3 bucket that allows:
Access to the Lotame ARN of arn:aws:iam::311305431179:role/LotameS2SExternalRole-us-east-1
For the following S3 actions:
s3:ListBucket
s3:GetObject
s3:PutObject
An example S3 bucket policy clause is below as an example:
{
"Sid": "AllowLotameWrite",
"Effect": "Allow",
"Principal": {
"AWS": "arn:aws:iam::311305431179:role/LotameS2SExternalRole-us-east-1"
},
"Action": [
"s3:ListBucket",
"s3:GetObject",
"s3:PutObject"
],
"Resource": [
"arn:aws:s3:::<your bucket name>",
"arn:aws:s3:::<your bucket name>/<base path for Lotame files>/*"
]
}Lotame requires clients to provide the following:
AWS Bucket Name.
A directory structure, as noted below based on the s3 bucket directory you provided above.
Either <YYYYMMDDHH>/<clientDir> or <clientDir>/<YYYYMMDDHH>.
The <clientDir> value will be provided by Lotame, and it is static and will not change. <YYYYMMDDHH> value is the GMT date + hour of the file contents and will be created by our upload process for each file delivery.
Google Cloud Storage
Lotame supports delivering files to your Google Cloud Storage bucket. To support, please provide Lotame with the following:
Storage Bucket Name & Path
Google Cloud Project ID
Service Account HMAC Key
Permissions on the account that allows Storage Object Creator.
Please share the HMAC key securely. Reach out to your Lotame account representative for options.
sFTP Transfer
Lotame Hosted sFTP Server
Lotame provides an sFTP server for file transfer. When clients provide an SSH public key, Lotame will return the sFTP user account and directory path to retrieve the files.
- Hostname - booth.crwdcntrl.net
- Port - standard (22)
The directory structure is <YYYYMMDDHH>/<clientDir> or <clientDir>/<YYYYMMDDHH>. The <clientDir> value will be provided by Lotame and it is static and will not change. <YYYYMMDDHH> value is the GMT date + hour of the file contents and will be created by our upload process for each file delivery.
Client Hosted sFTP Server
In the case where you want the files sent to your own sFTP server, complete the following steps:
- Lotame will provide you with our SSH public key which you will need to apply to your server.
- Provide Lotame the DNS or IP address of the sFTP server.
- Provide Lotame the username that will allow our SSH key to login.
- Create a directory as noted below based at the root of your username's path.
<clientDir>= Your Technical Account Manager will coordinate with naming of this directory. Once created, they are static.
<clientDir>/<YYYYMMDDHH> is the GMT date + hour of the file contents and will be created by our upload process for each file delivery.
Data File Types
Lotame supports sending files as comprehensive or deltas from the prior file.
- Comprehensive – Lotame will send all users that had activity for the day, and their comprehensive audience membership list.
- Incremental – Lotame will only send updates:
A new user is created in the Spherical platform
An existing user qualified for a new audience
Please discuss with your Lotame Technical Account Manager options on which file type works best for your integration.
Note: Delta file types require a periodic comprehensive file sent to ensure our segments do not get out of sync. The default is 30 days, but you can work with your Lotame Technical Account Manager to decide a different timeframe that is best for your business needs.
Data File Specifications
Lotame sends 5 files for the Outbound Batch processing.
- Audience Membership file which contains all the UserIDs and their associated audiences.
- Audience Metadata file which contains a mapping of audience ID to human-readable description of that audience.
- Audience Membership MD5 checksum file to be used to validate the correctness of the Audience Membership file delivery.
- Audience Metadata MD5 checksum file to be used to validate the correctness of the Audience Metadata file delivery.
- A DONE file to denote to your processing that Lotame is done with file uploads for that day.
Audience Membership File
This file has a static filename of audiencemembership.tsv.gz. This file is a gzip encoded file to be file space efficient and minimize transfer timings.
The file is tab-separated between the two data points of UserID and Audiences. The UserID are unique in the file.
| Key | Data Type | Description |
| UserID | String | UserID identifier to use in the Spherical platform. UserIDs have a a prefix followed by colon to identify the type of identifier passed. Allowed identifier types are listed below. |
| Audiences | Comma Separated List of Strings | Comma separated list of audiences to link to the UserID |
Supported UserID Identifiers
| Universal IDs | |
| Identifier Prefix | Description |
| PANO | Lotame Panorama ID ™ |
| Web IDs | |
| Identifier Prefix | Description |
| {no prefix or colon} | Lotame Profile IDs (pid) |
| {no prefix or colon} | Third Party IDs (tpid) |
| Mobile IDs | |
| Identifier Prefix | Description |
| IDFA | Apple Identifier for Advertising |
| GAID | Google Advertising ID |
| Connected TV IDs (OTT) IDs | |
| Identifier Prefix | Description |
| RIDA | Roku TV and Streaming Devices |
| TVOS | Apple TV |
| CHRM | Android TV / Google Chromecast Devices |
| AFIA | Amazon Fire TV Devices |
| SMSG | Samsung TVs |
| HIP4 | IPv4 Address |
| Connected TV IDs (OTT) IDs | |
| Spherical also supports exporting your customer-specific ID types you have sent into the system. Please work with your Lotame Account Manager to learn more about this and whether it is right for your implementation. | |
To see our full list of supported CTV IDs, please see our CTV Overview page.
Lotame Profile IDs (PID)/ Third Party IDs (TPID), Mobile Advertising Device IDs and CTV (OTT) IDs can be combined in the same file, or separated into multiple files if requested.
CTV (OTT) file can be further broken down into multiple files by each device type (Roku, Apple TV etc) on request.
Third Party IDs (TPID) and Lotame Profile IDs (PID) cannot be combined in the same file.
Example File
e1ec57335975afb3eb81c898d09cf9b9 395338,285289
cac945ff3946e16842af8c0951e7b9ee 395338
PANO:0bed52425b1b65dec4cf2373119b16d53938b85871267f094f2ea13a224849e5 365147,395338,296412
PANO:ac3382286397f7297242867dbd2216d539381bc632e61fafd9ba38aebf4a4a30 285289,395338,375412
IDFA:C87CB4B6-87A1-42E3-A994-B3734A0D4F69 395338,375412
IDFA:E860367A-E08C-406F-9472-C57A916A2889 285289,395338
GAID:000958bf-4c0d-4c68-9ff5-d6bbb1b08739 358945,285289
GAID:2v2fbcab-13b1-4350-be7f-fd21d0924p2b 395338Audience Metadata File
This file has a static filename of metadata.json.
The JSON file is contains an audience object which contains an array of mapping objects. The format of the mapping object is denoted below.
| Key | Data Type | Description |
| id | Integer | Lotame Audience ID value found in the above Audience Membership file |
| name | String | Human-readable description of the Audience ID |
Example File
{
"audience":[
{
"id":123,
"name":"Sports Lovers"
},
{
"id":234,
"name": "Exposed to Campaign X"
}
]
}Audience Membership MD5 Hash File
This file has a static filename of audiencemembership.tsv.gz.md5. This plain-text file only contains the MD5 hash of the gzip encoded Audience Membership. Use the MD5 hash to validate the completeness of the uploaded Audience Membership file.
Audience Metadata MD5 Hash File
This file has a static filename of metadata.json.md5. This plain-text file contains the MD5 hash of the gzip encoded Audience Metadata file. Use the MD5 hash to validate the completeness of the uploaded Audience Metadata file.
Done File
The Done file has a filename of YYYYMMDDHH.done. This zero-length file will be created when all uploads by Lotame are complete for the day. Please have your processing wait on this file to exist before loading the day's files.