Advanced-Level Integration Example

If you’d like to provide your customers with the ability to easily send many segments (lists) to many different destinations, you can build out a more advanced-level integration (similar to the capabilities that LiveRamp provides within the Connect UI).

This type of integration requires a more significant development effort as it involves utilizing the Distribution API to create more complex workflows and visualizations, involving providing the customer capabilities listed below:

Distribute any combination of segments to any combination of destination accounts.
View a description of destination account fields (so that they can correctly enter in the appropriate values when activating a destination account).
Manage all currently distributing LiveRamp segments.
View all activated destination accounts and their properties.
Have their updated lists/segments reflected in LiveRamp so that their data will always be up to date
Be notified via email when their segment is successfully delivered to the end destination platform so that they can get their campaigns out as soon as possible.

See the appropriate sections below for more information on creating this user experience within your application UI (including the relationship between customer actions, application actions, and API endpoints (where appropriate) for each of these capabilities).

Application Integration Actions Required

See the appropriate sections below for more information on the relationship between customer actions, application actions, and API endpoints (where appropriate) for each of these capabilities.

Distribute any Combination of Segments to any Combination of Destination Accounts

The primary action your customers will need to perform is distributing multiple segments (lists) to multiple destinations. This workflow varies somewhat depending on whether any of the selected segments have already been uploaded to LiveRamp and whether the customer has already created destination accounts for all of the selected destinations.

Customer Steps	Customer Actions	Application Actions	API Endpoint Involved
1	Selects segments (lists) to distribute through LiveRamp	Check to see if any segments have been previously uploaded	List All Segments
		Ensure that any data files not previously uploaded meet LiveRamp formatting requirements	None
		Upload any files not previously uploaded to LiveRamp’s SFTP with the customer-specific credentials	None
2	Selects their desired destinations	For destinations that the customer has not previously activated, displays the fields the customer needs to enter (client seat, distribution name, etc.) to activate the destination account by utilizing the json template for that destination	None
3	Enters destination account properties (only for destinations that the customer has not previously activated)	Calls the API with the required template information	Activate New Destination Account
		For segments that have not been previously uploaded, calls the API to confirm that the segment has been processed and is available for distribution (usually within 24 hours of upload) and to obtain the segment ID	Segment Lookup
		Calls the API (with the segment ID obtained from the Segment Lookup call) to add the segment to the distribution for that destination account	Add Segments to a Destination Account

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. If your application will be enabling distributions to a platform that requires OAuth authorization, see Performing OAuth Authorization for a Destination Account for information on including that functionality in your application.

Manage all Currently Distributing LiveRamp Segments

At times your customers might want to view a list of all their currently distributing segments (lists), along with a list of the destinations those segments are being distributed to. They also might want to remove a particular segment from active distribution.

Customer Steps	Customer Actions	Application Actions	API Endpoint Involved
1	Navigates to the application UI location to view all currently distributing LiveRamp segments	Displays a list of the segments have been previously uploaded to LiveRamp	List All Segments
		Displays a list of the destinations each segment is distributing to	List All Segments for a Destination Account
2	Removes a segment from distribution (if desired)	Calls the API (with the segment ID obtained from the Segment Lookup call) to remove the segment from the distribution for that destination account	Remove Segments from a Destination Account

View all Activated Destination Accounts and Their Properties

At times your customers might want to view a list of all their previously activated destination accounts and their properties.

Customer Steps	Customer Actions	Application Actions	API Endpoint Involved
1	Navigates to the CDP UI location to view all destination accounts	Displays a list of the destination accounts that have been previously activated	List All Accounts
2	Selects a destination account to view properties	Displays the destination account properties	Account Detail

Handling Segment Updates

If your customer updates the data for an existing segment, the data should be updated in LiveRamp. See “Updating Segments in LiveRamp” for more information.