Package 

Class Geo

  • 
public final class Geo

    This object encapsulates various methods for specifying a geographic location. When subordinate to a Device object, it indicates the location of the device which can also be interpreted as the user’s current location. When subordinate to a User object, it indicates the location of the user’s home base (i.e., not necessarily their current location). The lat/lon attributes should only be passed if they conform to the accuracy depicted in the type attribute. For example, the centroid of a geographic region such as postal code should not be passed.

    • Constructor Detail

      • Geo

        Geo()

    • Method Detail

      • getLatitude

         final Float getLatitude()

        Latitude from -90.0 to +90.0, where negative is south.

      • setLatitude

         final Unit setLatitude(@SerializedName(value = lat) Float latitude)

        Latitude from -90.0 to +90.0, where negative is south.

      • getLongitude

         final Float getLongitude()

        Longitude from -180.0 to +180.0, where negative is west.

      • setLongitude

         final Unit setLongitude(@SerializedName(value = lon) Float longitude)

        Longitude from -180.0 to +180.0, where negative is west.

      • getType

         final Geo.GeoType getType()

        Source of location data; recommended when passing lat/lon.

      • setType

         final Unit setType(@SerializedName(value = type) Geo.GeoType type)

        Source of location data; recommended when passing lat/lon.

      • getAccuracy

         final Integer getAccuracy()

        Estimated location accuracy in meters; recommended when lat/lon are specified and derived from a device’s location services (i.e., type = 1).

      • setAccuracy

         final Unit setAccuracy(@SerializedName(value = accuracy) Integer accuracy)

        Estimated location accuracy in meters; recommended when lat/lon are specified and derived from a device’s location services (i.e., type = 1).

      • getLastFix

         final Integer getLastFix()

        Number of seconds since this geolocation fix was established. Note that devices may cache location data across multiple fetches. Ideally, this value should be from the time the actual fix was taken.

      • setLastFix

         final Unit setLastFix(@SerializedName(value = lastfix) Integer lastFix)

        Number of seconds since this geolocation fix was established. Note that devices may cache location data across multiple fetches. Ideally, this value should be from the time the actual fix was taken.

      • setIpService

         final Unit setIpService(@SerializedName(value = ipservice) Geo.IPLocationService ipService)

        Service or provider used to determine geolocation from IP address if applicable

      • setCountry

         final Unit setCountry(@SerializedName(value = country) String country)

        Country code using ISO-3166-1-alpha-3.

      • getRegion

         final String getRegion()

        Region code using ISO-3166-2; 2-letter state code if USA.

      • setRegion

         final Unit setRegion(@SerializedName(value = region) String region)

        Region code using ISO-3166-2; 2-letter state code if USA.

      • getRegionFIPS104

         final String getRegionFIPS104()

        Region of a country using FIPS 10-4 notation. While OpenRTB supports this attribute, it has been withdrawn by NIST in 2008.

      • setRegionFIPS104

         final Unit setRegionFIPS104(@SerializedName(value = regionfips104) String regionFIPS104)

        Region of a country using FIPS 10-4 notation. While OpenRTB supports this attribute, it has been withdrawn by NIST in 2008.

      • getMetro

         final String getMetro()

        Google metro code; similar to but not exactly Nielsen DMAs.

      • setMetro

         final Unit setMetro(@SerializedName(value = metro) String metro)

        Google metro code; similar to but not exactly Nielsen DMAs.

      • getCity

         final String getCity()

        City using United Nations Code for Trade & Transport Locations.

      • setCity

         final Unit setCity(@SerializedName(value = city) String city)

        City using United Nations Code for Trade & Transport Locations.

      • setZip

         final Unit setZip(@SerializedName(value = zip) String zip)

        Zip or postal code.

      • setLocalTime

         final Unit setLocalTime(@SerializedName(value = utcoffset) Integer localTime)

        Local time as the number +/- of minutes from UTC.

      • getExtension

         final Object getExtension()

        Placeholder for exchange-specific extensions to OpenRTB.

      • setExtension

         final Unit setExtension(@SerializedName(value = ext) Object extension)

        Placeholder for exchange-specific extensions to OpenRTB.