Support for First Party Data

[yoalex5]

GitHub issue #181

//ACL block

1. Access Control List

Targeting API:

func addBidderToAccessControlList(_ bidderName: String)
func removeBidderFromAccessControlList(_ bidderName: String)
func clearAccessControlList()

Example

Swift:

Targeting.shared.addBidderToAccessControlList(Prebid.bidderNameRubiconProject)

Objective-C:

[Targeting.shared addBidderToAccessControlList: Prebid.bidderNameRubiconProject];

OpenRTB request:

"ext": {
	"prebid": {
		"data": {
			"bidders": [
				"rubicon"]
		}
	}
}

//data block
2. global user data

Targeting API:

func addUserData(key: String, value: String)
func updateUserData(key: String, value: Set<String>) 
func removeUserData(forKey: String)
func clearUserData()

Example

Swift:

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

Objective-C:

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

OpenRTB request:

"user": {
	"ext": {
		"data": {
			"globalUserDataKey1": [
				"globalUserDataValue1"]
		}
	}
}

3. global context data

Targeting API:

func addContextData(key: String, value: String)
func updateContextData(key: String, value: Set<String>)
func removeContextData(forKey: String)
func clearContextData()

Example

Swift:

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

Objective-C:

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

OpenRTB request:

"app": {
	"ext": {
		"data": {
			"globalContextDataKey1": [
				"globalContextDataValue1"]
		}
	}
}

4. adunit context data

AdUnit API:

func addContextData(key: String, value: String)
func updateContextData(key: String, value: Set<String>)
func removeContextData(forKey: String)
func clearContextData()

Example

Swift:

adUnit.addContextData(key: "adunitContextDataKey1", value: "adunitContextDataValue1")

Objective-C:

[self.adUnit addContextDataWithKey:@"adunitContextDataKey1" value:@"adunitContextDataValue1"];

OpenRTB request:

"imp": [{
	"ext": {
		"context": {
			"data": {
				"adunitContextDataKey1": [
					"adunitContextDataValue1"]
			}
		}
	}
}]

5. global context keywords

Targeting API:

func addContextKeyword(_ newElement: String)
func addContextKeywords(_ newElements: Set<String>)
func removeContextKeyword(_ element: String)
func clearContextKeywords() 

Example

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"];

OpenRTB request:

"app": {
    "keywords": "globalContextKeywordValue1,globalContextKeywordValue2,globalContextKeywordValue3"
}

6. global user keywords

Targeting API:

func addUserKeyword(_ newElement: String)
func addUserKeywords(_ newElements: Set<String>)
func removeUserKeyword(_ element: String)
func clearUserKeywords()

Example

Swift:

Targeting.shared.addUserKeyword("globalUserKeywordValue1")
Targeting.shared.addUserKeyword("globalUserKeywordValue2")
Targeting.shared.addUserKeyword("globalUserKeywordValue3")

Objective-C:

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

OpenRTB request:

"user": {
    "keywords": "globalUserKeywordValue1,globalUserKeywordValue2,globalUserKeywordValue3"
}

7. adunit context keywords

AdUnit API:

func addContextKeyword(_ newElement: String)
func addContextKeywords(_ newElements: Set<String>)
func removeContextKeyword(_ element: String)
func clearContextKeywords()

Example

Swift:

adUnit.addContextKeyword("adunitContextKeywordValue1")
adUnit.addContextKeyword("adunitContextKeywordValue2")
adUnit.addContextKeyword("adunitContextKeywordValue3")

Objective-C:

[self.adUnit addContextKeyword:@"adunitContextKeywordValue1"];
[self.adUnit addContextKeyword:@"adunitContextKeywordValue2"];
[self.adUnit addContextKeyword:@"adunitContextKeywordValue3"];

OpenRTB request:

"imp": [{
    "ext": {
        "context": {
            "keywords": "adunitContextKeywordValue1,adunitContextKeywordValue2,adunitContextKeywordValue3"
        }
    }
}]

Deprecated API
AdUnit. userKeywords was marked as deprecated, because this parameter creates user.keywords object.
Since global user keywords API has been added in this PR and it brings the functionality to work with userKeywords on global level hence I have added a compatibility function to create user.keywords object.
The logic is: if globalUserKeywords is not empty use this one, else use adunitUserKeywords

all_changes_are_included_2.chls.zip

[yoalex5]

@ppuviarasu Have you had a chance to review this feature ?

[ppuviarasu]

I believe this PR is for 1st party data… But i see changes made in PBMViewTool.swift. This has no relevance to the feature specified. PBMViewTool.swift changes are big & can be separated out as a separate enhancement PR. Please do not mix a feature PR with enhancement changes.

[ppuviarasu]

Also this PR has merge conflicts. do resolve the same and request for review

[yoalex5]

@ppuviarasu, I have removed PBMViewTool changes and created issue #225. Merge conflicts were solved

[yoalex5]

@ppuviarasu, I have fixed conflicts, could you please check it ?