forked from prebid/Prebid.js
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'prebid:master' into master
- Loading branch information
Showing
29 changed files
with
1,848 additions
and
643 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,213 @@ | ||
| import {registerBidder} from '../src/adapters/bidderFactory.js'; | ||
| import {BANNER} from '../src/mediaTypes.js'; | ||
| import {deepAccess, isArray, isFn, logError, logInfo} from '../src/utils.js'; | ||
| import {config} from '../src/config.js'; | ||
|
|
||
| /** | ||
| * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest | ||
| * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid | ||
| * @typedef {import('../src/adapters/bidderFactory.js').ServerRequest} ServerRequest | ||
| * @typedef {import('../src/adapters/bidderFactory.js').BidderSpec} BidderSpec | ||
| */ | ||
|
|
||
| const BIDDER_CODE = 'anyclip'; | ||
| const ENDPOINT_URL = 'https://prebid.anyclip.com'; | ||
| const DEFAULT_CURRENCY = 'USD'; | ||
| const NET_REVENUE = false; | ||
|
|
||
| /* | ||
| * Get the bid floor value from the bidRequest object, either using the getFloor function or by accessing the 'params.floor' property. | ||
| * If the bid floor cannot be determined, return 0 as a fallback value. | ||
| */ | ||
| function getBidFloor(bidRequest) { | ||
| if (!isFn(bidRequest.getFloor)) { | ||
| return deepAccess(bidRequest, 'params.floor', 0); | ||
| } | ||
|
|
||
| try { | ||
| const bidFloor = bidRequest.getFloor({ | ||
| currency: DEFAULT_CURRENCY, | ||
| mediaType: '*', | ||
| size: '*', | ||
| }); | ||
| return bidFloor.floor; | ||
| } catch (err) { | ||
| logError(err); | ||
| return 0; | ||
| } | ||
| } | ||
|
|
||
| /** @type {BidderSpec} */ | ||
| export const spec = { | ||
| code: BIDDER_CODE, | ||
| supportedMediaTypes: [BANNER], | ||
|
|
||
| /** | ||
| * @param {object} bid | ||
| * @return {boolean} | ||
| */ | ||
| isBidRequestValid: (bid = {}) => { | ||
| const bidder = deepAccess(bid, 'bidder'); | ||
| const params = deepAccess(bid, 'params', {}); | ||
| const mediaTypes = deepAccess(bid, 'mediaTypes', {}); | ||
| const banner = deepAccess(mediaTypes, BANNER, {}); | ||
|
|
||
| const isValidBidder = (bidder === BIDDER_CODE); | ||
| const isValidSize = (Boolean(banner.sizes) && isArray(mediaTypes[BANNER].sizes) && mediaTypes[BANNER].sizes.length > 0); | ||
| const hasSizes = mediaTypes[BANNER] ? isValidSize : false; | ||
| const hasRequiredBidParams = Boolean(params.publisherId && params.supplyTagId); | ||
|
|
||
| const isValid = isValidBidder && hasSizes && hasRequiredBidParams; | ||
| if (!isValid) { | ||
| logError(`Invalid bid request: isValidBidder: ${isValidBidder}, hasSizes: ${hasSizes}, hasRequiredBidParams: ${hasRequiredBidParams}`); | ||
| } | ||
| return isValid; | ||
| }, | ||
|
|
||
| /** | ||
| * @param {BidRequest[]} validBidRequests | ||
| * @param {*} bidderRequest | ||
| * @return {ServerRequest} | ||
| */ | ||
| buildRequests: (validBidRequests, bidderRequest) => { | ||
| const bidRequest = validBidRequests[0]; | ||
|
|
||
| let refererInfo; | ||
| if (bidderRequest && bidderRequest.refererInfo) { | ||
| refererInfo = bidderRequest.refererInfo; | ||
| } | ||
|
|
||
| const timeout = bidderRequest.timeout; | ||
| const timeoutAdjustment = timeout - ((20 / 100) * timeout); // timeout adjustment - 20% | ||
|
|
||
| if (isPubTagAvailable()) { | ||
| // Options | ||
| const options = { | ||
| publisherId: bidRequest.params.publisherId, | ||
| supplyTagId: bidRequest.params.supplyTagId, | ||
| url: refererInfo.page, | ||
| domain: refererInfo.domain, | ||
| prebidTimeout: timeoutAdjustment, | ||
| gpid: bidRequest.adUnitCode, | ||
| ext: { | ||
| transactionId: bidRequest.transactionId | ||
| }, | ||
| sizes: bidRequest.sizes.map((size) => { | ||
| return {width: size[0], height: size[1]} | ||
| }) | ||
| } | ||
| // Floor | ||
| const floor = parseFloat(getBidFloor(bidRequest)); | ||
| if (!isNaN(floor)) { | ||
| options.ext.floor = floor; | ||
| } | ||
| // Supply Chain (Schain) | ||
| if (bidRequest?.schain) { | ||
| options.schain = bidRequest.schain | ||
| } | ||
| // GDPR & Consent (EU) | ||
| if (bidderRequest?.gdprConsent) { | ||
| options.gdpr = (bidderRequest.gdprConsent.gdprApplies ? 1 : 0); | ||
| options.consent = bidderRequest.gdprConsent.consentString; | ||
| } | ||
| // GPP | ||
| if (bidderRequest?.gppConsent?.gppString) { | ||
| options.gpp = { | ||
| gppVersion: bidderRequest.gppConsent.gppVersion, | ||
| sectionList: bidderRequest.gppConsent.sectionList, | ||
| applicableSections: bidderRequest.gppConsent.applicableSections, | ||
| gppString: bidderRequest.gppConsent.gppString | ||
| } | ||
| } | ||
| // CCPA (US Privacy) | ||
| if (bidderRequest?.uspConsent) { | ||
| options.usPrivacy = bidderRequest.uspConsent; | ||
| } | ||
| // COPPA | ||
| if (config.getConfig('coppa') === true) { | ||
| options.coppa = 1; | ||
| } | ||
| // Eids | ||
| if (bidRequest?.userIdAsEids) { | ||
| const eids = bidRequest.userIdAsEids; | ||
| if (eids && eids.length) { | ||
| options.eids = eids; | ||
| } | ||
| } | ||
|
|
||
| // Request bids | ||
| const requestBidsPromise = window._anyclip.pubTag.requestBids(options); | ||
| if (requestBidsPromise !== undefined) { | ||
| requestBidsPromise | ||
| .then(() => { | ||
| logInfo('PubTag requestBids done'); | ||
| }) | ||
| .catch((err) => { | ||
| logError('PubTag requestBids error', err); | ||
| }); | ||
| } | ||
|
|
||
| // Request | ||
| const payload = { | ||
| tmax: timeoutAdjustment | ||
| } | ||
|
|
||
| return { | ||
| method: 'GET', | ||
| url: ENDPOINT_URL, | ||
| data: payload, | ||
| bidRequest | ||
| } | ||
| } | ||
| }, | ||
|
|
||
| /** | ||
| * @param {*} serverResponse | ||
| * @param {ServerRequest} bidRequest | ||
| * @return {Bid[]} | ||
| */ | ||
| interpretResponse: (serverResponse, { bidRequest }) => { | ||
| const bids = []; | ||
|
|
||
| if (bidRequest && isPubTagAvailable()) { | ||
| const bidResponse = window._anyclip.pubTag.getBids(bidRequest.transactionId); | ||
| if (bidResponse) { | ||
| const { adServer } = bidResponse; | ||
| if (adServer) { | ||
| bids.push({ | ||
| requestId: bidRequest.bidId, | ||
| creativeId: adServer.bid.creativeId, | ||
| cpm: bidResponse.cpm, | ||
| width: adServer.bid.width, | ||
| height: adServer.bid.height, | ||
| currency: adServer.bid.currency || DEFAULT_CURRENCY, | ||
| netRevenue: NET_REVENUE, | ||
| ttl: adServer.bid.ttl, | ||
| ad: adServer.bid.ad, | ||
| meta: adServer.bid.meta | ||
| }); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return bids; | ||
| }, | ||
|
|
||
| /** | ||
| * @param {Bid} bid | ||
| */ | ||
| onBidWon: (bid) => { | ||
| if (isPubTagAvailable()) { | ||
| window._anyclip.pubTag.bidWon(bid); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @return {boolean} | ||
| */ | ||
| const isPubTagAvailable = () => { | ||
| return !!(window._anyclip && window._anyclip.pubTag); | ||
| } | ||
|
|
||
| registerBidder(spec); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| # Overview | ||
|
|
||
| ``` | ||
| Module Name: AnyClip Bidder Adapter | ||
| Module Type: Bidder Adapter | ||
| Maintainer: support@anyclip.com | ||
| ``` | ||
|
|
||
| # Description | ||
|
|
||
| Connects to AnyClip Marketplace for bids. | ||
|
|
||
| For more information about [AnyClip](https://anyclip.com), please contact [support@anyclip.com](support@anyclip.com). | ||
|
|
||
| AnyClip bid adapter supports Banner currently*. | ||
|
|
||
| Use `anyclip` as bidder. | ||
|
|
||
| # Bid Parameters | ||
|
|
||
| | Key | Required | Example | Description | | ||
| |---------------|----------|--------------------------|---------------------------------------| | ||
| | `publisherId` | Yes | `'12345'` | The publisher ID provided by AnyClip | | ||
| | `supplyTagId` | Yes | `'-mptNo0BycUG4oCDgGrU'` | The supply tag ID provided by AnyClip | | ||
| | `floor` | No | `0.5` | Floor price | | ||
|
|
||
|
|
||
| # Sample Ad Unit: For Publishers | ||
| ## Sample Banner only Ad Unit | ||
| ```js | ||
| var adUnits = [{ | ||
| code: 'adunit1', // ad slot HTML element ID | ||
| mediaTypes: { | ||
| banner: { | ||
| sizes: [ | ||
| [300, 250], | ||
| [728, 90] | ||
| ] | ||
| } | ||
| }, | ||
| bids: [{ | ||
| bidder: 'anyclip', | ||
| params: { | ||
| publisherId: '12345', // required, string | ||
| supplyTagId: '-mptNo0BycUG4oCDgGrU', // required, string | ||
| floor: 0.5 // optional, floor | ||
| } | ||
| }] | ||
| }] | ||
| ``` | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.