From bbcbf90894a4dd8144dd0757e4bb57610d481e90 Mon Sep 17 00:00:00 2001 From: Patrick McCann Date: Fri, 30 May 2025 10:00:24 -0400 Subject: [PATCH] docs: add parameter tables for several modules --- dev-docs/modules/arcspanRtdProvider.md | 8 ++++++++ dev-docs/modules/categoryTranslation.md | 8 ++++++++ dev-docs/modules/confiantRtdProvider.md | 11 +++++++++++ dev-docs/modules/dsaControl.md | 11 ++++++++++- dev-docs/modules/freewheel.md | 9 +++++++++ dev-docs/modules/mediafilterRtdProvider.md | 8 ++++++++ 6 files changed, 54 insertions(+), 1 deletion(-) diff --git a/dev-docs/modules/arcspanRtdProvider.md b/dev-docs/modules/arcspanRtdProvider.md index 5f90e986b3..b2fa82bd16 100644 --- a/dev-docs/modules/arcspanRtdProvider.md +++ b/dev-docs/modules/arcspanRtdProvider.md @@ -56,5 +56,13 @@ pbjs.setConfig({ }) ``` +### Parameters + +{: .table .table-bordered .table-striped } + +| Name | Type | Description | Required | Default | +| :--- | :--- | :--- | :--- | :--- | +| `silo` | Integer | ArcSpan provided silo identifier used to load the contextual script | yes | n/a | + {: .alert.alert-info :} For best results, we recommend that you also deploy ArcSpan's JavaScript tag in your tag management solution, as instructed in the implementation overview you received from your ArcSpan representative. This will ensure that more of your auctions contain ArcSpan's contextual signals. Please reach out to your ArcSpan representative if you have any questions. diff --git a/dev-docs/modules/categoryTranslation.md b/dev-docs/modules/categoryTranslation.md index aaa01b8d8b..8651c6aff1 100644 --- a/dev-docs/modules/categoryTranslation.md +++ b/dev-docs/modules/categoryTranslation.md @@ -38,6 +38,14 @@ pbjs.setConfig({ }); ``` +### Parameters + +{: .table .table-bordered .table-striped } + +| Name | Type | Description | Required | Default | +| :--- | :--- | :--- | :--- | :--- | +| `translationFile` | String | URL of a custom brand category translation map | no | Prebid default map | + This file will be stored locally to expedite the conversion process. If a publisher opts to not provide a conversion mapping file Prebid will use its default conversion mapping file. Publishers should ensure that the JSON returned from their custom file is valid for Prebid by adhering to the following structure: diff --git a/dev-docs/modules/confiantRtdProvider.md b/dev-docs/modules/confiantRtdProvider.md index e8c8af20b7..7d881c4386 100644 --- a/dev-docs/modules/confiantRtdProvider.md +++ b/dev-docs/modules/confiantRtdProvider.md @@ -53,3 +53,14 @@ pbjs.setConfig({ } }); ``` + +## Parameters + +{: .table .table-bordered .table-striped } + +| Name | Type | Description | Required | Default | +| :--- | :--- | :--- | :--- | :--- | +| `propertyId` | String | Identifier provided by Confiant | yes | n/a | +| `prebidExcludeBidders` | String | Comma separated bidder codes to exclude from Confiant scanning | no | empty | +| `prebidNameSpace` | String | Custom namespace for the integration | no | empty | +| `shouldEmitBillableEvent` | Boolean | Emit a billable event when a Confiant scan occurs | no | `false` | diff --git a/dev-docs/modules/dsaControl.md b/dev-docs/modules/dsaControl.md index 7df4d686d9..9df36217eb 100644 --- a/dev-docs/modules/dsaControl.md +++ b/dev-docs/modules/dsaControl.md @@ -30,7 +30,7 @@ pbjs.setConfig({ regs: { ext: { dsa: { - dsarequired: 2, + dsarequired: 2, pubrender: 0 // ... } @@ -40,6 +40,15 @@ pbjs.setConfig({ }) ``` +### Parameters + +{: .table .table-bordered .table-striped } + +| Name | Type | Description | Required | Default | +| :--- | :--- | :--- | :--- | :--- | +| `dsarequired` | Integer | Indicates if DSA transparency information must be included (`0` = not required, `2` = required but advertiser may render, `3` = required and advertiser must render) | yes | n/a | +| `pubrender` | Integer | Signals publisher rendering capabilities (`0` = cannot render, `2` = will render) | yes | n/a | + This module will then enforce that: * all bids include DSA information, if required (`dsarequired` is either `2` or `3`); diff --git a/dev-docs/modules/freewheel.md b/dev-docs/modules/freewheel.md index c6a4308360..43f23ea15e 100644 --- a/dev-docs/modules/freewheel.md +++ b/dev-docs/modules/freewheel.md @@ -59,6 +59,15 @@ pbjs.adServers.freewheel.getTargeting({ } ``` +### Parameters + +{: .table .table-bordered .table-striped } + +| Name | Type | Description | Required | Default | +| :--- | :--- | :--- | :--- | :--- | +| `codes` | Array | AdUnit codes to retrieve targeting for | yes | n/a | +| `callback` | Function | Function invoked with error and targeting map | yes | n/a | + The values returned by `getTargeting` are concatenation of CPM, industy code, and video duration. FreeWheel SDK will send those values to FreeWheel Ad Server within the following query: ```text diff --git a/dev-docs/modules/mediafilterRtdProvider.md b/dev-docs/modules/mediafilterRtdProvider.md index 3020d971f9..74dab375c2 100644 --- a/dev-docs/modules/mediafilterRtdProvider.md +++ b/dev-docs/modules/mediafilterRtdProvider.md @@ -47,3 +47,11 @@ pbjs.setConfig({ } }); ``` + +### Parameters + +{: .table .table-bordered .table-striped } + +| Name | Type | Description | Required | Default | +| :--- | :--- | :--- | :--- | :--- | +| `configurationHash` | String | Hash provided by The Media Trust to load the protection script | yes | n/a |