Skip to content

Commit

Permalink
symitriDapRtdProvider - update docs with X2 instructions for client c… (
Browse files Browse the repository at this point in the history
#5800)

* symitriDapRtdProvider - update docs with X2 instructions for client configs

* Cleanup docs

---------

Co-authored-by: Jeff Palladino <[email protected]>
  • Loading branch information
jpalladino84 and Jeff Palladino authored Jan 17, 2025
1 parent de8f758 commit 67b31ec
Showing 1 changed file with 9 additions and 13 deletions.
22 changes: 9 additions & 13 deletions dev-docs/modules/symitriDapRtdProvider.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,11 @@ pbjs.setConfig({
waitForIt: true,
params: {
apiHostname: '<see your Symitri account rep>',
apiVersion: "x1",
apiAuthToken: '<see your Symitri account rep>',
apiVersion: 'x1'|'x2',
domain: 'your-domain.com',
identityType: 'simpleid'|'compositeid'|'hashedid'|'dap-signature:1.0.0',
identityType: 'simpleid'|'compositeid'|'hashedid',
identityValue: '<user identifier>',
segtax: 708,
dapEntropyUrl: 'https://sym-dist.symitri.net/dapentropy.js',
dapEntropyTimeout: 1500,
pixelUrl: '<see your Symitri account rep>',
}
}
Expand All @@ -68,29 +65,28 @@ Please reach out to your Symitri account representative(<[email protected]>) to
| name | String | Symitri Dap Rtd module name | 'symitriDap' always|
| waitForIt | Boolean | Required to ensure that the auction is delayed until prefetch is complete | Optional. Defaults to false |
| apiHostname | String | Hostname provided by Symitri | Please reach out to your Symitri account representative(<[email protected]>) for this value|
| apiVersion | String | This holds the API version | It should be "x1" always |
| apiAuthToken | String | Symitri API AuthToken | Please reach out to your Symitri account representative(<[email protected]>) for this value |
| apiVersion | String | This holds the API version | Please reach out to your Symitri account representative(<[email protected]>) for this value |
| domain | String | The domain name of your webpage | |
| identityType | String | 'simpleid' or 'compositeid' or 'hashedid' or 'dap-signature:1.0.0' | See the section below labelled "identityType" for more details. |
| identityType | String | 'simpleid' or 'compositeid' or 'hashedid' | See the section below labelled "identityType" for more details. |
| identityValue | String | This is optional field to pass user hid. Will be used only if identityType is hid | |
| segtax | Integer | The taxonomy for Symitri | The value should be 708 |
| dapEntropyUrl | String | URL to dap entropy script | Optional if the script is directly included on the webpage. Contact your Symitri account rep for more details |
| dapEntropyTimeout | Integer | Maximum time allotted for the entropy calculation to happen | |
| pixelUrl | String | Pixel URL provided by Symitri which will be triggered when bid matching with Symitri dealid wins and creative gets rendered | |

### identityType
Use 'simpleid' to pass email or other plain text ids and SymitriRTD Module will hash it.

Use 'hashedid' to pass in single already hashed id.

Use 'compositeid' to pass in multiple identifiers as key-value pairs as shown below:
Use 'compositeid' to pass in multiple identifiers as key-value pairs as shown below, can also be used for single already hashed identifiers:

```bash
{
"identityType1": "identityValue1",
"identityType2": "identityValue2",
"identityType": "compositeid",
"identityValue": "HEM:<hem>,ID5:<id5>,RampId:<RampId>",
...
}
"identityType": "hashedid",
"identityValue": "<hem>",
```

### Testing
Expand Down

0 comments on commit 67b31ec

Please sign in to comment.