From 7fd5d5f82544903984c8ddc2147b2be2e1938398 Mon Sep 17 00:00:00 2001 From: Viktor Chernodub <37013688+chernodub@users.noreply.github.com> Date: Sun, 21 Apr 2024 15:43:37 +0000 Subject: [PATCH 1/5] feat: add yandex id system docs --- dev-docs/modules/userid-submodules/yandex.md | 30 ++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 dev-docs/modules/userid-submodules/yandex.md diff --git a/dev-docs/modules/userid-submodules/yandex.md b/dev-docs/modules/userid-submodules/yandex.md new file mode 100644 index 0000000000..2f546e5e07 --- /dev/null +++ b/dev-docs/modules/userid-submodules/yandex.md @@ -0,0 +1,30 @@ +--- +layout: userid +title: Yandex ID +description: Yandex User ID sub-module +useridmodule: yandexIdSystem +--- + +Yandex ID module is designed to improve the personalization of ads for publishers' users. This documentation provides information about the Yandex User ID module, and instructions to install it. + +## Step 1. Add Yandex ID to Prebid.js package + +Add the module to your Prebid.js package: + +{: .alert.alert-info :} +gulp build --modules=yandexIdSystem + +## Step 2. Enable Yandex ID + +Include the following call to `setConfig` in your Prebid.js code: + +```javascript +pbjs.setConfig({ + userSync: { + userIds: [{ + name: 'yandex', + bidders: ['yandex'], + }] + } +}); +``` From 90a224a45e69e9ff0bc8117126c6acf0ca63cae2 Mon Sep 17 00:00:00 2001 From: Viktor Chernodub <37013688+chernodub@users.noreply.github.com> Date: Mon, 6 May 2024 14:37:42 +0000 Subject: [PATCH 2/5] fix: add yandex id to adapters table --- dev-docs/modules/userId.md | 1 + 1 file changed, 1 insertion(+) diff --git a/dev-docs/modules/userId.md b/dev-docs/modules/userId.md index 6288f65107..5ba317c799 100644 --- a/dev-docs/modules/userId.md +++ b/dev-docs/modules/userId.md @@ -258,6 +258,7 @@ Bidders that want to support the User ID module in Prebid.js need to update thei | Unified ID | Trade Desk | tdid | adserver.org | "1111" | | ConnectID | Yahoo | connectId | yahoo.com | {"connectId": "72d04af6..."} | | FreePass ID | FreePass | freepassId | | "1111" | +| Yandex ID | Yandex | yandexId | yandex.com | "11111111111111111" | For example, the adapter code might do something like: From c8522e68fef101ef468df8b9325b5d77e26adb7a Mon Sep 17 00:00:00 2001 From: Viktor Chernodub <37013688+chernodub@users.noreply.github.com> Date: Mon, 6 May 2024 15:02:01 +0000 Subject: [PATCH 3/5] fix: update docs on how to add user id module --- dev-docs/modules/userId.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/dev-docs/modules/userId.md b/dev-docs/modules/userId.md index 5ba317c799..f72f4b7fc4 100644 --- a/dev-docs/modules/userId.md +++ b/dev-docs/modules/userId.md @@ -344,7 +344,11 @@ If you're an ID provider that wants to get on this page: * Add your *IdSystem name into the modules/.submodules.json file * Follow all the guidelines in the [contribution page](https://github.com/prebid/Prebid.js/blob/master/CONTRIBUTING.md). * Submit a Pull Request against the [Prebid.js repository](https://github.com/prebid/Prebid.js). -* Fork the prebid.org [documentation repository](https://github.com/prebid/prebid.github.io), modify /dev-docs/modules/userId.md, /download.md, and submit a documentation Pull Request. +* Update the Prebid docs + 1. Fork the prebid.org [documentation repository](https://github.com/prebid/prebid.github.io) + 2. Add `/dev-docs/modules/userid-submodules/.md` + 3. Add a new row to `/dev-docs/modules/userId.md#prebidjs-adapters` + 4. Submit a documentation Pull Request From ca9e17ef3716cc5a6d21da4bd92faa31c4158871 Mon Sep 17 00:00:00 2001 From: Viktor Chernodub <37013688+chernodub@users.noreply.github.com> Date: Mon, 6 May 2024 15:06:33 +0000 Subject: [PATCH 4/5] fix: adjust list type --- dev-docs/modules/userId.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/dev-docs/modules/userId.md b/dev-docs/modules/userId.md index f72f4b7fc4..63a3659eb8 100644 --- a/dev-docs/modules/userId.md +++ b/dev-docs/modules/userId.md @@ -345,10 +345,10 @@ If you're an ID provider that wants to get on this page: * Follow all the guidelines in the [contribution page](https://github.com/prebid/Prebid.js/blob/master/CONTRIBUTING.md). * Submit a Pull Request against the [Prebid.js repository](https://github.com/prebid/Prebid.js). * Update the Prebid docs - 1. Fork the prebid.org [documentation repository](https://github.com/prebid/prebid.github.io) - 2. Add `/dev-docs/modules/userid-submodules/.md` - 3. Add a new row to `/dev-docs/modules/userId.md#prebidjs-adapters` - 4. Submit a documentation Pull Request + * Fork the prebid.org [documentation repository](https://github.com/prebid/prebid.github.io) + * Add `/dev-docs/modules/userid-submodules/.md` + * Add a new row to `/dev-docs/modules/userId.md#prebidjs-adapters` + * Submit a documentation Pull Request From a680fc0db535f396a8429dd7feef7e6855efab43 Mon Sep 17 00:00:00 2001 From: Viktor Chernodub <37013688+chernodub@users.noreply.github.com> Date: Mon, 10 Jun 2024 20:17:07 +0300 Subject: [PATCH 5/5] Add storage config --- dev-docs/modules/userid-submodules/yandex.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/dev-docs/modules/userid-submodules/yandex.md b/dev-docs/modules/userid-submodules/yandex.md index 2f546e5e07..1b0f8bbbbc 100644 --- a/dev-docs/modules/userid-submodules/yandex.md +++ b/dev-docs/modules/userid-submodules/yandex.md @@ -21,10 +21,17 @@ Include the following call to `setConfig` in your Prebid.js code: ```javascript pbjs.setConfig({ userSync: { - userIds: [{ - name: 'yandex', - bidders: ['yandex'], - }] - } + userIds: [ + { + name: 'yandex', + bidders: ['yandex'], + storage: { + type: 'cookie', + name: '_ym_uid', + expires: 365, + }, + }, + ], + }, }); ```