Merge branch 'master' into datawrkz_analytics_adapter_docs

Author: Likhith329

dev-docs/analytics/adplus.md

@@ -0,0 +1,18 @@
+---
+layout: analytics
+title: AdPlus
+description: AdPlus Analytics Adapter
+modulecode: appier
+---
+
+#### About
+
+Analytics adapter for AdPlus platform. Contact [adplusdestek@turkcell.com.tr](adplusdestek@turkcell.com.tr) if you have any questions about integration.
+
+#### Example Configuration
+
+```javascript
+pbjs.enableAnalytics({
+    provider: 'adplus',
+});
+```

dev-docs/analytics/pubmatic.md

@@ -17,15 +17,15 @@ PubMatic team. Please reach out to your account team for more information.
 {: .table .table-bordered .table-striped }
 | Name         | Scope              | Description                                                                                                                 | Example                                                                             | Type             |
 |-------------|---------|--------------------|-----------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|------------------|
-| publisherId | required  | The PubMatic Publisher ID | 1001  | int |
+| publisherId | required  | The PubMatic Publisher ID | "1001"  | string |
 
 ### Example Configuration
 
-```
+```javascript
     pbjs.enableAnalytics({
         provider: 'pubmatic',
         options: {
-            "publisherId": 12345 // please contact PubMatic to get a publisherId for yourself
+            "publisherId": "12345" // please contact PubMatic to get a publisherId for yourself
         }
     });
 ```

dev-docs/bidders/adplus.md

@@ -4,13 +4,14 @@ title: AdPlus
 description: Prebid AdPlus Bidder Adapter
 biddercode: adplus
 media_types: banner
+userIds: all
 pbjs: true
 sidebarType: 1
 ---
 
 ### Note
 
-The AdPlus Bidding adapter requires setup before beginning. Please contact us at <adplusdestek@turkcell.com.tr>.
+The AdPlus Bidding adapter requires setup before beginning. Please contact us at <dijitalreklam@turkcell.com.tr>.
 
 ### Bid Params
 

dev-docs/bidders/medianet.md

@@ -36,7 +36,7 @@ endpoint_compression: false
 | `cid`      | required | The customer id provided by Media.net. | `'8CUX0H51C'` | `string` |
 | `crid`     | required | The placement id provided by Media.net | `'1234567'`   | `string` |
 | `bidfloor` | optional | Bidfloor for the impression          | `1.0`         | `float`  |
-| `video`    | required for video Ad units | Object containing video targeting parameters.  See [Video Object](#media.net-video-object) for details.|`video: { maxduration: 60 }`         | `object`  |
+| `video`    | optional for video Ad units | Object containing video targeting parameters.  See [Video Object](#media.net-video-object) for details.|`video: { maxduration: 60 }`         | `object`  |
 
 <a name="media.net-video-object"></a>
 

dev-docs/bidders/oprx.md

@@ -36,3 +36,34 @@ privacy_sandbox: no
 | `npi`         | optional | NPI                    | `'22222'`  | `string`  |
 | `ndc`         | optional | NDC                    | `'33333'`  | `string`  |
 | `type`        | required | Type of Bid/Impression | `'banner'` | `string`  |
+
+### AdUnit Format
+
+```javascript
+var adUnits = [
+  {
+    code: 'test-div',
+    mediaTypes: {
+        banner: {
+            sizes: [[728, 90]]
+          }
+        },
+    bids: [
+      {
+        bidder: 'oprx',
+        params: {
+            placement_id: 1234567890,   // placement ID (required)
+            key: "123456abcd",          // key (required)
+            width: 728,                 // width
+            height: 90,                 // height
+            bid_floor: 0.5,             // bidding price floor
+            npi: "1234567890",          // NPI
+            ndc: "12345678901"          // NDC
+            type: "banner",             // media type (required)
+          },
+        }
+      }
+    ]
+  }
+];
+```

dev-docs/bidders/startio.md

@@ -4,21 +4,21 @@ title: Start.io
 biddercode: startio
 description: Prebid Start.io Adapter
 tcfeu_supported: true
-coppa_supported: false
+coppa_supported: true
 gpp_supported: false
-floors_supported: false
+floors_supported: true
 media_types: banner, video, native
 multiformat_supported: will-bid-on-any
 safeframes_ok: false
 schain_supported: false
 gvl_id: 1216
-usp_supported: false
+usp_supported: true
 pbjs: true
 pbs: true
 prebid_member: false
 fpd_supported: false
 privacy_sandbox: no
-ortb_blocking_supported: false
+ortb_blocking_supported: true
 sidebarType: 1
 ---
 

dev-docs/getting-started.md

@@ -15,7 +15,7 @@ sidebarType: 1
 
 ## Overview
 
-To run heading bidding on your site with Prebid.js you need to [download the Prebid.js package](/download.html), including your selected bidders and adapters, and add the code to your page. This code will gather bids from your selected demand sources (bidders) and pass the information on to your ad server. For full details on how Prebid.js works, see [What is Prebid.js?](/prebid/prebidjs.html).
+To run header bidding on your site with Prebid.js you need to [download the Prebid.js package](/download.html), including your selected bidders and adapters, and add the code to your page. This code will gather bids from your selected demand sources (bidders) and pass the information on to your ad server. For full details on how Prebid.js works, see [What is Prebid.js?](/prebid/prebidjs.html).
 
 Developers should work with their ad ops team to plan out your Prebid configuration. You'll need to add information to your code regarding things such as:
 

dev-docs/modules/userid-submodules/adplus.md

@@ -0,0 +1,43 @@
+---
+layout: userid
+title: AdPlus ID
+description: AdPlus ID User ID sub-module
+useridmodule: adplusIdSystem
+bidRequestUserId: adplusId
+eidsource: ad-plus.com.tr
+example: '"1111"'
+---
+
+## AdPlus ID Configuration
+
+Please make sure to add the AdPlus user ID sub-module to your Prebid.js package with:
+
+```shell
+gulp build --modules=adplusIdSystem,userId
+```
+
+{: .table .table-bordered .table-striped }
+
+| Param under userSync.userIds[] | Scope | Type | Description | Example |
+| --- | --- | --- | --- | --- |
+| name | Required | String | The name of this module: `"adplusId"` | `"adplusId"` |
+| storage.expires | Optional | Number | How long (in days) the user ID information will be stored | `7` (recommended) |
+| storage.refreshInSeconds | Optional | Number | How many seconds until the ID is refreshed | `24 * 3600` (recommended) |
+
+## AdPlus ID Example
+
+```javascript
+pbjs.setConfig({
+    userSync: {
+        userIds: [{
+            name: "adplusId",
+            storage: {
+                name: "adplusId",
+                type: "cookie&html5",
+                expires: 7,
+                refreshInSeconds: 24 * 3600
+            }
+        }]
+    }
+});
+```

dev-docs/modules/userid-submodules/id5.md

@@ -42,6 +42,7 @@ The following configuration parameters are available:
 | params.disableExtensions | Optional | Boolean | Set this to `true` to force turn off extensions call. Default `false` | `true` or `false` |
 | params.canCookieSync | Optional | Boolean | Set this to `true` to enable cookie syncing with other ID5 partners. See [our documentation](https://wiki.id5.io/docs/initiate-cookie-sync-to-id5) for details. Default `false` | `true` or `false` |
 | params.provider | Optional | String | An identifier provided by ID5 to technology partners who manage API deployments on behalf of their clients. Reach out to ID5 if you have questions about this parameter. | `"providerName"` |
+| params.gamTargetingPrefix | Optional | String  | When this parameter is set the ID5 module will set appropriate GAM pubads targeting tags                                                                                                                                                                                            | `"id5"`                                               |
 
 {: .alert.alert-info :}
 **NOTE:** The ID5 ID that is delivered to Prebid will be encrypted by ID5 with a rotating key to avoid unauthorized usage and to enforce privacy requirements. Therefore, we strongly recommend setting `storage.refreshInSeconds` to `2` hours (`7200` seconds) or less to ensure all demand partners receive an ID that has been encrypted with the latest key, has up-to-date privacy signals, and allows them to transact against it.
@@ -52,6 +53,19 @@ Publishers may want to test the value of the ID5 ID with their downstream partne
 
 To turn on A/B Testing, simply edit the configuration (see above table) to enable it and set what percentage of users you would like to set for the control group. The control group is the set of user where an ID5 ID will not be exposed in to bid adapters or in the various user id functions available on the `pbjs` global. An additional value of `ext.abTestingControlGroup` will be set to `true` or `false` that can be used to inform reporting systems that the user was in the control group or not. It's important to note that the control group is user based, and not request based. In other words, from one page view to another, a user will always be in or out of the control group.
 
+Since [Prebid version 9.42.0](https://github.com/prebid/Prebid.js/releases/tag/9.42.0) an [Enrichment Lift module](https://docs.prebid.org/dev-docs/modules/enrichmentLiftMeasurement.html) is available which also supports A/B Testing. It should not be configured for ID5 UserId Module if the `params.abTesting.enabled` is set to `true`.
+
+### Tags set by GAM targeting
+
+The ID5 UserId module can set GAM targeting tags, if enabled by setting the `params.gamTargetingPrefix`. 
+The prefix used should be unique on the property - if more than one Prebid integration is used, the prefix should be different for each integration. 
+If the same prefix is used, the ID5 module will overwrite the existing GAM targeting tags.
+
+If `params.gamTargetingPrefix` is set to a non-empty value and an ID5 module has initialized, the ID5 module will set the following GAM targeting tags:
+
+- `{prefix}_id` - set to `y` if a valid id5id was present, otherwise tag is not set
+- `{prefix}_ab` - set if `abTesting` was enabled - `n` if in Normal group (with ID5 returned), `c` if in Control group (without ID5 returned)
+
 ### A Note on Using Multiple Wrappers
 If you or your monetization partners are deploying multiple Prebid wrappers on your websites, you should make sure you add the ID5 ID User ID module to *every* wrapper. Only the bidders configured in the Prebid wrapper where the ID5 ID User ID module is installed and configured will be able to pick up the ID5 ID. Bidders from other Prebid instances will not be able to pick up the ID5 ID.
 
@@ -72,7 +86,8 @@ pbjs.setConfig({
           enabled: true,         // false by default
           controlGroupPct: 0.1   // valid values are 0.0 - 1.0 (inclusive)
         },
-        canCookieSync: true      // optional, has effect only when externalModuleUrl is used 
+        canCookieSync: true,      // optional, has effect only when externalModuleUrl is used
+        gamTargetingPrefix: "id5" // optional, when set the ID5 module will set gam targeting paramaters with this prefix
       },
       storage: {
         type: 'html5',           // "html5" is the recommended storage type
@@ -108,10 +123,10 @@ The module provides following eids:
     ]
   },
   {
-    source: 'true-link-id5-sync.com',
+    source: 'gpid.id5-sync.com',
     uids: [
       {
-        id: 'some-publisher-true-link-id',
+        id: 'some-publisher-gp-id',
         atype: 1
       }
     ]
@@ -133,18 +148,20 @@ The module provides following eids:
 
 The id from `id5-sync.com` should be always present (though the id provided will be '0' in case of no consent or optout)
 
-The id from `true-link-id5-sync.com` will be available if the page is integrated with TrueLink (if you are an ID5 partner you can learn more at [ID5 wiki](https://wiki.id5.io/en/identitycloud/retrieve-id5-ids/true-link-integration))
+The id from `gpid.id5-sync.com` will be available if the publisher has enabled Guarded Publisher ID [ID5 wiki](https://wiki.id5.io/docs/guarded-publisher-id)
+
+The id from `uidapi.com` will be available if the partner used in ID5 user module has the EUID2 integration enabled (it has to be enabled on the ID5 side)
 
-The id from `uidapi.com` will be available if the partner that is used in ID5 user module has the EUID2 integration enabled (it has to be enabled on the ID5 side)
+Additional EIDS may be provided if the publisher has enabled bid enrichment with ID5. 
 
-### Providing TrueLinkId as a Google PPID
+### Providing Guarded Publisher ID as a Google PPID
 
-TrueLinkId can be provided as a PPID - to use, it the `true-link-id5-sync.com` needs to be provided as a ppid source in prebid userSync configuration:
+GPID can be provided as a PPID - to use, it the `gpid.id5-sync.com` needs to be provided as a ppid source in prebid userSync configuration:
 
 ```javascript
 pbjs.setConfig({
   userSync: {
-    ppid: 'true-link-id5-sync.com',
+    ppid: 'gpid.id5-sync.com',
     userIds: [],  //userIds modules should be configured here
   }
 });

dev-docs/modules/userid-submodules/pubmatic.md

@@ -25,7 +25,7 @@ The following configuration parameters are available:
 | --- | --- | --- | --- | --- |
 | name | Required | String | The name of this sub-module | `"pubmaticId"` |
 | params ||| Details for the sub-module initialization ||
-| params.publisherId | Required | Number | Publisher ID | `123456` |
+| params.publisherId | Required | String | Publisher ID | `"123456"` |
 | storage |||||
 | storage.name | Required | String | The name of the cookie or html5 local storage key | `"pubmaticId"` |
 | storage.type | Required | String | This is where the PubMatic user ID will be stored | `"cookie&html5"` (recommended) or `"html5"` or `"cookie"` |
@@ -40,7 +40,7 @@ pbjs.setConfig({
     userIds: [{
       name: "pubmaticId",
       params: {
-        publisherId: 123456 // Example ID
+        publisherId: "123456" // Example ID
       },
       storage: {
         name: "pubmaticId",