Contact support
    • Monetization
    • Developer documentation
    • Supply inventory
    • Supply in-stream video inventory
    • Supply inventory with the video plugin

    Video plugin: send user IDs

    Table of Contents

    Overview Send first-party user IDs Send third-party user IDs User object example

    Overview

    This document explains how to send user IDs, using the user object of Equativ's Video plugin.

    Send first-party user IDs

    Use the user.uid parameter (string) to send the publisher's first-party user Ids. 

    Send third-party user IDs

    Use the user.eids object to send third-party user IDs. This is an array containing extended IDs—also known as universal IDs—from different providers. For more details, see the IAB AdCOM 1.0 specification.
    This object is compatible with POST ad requests only.

    The user.eids  array has the following properties:

    Name Type Description
    uids Array An array of user IDs, each with its id and atype. Usually, the uids.length is: 1. 
    uids.atype Integer

    The agent type the ID originates from:

    • 1: Web (browser or device-specific; cookie-based, probabilistic, or other)
    • 2: IDFA
    • 3: AAID
    • 4: Windows Mobile Advertising ID
    • 5: Other Mobile ID
    uids.id String The actual user ID value provided by the identification provider.
    source String The user identification provider that provides the uids.

    User object example

    The following example shows the user object with a first party uid and three third-party IDs from three different providers.

    sas.video.register({
  id: 'myContainer',
  adData: { ... },
  user: {
    uid: 'user-identification-string',
    eids: [{
      source: 'id5-sync.com',
      uids: [{
        id: 'ID5-abc123',
        atype: 1
      }]
    }, {
      source: 'criteo.com',
      uids: [{
        id: '1234',
        atype: 1
      }]
    }, {
      source: 'digitru.st',
      uids: [{
        id: 'abcd',
        atype: 1
      }]
    }]
  }
});

    RELATED ARTICLES