Page tree


Note: This document supports a set of APIs for older integrations.

This section provides information about the user-specific parameters included in the RTB request.


Example:


{
...
"user" : {
"yob" : "1970",
"gender" : "F",
"ethnicity" : "0",
"income" : "$12000"
"city" : "New York"
"state" : "NY"
"dma" : 734,
"zip" : "12345",
"geo_type" : 2,
"cuid" : "Mik0NTM4Nzc4AEyi4kV6/Gv226rbxgIP+BRX7x+fknJqPTBx5yj1w0da",
"cuidtype" : 1,
"keywords" : "news, technology"
},
...
}‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

User Parameters Format

Note: The following parameters in this object are populated using the publisher-provided user information, if available.

                                                                                 

PropertyMandatoryMulti ValuedDescription
yobNoNo

User’s year of birth as a 4-digit integer.
Note: If the user has either opted out of the PubMatic system OR has the “do not track” header enabled in the user’s browser (HTTP_DNT = 1), then this parameter will not be passed in the RTB request.

genderNoNo

Gender of the user, that is, M for male, F for female, and O for other.
Note: If the user has either opted out of the PubMatic system OR has the “do not track” header enabled in the user’s browser (HTTP_DNT = 1), then this parameter will not be passed in the RTB request.

ethnicityNoNo

Ethnicity of the user (Example: 0). Possible options are:

  • 0 - Hispanic
  • 1 - African-American
  • 2 - Caucasian
  • 3 - Asian-American
  • 4 - Other

Note: If the user has either opted out of the PubMatic system OR has the “do not track” header enabled in the user’s browser (HTTP_DNT = 1), then this parameter will not be passed in the RTB request.
incomeNoNo

Income of the user.
Note: If the user has either opted out of the PubMatic system OR has the “do not track” header enabled in the user’s browser (HTTP_DNT = 1), then this parameter will not be passed in the RTB request.

cityNoNoCity of the user (Example:  New York).
stateNoNoState of the user (Example:  NY).
dmaNoNoDesignated Market Area of the user (Example:  734).
zipNoNoHome zip code if USA; else postal code.
geo_typeNoNo

Type of geographical source (Example: 1).

  • 1 - GPS or location
  • 2 - IP address
  • 3 - user-provided
cuidNoNoCarrier-specific user's ID
cuidtypeNoNo

Type of carrier-specific user's ID. Currently, only the following value is supported:

  • 1 - Verizon
keywordsNoNoComma separated list of keywords of user’s interests or intent

 

⇧ Top