LiveRamp Activation API

The LiveRamp Activation API offers programmatic access to LiveRamp marketing solutions.

Guides    API Reference

Configure Distributions

Use the Activation API to manage integration connections.

The Activation API allows you to manage integration connections.

To distribute segment data to a particular platform using the LiveRamp Activation API, your customer must activate an integration connection for that platform destination. An integration connection allows your customer to configure a distribution to one seat at a connection. Each customer often has only one seat per connection.

Before data is available to your customer, the data must meet the integration connection requirements. This typically requires the customer’s account ID and other account-related information for a platform. LiveRamp has templates available for each available integration connection that outline all required properties. The template must be included in the API call to activate an integration connection.

Activate an Integration Connection

To activate an integration connection and to make it available for segment distribution, your customer must do the following:

  • Identify the desired destination
  • Select the device types to match to
  • Submit the required properties in your application UI

📘

About integration connection authorization

For security reasons, some integration connections require customer authorization using OAuth before distributions can be made to the platform. If your application enables integration connections to a platform that requires OAuth authorization, see OAuth Configuration.

Integration Connection Endpoints

The following integration connection endpoints are used in the Configure Distributions section of the Activation API.

Activation API Endpoint

Description

Create an Integration Connection

Create an integration connection

Used to activate (create) a new integration connection and get the ID for it.

OAuth Configuration

Perform OAuth authorization to create an OAuthConnection
(For destination platforms that require OAuth authorization before segments can be distributed)

Used to return the destination platform’s authorization URL and then redirect back to your UI once authorization has been completed.

Fetch a list of Integration Connections

Display a list of all integration connections

Used to get a list of all the integration connections that have been activated in the particular account within LiveRamp.

Delete an Integration Connection

Delete an integration connection

Create an integration connection to receive your customer’s segment data

If this is your customer’s first distribution to a specific destination platform, or if you set up your UI to require that a new integration connection must be created for each distribution, your customer will need to create an integration connection with the properties required for that destination.

An integration connection is a platform to which your customers can distribute their data using the LiveRamp Activation API. An integration connection allows you to configure a distribution to one seat at a destination. In most cases, you should only have one seat per destination per customer. Let your LiveRamp representative know ahead of time which destinations you anticipate your customers will need.

Use the Create an Integration Connection call to activate the integration connection.

Create an OAuth connection

For security reasons, some destination platforms require that your customer is authorized via OAuth before any distributions can be made to that destination. This requires your customer to enter their credentials on the destination platform’s authorization site, which then returns an access token that allows LiveRamp to distribute segments to that destination on the customer’s behalf.

If the integration has an oAuthEndpointID, OAuth is required when creating an integration connection and oAuthEndpointID must be included with the request.

To create an OAuth connection:

  1. POST /v2/o-auth-connection-attempts with the integration's oAuthEndpointID.
  2. Include the returned id value in a GET /v2/o-auth-connection-attempts/:id request. An authorizationUrl is included in the response.
  3. In your browser, open the authorizationUrl and complete the OAuth flow as shown in the following example.
  1. Repeat the GET /v2/o-auth-connection-attempts/:id request. The response now includes the oAuthConnectionID, which can be used to create an integration connection that requires OAuth.

Handling distribution problems

Occasionally a previous OAuth authorization might become unauthorized (either due to actions on the destination platform end or due to someone inadvertently unauthorizing LiveRamp). Have your customer perform the authorization again to see if that solves the distribution issue.

To update an existing OAuth connection, such as when a password is updated:

  1. POST /v2/o-auth-connection-attempts with the integration's oAuthEndpointID and its oAuthConnectionID.
  2. Include the returned id value in a GET /v2/o-auth-connection-attempts/:id request. An authorizationUrl is included in the response.
  3. In your browser, open the authorizationUrl and complete the OAuth flow.
  4. Repeat the GET /v2/o-auth-connection-attempts/:id request. The response now includes the oAuthConnectionID, which can be used to create an integration connection that requires OAuth.

Updated 2 months ago

Configure Distributions


Use the Activation API to manage integration connections.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.