Pass Mobile Identity Envelopes to the Bidstream

Once ATS API is set up, you can now configure the programmatic advertising solution to pass your envelopes into downstream workflows and monetize your inventory. LiveRamp is working with several partners that support setting identity envelopes in their SDKs, and passing them into their programmatic bidstreams.

Prebid (SDK)

You can pass envelopes a Prebid server instance from the Prebid iOS/Android SDK by adding the envelope as an ExternalUserId .

externalUserIdArray.add(new ExternalUserId("liveramp.com", "<liverampEnvelope>", null, null));

externalUserIdArray.append(ExternalUserId(source: "liveramp.com", identifier: "<liverampEnvelope>"))

For more information, see the Prebid SDK documentation for iOS or Android SDK.

InMobi

InMobi allows in-app publishers to pass identity envelopes into InMobi's exchange using their UnifID service. There are two ways you can pass envelopes to InMobi:

• Use the ATS Envelope API to generate the envelopes and pass them to InMobi's UnifID service using setPublisherProvidedUnifiedId.

val unifiedIds = JSONObject().put("liveramp.com", envelope)
InMobiSdk.setPublisherProvidedUnifiedId(unifiedIds)

var idDictionary = ["liveramp.com": envelope]
IMSdk.self.setPublisherProvidedUnifiedId(idDictionary)

• Use InMobi’s own SDK to generate and pass envelopes. See InMobi's SDK Specifications to learn how.

Pubmatic

iF you are working with Pubmatic, you can pass envelopes through Pubmatic OpenWrap SDK to configured OpenWrap partners.

// Set the envelope here
// It MUST be liveramp.com to work
var userId = POBExternalUserId(source: "liveramp.com", andId: "<liverampEnvelope>")
 
 
// Add the ID to OW SDK 
OpenWrapSDK.addExternalUserId(userId)

// Set the envelope here
// It MUST be liveramp.com to work
POBExternalUserId adServerUserId = new POBExternalUserId("liveramp.com","<liverampEnvelope>");


// Add the ID to OW SDK 
OpenWrapSDK.addExternalUserId(adServerUserId);

See the following documentation in Pubmatic's portal to learn more (login to Pubmatic required):

• iOS
• Android

Nimbus

Nimbus SDK allows you to pass envelopes to Nimbus' exchange. There are two ways you can do this:

• Pass envelopes directly to Nimbus SDK. For example:

  Android (Kotlin)iOS (Swift)

  NimbusAdManager.addExtendedId(
        source = "liveramp.com",
        id = envelope,
        extensions = mapOf("rtiPartner" to "idl"),
  )

   var extendedId = NimbusExtendedId(source: "liveramp.com", id: envelope)
  extendedId.extensions = ["rtiPartner": NimbusCodable("idl")]
  
  /* Setting extendedIds more than once will clear the previous results and is nil by default */
  NimbusAdManager.extendedIds = [extendedId]

• Use the Nimbus-LiveRamp extension to generate and pass envelopes. For more information, see Nimbus' documentation for Android and iOS.

MobileFuse

MobileFuse's SDK allows you to pass RampID Envelopes to MobileFuse's exchange - MFX.

There are two ways you can do this:

• Pass envelopes directly to MobileFuse using MobileFuseTargetingData:

// Pass in a RampID Envelope here
[MobileFuseTargetingData setLiveRampEnvelope: @"<liverampEnvelope>"];

// Pass in a RampID Envelope here
MobileFuseTargetingData.setLiveRampEnvelope(“<liverampEnvelope>”)

• Use MobileFuse's SDK to generate and pass identity envelopes. See MobileFuse's documentation to learn how or reach out to your MobileFuse account manager.

AppLovin MAX (SDK)

You can pass envelopes to AppLovin MAX fto AppLovin MAX by adding the RampID Envelope as an extra parameter in AppLovinSdkSettings:

AppLovinSdkSettings settings = AppLovinSdk.getInstance( context ).getSettings();
settings.setExtraParameter( "liveramp.com", "<liverampEnvelope>" );

let settings = ALSdk.shared()?.settings
settings?.setExtraParameterForKey("liveramp.com", value: "<liverampEnvelope>")

For more information, see AppLovin's MAX SDK documentation on how to pass identifier tokens for iOS or Android.