Skip to content

Commit

Permalink
Halo ID & RTD Documentation Update (#3154)
Browse files Browse the repository at this point in the history
* update halo docs

* update doc

* Update haloRtdProvider.md

* Update haloRtdProvider.md
  • Loading branch information
Anthony Lauzon authored Aug 4, 2021
1 parent 1129732 commit b4bb13d
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 18 deletions.
33 changes: 18 additions & 15 deletions dev-docs/modules/haloRtdProvider.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,24 @@ sidebarType : 1
* TOC
{:toc}

Audigent is a next-generation data management platform and a first-of-a-kind
"data agency" containing some of the most exclusive content-consuming audiences
across desktop, mobile and social platforms.

This real-time data module provides an integrated post-cookie Halo identity and
real-time user segmentation solution that seamlessly integrates into your bid
request cycle. Users are identified and bid request objects are augmented
with first-party data derived segments prior to being sent to exchange/ssp
services in order to optimize targeting and increase publisher revenue.

Audigent maintains a large database of first-party Tradedesk Unified ID,
Audigent Halo ID and other id provider mappings to various third-party segment
types that are utilizable across different backends. With the Halo RTD module,
these segments and other data can be retrieved and utilized by supporting
exchange and SSP backends in real-time during your bid request cycle.
Audigent is a next-generation, first-party data management platform and the
world’s first "data agency", powering the programmatic landscape and DTC
eCommerce with actionable first-party audience and contextual data from
retailers, lifestyle publishers, content creators, athletes and artists.

The Halo real-time data module in Prebid has been built so publishers
can maximize the power of their first-party audiences and contextual data.
This module provides both an integrated cookieless Halo identity, contextual
targeting and audience segmentation solution that seamlessly and easily
integrates into your existing Prebid deployment.

Users, devices, content, cohorts and other features are identified and utilized
to augment every bid request with targeted, first-party data-derived segments
before being submitted to supply-side platforms. Enriching the bid request with
robust first-party audience and contextual data, Audigent's Halo RTD module
helps optimize targeting and header-bidding performance. For more information,
please visit https://audigent.com or contact our Prebid integration team at
[email protected].


## Publisher Usage
Expand Down
14 changes: 11 additions & 3 deletions dev-docs/modules/userId.md
Original file line number Diff line number Diff line change
Expand Up @@ -594,13 +594,21 @@ pbjs.setConfig({
});
```

The `request.userId.haloId` will contain the Audigent HaloId and associated segments:
The `request.userId.haloId` will contain the Audigent HaloId:
```
{
"haloId": "user-halo-id",
"auSeg": ["segment1", "segment2"]
"haloId": "0201chpvai07jv2yg08xizqr0bwpa1w0evvmq014d2ykn0b5oe"
}
```
The following configuration parameters are available:

{: .table .table-bordered .table-striped }
| Param under usersync.userIds[] | Scope | Type | Description | Example |
| --- | --- | --- | --- | --- |
| name | Required | String | ID value for the HaloID module - `"haloId"` | `"haloId"` |
| params | Optional | Object | Used to store params for the HaloId system |
| params.url | Optional | String | Set an alternate GET url for HaloId with this parameter |
| params.urlArg | Optional | Object | Optional url parameter for params.url |

### ID+

Expand Down

0 comments on commit b4bb13d

Please sign in to comment.