IX Bid Adapter: Documentation for Native Support (prebid#3831)

* added native support * Update ix.md (prebid#3) added content for native support Co-authored-by: Love Sharma <[email protected]> Co-authored-by: rimaburder-index <[email protected]>
AuDigent · Aug 31, 2023 · 7c7fd96 · 7c7fd96
1 parent 1f99a05
commit 7c7fd96
Showing 1 changed file with 50 additions and 3 deletions.
diff --git a/dev-docs/bidders/ix.md b/dev-docs/bidders/ix.md
@@ -12,7 +12,7 @@ coppa_supported: true
 gdpr_supported: true
 floors_supported: true
 usp_supported: true
-media_types: banner, video
+media_types: banner, video, native
 fpd_supported: true
 gvl_id: 10
 prebid_member: yes
@@ -63,7 +63,7 @@ var adUnits = [{
 |---|---|
 | `banner` | Fully supported for all IX approved sizes |
 | `video`  | Fully supported for all IX approved sizes |
-| `native` | Not supported |
+| `native` | Supported |
 
 ### Supported Media Types (Prebid Server)
 
@@ -111,6 +111,9 @@ In Prebid.js versions 5.0 and above, mediaType and sizes are not required to be
 | `video.playerConfig.floatOnScroll` | Optional | Boolean | A boolean specifying whether you want to use the player’s floating capabilities, where: <br /> - `true`: Use the Index player’s float capabilities.<br /> **Note**: If you set `floatOnScroll` to `true`, Index updates the `placement` value to `5`. <br />**Note:** We do not recommend using the player's default float capabilities if you have more than one outstream ad unit per page. <br />- `false`: Do not use the Index player's float capabilities (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
+Index supports the native assets that Prebid.js recognizes. For the list of native assets, see [Prebid.js Native Implementation Guide on the Prebid site.](https://docs.prebid.org/prebid/native-implementation.html#3-prebidjs-native-adunit-overview)
+
 ## Setup Guide
 
 Follow these steps to configure and add the IX module to your Prebid.js
@@ -283,6 +286,50 @@ pbjs.setConfig({
 });
 ```
 
+#### Native
+We support the three native template rendering options that are provided in the [Setting up Prebid Native in Google Ad Manager](https://docs.prebid.org/adops/gam-native.html). The following code is an example of a Prebid native set up using Google Ad Manager, but the concept and implementation should be similar for other ad servers.
+
+```
+pbjs.addAdUnits({
+    code: slot.code,
+    mediaTypes: {
+        native: {
+            image: {
+                required: true,
+                sizes: [150, 50]
+            },
+            title: {
+                required: true,
+                len: 80
+            },
+            sponsoredBy: {
+                required: true
+            },
+            clickUrl: {
+                required: true
+            },
+            privacyLink: {
+                required: false
+            },
+            body: {
+                required: true
+                len: 90
+            },
+            icon: {
+                required: true,
+                sizes: [50, 50]
+            }
+        }
+    },
+    bids: [{
+        bidder: 'ix',
+        params: {
+            siteId: '715966'
+        }
+    }]
+});
+```
+
 #### User Sync
 Add the following code to enable user sync. IX strongly recommends enabling user syncing through iFrames. This functionality improves DSP user match rates and increases the IX bid rate and bid price. Be sure to call `pbjs.setConfig()` only once.
 
@@ -471,7 +518,7 @@ to `'ix'` across all ad units that bids are being requested for does not exceed
 
 ### Time-To-Live (TTL)
 
-Banner bids from Index have a TTL of 600 seconds while video bids have a TTL of 3 hours, after which time they become invalid.
+Banner bids from Index have a TTL of 600 seconds while video bids have a TTL of 3 hours, after which time they become invalid.</br>
 **Note:** Index supports the `bid.exp` attribute in the bid response which allows our adapter to specify the maximum number of seconds allowed between the auction and billing notice. In the absence of the `bid.exp` attribute, the TTL provided above applies.
 
 ## FAQs