These docs are for v1.0.2. Click to read the latest docs for v2.9.0.

Create a Data Store Segment

Allows for the creation of specific Data Store segments.

Create a Data Store segment

Use the Create Data Store segment route to create a Data Store segment. At minimum, you must specify the following parameters:

field_name
Corresponds to the column header in the imported source file.
value_name
Corresponds to the desired string or numeric value in that column.
audience_id
The ID of the audience the file is being imported into.
field_type
Indicates whether the data being imported will be designated as numeric or string values. The two enum options here are 'string' and 'numeric'.
name
The name of the segment as it will appear in the Data Store

If you need help, please reach out to your LiveRamp representative for help determining the correct values for audience_id and field_type.

Set seller_approval to true to list the segment in the Data Store (leaving it as false would disable it from being purchased and prevent it from being distributed).

When sending custom segments, set the segment as custom and include whitelisted destination IDs and buyers. To find an ID for a given destination, use the List all available Data Store Destinations action. Optionally, you may download a reference sheet from LiveRamp Connect.

Once complete, save the resulting data_store_segment_id. This identifier will be used to interact with the rest of the Data Store API.

❗️

Make sure your data gets imported!

While you are able to create a Data Store segment before/after file import a file to us, we will not be able to deliver the segment to any destinations until we have ingested it into the correct audience!

Learn to check for existing segments here.

Please reach out to your LiveRamp contact to learn about how this step can be automated.

🚧

If you are migrating from the Beta API...

If you are referencing Fields and Values by their IDs, you will need to remove them from the API call. Only one of Field/Value names and Field/Value IDs can be specified -- providing both pairs, or providing only one ID or only one name, will raise errors.