Why Platform Segments?
Creating Platform Segments via API is intended for power users who perform external analysis of Salesforce DMP data. Based off the external analysis, the user can create segments comprised of Salesforce DMP ID’s (KUID’s) outside of Konsole.
What are the steps necessary for creating platform segments?
Essentially, there are 2 steps to creating platform segments:
- Create a Platform Segment via API
- Populate the users in the platform segment by uploading the list of associated KUIDs
1. Creating a platform segment shell
There are multiple ways to create a segment shell to obtain the segmentid to include in the user-data file that gets uploaded to S3. Use the DMP UI to manually create it, or use an API.
Both options may be used and segments created via API may be edited manually in the DMP UI.
A. Create using the DMP Segment Management Tools
- Navigate to Segments in the DMP UI
- Create New Segment
- Choose Platform Segment
- Enter a name and save (Optionally include additional information, such as Category, Sub-Category, etc.)
B. Create using an API
Before you build platform segments via API, Salesforce must provide an API key and enable the user for use of the API. Please contact your Salesforce DMP account team for the API key and enablement of the API for specific users.
In order to build platform segments via API, you must run commands via a command line interface like the Mac’s Terminal. This is the API call:
cURL? POST request?
The Salesforce DMP Platform Segment API uses cURL, a lightweight, command-line tool for making HTTP requests without a web browser. The Salesforce DMP Platform Segment API using cURL makes a POST request, which is how the segment gets created in Konsole.
If the API call was successful, you should see a response like this:
Confirm in Konsole that the platform segment you created exists.
2. Uploading User-data file for Platform Segments
The data can either be sent to or pulled by Salesforce. The data transfer is facilitated via S3. Please notify your Salesforce DMP team on the:
- Name & Location of user-data transfer
- Timing and Frequency, including when the transfer will take place
- Format of the user data file
The user-data file location should be like this:
User-data file format should look like:
Where segment_uuid_long is the segment ID of the segment just created via API, and KUID is the Krux user ID.
The user-data file needs to be a gzipped plain text file in UTF-8.
Please note that platform segments are not editable. They are not rule based, and their population will be determined as each user-data file is processed. Each time Salesforce processes a user-data file, it’s processed as a full load, or full refresh. This means that the entire population that you intend to include in the platform segment should be present in each user-data file.
Can I include device ID’s (IDFA/ADID) as part of a platform segment?
Yes you can. When dealing with device ID’s, the KUID defaults to the Device ID like an IDFA.
*If you’re looking to import device ID’s as attributes in Konsole, you would have to do so via a first party import.
Can I build a lookalike from a platform segment?
Yes - In order to do so, you will need to build a standard segment from the platform segment.