Skip to content

Commit

Permalink
Yandex ID System page (prebid#5268)
Browse files Browse the repository at this point in the history
* feat: add yandex id system docs

* fix: add yandex id to adapters table

* fix: update docs on how to add user id module

* fix: adjust list type

* Add storage config
  • Loading branch information
chernodub authored and linzhucheng committed Jul 5, 2024
1 parent 29adbd3 commit b366f04
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 1 deletion.
7 changes: 6 additions & 1 deletion dev-docs/modules/userId.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,7 @@ Bidders that want to support the User ID module in Prebid.js need to update thei
| ConnectID | Yahoo | connectId | yahoo.com | {"connectId": "72d04af6..."} |
| FreePass ID | FreePass | freepassId | | "1111" |
| UtiqMtp ID | Utiq | utiqMtpId | utiq-mtp.com | "1111" |
| Yandex ID | Yandex | yandexId | yandex.com | "11111111111111111" |

For example, the adapter code might do something like:

Expand Down Expand Up @@ -344,7 +345,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
* Fork the prebid.org [documentation repository](https://github.com/prebid/prebid.github.io)
* Add `/dev-docs/modules/userid-submodules/<userIdModuleName>.md`
* Add a new row to `/dev-docs/modules/userId.md#prebidjs-adapters`
* Submit a documentation Pull Request

<a name="getUserIds"></a>

Expand Down
37 changes: 37 additions & 0 deletions dev-docs/modules/userid-submodules/yandex.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
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'],
storage: {
type: 'cookie',
name: '_ym_uid',
expires: 365,
},
},
],
},
});
```

0 comments on commit b366f04

Please sign in to comment.