Documentation

Leveraging RampID

Instruction how to pass Ramp external ID value through BidMachine SDK:

By providing LiveRamp envelope to BidMachine, publishers can boost monetization while staying compliant with privacy standards. BidMachine collaborates with LiveRamp and uses the LiveRamp Authenticated Traffic Solution (ATS) API.

For more information on LiveRamp’s Authenticated Traffic Solution and how it works, refer to this link

How to submit data:

Note that BidMachine only accept LiveRamp envelopes.

Learn more about the identity envelope link

To participate, please follow these steps:

  1. Establish a contract and integration with LiveRamp.
  2. Currently, the BidMachine SDK supports passing a publisher’s LiveRamp envelope as an external ID within the SDK. So you need to generate envelope using ATS and pass it to BidMachine SDK.

Passing in an external LiveRamp envelope value to BidMachine SDK:

import BidMachine

let exampleEnvelopeString = "AY3SYJlFDI1RqsMv9gZOjOab6hGuwWKmbE4K70Z-Zex27DD6M9U0Jg"

BidMachineSdk.shared.targetingInfo.populate {
    $0.appendExternalId("liveramp.com", exampleEnvelopeString)
}
#import <BidMachine/BidMachine.h>
  
NSString* exampleEnvelopeString = @"AY3SYJlFDI1RqsMv9gZOjOab6hGuwWKmbE4K70Z-Zex27DD6M9U0Jg";

[BidMachineSdk.shared.targetingInfo populate:^(id<BidMachineTargetingInfoBuilderProtocol> builder) {
    [builder appendExternalId:@"liveramp.com" :exampleEnvelopeString];
}];

Retrieving the previously passed external LiveRamp envelope value:

import BidMachine

if let liveRampEnvelopeString = BidMachineSdk.shared.targetingInfo.externalIds["liveramp.com"] {
    // use the liveRampEnvelopeString as needed for your specific implementation.
}
#import <BidMachine/BidMachine.h>
  
NSString *liveRampEnvelopeString = [BidMachineSdk.shared.targetingInfo.externalIds valueForKey:@"liveramp.com"];

if (liveRampEnvelopeString) {
    // use the liveRampEnvelopeString as needed for your specific implementation.
}