Get segments

📘

Best Practices for CountryCode and CurrencyCode

In previous versions of the Buyer API, when you requested segments, LiveRamp automatically applied filters for the default country and currency specified by the company profile in Connect Admin. If nothing was specified, the filters defaulted to the US for both country and currency.

In order to give you greater control over filtering, these defaults no longer apply. To restrict your results to segments in the US, specify countryCodes=USAand currencyCodes=USD]as part of the call.

We recommend that all calls include country code and currency code.

Segment Request Parameters

You can specify the following:

• The number of segments to return per call. A maximum of 100 segments can be returned per call.
• The pagination settings for subsequent calls that are pulled from the _pagination.after parameter value of the previous call.
• Filters to return only segments matching any combination of requirements:
  • Advertiser name (to display only segments not blocked from that advertiser)
  • Data provider name
  • Country
  • Currency
  • Identifier type (cookie, mobile, CID, identity link, or offline
  • Fully or partially refreshed since a specified date
  • Whether reach expansion has been enabled

🚧

About Advertiser and Data Provider Names

The advertiser name and the data provider name must match the name in our system. Contact your LiveRamp CSM for a list of data provider names to make sure the name you include matches the name in our system.

Combining Filters for Segment Requests

You can combine as many filters as you like. You can include multiple possible values for a single filter when this is indicated in the parameter reference below. Within a parameter, the logical operator is OR. Between different parameters, the logical operator is AND.

For example, suppose you want segments with price type CPM or CPC, ID type cookie or MAID, and reach extension disabled. This translates to segments which meet the following criteria:

(Price type = CPM OR CPC) AND (ID type = cookie OR MAID) AND (reach extension = false)

For more information, see Filtering Segments

Information Returned for Segment Requests

The call returns the following information for each segment:

• Segment ID
• Segment name
• Description
• Data provider name
• Segment type
• Number of records
• Reach:
  • Android reach
  • iOS reach
  • Cookie reach
• Pricing:
  • Digital ad targeting
  • TV targeting
  • CPM
  • Content marketing
  • % of media revenue share
• Date the metadata was last updated