Yieldmo Synthetic Inventory Module: initial commit

Author: ym-abaranov

dev-docs/modules/ymSyntheticInventoryModule.md

@@ -0,0 +1,68 @@
+---
+layout: page_v1
+page_type: module
+title: Yieldmo Synthetic Inventory Module
+description: Yieldmo PMP deals
+module_code : ymSyntheticInventoryModule
+display_name : Synthetic Inventory Module
+enable_download : true
+sidebarType : 1
+---
+
+# Yieldmo Synthetic Inventory Module
+{:.no_toc}
+
+### Note: In order to use Yieldmo adapter please reach out to your Yieldmo account's person or support@yieldmo.com for more information.
+
+* TOC
+{:toc}
+
+## Overview
+
+This module enables publishers to set up Yieldmo Synthetic Outstream ads on their pages.
+
+If publishers will enable this module and provide placementId, this module will create a placement on the page and inject Yieldmo SDK into this placement. Publisher will then need to get a palcement id from their Yieldmo account manager (accounts email) and setup corresponding ad units on the GAM ad server
+
+{: .alert.alert-warning :}
+## Disclosure
+
+This module loads external JavaScript to render creatives
+
+## Integration
+
+Build the MASS module into the Prebid.js package with:
+
+```
+gulp build --modules=ymSyntheticInventoryModule,...
+```
+
+
+## Module Configuration
+
+```js
+pbjs.que.push(function() {
+    pbjs.setConfig({
+        ym_synthetic_inventory: {
+            placementId: 123456
+        }
+    });
+});
+```
+
+### Configuration Parameters
+
+|Name |Type |Description |
+| :------------ | :------------ | :------------ |
+|placementId | Number | Enable/disable the module if valid placementId is present
+
+### Example Configurations
+
+```js
+pbjs.que.push(function() {
+    pbjs.setConfig({
+        ym_synthetic_inventory: {
+            placementId: 123456
+        }
+    });
+});
+```