iOS Methods for LRAtsMediationAdapter

This article lists all the methods and properties available with LRAtsMediationAdapter for iOS. LRAtsMediationAdapter facilitates data exchange between the Google AdMob and LRAtsSDKby allowing AdMob SDK to collect signals from LRAtsSDK.

To learn how to implement LRAtsMediationAdapter with Google Secure Signals, see "Generate and Pass Identity Envelopes with Google Secure Signals Adapter".

For SDK v3.0.0 and Above

If you are running the ATS Mobile SDK v3.0.0 and later, you don't need to perform any of the instructions and methods in this article. All required configurations to pass Google envelopes are set up out-of-the-box in these SDK versions.

Initialize the LRAtsSDK as feasibly as possible, and retrieve an envelope by calling getEnvelope. An identity envelope will automatically be included in your ad requests if LiveRamp is enabled as a secure signals partner. See the prerequisites to learn more.

📘

To check which SDK version you are running, call sdkVersion.

Installation

To install with Swift Package Manager:

1. in Xcode, go to File > Add packages.
2. In Search or Enter Package URL, enter: https://github.com/LiveRamp/ats-sdk-ios-google-adapter
3. Click Add Package.

To install with CocoaPods:

1. Add the following line to your Podfile:

   pod 'LRAtsSDKMediationAdapter'
   

2. Open Terminal and go to the directory where Podfile is located.
3. Execute pod install to install the LRAtsSDKMediationAdapter.
4. In Xcode, go to your project's build settings and add the -ObjC linker flag to the Other Linker Flags build setting (AKA OTHER_LDFLAGS). This ensures that all Objective-C categories and class extensions are property linked.

Usage

🚧

Not Applicable for v3.0.0

This instruction is only applicable for iOS SDK v2.9.0 and below.

View how LRAtsMediationAdapter should be called below. If your ATS placement is enabled for Google SSP and Google envelope is detected, the collect signal call returns a Google-permissioned envelope. If not, it will return an ATS envelope

import LRAtsSDKMediationAdapter

LRAtsMediationAdapter.setIdentifier(LREmailIdentifier(email: "<#email#>"))
LRAtsMediationAdapter.configure(atsConfiguration: LRAtsConfiguration(appId: "<#your app id#>"))
// optional
// LRAtsMediationAdapter.hasConsentForNoLegislation = true

Methods

🚧

Deprecated for v3.0.0

The methods in this article are deprecated for v3.0.0 and later, since all configurations are automatically set up in these versions.

The methods below are only applicable for iOS SDK v2.9.0 and below.

configure(atsConfiguration: LRAtsConfiguration)

This method prepares the required information to configure LRAtsSDK. For more information, see LRAtsConfiguration.

Returns

No return parameter

setIdentifier(identifier: LRIdentifierData)

This method sets an identifier which will be used through a mediation adapter. You must call this method before attempting to retrieve signals.

adSDKVersion()

This method returns the SDK version as a GADVersionNumber object.

Parameters

No parameter

Returns

GADVersionNumber

adapterVersion()

This method returns the adapter version as a GADVersionNumber object.

Parameters
No parameter

Returns
GADVersionNumber

setUpWith(_:completionHandler:)

This method is automatically called from AdMob SDK once per session instructing the adapter to set up LRAts SDK. The adapter will call completionHandler once it can collect signals, or if it encounters an error while setting up.

Returns

No return parameter

Properties

hasConsentForNoLegislation

This property is used for countries that are not covered by any geo-targeting rules (countries that are not under GDPR or CCPA legislation) configured in Console. Setting this property to true will allow LRAtsSDK to continue and collect signals, otherwise, no signals will be collected.