Call the APIs

To use the ATS SDK, the initialization method needs to be called to start the initialization process. For more information, see Initialize the iOS SDK.

This method returns envelope for the specified identifier. Phone numbers as identifiers are only supported in the U.S..

To retrieve a valid envelope, your ATS placement must be in an approved state. If the placement is unapproved, the SDK will return fake data which should only be used for testing. Information regarding the placement status can be found in the log output of the SDK.

Returns: No return parameter.

Example using completion handler:

let lrEmailIdentifier = LREmailIdentifier("test@email.com")
LRAts.shared.getEnvelope(lrEmailIdentifier) { result, error in
    guard let envelope = result?.envelope else {
        print("Couldn't retrieve envelope. Error: \(error)")
        return
    }
    print("Received envelope: \(envelope)")
}

Example using async/await

do {
    let lrEmailIdentifier = LREmailIdentifier("test@email.com")
    let envelope = try await LRAts.shared.getEnvelope(lrEmailIdentifier)
    print("Received envelope: \(envelope)")
} catch {
    print("Couldn't retrieve envelope. Error: \(error)")
}

Calling this method will remove all data related to LRAtsSDK. To use the SDK after calling this method, you have to go through the initialization process again.

Parameters: No parameters.

Returns: No return parameters.

LRAts.sdkVersion is a property used for checking which version of the SDK you are currently running.

LRAtsSDK.shared is a singleton instance that contains references to the public API.

Example: LRAts.shared.resetSDK()

This property is used to subscribe/unsubscribe to LREvent and for dispatching events and errors.

This property will be used for countries that are outside of the geo-targeting legislation configured in Console. If set to true, SDK will proceed even if there is no legislation.

The default value for this property is false.

This property is used to control the status of the SDK. When set to true, the SDK becomes disabled. As a result, the APIs will not function and API calls will not be possible. Setting the property to false changes the SDK status to notInitialized and re-initialization is required before API calls can be made again.

The default value of this parameter is false.

This property provides information about the SDK status which value is a type of LRStatus.

The default value of this property is notInitialized.

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:

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

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

LRCustomIdentifier class implements LRIdentifierData protocol. As an object, LRCustomIdentifier is used to obtain envelopes as one of the possible parameters of the 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")

This class is used to configure LRAtsSDK during initialization.

SDK events are defined with LREvent enum.

The SDK error states are defined with LRError enum. SDK returns the standard Error types. To get more information, you can cast the error to LRError.

Status of the SDK is defined with LRStatus enum.