Use Case: Sending Behaviors to Spherical
OVERVIEW
Deliver a file with your data, containing userIDs and behaviors (segments), to ingest data into the Spherical platform account. 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 behaviors to Spherical. Combine this with the Transfer Mechanisms and File specifications pages to complete the integration.
When sending behaviors 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. 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 complete list of supported ID types. Note The idtype value is case-insensitive. |
segments | Array of Objects | Yes | Behaviors that you want to associate with the userid. You can pass sighting recency by passing a time stamp inside the object if needed. Refer to the below “Segment Object Details” table to pass these values. Note: You can specify the recency of the behavior by including a timestamp inside the object. |
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 |
ips | array of ip objects | No | The sightings data for the userID. See the below table for ips object details |
remove | String | No | Segments to remove from the userid. It is specifically applicable when sending delta files daily. |
Segment Object Details
Key | Data Type | Required? | Description |
name | String | Yes | Behavior that you want to associate with the userid. It is preferred segments are alphanumeric with no special characters. |
timestamp | Integer | No | The epoch timestamp in which the segment was attributed to the profile. Must be in UTC seconds. |
IPs Object Details
Key | Data Type | Required? | Description |
ip | String | Yes | IP4 address. (IPv6 not currently supported) |
timestamps | Array of Strings | Yes | The epoch timestamp in which the segment was attributed to the profile. Must be in UTC seconds. |
Examples
Example: Passing in Behaviors Only:
{"userid":"e1ec57335975afb3eb81c898d09cf9b9","idtype":"PID","segments": ["1","2","arts & music"],"consent":true}
{"userid":"e480a48a23eb8c6b82401048c3456945a7020ad0470402219bcec770d43b406e","idtype":"PANO","segments": ["rockmusic"],"consent":true}
{"userid":"1a2fbcab-13b1-4350-be7f-fd21d0924f4b","idtype":"IDFA","segments":["rockmusic"],"consent":true}
{"userid":"johndoe@test.com","idtype":"EMAIL","segments":["football","sports"],"tcfconsent":"CPS0IbiPS0IbiABAMBFRACCsAKgAAAPAAIYgAvwAwAAgAEAC-AAxEAA"}
{"userid":"79c7558b8890ef49f29a022b7704edeeafa4af9bd90f1771e87dbf5db7ce1f03","idtype":"EMAIL_SHA256","segments":["lkj899","ert345"],"consent":true}
Example: Adding Recency to a Behavior:
{"userid":"e1ec57335975afb3eb81c898d09cf9b9","idtype":"PID","segments":[{"name":"rockmusic","timestamp":1614274012},{"name":"jazz","timestamp":1614014782}],"consent":true}
Example: Adding Sightings information to a Behavior:
{"userid":"e1ec57335975afb3eb81c898d09cf9b9","idtype":"PID","segments":["rockmusic","jazz"],"ips":[{"ip":"10.255.255.182","timestamps":["1533149952","1533150020"]},{"ip":"10.255.100.222","timestamps":["1533140052"]}],"consent":true}
Example: Remove Behavior from a UserID:
{"userid":"e1ec57335975afb3eb81c898d09cf9b9","idtype":"PID","segments": ["1","2","arts & music"],"remove": ["rock music"],"consent":true}
Example: Kitchen Sink of all above as we support all options in the same file:
{"userid":"e1ec57335975afb3eb81c898d09cf9b9","idtype":"PID","segments": ["1","2","arts & music"],"consent":true}
{"userid":"e480a48a23eb8c6b82401048c3456945a7020ad0470402219bcec770d43b406e","idtype":"PANO","segments": ["rockmusic"],"consent":true}
{"userid":"mattsmitch22@test.com","idtype":"EMAIL","segments":["rockmusic"],"tcfconsent":"CPS0IbiPS0IbiABAMBFRACCsAKgAAAPAAIYgAvwAwAAgAEAC-AAxEAA"}
{"userid":"79c7558b8890ef49f29a022b7704edeeafa4af9bd90f1771e87dbf5db7ce1f03","idtype":"EMAIL_SHA256","segments":["lkj899","ert345"],"consent":true}
{"userid":"2v2ab-13b1-4350-be7f-fd21d0p2b","idtype":"GAID","segments":["football","sports"],"consent":true}
{"userid":"e1ec57335975afb3eb81c898d09cf9b9","idtype":"PID","segments":[{"name":"rockmusic","timestamp":1614274012},{"name":"jazz","timestamp":1614014782}],"ips":[{"ip":"10.255.255.182","timestamps":["1533149952","1533150020"]},{"ip":"10.255.100.222","timestamps":["1533140052"]}],"consent":true}
Content aside
Categories
-
- Activation Channel Partners
-
- Inbound to Spherical
- Overview
- Use Case: ID Mapping
- Use Case: Sending Behaviors to Spherical
- Use Case: Sending Sightings Data Only
- Use Case: Lotame Data Exchange
- Supported File Transfer Mechanisms
- Supported ID Types
- How to Create and Share Public SSH Keys
- Passing User Consent
- Onboarding - File Specifications
- Manually Uploading Onboarding Files to Lotame S3
- Outbound from Spherical
- Inbound to Spherical
- Data Collection with Lightning Tag
- Administrative API
- User ID Syncing
- Single Sign-On (SSO)
- Lotame Panorama ID—Prebid, Google ESP & Amazon CxM
- 1 yr agoLast active
- 1367Views
- 1 Following