MyGaru Id System: initial release (prebid#5040)

GeneGenie · muuki88 · web-flow · commit edb2018119bd · 2024-01-09T13:12:33.000+01:00
* MyGaru initial release

* Update dev-docs/modules/userid-submodules/mygaru.md

Co-authored-by: Muki Seiler &lt;muuki88@users.noreply.github.com&gt;

* Update dev-docs/modules/userid-submodules/mygaru.md

Co-authored-by: Muki Seiler &lt;muuki88@users.noreply.github.com&gt;

* MyGaru initial release

* EU note update

---------

Co-authored-by: Muki Seiler &lt;muuki88@users.noreply.github.com&gt;
diff --git a/dev-docs/modules/userid-submodules/mygaru.md b/dev-docs/modules/userid-submodules/mygaru.md
@@ -0,0 +1,41 @@
+---
+layout: userid
+title: MyGaru ID
+description: MyGaru User ID sub-module
+useridmodule: mygaruIdSystem
+---
+
+MyGaru provides single use tokens as a UserId for SSPs and DSP that consume telecom DMP data.
+
+## MyGaru ID Configuration
+
+First, add the AMX ID module to your Prebid.js build:
+
+```shell
+gulp build --modules=userId,myGaruIdSystem
+```
+
+Then configure the MyGaru id submodule in your `userSync` configuration:
+
+Params configuration is not required.
+Mygaru id system is asynchronous and in order to get ids for initial ad auctions you need to add an `auctionDelay` param to your `userSync` config.
+_Currently, Mygaru id system does not operate in EU region._
+
+```javascript
+pbjs.setConfig({
+    userSync: {
+        auctionDelay: 100,
+        userIds: [{
+            name: 'mygaruId',
+        }]
+    }
+});
+```
+
+This will add a `userId.mygaru` property to all bidRequests:
+
+```javascript
+{
+    mygaru: 'vatfS0UEgXShEqYuQy0lpzWl7rSuKeNs0U8C8841KoYbFUiyvTpS'
+}
+```
