YIELDONE adapter - added UserSync (#3045)

* added UserSync * added UserSync Unit Test
prebid · Sep 6, 2018 · 0f401ee · 0f401ee
1 parent bf4e2d6
commit 0f401ee
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 0 deletions.
diff --git a/modules/yieldoneBidAdapter.js b/modules/yieldoneBidAdapter.js
@@ -4,6 +4,7 @@ import {registerBidder} from 'src/adapters/bidderFactory';
 
 const BIDDER_CODE = 'yieldone';
 const ENDPOINT_URL = '//y.one.impact-ad.jp/h_bid';
+const USER_SYNC_URL = '//y.one.impact-ad.jp/push_sync';
 
 export const spec = {
   code: BIDDER_CODE,
@@ -66,6 +67,14 @@ export const spec = {
       bidResponses.push(bidResponse);
     }
     return bidResponses;
+  },
+  getUserSyncs: function(syncOptions) {
+    if (syncOptions.iframeEnabled) {
+      return [{
+        type: 'iframe',
+        url: USER_SYNC_URL
+      }];
+    }
   }
 }
 registerBidder(spec);
diff --git a/modules/yieldoneBidAdapter.md b/modules/yieldoneBidAdapter.md
@@ -25,3 +25,15 @@ THE YIELDONE adapter requires setup and approval from the YIELDONE team. Please
     }]
   }];
 ```
+
+### Configuration
+
+YIELDONE recommends the UserSync configuration below.  Without it, the YIELDONE adapter will not able to perform user syncs, which lowers match rate and reduces monetization.
+
+```javascript
+pbjs.setConfig({
+   userSync: {
+    iframeEnabled: true,
+    enabledBidders: ['yieldone']
+ }});
+```
diff --git a/test/spec/modules/yieldoneBidAdapter_spec.js b/test/spec/modules/yieldoneBidAdapter_spec.js
@@ -144,4 +144,20 @@ describe('yieldoneBidAdapter', function() {
       expect(result.length).to.equal(0);
     });
   });
+
+  describe('getUserSyncs', function () {
+    const userSyncUrl = '//y.one.impact-ad.jp/push_sync';
+
+    it('handles empty sync options', function () {
+      expect(spec.getUserSyncs({})).to.be.empty;
+    });
+
+    it('should return a sync url if iframe syncs are enabled', function () {
+      expect(spec.getUserSyncs({
+        'iframeEnabled': true
+      })).to.deep.equal([{
+        type: 'iframe', url: userSyncUrl
+      }]);
+    });
+  });
 });