diff --git a/dev-docs/bidders/dailymotion.md b/dev-docs/bidders/dailymotion.md new file mode 100644 index 0000000000..bac218a0a0 --- /dev/null +++ b/dev-docs/bidders/dailymotion.md @@ -0,0 +1,117 @@ +--- +layout: bidder +title: Dailymotion +description: Dailymotion Prebid Bidder Adapter +pbjs: true +pbs: false +biddercode: dailymotion +media_types: video +gvl_id: 573 +tcfeu_supported: true +usp_supported: true +coppa_supported: true +deals_supported: true +floors_supported: true +sidebarType: 1 +safeframes_ok: true +ortb_blocking_supported: false +--- + +### Registration + +To use the adapter with any non-test request, you first need to ask an API key from Dailymotion. Please contact us through . + +This API key will ensure proper identification of your inventory and allow you to get real bids. + +# Configuration options + +Before calling this adapter, you need to set its configuration with a call like this: + +```javascript +pbjs.setBidderConfig({ + bidders: ["dailymotion"], + config: { + dailymotion: { + api_key: 'fake_api_key', + } + } +}); +``` + +This call must be made before the first auction to allow proper authentication with our servers. + +`api_key` is your publisher API key. For testing purpose, you can use "dailymotion-testing". + +# Test Parameters + +By setting the following configuration options, you'll get a constant response to any request to validate your adapter integration: + +```javascript +pbjs.setBidderConfig({ + bidders: ["dailymotion"], + config: { + dailymotion: { + api_key: 'dailymotion-testing' + } + } +}); +``` + +Please note that failing to set these configuration options will result in the adapter not bidding at all. + +# Sample video AdUnit + +```javascript +const adUnits = [ + { + code: 'test-ad-unit', + mediaTypes: { + video: { + context: 'instream', + playerSize: [1280, 720], + api: [2,7], + description: 'this is a video description', + duration: 556, + iabcat2: 'test_cat', + id: '54321', + lang: 'FR', + private: false, + tags: 'tag_1,tag_2,tag_3', + title: 'test video', + topics: 'topic_1, topic_2', + xid: 'x123456' + }, + }, + bids: [{ + bidder: "dailymotion", + params: { + video: { + description: 'this is a test video description', + duration: 330, + iabcat2: 'test_cat', + id: '54321', + lang: 'FR', + private: false, + tags: 'tag_1,tag_2,tag_3', + title: 'test video', + topics: 'topic_1, topic_2, topic_3', + xid: 'x123456' + } + } + }] + } +]; +``` + +Following video metadata fields can be added in mediaTypes.video or bids.params.video. If a field exists in both places, it will be overridden by bids.params.video. + +* `description` - Video description +* `duration` - Video duration in seconds +* `iabcat2` - Video IAB category +* `id` - Video unique ID in host video infrastructure +* `lang` - ISO 639-1 code for main language used in the video +* `private` - True if video is not publicly available +* `tags` - Tags for the video, comma separated +* `title` - Video title +* `topics` - Main topics for the video, comma separated +* `xid` - Dailymotion video identifier (only applicable if using the Dailymotion player) and allows better targeting