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

Destination Account-Related Capabilities

A number of destination account-related capabilities are available in the Distribution section of the API.

To distribute segment data to a particular platform via LiveRamp’s Distribution API, your customer needs to activate a destination account for that platform destination. A destination account allows your customer to configure a distribution to one “seat” at a destination. In most cases, each customer should only have one seat per destination.

Each destination has different requirements in terms of the information it needs to receive data from LiveRamp and make that data available for your customer. This typically includes the customer’s account ID and other account-related information for that platform.

LiveRamp has templates available for each available destination that outline all required properties for a given destination. That template must be included in the API call to activate a destination account.

Activating a destination account so that it’s available for segment distribution involves your customer identifying the desired destination, selecting the device types to match to, and submitting all other required properties in your application UI.

For security reasons, some destination platforms require that your customer perform an authorization using OAuth before any distributions can be made to that destination platform. See Performing OAuth Authorization for a Destination Account for more information.

Available Destination Account-Related Capabilities

The following destination account-related capabilities are available in the Distribution section of the API:

  • Activate a New Destination Account: Use the Activate New Destination Account to activate (create) a new destination account and get the ID for that destination account when the information in the template for that destination is sent.
  • Perform OAuth authorization for an activated destination account: For destination platforms that require OAuth authorization before segments can be distributed, use the Perform OAuth Authorization call to return the destination platform’s authorization URL and then redirect back to your UI once authorization has been completed.
  • Display a list of all activated destination accounts: Use the List All Accounts call to get a list of all destination accounts that have been activated in that particular account within LiveRamp, including the destination account name, device types selected, and the status of the destination account (whether active or inactive).
  • Display destination account properties: Use the Account Detail call to get destination account details when the destination account ID for that destination account is sent.
  • Deactivate or reactivate a destination account: Use the Deactivate or Reactivate Destination Account call to deactivate an active destination account or to reactivate an inactive destination account.