Data Seller
API Reference

Enable Data Marketplace Segments

post
https://api.liveramp.com/data-marketplace/provider-api/v1/segments

Create and enable a Data Marketplace segment based on an existing first-party segment.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

You can use the segments endpoint to create Data Marketplace segments, which are based on first-party segment data that you previously uploaded to LiveRamp.

Permitted Use Cases

Although the restrictions object itself is not required, the permittedUseCases object beneath it is. You must select at least one permitted use case to create a segment, and also set its pricing in the pricing object. You may also use permittedUseCases to enable or disable the use of the segment in combination segments.

For information about use cases and pricing, see Supported Data Marketplace Pricing Models.

Blocklists and Allowlists

If you do not specify advertisers in the blocklist or the allowlist for a segment, the lists associated with your customer profile will be used by default. You must specify an allowlist for custom and direct segments, even if one is specified in your customer profile, but any specified allowlist will be overridden for syndicated segments.

For information about blocking advertisers, see Blocking Advertisers from Data Marketplace Segments.

Body Params

A Provider's Data Marketplace Segment(s)

uuid

The first-party segment ID.

string

First-party segment ID from the Activation API.

string
required

The segment name shown to Data Marketplace buyers. This is automatically populated by the info provided when your first-party segment was uploaded. See Naming Data Marketplace Segments for requirements and recommendations.

string
enum
required

SYNDICATED segments are created without a specific campaign in mind and are typically available to all data buyers in LiveRamp's Data Marketplace or another platform's UI. CUSTOM segments are typically targeted to a specific campaign. DIRECT segments are used on platforms where a pre-approved agreement is in place. The allowedPlatforms field must not be used for syndicated segments and is required for custom and direct segments.

Allowed:
string

A brief description of the segment, shown to Data Marketplace buyers.

string
enum

Geographical source location for the segment, or where this data can be bought. If not specified, provider defaults are used.

restrictions
object

This field can only be set by providers who have been configured for Customer Profiles. Please reach out to your LiveRamp representative for more information.

pricing
object

Segment pricing model and price. You must specify at least one price, and prices must exist for each use case that is enabled in the permittedUseCases object. Values are either in currency or percentage. $1.50 is input as 1.50. 75.6% is input as 75.6.

boolean

Whether the segment should be visible to buyer, once the Data Marketplace approval process is complete. Defaults to false unless otherwise specified during the creation of the Data Marketplace segment.

string

Data Marketplace provider ID.

string

Comments that are not visible to the buyer. Typically used to specify platform and seat ID for custom segments.

Headers
string
required

The standard way for a LiveRamp API client to identify the Org it is operating as is to set the LR-Org-ID HTTP header.

Responses

Updated 3 months ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated 3 months ago