prebid.js 7.3.0 → 7.6.0

package/modules/ixBidAdapter.md

@@ -13,7 +13,7 @@ Description
 This module connects publishers to Index Exchange's (IX) network of demand
 sources through Prebid.js. This module is GDPR and CCPA compliant.
 
-It is compatible with the newer PrebidJS 5.0 ad unit format where the `banner` and/or `video` properties are encapsulated within the `adUnits[].mediaTypes` object. We
+It is compatible with the newer PrebidJS 5.0 ad unit format where the `banner`, `video` and/or `native` properties are encapsulated within the `adUnits[].mediaTypes` object. We
 recommend that you use this newer format when possible as it will be better able
 to accommodate new feature additions.
 
@@ -32,7 +32,18 @@ var adUnits = [{
         video: {
             context: 'instream',
             playerSize: [300, 250]
-        }
+        },
+        native: {
+            title: {
+                required: true
+            },
+            image: {
+                required: true
+            },
+            body: {
+                required: false
+            }
+        },
     },
     // ...
 }];
@@ -44,7 +55,7 @@ var adUnits = [{
 | --- | ---
 | Banner | Fully supported for all IX approved sizes.
 | Video  | Fully supported for all IX approved sizes.
-| Native | Not supported.
+| Native | Supported (render through GAM or publisher's renderer).
 
 
 
@@ -56,14 +67,14 @@ Each of the IX-specific parameters provided under the `adUnits[].bids[].params`
 object are detailed here.
 
 
-### Banner
+## Banner
 
 | Key | Scope | Type | Description
 | --- | --- | --- | ---
 | siteId | Required | String | An IX-specific identifier that is associated with this ad unit. It will be associated to the single size, if the size provided. This is similar to a placement ID or an ad unit ID that some other modules have. Examples: `'3723'`, `'6482'`, `'3639'`
 | sizes | Required | Number[Number[]] | The size / sizes associated with the site ID. It should be one of the sizes listed in the ad unit under `adUnits[].mediaTypes.banner.sizes`. Examples: `[300, 250]`, `[300, 600]`, `[728, 90]`
 
-### Video
+## Video
 
 | Key | Scope | Type | Description
 | --- | --- | --- | ---
@@ -81,6 +92,58 @@ object are detailed here.
 | video.playerConfig.floatOnScroll | Optional | Boolean | A boolean specifying whether you want to use the player’s floating capabilities, where: <br /> - `true`: Allow the player to float.<br /> <b>Note</b>: If you set floatOnScroll to true, Index updates the placement value to `5`. <br />- `false`: Do not allow the player to float (default).
 | video.playerConfig.floatSize | Optional | Integer[] | The height and width of the floating player in pixels. If you do not specify a float size, the player adjusts to the aspect ratio of the player size that is defined when it is not floating. Index recommends that you review and test the float size to your user experience preference.
 
+## Native
+
+| Key | Scope | Type | Description
+| --- | --- | --- | ---
+| sendTargetingKeys | Optional | Boolean | Defines whether or not to send the hb_native_ASSET targeting keys to the ad server. Defaults to true.
+| adTemplate | Optional | String | Used in the ‘AdUnit-Defined Creative Scenario’, this value controls the Native template right in the page.
+| rendererUrl | Optional | String | Used in the ‘Custom Renderer Scenario’, this points to javascript code that will produce the Native template.
+| title | Optional | Title asset | The title of the ad, usually a call to action or a brand name.
+| body | Optional | Data asset | Text of the ad copy.
+| body2 | Optional | Data asset | Additional Text of the ad copy.
+| sponsoredBy | Optional | Data asset | The name of the brand associated with the ad.
+| icon | Optional | Image asset | The brand icon that will appear with the ad.
+| image | Optional | Image asset | A picture that is associated with the brand, or grabs the user’s attention.
+| displayUrl | Optional | Data asset | Text that can be displayed instead of the raw click URL. e.g, “Example.com/Specials”
+| cta | Optional | Data asset | Call to Action text, e.g., “Click here for more information”.
+| rating | Optional | Data asset | Rating information, e.g., “4” out of 5.
+| downloads | Optional | Data asset | 	The total downloads of the advertised application/product.
+| likes | Optional | Data asset | The total number of individuals who like the advertised application/product.
+| price | Optional | Data asset | The non-sale price of the advertised application/product.
+| salePrice | Optional | Data asset | The sale price of the advertised application/product.
+| address | Optional | Data asset | 	Address of the Buyer/Store. e.g, “123 Main Street, Anywhere USA”
+| phone | Optional | Data asset | Phone Number of the Buyer/Store. e.g, “(123) 456-7890”
+
+#### Title Asset
+
+| Key | Scope | Type | Description
+| --- | --- | --- | ---
+| required | Required | Boolean | Specify whether or not a title is required.
+| len | Optional | Integer | Maximum number of characters (defaults to 25 if omitted).
+| ext | Optional | Object | Arbitrary additional parameters to send to the bidder.
+
+#### Data Asset
+
+| Key | Scope | Type | Description
+| --- | --- | --- | ---
+| required | Required | Boolean | Specify whether or not the asset is required.
+| len | Optional | Integer | Maximum number of characters.
+| ext | Optional | Object | Arbitrary additional parameters to send to the bidder.
+
+#### Image Asset
+
+| Key | Scope | Type | Description
+| --- | --- | --- | ---
+| required | Required | Boolean | Specify whether or not the asset is required.
+| sizes | Optional | Integer[] | Minimum size requested for the image, e.g., [100, 100]
+| mimes | Optional | String[] | Whitelist of content MIME types supported, e.g., ["image/jpg", "image/gif"]
+| ext | Optional | Object | Arbitrary additional parameters to send to the bidder.
+
+### Rendering Native Ad
+
+Native ad can be rendered by setting up GAM or setup custom native renderer. Reference [Prebid implementing the native template](https://docs.prebid.org/prebid/native-implementation.html#4-implementing-the-native-template) for more information.
+
 ## Deprecation warning
 
 We are deprecating the older format
@@ -319,6 +382,33 @@ pbjs.setBidderConfig({
 });
 ```
 
+**Native**
+
+```javascript
+var adUnits = [{
+    code: 'native-div-a',
+    mediaTypes: {
+        native: {
+            title: {
+                required: true
+            },
+            image: {
+                required: true
+            },
+            sponsoredBy: {
+                required: false
+            }
+        }
+    },
+    bids: [{
+        bidder: 'ix',
+        params: {
+            siteId: '715966'
+        }
+    }]
+}];
+```
+
 ### 2. Include `ixBidAdapter` in your build process
 
 When running the build command, include `ixBidAdapter` as a module, as well as `dfpAdServerVideo` if you require video support.

package/modules/kargoAnalyticsAdapter.js

@@ -1,14 +1,96 @@
+import { logError } from '../src/utils.js';
+import { ajax } from '../src/ajax.js';
 import adapter from '../src/AnalyticsAdapter.js';
 import adapterManager from '../src/adapterManager.js';
+import CONSTANTS from '../src/constants.json';
 
-var kargoAdapter = adapter({
-  analyticsType: 'endpoint',
-  url: 'https://krk.kargo.com/api/v1/event/prebid'
-});
+const EVENT_URL = 'https://krk.kargo.com/api/v1/event';
+const KARGO_BIDDER_CODE = 'kargo';
+
+const analyticsType = 'endpoint';
+
+let _initOptions = {};
+
+let _logBidResponseData = {
+  auctionId: '',
+  auctionTimeout: 0,
+  responseTime: 0,
+};
+
+let _bidResponseDataLogged = [];
+
+var kargoAnalyticsAdapter = Object.assign(
+  adapter({ analyticsType }), {
+    track({ eventType, args }) {
+      switch (eventType) {
+        case CONSTANTS.EVENTS.AUCTION_INIT: {
+          _logBidResponseData.auctionTimeout = args.timeout;
+          break;
+        }
+        case CONSTANTS.EVENTS.BID_RESPONSE: {
+          handleBidResponseData(args);
+          break;
+        }
+      }
+    }
+  }
+);
+
+// handleBidResponseData: Get auction data for Kargo bids and send to server
+function handleBidResponseData (bidResponse) {
+  // Verify this is Kargo and we haven't seen this auction data yet
+  if (bidResponse.bidder !== KARGO_BIDDER_CODE || _bidResponseDataLogged.includes(bidResponse.auctionId) !== false) {
+    return
+  }
+
+  _logBidResponseData.auctionId = bidResponse.auctionId;
+  _logBidResponseData.responseTime = bidResponse.timeToRespond;
+  sendAuctionData(_logBidResponseData);
+}
+
+// sendAuctionData: Send auction data to the server
+function sendAuctionData (data) {
+  try {
+    _bidResponseDataLogged.push(data.auctionId);
+
+    if (!shouldFireEventRequest()) {
+      return;
+    }
+
+    ajax(
+      `${EVENT_URL}/auction-data`,
+      null,
+      {
+        aid: data.auctionId,
+        ato: data.auctionTimeout,
+        rt: data.responseTime,
+        it: 0,
+      },
+      {
+        method: 'GET',
+      }
+    );
+  } catch (err) {
+    logError('Error sending auction data: ', err);
+  }
+}
+
+// Sampling rate out of 100
+function shouldFireEventRequest () {
+  const samplingRate = (_initOptions && _initOptions.sampling) || 100;
+  return ((Math.floor(Math.random() * 100) + 1) <= parseInt(samplingRate));
+}
+
+kargoAnalyticsAdapter.originEnableAnalytics = kargoAnalyticsAdapter.enableAnalytics;
+
+kargoAnalyticsAdapter.enableAnalytics = function (config) {
+  _initOptions = config.options;
+  kargoAnalyticsAdapter.originEnableAnalytics(config);
+};
 
 adapterManager.registerAnalyticsAdapter({
-  adapter: kargoAdapter,
+  adapter: kargoAnalyticsAdapter,
   code: 'kargo'
 });
 
-export default kargoAdapter;
+export default kargoAnalyticsAdapter;

package/modules/kargoAnalyticsAdapter.md

@@ -0,0 +1,33 @@
+# Overview
+
+Module Name: Kargo Analytics Adapter
+Module Type: Analytics Adapter
+Maintainer: support@kargo.com
+
+# Description
+
+Analytics adapter for Kargo. Contact support@kargo.com for information.
+
+# Usage
+
+The simplest way to enable the analytics adapter is this
+
+```javascript
+pbjs.enableAnalytics([{
+  provider: 'kargo',
+  options: {
+      sampling: 100 // value out of 100
+  }
+}]);
+```
+
+# Test Parameters
+
+```
+{
+  provider: 'kargo',
+  options: {
+      sampling: 100
+  }
+}
+```

package/modules/kargoBidAdapter.js

@@ -88,6 +88,7 @@ export const spec = {
       }
 
       const bidResponse = {
+        ad: adUnit.adm,
         requestId: bidId,
         cpm: Number(adUnit.cpm),
         width: adUnit.width,
@@ -103,8 +104,6 @@ export const spec = {
 
       if (meta.mediaType == VIDEO) {
         bidResponse.vastXml = adUnit.adm;
-      } else {
-        bidResponse.ad = adUnit.adm;
       }
 
       bidResponses.push(bidResponse);

package/modules/minutemediaBidAdapter.js

@@ -286,6 +286,7 @@ function generateBidParameters(bid, bidderRequest) {
     sizes: sizesArray,
     floorPrice: Math.max(getFloor(bid, mediaType), params.floorPrice),
     bidId: getBidIdParameter('bidId', bid),
+    loop: getBidIdParameter('bidderRequestsCount', bid),
     bidderRequestId: getBidIdParameter('bidderRequestId', bid),
     transactionId: getBidIdParameter('transactionId', bid),
   };

package/modules/missenaBidAdapter.js

@@ -72,11 +72,29 @@ export const spec = {
 
     return bidResponses;
   },
-  getUserSyncs: function (syncOptions, serverResponses) {
+  getUserSyncs: function (
+    syncOptions,
+    serverResponses,
+    gdprConsent,
+    uspConsent
+  ) {
     if (!syncOptions.iframeEnabled) {
       return [];
     }
-    return [{ type: 'iframe', url: 'https://sync.missena.io/iframe' }];
+
+    let gdprParams = '';
+    if (
+      gdprConsent &&
+      'gdprApplies' in gdprConsent &&
+      typeof gdprConsent.gdprApplies === 'boolean'
+    ) {
+      gdprParams = `?gdpr=${Number(gdprConsent.gdprApplies)}&gdpr_consent=${
+        gdprConsent.consentString
+      }`;
+    }
+    return [
+      { type: 'iframe', url: 'https://sync.missena.io/iframe' + gdprParams },
+    ];
   },
   /**
    * Register bidder specific code, which will execute if bidder timed out after an auction