Use Extended IDs (EIDs)

Springserve supports EIDs or Extended IDs in accordance with the Open RTB extension for passing multiple third party user identifiers (see here for more details).

VAST Parameters

Springserve supports four VAST parameters for passing EIDs into Springserve. The below outlines what each parameter is and when it should be utilized.

  • &extra_eids
    • Use this parameter if
      • multiple EIDs are supported and you want to pass them through one parameter
      • if EIDs other than Liveramp RampID and TTD UID 2.0 are supported
  • This parameter supports passing multiple EID sources, and multiple EID values through it
  • The value(s) passed in this parameter follow a specific format:
    1. Each EID entry consists of multiple fields separated by commas (,)
    2. Different EID entries are separated by exclamation marks (!)
    3. Each field within an EID entry is labeled and followed by a hyphen (-)
  • Fields supported via this parameter include:
    1. Value [required]: integer for the corresponding EID
    2. Source: which EID source this value corresponds to. Denoted by the label "S"
      1. UID = uidapi.com
      2. Pair ID = google.com
      3. Liveramp IDL = liveramp.com
      4. Yahoo ConnectID = yahoo.com
    3. EID string: The actual EID value. Denoted by the label "ID"
    4. ATYPE: Denoted by the label "ATYPE"
    5. RTI Partner: Denoted by the label "RTI"
  • Example inbound VAST param and value:
  • Example resulting outbound ORTB call
{
    "eids":
    [
        {
            "source": "uidapi.com",
            "uids":
            [
                {
                    "id": "71bsbsb177171",
                    "atype": "1"
                }
            ]
        },
        {
            "source": "google.com",
            "uids":
            [
                {
                    "id": "99bsbsb99999",
                    "atype": "2",
                    "ext":
                    {
                        "rtiPartner": "PairID"
                    }
                }
            ]
        }
    ]
}
  • &extra_eids2
    1. This parameter should be used if:
      1. The VAST call is originating from Freewheel. This field was created in accordance with the Freewheel ad server’s specification for supporting EIDs.
    2. This is a pre-configured setup. Be sure to configure each EID source in our system ahead of time. Currently supported sources include:
      1. Liveramp IDL
      2. Yahoo ConnectID
      3. TTD Unified ID 2.0
      4. Google PAIR ID
    3. Multiple values are separated by the comma (,) character
    4. Atype is not supported
    5. Example inbound VAST param and value
      1. &extra_eids2=connectid:xyz123,UID2:AgAACCssygHiIf
    6. Example resulting outbound ORTB call
[
  {
    "source": "yahoo.com",
    "uids": [
      {
        "id": "xyz123",
        "rtiPartner": "ConnectID"
      }
    ]
  },
  {
    "source": "uidapi.com",
    "uids": [
      {
        "id": "AgAACCssygHiIf",
        "rtiPartner": "UID2"
      }
    ]
  }
]
  • &ttd_uid2
    • This parameter should be used if:
      • The only EID supported by the publisher is the TTD UID2.0
      • The publisher wants to have a standalone parameter for the TTD UID2.0
    • This is a field specific to the TTD UID2.0 solution
    • Example inbound VAST param and value:
      • &ttd_uid2=asdjiofwjpoifwn
    • Example resulting outbound ORTB call
"eids": [
  {
    "uids": [
      {
        "ext": {
          "rtiPartner": "UID2"
        },
        "id": "asdjiofwjpoifwn"
      }
    ],
    "source": "uidapi.com"
  },
] 
  • &rampid
    1. This parameter should be used if:
      1. The only EID supported by the publisher is the Liveramp IDL
      2. The publisher wants to have a standalone parameter for the Liveramp IDL
    2. This a field specific to the Liveramp Ramp ID solution
    3. Example inbound VAST param and value:
      1. &rampid=jkpfoi12098jhkjl
    4. Example resulting outbound ORTB call
"eids": [
  {
    "uids": [
      {
        "ext": {
          "rtiPartner": "IDL"
        },
        "id": "jkpfoi12098jhkjl"
      }
    ],
    "source": "liveramp.com"
  }
]