Skip to content

Commit

Permalink
Flipp Bid Adapter: add additional check for userKey value, update docs (
Browse files Browse the repository at this point in the history
prebid#10628)

* Flipp Bid Adapter: initial release

* Added flippBidAdapter

* OFF-372 Support DTX/Hero in flippBidAdapter (#2)

* support creativeType

* OFF-422 flippBidAdapter handle AdTypes

---------

Co-authored-by: Jairo Panduro <jpanduro@blackbird-lab.com>

* OFF-465 Add getUserKey logic to prebid.js adapter (#3)

* Support cookie sync and uid

* address pr feedback

* remove redundant check

* OFF-500 Support "startCompact" param for Prebid.JS #4

* set startCompact default value (#5)

* fix docs

* use client bidding endpoint

* update unit testing endpoint

* OFF-876 [Prebid Adapter] Check userKey for empty string (#6)

* add more checks to userKey

* update document

* add uuid format statement

* modify docs

---------

Co-authored-by: Jairo Panduro <jpanduro@blackbird-lab.com>
  • Loading branch information
mike-lei and jpanduro-blackbird authored Oct 27, 2023
1 parent f40a324 commit 54e5cb1
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
15 changes: 9 additions & 6 deletions modules/flippBidAdapter.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,16 @@ export function getUserKey(options = {}) {
}

// If the partner provides the user key use it, otherwise fallback to cookies
if (options.userKey && isValidUserKey(options.userKey)) {
userKey = options.userKey;
return options.userKey;
if ('userKey' in options && options.userKey) {
if (isValidUserKey(options.userKey)) {
userKey = options.userKey;
return options.userKey;
}
}

// Grab from Cookie
const foundUserKey = storage.cookiesAreEnabled() && storage.getCookie(FLIPP_USER_KEY);
if (foundUserKey) {
const foundUserKey = storage.cookiesAreEnabled(null) && storage.getCookie(FLIPP_USER_KEY, null);
if (foundUserKey && isValidUserKey(foundUserKey)) {
return foundUserKey;
}

Expand All @@ -47,7 +50,7 @@ export function getUserKey(options = {}) {
}

function isValidUserKey(userKey) {
return !userKey.startsWith('#');
return typeof userKey === 'string' && !userKey.startsWith('#') && userKey.length > 0;
}

const generateUUID = () => {
Expand Down
5 changes: 3 additions & 2 deletions modules/flippBidAdapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,10 @@ var adUnits = [
publisherNameIdentifier: 'wishabi-test-publisher', // Required
siteId: 1192075, // Required
zoneIds: [260678], // Optional
userKey: "", // Optional
userKey: ``, // Optional, but recommended for better user experience. Can be a cookie, session id or any other user identifier
options: {
startCompact: true // Optional, default to true
startCompact: true, // Optional. Height of the experience will be reduced. Default to true
dwellExpand: true // Optional. Auto expand the experience after a certain time passes. Default to true
}
}
}
Expand Down

0 comments on commit 54e5cb1

Please sign in to comment.