Skip to content

Commit 19ee99b

Browse files
patmmccannmuuki88
andauthored
docs: add parameter tables for several modules (#6077)
Co-authored-by: Muki Seiler <[email protected]>
1 parent bda8bc3 commit 19ee99b

File tree

6 files changed

+54
-1
lines changed

6 files changed

+54
-1
lines changed

dev-docs/modules/arcspanRtdProvider.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,5 +56,13 @@ pbjs.setConfig({
5656
})
5757
```
5858

59+
### Parameters
60+
61+
{: .table .table-bordered .table-striped }
62+
63+
| Name | Type | Description | Required | Default |
64+
| :--- | :--- | :--- | :--- | :--- |
65+
| `silo` | Integer | ArcSpan provided silo identifier used to load the contextual script | yes | n/a |
66+
5967
{: .alert.alert-info :}
6068
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.

dev-docs/modules/categoryTranslation.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,14 @@ pbjs.setConfig({
3838
});
3939
```
4040

41+
### Parameters
42+
43+
{: .table .table-bordered .table-striped }
44+
45+
| Name | Type | Description | Required | Default |
46+
| :--- | :--- | :--- | :--- | :--- |
47+
| `translationFile` | String | URL of a custom brand category translation map | no | Prebid default map |
48+
4149
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.
4250

4351
Publishers should ensure that the JSON returned from their custom file is valid for Prebid by adhering to the following structure:

dev-docs/modules/confiantRtdProvider.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,14 @@ pbjs.setConfig({
5353
}
5454
});
5555
```
56+
57+
## Parameters
58+
59+
{: .table .table-bordered .table-striped }
60+
61+
| Name | Type | Description | Required | Default |
62+
| :--- | :--- | :--- | :--- | :--- |
63+
| `propertyId` | String | Identifier provided by Confiant | yes | n/a |
64+
| `prebidExcludeBidders` | String | Comma separated bidder codes to exclude from Confiant scanning | no | empty |
65+
| `prebidNameSpace` | String | Custom namespace for the integration | no | empty |
66+
| `shouldEmitBillableEvent` | Boolean | Emit a billable event when a Confiant scan occurs | no | `false` |

dev-docs/modules/dsaControl.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ pbjs.setConfig({
3030
regs: {
3131
ext: {
3232
dsa: {
33-
dsarequired: 2,
33+
dsarequired: 2,
3434
pubrender: 0
3535
// ...
3636
}
@@ -40,6 +40,15 @@ pbjs.setConfig({
4040
})
4141
```
4242

43+
### Parameters
44+
45+
{: .table .table-bordered .table-striped }
46+
47+
| Name | Type | Description | Required | Default |
48+
| :--- | :--- | :--- | :--- | :--- |
49+
| `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 |
50+
| `pubrender` | Integer | Signals publisher rendering capabilities (`0` = cannot render, `2` = will render) | yes | n/a |
51+
4352
This module will then enforce that:
4453

4554
* all bids include DSA information, if required (`dsarequired` is either `2` or `3`);

dev-docs/modules/freewheel.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,15 @@ pbjs.adServers.freewheel.getTargeting({
5959
}
6060
```
6161

62+
### Parameters
63+
64+
{: .table .table-bordered .table-striped }
65+
66+
| Name | Type | Description | Required | Default |
67+
| :--- | :--- | :--- | :--- | :--- |
68+
| `codes` | Array<string> | AdUnit codes to retrieve targeting for | yes | n/a |
69+
| `callback` | Function | Function invoked with error and targeting map | yes | n/a |
70+
6271
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:
6372

6473
```text

dev-docs/modules/mediafilterRtdProvider.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,11 @@ pbjs.setConfig({
4747
}
4848
});
4949
```
50+
51+
### Parameters
52+
53+
{: .table .table-bordered .table-striped }
54+
55+
| Name | Type | Description | Required | Default |
56+
| :--- | :--- | :--- | :--- | :--- |
57+
| `configurationHash` | String | Hash provided by The Media Trust to load the protection script | yes | n/a |

0 commit comments

Comments
 (0)