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.
You can retrieve and set the year of birth for targeting:
TargetingParams.setYearOfBirth(1990)
val yob = TargetingParams.getYearOfBirth()
You can retrieve and set the following values for gender:
FEMALEMALEUNKNOWNTargetingParams.setGender(TargetingParams.GENDER.FEMALE)
val gender = TargetingParams.getGender();
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.
void addUserKeyword(String keyword)
void addUserKeywords(Set<String> keywords)
void removeUserKeyword(String keyword)
void clearUserKeywords()
Example:
TargetingParams.addUserKeyword("globalUserKeywordValue1")
TargetingParams.addUserKeyword("globalUserKeywordValue2")
Use the following code to retrieve the platform-specific bundle/package name:
bundleName = TargetingParams.getBundleName()
Pass in the platform-specific identifier - the bundle/package name - to set the bundle ID:
TargetingParams.setBundleName(bundleName)
Retrieve and set the domain of your app with the following commands:
TargetingParams.setDomain(domain)
val domain = TargetingParams.getDomain()
Retrieve and set your app’s store URL:
TargetingParams.setStoreUrl(storeUrl)
val storeUrl = TargetingParams.getStoreUrl()
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 eligible 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:
This will be the IAB OMSDK compliant partner name responsible for integrating with the OMSDK spec. See below for configuration and examples
Open Measurement partner name.
TargetingParams.setOmidPartnerName("Google")
The OMSDK version number the partner integrated with. See below for configuration and examples.
Partner’s OMSDK version number implementation
TargetingParams.setOmidPartnerVersion();
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:
val bannerAdUnit = BannerAdUnit("PREBID_SERVER_CONFIGURATION_ID", 300, 250)
val parameters = BannerBaseAdUnit.Parameters()
parameters.api = listOf(Signals.Api(7))
bannerAdUnit.parameters = parameters
Note that the OMID value for imp.banner/video/native.api field should be 7, as defined by the IAB in the OMSDK v1.2 document.
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.
void addContextKeyword(String keyword)
void addContextKeywords(Set<String> keywords)
void removeContextKeyword(String keyword)
void clearContextKeywords()
Example:
TargetingParams.addContextKeyword("globalContextKeywordValue1")
TargetingParams.addContextKeyword("globalContextKeywordValue2")
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:
The below first party user and inventory context will apply to all ad units. For ad unit level first party data, refer to First Party Data section in the Ad Unit page.
User specic data is passed in the global scope (i.e. applicable to all ad units).
void addUserData(String key, String value)
void updateUserData(String key, Set<String> value)
void removeUserData(String key)
void clearUserData()
Example:
TargetingParams.addUserData("globalUserDataKey1", "globalUserDataValue1")
Inventory specific free form data decribing the context of the inventory.
void addContextData(String key, String value)
void updateContextData(String key, Set<String> value)
void removeContextData(String key)
void clearContextData()
Example:
TargetingParams.addContextData("globalContextDataKey1", "globalContextDataValue1, globalContextDataValue2")
For ad unit context data, please refer to the ad unit section.
The First Party Data Access Control List provides a method to restrict access to first party data to a supplied list of bidders.
Only bidders supplied in the ACL will have access to the first party data. If no bidder is supplied, Prebid Server will supply first party data to all bid adapers.
void addBidderToAccessControlList(String bidderName)
void removeBidderFromAccessControlList(String bidderName)
void clearAccessControlList()
Example:
TargetingParams.addBidderToAccessControlList(TargetingParams.BIDDER_NAME_RUBICON_PROJECT);
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
Enable (true) or disable (false) the ability to provide consent.
TargetingParams.isSubjectToGDPR()
TargetingParams.setSubjectToGDPR(true)
val consent = TargetingParams.getGDPRConsentString();
TargetingParams.setGDPRConsentString(string);
val consent = TargetingParams.getPurposeConsents()
TargetingParams.setPurposeConsents(string)
Prebid mobile also checks if the values are present in the SharedPreferences keys specified by the IAB. If the values are also set in these objects they will be passed in the OpenRTB request object.
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.
Example:
TargetingParams.setSubjectToCOPPA(true);
Prebid SDK supports two interfaces to pass / maintain User IDs and ID vendor details:
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 supports passing an array of UserID(s) at auction time in the field setExternalUserIds, 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 static void setExternalUserIds(List<ExternalUserId> externalUserIds)
public static List<ExternalUserId> getExternalUserIds()
Exmaple (JAVA):
// User Id from External Third Party Sources
ArrayList<ExternalUserId> externalUserIdArray = new ArrayList<>();
externalUserIdArray.add(new ExternalUserId("adserver.org", "111111111111", null, new HashMap() {
{
put ("rtiPartner", "TDID");
}
}));
externalUserIdArray.add(new ExternalUserId("netid.de", "999888777", null, null));
externalUserIdArray.add(new ExternalUserId("criteo.com", "_fl7bV96WjZsbiUyQnJlQ3g4ckh5a1N", null, null));
externalUserIdArray.add(new ExternalUserId("liveramp.com", "AjfowMv4ZHZQJFM8TpiUnYEyA81Vdgg", null, null));
externalUserIdArray.add(new ExternalUserId("sharedid.org", "111111111111", 1, new HashMap() {
{
put("third", "01ERJWE5FS4RAZKG6SKQ3ZYSKV");
}
}));
//Set External User ID
PrebidMobile.setExternalUserIds(externalUserIdArray);
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 (setExternalUserIds) 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 (setExternalUserIds) will prevail.
Prebid SDK Provides five functions to handle User ID details:
public static void storeExternalUserId(ExternalUserId externalUserId)
public static ExternalUserId fetchStoredExternalUserId(@NonNull String source)
public static List<ExternalUserId> fetchStoredExternalUserIds()
public static void removeStoredExternalUserId(@NonNull String source)
public static void clearStoredExternalUserIds()
Examples
//Set External User ID
TargetingParams.storeExternalUserId(new ExternalUserId("sharedid.org", "111111111111", 1, new HashMap() {
{
put ("third", "01ERJWE5FS4RAZKG6SKQ3ZYSKV");
}
}));
//Get External User ID
ExternalUserId externalUserId = TargetingParams.fetchStoredExternalUserId("sharedid.org");
//Get All External User IDs
List<ExternalUserId> externalUserIdList = TargetingParams.fetchStoredExternalUserIds();
//Remove External UserID
TargetingParams.removeStoredExternalUserId("adserver.org");
//Remove All External UserID
TargetingParams.clearStoredExternalUserIds();