Global Targeting Parameters

Prebid Mobile supports the following global targeting parameters. These targeting parameters are set only once and apply to all Prebid Mobile ad units. They do not change for a given user session.

Global User Targeting

Gender

public var gender:Gender

gender is an enum with the following values:


public enum Gender: String {
    case unknown
    case male
    case female
}

You can retrieve and set the gender for targeting:

let gender = Targeting.shared.gender

//do something with gender
Targeting.shared.gender = .unknown;

Year of Birth

public var yearofbirth:Int?

You can retrieve and set the year of birth for targeting:

if let yob = Targeting.shared.yearofbirth {
    //do something with yob
};

guard let yob = Targeting.shared.yearofbirth else {
    print("There was an error retrieving year of birth)
    return
}

//do something with yob
Targeting.shared.yearofbirth = 1990;

User Keywords

User keywords are a list of keywords, intrests or intent as defined by user.keywords in OpenRTB 2.5. Any keywords passed in the UserKeywords object may be passsed to DSPs.

Add User Keyword

func addUserKeyword(_ newElement: String)

Add User Keywords

func addUserKeywords(_ newElements: Set<String>)

Remove User Keywords

func removeUserKeyword(_ element: String)

Clear User Keywords

func clearUserKeywords()

Examples:

Targeting.shared.addUserKeyword("globalUserKeywordValue1")
Targeting.shared.addUserKeyword("globalUserKeywordValue2")
Targeting.shared.addUserKeyword("globalUserKeywordValue3")
[Targeting.shared addUserKeyword:@"globalUserKeywordValue1"];
[Targeting.shared addUserKeyword:@"globalUserKeywordValue2"];
[Targeting.shared addUserKeyword:@"globalUserKeywordValue3"];

Global Application Targeting

Domain

Retrieve and set the domain of your app with the following commands:

Targeting.shared.domain
Targeting.shared.domain = domain

Store URL

Retrieve and set the domain of your store URL with the following command:

Targeting.shared.storeURL
Targeting.shared.storeURL = "itunes store URL string"

iTunesID

Retrieve and set the domain of your iTunes ID with the below command. This field will be transmitted to buyers as the bundle ID as recommended in OpenRTB 2.5. Failure to supply this value can have a negative monetary impact.

Targeting.shared.itunesID
Targeting.shared.itunesID = itunesID

Open Measurment SDK (OMSDK)

OMSDK is designed to facilitate 3rd party viewability and verification measurement for ads served in mobile app enviroments. Prebid SDK will provide the signaling component to Bid Adapters, by way of Prebid Server, indicating the impression is elligible for OMSDK support. Prebid SDK does not currently integrate with OMSDK itself, instead it will rely on a publisher ad server to render viewability and verification measurement code.

There three components to signaling support for OMSDK:

  • Partner Name
  • Partner Version
  • API code

Partner Name

This will be the IAB OMSDK compliant partner name responsible for integrating with the OMSDK spec. See below for configuration and examples

omidPartnerName

Open Measurement partner name.

Targeting.shared.omidPartnerName

Examples:

Swift

Targeting.shared.omidPartnerName = "Google"

Objective C

Targeting.shared.omidPartnerName = @"Google";

Partner Version

The OMSDK version number the partner integrated with. See below for configuration and examples.

omidPartnerVersion

Partner’s OMSDK version number implementation

Targeting.shared.omidPartnerVersion

Examples:

Swift

Targeting.shared.omidPartnerVersion = "1.0"

Objective C

Targeting.shared.omidPartnerVersion = @"1.0";

API Code

Per OpenRTB 2.5, support for OMSDK is signaled using the imp.[media type].api field represented in Prebid SDK withing each ad format type under the parameters object. Refer to the documentation of the respective ad unit class.

Example:

let bannerUnit = BannerAdUnit(configId: "6ace8c7d-88c0-4623-8117-75bc3f0a2e45", size: CGSize(width: 300, height: 250))
let parameters = BannerAdUnit.Parameters()
parameters.api = [Signals.Api(7)]
adUnit.setParameters(parameters);

Inventory (Context) Keywords

Context Keywords are a list of keywords about the app as referenced in OpenRTB 2.5 as app.keywords. Any keyword passed in the context keyword field may be passed to the buyer for targeting.

Add Context Keyword

func addContextKeyword(_ newElement: String)

Add Context Keywords

func addContextKeywords(_ newElements: Set<String>)

Remove Context Keywords

func removeContextKeyword(_ element: String)

Clear Context Keywords

func clearContextKeywords()

Examples:

Swift

Targeting.shared.addContextKeyword("globalContextKeywordValue1")
Targeting.shared.addContextKeyword("globalContextKeywordValue2")
Targeting.shared.addContextKeyword("globalContextKeywordValue3")

Objective C

[Targeting.shared addContextKeyword:@"globalContextKeywordValue1"];
[Targeting.shared addContextKeyword:@"globalContextKeywordValue2"];
[Targeting.shared addContextKeyword:@"globalContextKeywordValue3"];

First Party Data

First Party Data (FPD) is free form data supplied by the publisher to provide additional targeting of the user or inventory context, used primarily for striking PMP (Private MarketPlace) deals with Advertisers. Data supplied in the data parameters are typically not sent to DSPs whereas information sent in non-data objects (i.e. setYearOfBirth, setGender, etc.) will be. Access to FPD can be limited to a supplied set of Prebid bidders via an access control list.

Data is broken up into two different data types:

  • User
    • Global in scope only
  • Inventory (context)
    • Global scope
    • Ad Unit grain

The below first party user and inventory context will apply to all ad units. For ad unit level first party data, refer to First Partay Data section in the Ad Unit page.

First Party User Data

Add User Data

func addUserData(key: String, value: String)

Update User Data

func updateUserData(key: String, value: Set<String>)

Remove User Data

func removeUserData(forKey: String)

Clear User Data

func clearUserData()

Examples:

Swift

Targeting.shared.addUserData(key: "globalUserDataKey1", value: "globalUserDataValue1")

Object C

[Targeting.shared addUserDataWithKey:@"globalUserDataKey1" value:@"globalUserDataValue1"];

First Party Inventory (Context) Data

Add Context Data

func addContextData(key: String, value: String)

Update Context Data

func updateContextData(key: String, value: Set<String>)

Remove Context Data

func removeContextData(forKey: String)

Clear Context Data

func clearContextData()

Examples:

Swift

Targeting.shared.addContextData(key: "globalContextDataKey1", value: "globalContextDataValue1")

Objective C

[Targeting.shared addContextDataWithKey:@"globalContextDataKey1" value:@"globalContextDataValue1"];

Ad Unit Context Data

For ad unit context data, please refer to the ad unit section.

Access Control

The First Party Data Access Control List provides a method to restrict access to first party data to a supplied list of bidders.

addBidderToAccessControlList

func addBidderToAccessControlList(_ bidderName: String)

removeBidderFromAccessControlList

func removeBidderFromAccessControlList(_ bidderName: String)

clearAccessControlList

func clearAccessControlList()

Examples:

Swift

Targeting.shared.addBidderToAccessControlList(Prebid.bidderNameRubiconProject)

Objective C

[Targeting.shared addBidderToAccessControlList: Prebid.bidderNameRubiconProject];

GPDR

Prebid Mobile supports the IAB GDPR recommendations. For a general overview of Prebid Mobile support for GDPR, see Prebid Mobile Guide to European Ad Inventory and Providing Notice, Transparency and Choice

Subject To GPDR

public var subjectToGDPR:Bool?

You can retrieve and set the subjectToGDPR for targeting:

if let subjectToGDPR = Targeting.shared.subjectToGDPR {
    //do something with subjectToGDPR
};

guard let subjectToGDPR = Targeting.shared.subjectToGDPR else {
    print("There was an error retrieving subjectToGDPR)
    return
}

//do something with subjectToGDPR

Targeting.shared.subjectToGDPR = false
public var gdprConsentString?

You can retrieve and set the subjectToGDPR for targeting:

if let gdprConsentString = Targeting.shared.gdprConsentString {
    //do something with gdprConsentString
};

guard let gdprConsentString = Targeting.shared.gdprConsentString else {
    print("There was an error retrieving gdprConsentString)
    return
}

//do something with gdprConsentString

Targeting.shared.gdprConsentString = "A String"
public var purposeConsents: String?

You can retrieve and set the purposeConsents for targeting:

//given

Targeting.shared.purposeConsents = "100000000000000000000000"

defer {

  Targeting.shared.purposeConsents = nil

}

//when

let deviceAccessConsent = Targeting.shared.getDeviceAccessConsent()

Subject to COPPA

Prebid supports passing of the Child Online Privacy Prection (COPPA) signal to Prebid Server (PBS) for all COPPA traffic. When PBS receives the COPPA flag we strip out all personal data from the requeset. For a general overview of COPPA, see the FTC’s guidlines.

var subjectToCOPPA: Bool

Example:

SWIFT

Targeting.shared.subjectToCOPPA = true

Objective C

Targeting.shared.subjectToCOPPA = true;

User Identity

Prebid SDK supports two interfaces to pass / maintain User IDs and ID vendor details:

  • Real-time in Prebid SDK’s API field externalUserIdArray
  • Store User Id(s) in local storage

Any identity vendor’s details in local storage will be sent over to Prebid Server as is, unadulterated. If data is sent in the API and entered into local storage, the API detail will prevail.

Prebid SDK API Access

Prebid SDK supports passing an array of UserID(s) at auction time in the field externalUserIdArray, that is globably scopped. It is sufficient enough to set the externalUserIdArray object once per user session, as these values would be used in all consecutive ad auctions in the same session.

public var externalUserIdArray = [ExternalUserId]()

Exmaples

SWIFT

// User Id from External Third Party Sources
var externalUserIdArray = [ExternalUserId]()
externalUserIdArray.append(ExternalUserId(source: "adserver.org", identifier: "111111111111", ext: ["rtiPartner" : "TDID"]))
externalUserIdArray.append(ExternalUserId(source: "netid.de", identifier: "999888777")) 
externalUserIdArray.append(ExternalUserId(source: "criteo.com", identifier: "_fl7bV96WjZsbiUyQnJlQ3g4ckh5a1N")) 
externalUserIdArray.append(ExternalUserId(source: "liveramp.com", identifier: "AjfowMv4ZHZQJFM8TpiUnYEyA81Vdgg"))
externalUserIdArray.append(ExternalUserId(source: "sharedid.org", identifier: "111111111111", atype: 1, ext: ["third" : "01ERJWE5FS4RAZKG6SKQ3ZYSKV"]))
Prebid.shared.externalUserIdArray = externalUserIdArray

Objective-C

// User Id from External Third Party Sources
NSMutableArray<ExternalUserId *> *externalUserIdArray = [[NSMutableArray<ExternalUserId *> alloc] init];
[externalUserIdArray addObject:[[ExternalUserId alloc]initWithSource:@"adserver.org" identifier:@"111111111111" atype:nil ext:@{@"rtiPartner" : @"TDID"}]];
[externalUserIdArray addObject:[[ExternalUserId alloc]initWithSource:@"netid.de" identifier:@"999888777" atype: nil ext:nil]];
[externalUserIdArray addObject:[[ExternalUserId alloc]initWithSource:@"criteo.com" identifier:@" _fl7bV96WjZsbiUyQnJlQ3g4ckh5a1N" atype:nil ext:nil]];
[externalUserIdArray addObject:[[ExternalUserId alloc]initWithSource:@"liveramp.com" identifier:@" AjfowMv4ZHZQJFM8TpiUnYEyA81Vdgg" atype:nil ext:nil]];
[externalUserIdArray addObject:[[ExternalUserId alloc]initWithSource:@"sharedid.org" identifier:@"111111111111" atype:[NSNumber numberWithInt:1] ext:@{@"third" : @"01ERJWE5FS4RAZKG6SKQ3ZYSKV"}]];
Prebid.shared.externalUserIdArray = externalUserIdArray;

Local Storage

Prebid SDK provides a local storage interface to set, retrieve or update an array of user IDs with associated identity vendor details. Prebid SDK will retrieve and pass User IDs and ID vendor details to PBS if values are present in local storage. The main difference between the Prebid API interface and the local storage interface is the persistence of storage of data. Local Storage data will persist across user sessions whereas the Prebid API interface (externalUserIdArray) persists only for the user session. If a vendor’s details are passed both in local storage and the Prebid API at the same time, the Prebid API data (externalUserIdArray) will prevail.

Prebid SDK Provides five functions to handle User ID details:

  • storeExternalUserId
  • fetchStoredExternalUserIds
  • fetchStoredExternalUserId
  • removeStoredExternalUserId
  • removeStoredExternalUserIds
/**
* This method allows to save External User Id in the User Defaults
*/
public func storeExternalUserId(_ externalUserId: ExternalUserId) {
    if let index = externalUserIds.firstIndex(where: {
        $0.source == externalUserId.source
    })

    {
        externalUserIds[index] = externalUserId
    }

    else{
        externalUserIds.append(externalUserId)
    }

    StorageUtils.setExternalUserIds(value: externalUserIds)
}
/**
* This method allows to get All External User Ids from User Defaults
*/
public func fetchStoredExternalUserIds()->[ExternalUserId]? {
    return StorageUtils.getExternalUserIds()
}
/**
* This method allows to get External User Id from User Defaults by passing respective 'source' string as
param */
public func fetchStoredExternalUserId(_ source : String)->ExternalUserId? {
    guard let array = StorageUtils.getExternalUserIds(), let externalUserId = array.first(where: {
        $0.source
        == source
    })

    else{
        return nil
    }

    return externalUserId
}
/**
* This method allows to remove specific External User Id from User Defaults by passing respective 'source'
string as param
*/
public func removeStoredExternalUserId(_ source : String) {
    if let index = externalUserIds.firstIndex(where: {
        $0.source == source
    })

    {
        externalUserIds.remove(at: index)
        StorageUtils.setExternalUserIds(value: externalUserIds)
    }

}
/**
* This method allows to remove all the External User Ids from User Defaults
*/
public func removeStoredExternalUserIds() {
    if var arrayExternalUserIds = StorageUtils.getExternalUserIds(){
        arrayExternalUserIds.removeAll() StorageUtils.setExternalUserIds(value: arrayExternalUserIds)
    }

}

Examples

//Set External User ID
Targeting.shared.storeExternalUserId(ExternalUserId(source: "sharedid.org", identifier: "111111111111", atype: 1, ext: ["third" : "01ERJWE5FS4RAZKG6SKQ3ZYSKV"]))

//Get External User ID
let externalUserIdSharedId = Targeting.shared.fetchStoredExternalUserId("sharedid.org")

//Get All External User IDs
let externalUserIdsArray = Targeting.shared.fetchStoredExternalUserIds()

//Remove External UserID
Targeting.shared.removeStoredExternalUserId("sharedid.org")

//Remove All External UserID
Targeting.shared.removeStoredExternalUserIds()

Further Reading