Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow configuration of the sync URL and to allow callbacks for specific custom partner integrations #3586

Merged
merged 12 commits into from
Mar 25, 2022
Merged

Allow configuration of the sync URL and to allow callbacks for specific custom partner integrations #3586

Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
556d56a
Update userId.md
Feb 24, 2021
d95e028
Update download.md
Feb 24, 2021
62349f1
Revert "Update userId.md"
Mar 1, 2021
bc4683e
Update userId.md
Mar 2, 2021
09a23ce
Merge branch 'master' of https://github.com/prebid/prebid.github.io i…
rajsidhunovatiq Feb 1, 2022
2411031
Merge pull request #1 from novatiq/merge_latest
rajsidhunovatiq Feb 1, 2022
4ed64d3
fix layout and format as per other examples
rajsidhunovatiq Feb 1, 2022
726ce25
tables still broken, missed markup line just before the close div - t…
rajsidhunovatiq Feb 1, 2022
cc44816
whitespace?
rajsidhunovatiq Feb 1, 2022
55a0fbe
Merge branch 'master' of https://github.com/prebid/prebid.github.io i…
rajsidhunovatiq Feb 18, 2022
223b720
Document "Allow configuration of the sync URL and to allow callbacks …
rajsidhunovatiq Feb 18, 2022
67eeef9
typos
rajsidhunovatiq Feb 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 8 additions & 26 deletions dev-docs/modules/userId.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1417,6 +1417,14 @@ pbjs.setConfig({
| name | Required | String | Module identification: `"novatiq"` | `"novatiq"` |
| params | Required | Object | Configuration specifications for the Novatiq module. | |
| params.sourceid | Required | String | This is the Novatiq Partner Number obtained via Novatiq registration. | `1a3` |
| params.useSharedId | Optional | Boolean | Use the sharedID module if it's activated. | `true` |
| params.sharedIdName | Optional | String | Same as the SharedID "name" parameter <br /> Defaults to "_pubcid" | `"demo_pubcid"` |
| params.useCallbacks | Optional | Boolean | Use callbacks for custom integrations | `false` |
| params.urlParams | Optional | Object | Sync URl configuration for custom integrations | |
| params.urlParams.novatiqId | Optional | String | The name of the parameter used to indicate the Novatiq ID uuid | `snowflake` |
| params.urlParams.useStandardUuid | Optional | Boolean | Use a standard UUID format, or the Novatiq UUID format | `false` |
| params.urlParams.useSspId | Optional | Boolean | Send the sspid (sourceid) along with the sync request <br > Makes the params.sourceid optional if set | `false` |
| params.urlParams.useSspHost | Optional | Boolean | Send the ssphost along with the sync request | `false` |
{: .table .table-bordered .table-striped }
</div>

Expand Down Expand Up @@ -1470,32 +1478,6 @@ pbjs.setConfig({
});
{% endhighlight %}

#### Parameters for the Novatiq Module

<div class="table-responsive" markdown="1">
| Param | Scope | Type | Description | Example |
| --- | --- | --- | --- | --- |
| name | Required | String | Module identification: `"novatiq"` | `"novatiq"` |
| params | Required | Object | Configuration specifications for the Novatiq module. | |
| params.sourceid | Required | String | The Novatiq Partner Number obtained via Novatiq | `1a3` |
| params.useSharedId | Optional | Boolean | Use the sharedID module if it's activated. | `true` |
| params.sharedIdName | Optional | String | Same as the SharedID "name" parameter <br /> Defaults to "_pubcid" | `"demo_pubcid"` |
{: .table .table-bordered .table-striped }
</div>

#### Parameters for the SharedID Module

<div class="table-responsive" markdown="1">
| Param | Scope | Type | Description | Example |
| --- | --- | --- | --- | --- |
| name | Required | String | Module identification: `"pubCommonId"` | `"pubCommonId"` |
| params | Required | Object | Configuration specifications for the SharedID module. | | |
| params.storage | Required | Object | | |
| params.storage.type | Required | String | Storage type, Set to `"cookie"` | `"cookie"` |
| params.storage.name | Optional | String | Storage cookie name. If this is changed must match sharedIdName <br /> in the Novatiq module | `"demo_pubcid"` ||
| params.storage.expires | Required | integer | Time to expire | `365` |
{: .table .table-bordered .table-striped }
</div>

If you have any questions, please reach out to us at [[email protected]](mailto:[email protected])

Expand Down