From 3a988c0fa48ce05a89f06594fcf18e3d7a11ecb6 Mon Sep 17 00:00:00 2001 From: bretg Date: Tue, 7 May 2024 10:37:20 -0400 Subject: [PATCH] idward renamed to anonymised (#5303) --- dev-docs/modules/anonymisedRtdProvider.md | 61 +++++++++++++++++++++++ dev-docs/modules/idWardRtdProvider.md | 10 +++- 2 files changed, 70 insertions(+), 1 deletion(-) create mode 100644 dev-docs/modules/anonymisedRtdProvider.md diff --git a/dev-docs/modules/anonymisedRtdProvider.md b/dev-docs/modules/anonymisedRtdProvider.md new file mode 100644 index 0000000000..d266b01d6f --- /dev/null +++ b/dev-docs/modules/anonymisedRtdProvider.md @@ -0,0 +1,61 @@ +--- +layout: page_v2 +title: Anonymised Real Time Data Provider Module +display_name: Anonymised Real Time Data Provider Module +description: Anonymised Real Time Data Provider Module +page_type: module +module_type: rtd +module_code : anonymisedRtdProvider +enable_download : true +vendor_specific: true +sidebarType : 1 +--- + +# Anonymised Real Time Data Provider Module + +Anonymised is a data anonymization technology for privacy-preserving advertising. Publishers and advertisers are able to target and retarget custom audience segments covering 100% of consented audiences. +Anonymised’s Real-time Data Provider automatically obtains segment IDs from the Anonymised on-domain script (via `localStorage`) and passes them to the bid-stream. + +## Publisher Usage + +- Build the anonymisedRtd module into the Prebid.js package with: + +```bash +gulp build --modules=anonymisedRtdProvider,... +``` + +- Use `setConfig` to instruct Prebid.js to initilaize the anonymisedRtdProvider module, as specified below. + +### Configuration + +```javascript + pbjs.setConfig({ + realTimeData: { + dataProviders: [ + { + name: "anonymised", + waitForIt: true, + params: { + cohortStorageKey: "cohort_ids", + bidders: ["smartadserver", "appnexus"], + segtax: 1000 + } + } + ] + } + }); +``` + +Please note that anonymisedRtdProvider should be integrated into the publisher website along with the [Anonymised Marketing Tag](https://support.anonymised.io/integrate/marketing-tag). +Please reach out to Anonymised [representative](mailto:support@anonymised.io) if you have any questions or need further help to integrate Prebid, anonymisedRtdProvider, and Anonymised Marketing Tag + +**Config Syntax details:** + +{: .table .table-bordered .table-striped } +| Name |Type | Description | Notes | +| :------------ | :------------ | :------------ |:------------ | +| name | String | Anonymised Rtd module name | 'anonymised' always| +| waitForIt | Boolean | Required to ensure that the auction is delayed until prefetch is complete | Optional. Defaults to false | +| params.cohortStorageKey | String | the `localStorage` key, under which Anonymised Marketing Tag stores the segment IDs | 'cohort_ids' always | +| params.bidders | Array | Bidders with which to share segment information | Required | +| params.segtax | Integer | The taxonomy for Anonymised | '1000' always | diff --git a/dev-docs/modules/idWardRtdProvider.md b/dev-docs/modules/idWardRtdProvider.md index 9d5059a04a..ebf2320b93 100644 --- a/dev-docs/modules/idWardRtdProvider.md +++ b/dev-docs/modules/idWardRtdProvider.md @@ -6,11 +6,19 @@ description: ID Ward Real Time Data Provider Module page_type: module module_type: rtd module_code : idWardRtdProvider -enable_download : true +enable_download : false vendor_specific: true sidebarType : 1 --- +> **Warning!** +> +> The **idWardRtdProvider** module has been renamed to [anonymisedRtdProvider](anonymisedrtdprovider) in light of the company's rebranding. +> **idWardRtdProvider** module is maintained for backward compatibility until the next major Prebid release. +> +> Please use anonymisedRtdProvider instead of idWardRtdProvider in your Prebid integration. +> + # ID Ward Real Time Data Provider Module ID Ward is a data anonymization technology for privacy-preserving advertising. Publishers and advertisers are able to target and retarget custom audience segments covering 100% of consented audiences.