forked from prebid/prebid.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
idward renamed to anonymised (prebid#5303)
- Loading branch information
Showing
2 changed files
with
70 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters