Geo Parameters

Document created by pubmatic-archivist on Mar 27, 2017Last modified by catherine.racette on Jun 7, 2017
Version 2Show Document
  • View in full screen mode

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

Due to privacy concerns, and particularly in jurisdictions such as Europe, a Publisher or simple legal compliance might prohibit us from passing the actual and complete IP Address of the user. Hence, additional Geo parameters have been added to pass location information to Demand Partners. “geo” object will only be passed if publisher restricts us from passing actual and complete IP Address.

Example:


Content-Type: application/json
Content-Length: <length>
{“exclude”: {
                    .............
} ,
      “site_richmedia_attributes” : {

                  .............

        },

        “contextual_brand_safety_data”:[........],

“mobile” : {

                 .............

},    


“geo” : {“country” : “US”,

   “state” : “CA”,

         “city” :  “San Francisco”,

         “dma” : 1234,

         “zip” :90210,

         "cat": [

             1,

             2

         ],

         "brand": [

             4,

             5

         ],

         "loccatsrc": 1,

         “lat” : 41.906365,

         “lon” : -75.327759,

         “loc_source” : 2

}

}

 

Geo Parameters Format

Note: Except the “lat”, “lon” and “loc_source” parameters mentioned below, the remaining parameters in this object are populated by PubMatic using the user’s IP address.

                                                                           

Property
Mandatory
Multi Valued
Description
country
Yes
No
Country from where request originated
state
No
No
State from where the request originated
city
No
No
City from where the request originated
dma
No
No
DMA from where the request originated
zip
No
No
Zip code of the user.
lat
No
No
Latitude of the IP address of the user.
lon
No
No
Longitude of the IP address of the user.
loc_source
No
No
Source of user's location provided in the “lat” and “lon” parameters mentioned above. These location source details are provided by the publisher.
This parameter does not indicate the source for the user's geo-specific parameters such as country, state, city, and so on. These geo-specific parameters are populated by PubMatic.
Possible options are as follows:
 
                            
Location source
Targeted object
“loc_source” value
Unknown
geo.lat
geo.lon
loc_source=0
GPS/Location service
*device.loc
   And
geo.lat
geo.lon
loc_source=1
IP address
geo.lat
geo.lon
loc_source=2
User registration
geo.lat
geo.lon
loc_source=3
* “device.loc” is populated only when loc_source=1. If DSPs want to use the latitude and longitude information derived from only GPS/location service, they can use “device.loc”. However, if they want to use this information from all types of location sources, including GPS/location service, then they should use “geo.lat” and “geo.lon” instead of “device.loc”.
 
Note: The “geo_type” parameter previously present in this object has been deprecated since it is now replaced by this “loc_source” parameter.
catNoYes

Categories of the location in which the user is present. For the list of values, refer to the xAd documentation.

For example, "cat":[1,2]
brandNoYes

Brands available in the location in which the user is present. For the list of values, refer to the xAd documentation.

For example, "brand":[4,5]
loccatsrcNoNo

Source from which the above-mentioned location categories and brands are obtained. For the list of values, refer to the xAd documentation.

For example, "loccatsrc":1

Attachments

    Outcomes