Real Time API Terminology

2 Minutes to read

Article summary

Did you find this summary helpful?

Thank you for your feedback!

The tables below define the terminology used in the context of user data and describe how each term is supported by the DataX Real-Time API.

Term	Also Known As	Description	Type/JSON Tag
Segment	Audience, Facts, Events	Represents a set of users that qualify against a certain predefined criteria or perform a pre-defined action. Users can be included in or excluded from a segment.	Type and JSON tag shown below.

{
 "schema":
[
   "",
   "",
   "",
   "SEGMENTS"
 ]
}

Term	Also Known As	Description	Type/JSON Tag
Syndicated Segment	Standard Segment	An off-the-shelf segment defined by a partner.	Type and JSON tag shown below.

{
 "schema":
[
   "",
   "",
   "",
   "SEGMENTS"
 ]
}

Term	Also Known As	Description	Type/JSON Tag
URN	User-Id	A user identifier that both you (the partner) and Verizon Media understand. This can be a Verizon Media cookie or a predefined id generated as the result of a user match or any one or more of the id types listed later in the document.	User Data:

{ "schema":
[
   "DXID",
   "IXID",
   "IDFA",
   “GPADVID”,
   “SEGMENTS”
 ]
}

Term	Also Known As	Description	Type/JSON Tag
TimeStamp	ts	[Optional] Timestamp associated with this qualification. It must be a UNIX epoch value expressed in seconds, for example, 1571598284 for Sun Oct 18 18:11:10 2019	Type and JSON tag shown below.

"data": [
   [
     "",
     "IXID1",
     "",
     "seg_id=1234&ts=137624467 ],

Term	Also Known As	Description	Type/JSON Tag
User Expiration	exp	[Optional] It represents the expiration associated with this qualification. It must be a UNIX epoch value expressed in seconds, for example, 1571598284 for Sun Oct 18 18:11:10 2019	Type and JSON tag shown below.

    "data": [
[
  "",
  "IXID1",
  "",
  "exp=1376244671&seg_id=1234 ],

Term

Also Known As

Description

Type/JSON Tag

GDPR

gdpr

Use to pass EU user consent

true - Europe audience data. Data provider indicates that the data is subject to GDPR regulations.

false - Rest of the world. Data provider indicates that the data is not subject to GDPR regulations. empty - DataX Real-Time will handle the jurisdiction flag as ‘true’ and process data applying GDPR regulations.

Term

Also Known As

Description

Type/JSON Tag

GDPR Consent

euconsent

Used to include user consent attributes (using IAB Purpose bit descriptions)

Storage and Access of Information: the storage of information, or access to information that is already stored on user device such as accessing advertising identifiers and/or other device identifiers, and/or using cookies or similar technologies.

Personalization: the collection and processing of information about users of a site to subsequently personalize advertising for them in other contexts, i.e., on other sites or apps over time. Typically, the content of the site or app is used to make inferences about user interests, which inform future selections.

Term	Also Known As	Description	Type/JSON Tag
grant_type	OAuth Grant Types	The OAuth framework specifies several grant types for different use cases, as well as a framework for creating new grant types. This is typically used by clients to access resources about themselves rather than to access a user’s resources	DataX Real-Time uses the Client Credentials grant type to obtain an access token.
client_id	Oauth client id	This is the client id assigned to the application that you generated within the API Application
client_secret	Oauth secret id	This is the client secret assigned to the application that you generated within the API application.
scope		A mechanism in OAuth 2.0 to limit an application’s access to a user’s account
realm		OAuth2 authentication and authorization for client to access resources on his/her behalf.	dataxonline

Was this article helpful?

What's Next

Oauth 2.0 Authentication