Skip to main content

identitylink

LiveRamp IdentityLink module (-> Docs)

This module provides LiveRamp ATS (authenticated traffic solution) functionality to moli. Basically, this means that users are identified cross-platform using a hash of their email address.

Integration​

In your index.ts, import IdentityLink and register the module.

import { IdentityLink } from '@highfivve/module-identitylink';

moli.registerModule(
  new IdentityLink({
    assetUrl: '//ats.rlcdn.com/ats.js',
    placementId: 1337,
    hashedEmailAddresses: ['[MD5 hash]', '[SHA-1 hash]', '[SHA-256 hash]']
  })
);

Configure the module with:

  • the ats.js URL (can be protocol relative)
  • your LiveRamp placement id
  • pre-hashed versions of the user's email address (MD5, SHA-1, and SHA-256 format)

Interfaces​

IIdentityLinkModule​

IdentityLink Module

This module provides LiveRamp ATS (authenticated traffic solution) functionality to moli. Basically, this means that users are identified cross-platform using a hash of their email address.

See​

https://developers.liveramp.com/authenticatedtraffic-api/docs/atsjs-quickstart-guide

Extends​

  • IModule

Properties​

description​

readonly description: string

Inherited from​

IModule.description

moduleType​

readonly moduleType: string

Inherited from​

IModule.moduleType

name​

readonly name: string

Inherited from​

IModule.name

Methods​

config__()​

config__(): null | Object

If the module has some sort of configuration this can be fetched with this method

Returns​

null | Object

Inherited from​

IModule.config__

configureSteps__()​

configureSteps__(): ConfigureStep[]

Returns a list of steps that should be executed in the ad pipeline.

Returns​

ConfigureStep[]

Inherited from​

IModule.configureSteps__

configure__()​

configure__(moduleConfig?): void

Initialize the module with the given module configuration. Depending on the configuration the module may become active or inactive.

Parameters​

• moduleConfig?: ModulesConfig

Returns​

void

Inherited from​

IModule.configure__

initSteps__()​

initSteps__(): InitStep[]

Returns a list of steps that should be executed in the ad pipeline.

Returns​

InitStep[]

Inherited from​

IModule.initSteps__

loadAts()​

loadAts(context, moduleConfig): Promise<void>

Parameters​

• context: AdPipelineContext

• moduleConfig: IdentityLinkModuleConfig

Returns​

Promise<void>

prebidBidsBackHandler__()?​

optional prebidBidsBackHandler__(): PrebidBidsBackHandler[]

This method is called in the bidsBackHandler of prebid.

A module may provide those callbacks if it needs to alter the requests send to the ad server. The auctionEnd event cannot be used for this, as there's no guarantee the event handler will run before the requestAds step.

Note: Amazon TAM (A9) also has a callback that could be used for similar things. Unfortunately does the callback not provide the necessary information to implement any meaningful business logic. Especially the cpm parameter and bidder

The callback receives additional information coming from the ad pipeline run.

Note: These callbacks should not perform any initialization code or only be created once as this array will be accessed on every pbjs.requestBids() callback.

Use cases​

The generic-skin module provides prebid bids back handlers to block certain ad units from being requested.

Returns​

PrebidBidsBackHandler[]

See​
Inherited from​

IModule.prebidBidsBackHandler__

prepareRequestAdsSteps__()​

prepareRequestAdsSteps__(): PrepareRequestAdsStep[]

Returns a list of steps that should be executed in the ad pipeline.

Returns​

PrepareRequestAdsStep[]

Inherited from​

IModule.prepareRequestAdsSteps__

requestBidsSteps__()?​

optional requestBidsSteps__(): RequestBidsStep[]

Returns a list of steps that should be executed in the ad pipeline.

This step is optional, as should have been all steps to reduce implementation complexity of modules.

Note: prebid and amazon tam (a9) maybe implemented as modules in the future as they add those steps to the ad pipeline.

Returns​

RequestBidsStep[]

Inherited from​

IModule.requestBidsSteps__

Functions​

createIdentityLink(): IIdentityLinkModule

Returns​

IIdentityLinkModule