Classes

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.

You can instantiate the LREmailIdentifier object using 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")

LRHashedEmailIdentifier

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

You can instantiate the LRHashedEmailIdentifier object using the following constructor which accepts one or more hash values (SHA1, SHA256, MD5) as strings:

LRHashedEmailIdentifier(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.

You can instantiate the LRPhoneNumberIdentifier object using one of the following constructors.

With a constructor that accepts phone number as a string:

LRPhoneNumberIdentifier("0123456789")

Or with a 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 the 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")

LREnvelopeIdentifier

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

LREnvelopeIdentifier object can be instantiated using a constructor that accepts envelope as a string.

LREnvelopeIdentifier("someEnvelopeString")

LRAtsConfiguration

This class is used to configure LRAtsSDK during initialization.

LRDealIdentifier

LRDealIdentifier class implements the LRIdentifierData protocol and the LRDealIdentifier object is used for generating Deal IDs as a parameter of getDealIDs method.

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

With a constructor that accepts mail as a string:

LRDealIdentifier("[email protected]")

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

LRDealIdentifier(sha256:"f0e2a21bcf499cbc713c47d8f034d66e90a99f9ffcfe96466c9971dfdc5c9816")

LREnvelope

This class is used to return envelope for specified identifier.