LREmailIdentifier

LREmailIdentifier class implements the LRIdentifierData protocol. As an object, LREmailIdentifier is used to obtain envelopes as one of the possible parameters of the getEnvelope method.

The LREmailIdentifier object can be instantiated using one of the following constructors.

With a constructor that accepts mail as a string:

LREmailIdentifier("[email protected]")

Or with a constructor that accepts sha1, sha256 and md5 hash values as strings:

LREmailIdentifier(sha1:"52e17b67fd82b0545bb4fbdc5748ed23104133c7",
                sha256:"F0E2A21BCF499CBC713C47D8F034D66E90A99F9FFCFE96466C9971DFDC5C9816", 
                md5:"97dfebf4098c0f5c16bca61e2b76c373")

LRPhoneNumberIdentifier

🚧

Currently, phone numbers are only supported in the U.S..

LRPhoneNumberIdentifier class implements the LRIdentifierData protocol. As an object, LRPhoneNumberIdentifier is used to obtain envelopes as one of possible parameters of getEnvelope method.

LRPhoneNumberIdentifier object can be instantiated using one of the following constructors.

With a constructor that accepts phone number as a string:

LRPhoneNumberIdentifier("0123456789")

Or with constructor that accepts sha1 hash value as a string:

LRPhoneNumberIdentifier(sha1:"87acec17cd9dcd20a716cc2cf67417b71c8a7016")

LRCustomIdentfier

❗️

Not available for all publishers

Due to the complexity of the customer ID mapping process, this class is only available for selected publishers who must go through an extensive onboarding process. Please note that you cannot use this API out-of-the-box.

LRCustomIdentifier class implements LRIdentifierData protocol. As an object, LRCustomIdentifier is used to obtain envelopes as one of possible parameters of getEnvelope method.

LRCustomIdentifier object can be instantiated using a constructor that accepts customID as a string and the passed value needs to be in the following format ANA_ID:CUSTOM_ID.

ANA_ID represents the Account ID (provided by LiveRamp) whereas CUSTOM_ID represents the custom identifier.

LRCustomIdentifier("54321:abc123")

LRAtsConfiguration

This class is used to configure LRAtsSDK during initialization.

Property NameTypeDefaultDescription
appIdString/App ID (Config ID) obtained from LiveRamp Console.
isTestModeBoolfalseIf set to true, test mode will be enabled in which test data is returned instead of real data from the backend. See Test Mode to learn more.
logToFileEnabledBoolfalseIf set to true, all log levels will be logged to file in /Documents/ats-sdk-ios/logs directory in the app sandbox.