Package com.google.openrtb

Interface OpenRtb.BidRequest.GeoOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int getAccuracy()
      Estimated location accuracy in meters; recommended when lat/lon are specified and derived from a device's location services (i.e., type = 1).
      String getCity()
      City using United Nations Code for Trade & Transport Locations.
      com.google.protobuf.ByteString getCityBytes()
      City using United Nations Code for Trade & Transport Locations.
      String getCountry()
      Country using ISO-3166-1 Alpha-3.
      com.google.protobuf.ByteString getCountryBytes()
      Country using ISO-3166-1 Alpha-3.
      OpenRtb.LocationService getIpservice()
      Service or provider used to determine geolocation from IP address if applicable (i.e., type = 2).
      int getLastfix()
      Number of seconds since this geolocation fix was established.
      double getLat()
      Latitude from -90.0 to +90.0, where negative is south.
      double getLon()
      Longitude from -180.0 to +180.0, where negative is west.
      String getMetro()
      Google metro code; similar to but not exactly Nielsen DMAs.
      com.google.protobuf.ByteString getMetroBytes()
      Google metro code; similar to but not exactly Nielsen DMAs.
      String getRegion()
      Region code using ISO-3166-2; 2-letter state code if USA.
      com.google.protobuf.ByteString getRegionBytes()
      Region code using ISO-3166-2; 2-letter state code if USA.
      String getRegionfips104()
      Region of a country using FIPS 10-4 notation.
      com.google.protobuf.ByteString getRegionfips104Bytes()
      Region of a country using FIPS 10-4 notation.
      OpenRtb.LocationType getType()
      Source of location data; recommended when passing lat/lon.
      int getUtcoffset()
      Local time as the number +/- of minutes from UTC.
      String getZip()
      Zip/postal code.
      com.google.protobuf.ByteString getZipBytes()
      Zip/postal code.
      boolean hasAccuracy()
      Estimated location accuracy in meters; recommended when lat/lon are specified and derived from a device's location services (i.e., type = 1).
      boolean hasCity()
      City using United Nations Code for Trade & Transport Locations.
      boolean hasCountry()
      Country using ISO-3166-1 Alpha-3.
      boolean hasIpservice()
      Service or provider used to determine geolocation from IP address if applicable (i.e., type = 2).
      boolean hasLastfix()
      Number of seconds since this geolocation fix was established.
      boolean hasLat()
      Latitude from -90.0 to +90.0, where negative is south.
      boolean hasLon()
      Longitude from -180.0 to +180.0, where negative is west.
      boolean hasMetro()
      Google metro code; similar to but not exactly Nielsen DMAs.
      boolean hasRegion()
      Region code using ISO-3166-2; 2-letter state code if USA.
      boolean hasRegionfips104()
      Region of a country using FIPS 10-4 notation.
      boolean hasType()
      Source of location data; recommended when passing lat/lon.
      boolean hasUtcoffset()
      Local time as the number +/- of minutes from UTC.
      boolean hasZip()
      Zip/postal code.

      • Methods inherited from interface com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder

        getDefaultInstanceForType, getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, hasExtension, hasExtension, hasExtension

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasLat

        boolean hasLat()
         Latitude from -90.0 to +90.0, where negative is south.
        optional double lat = 1;
        Returns:
        Whether the lat field is set.

      • getLat

        double getLat()
         Latitude from -90.0 to +90.0, where negative is south.
        optional double lat = 1;
        Returns:
        The lat.

      • hasLon

        boolean hasLon()
         Longitude from -180.0 to +180.0, where negative is west.
        optional double lon = 2;
        Returns:
        Whether the lon field is set.

      • getLon

        double getLon()
         Longitude from -180.0 to +180.0, where negative is west.
        optional double lon = 2;
        Returns:
        The lon.

      • hasCountry

        boolean hasCountry()
         Country using ISO-3166-1 Alpha-3.
        optional string country = 3;
        Returns:
        Whether the country field is set.

      • getCountry

        String getCountry()
         Country using ISO-3166-1 Alpha-3.
        optional string country = 3;
        Returns:
        The country.

      • getCountryBytes

        com.google.protobuf.ByteString getCountryBytes()
         Country using ISO-3166-1 Alpha-3.
        optional string country = 3;
        Returns:
        The bytes for country.

      • hasRegion

        boolean hasRegion()
         Region code using ISO-3166-2; 2-letter state code if USA.
        optional string region = 4;
        Returns:
        Whether the region field is set.

      • getRegion

        String getRegion()
         Region code using ISO-3166-2; 2-letter state code if USA.
        optional string region = 4;
        Returns:
        The region.

      • getRegionBytes

        com.google.protobuf.ByteString getRegionBytes()
         Region code using ISO-3166-2; 2-letter state code if USA.
        optional string region = 4;
        Returns:
        The bytes for region.

      • hasRegionfips104

        boolean hasRegionfips104()
         Region of a country using FIPS 10-4 notation. While OpenRTB supports
 this attribute, it has been withdrawn by NIST in 2008.
        optional string regionfips104 = 5;
        Returns:
        Whether the regionfips104 field is set.

      • getRegionfips104

        String getRegionfips104()
         Region of a country using FIPS 10-4 notation. While OpenRTB supports
 this attribute, it has been withdrawn by NIST in 2008.
        optional string regionfips104 = 5;
        Returns:
        The regionfips104.

      • getRegionfips104Bytes

        com.google.protobuf.ByteString getRegionfips104Bytes()
         Region of a country using FIPS 10-4 notation. While OpenRTB supports
 this attribute, it has been withdrawn by NIST in 2008.
        optional string regionfips104 = 5;
        Returns:
        The bytes for regionfips104.

      • hasMetro

        boolean hasMetro()
         Google metro code; similar to but not exactly Nielsen DMAs.
 See Appendix A for a link to the codes.
 (http://code.google.com/apis/adwords/docs/appendix/metrocodes.html).
        optional string metro = 6;
        Returns:
        Whether the metro field is set.

      • getMetro

        String getMetro()
         Google metro code; similar to but not exactly Nielsen DMAs.
 See Appendix A for a link to the codes.
 (http://code.google.com/apis/adwords/docs/appendix/metrocodes.html).
        optional string metro = 6;
        Returns:
        The metro.

      • getMetroBytes

        com.google.protobuf.ByteString getMetroBytes()
         Google metro code; similar to but not exactly Nielsen DMAs.
 See Appendix A for a link to the codes.
 (http://code.google.com/apis/adwords/docs/appendix/metrocodes.html).
        optional string metro = 6;
        Returns:
        The bytes for metro.

      • hasCity

        boolean hasCity()
         City using United Nations Code for Trade & Transport Locations.
 See Appendix A for a link to the codes.
 (http://www.unece.org/cefact/locode/service/location.htm).
        optional string city = 7;
        Returns:
        Whether the city field is set.

      • getCity

        String getCity()
         City using United Nations Code for Trade & Transport Locations.
 See Appendix A for a link to the codes.
 (http://www.unece.org/cefact/locode/service/location.htm).
        optional string city = 7;
        Returns:
        The city.

      • getCityBytes

        com.google.protobuf.ByteString getCityBytes()
         City using United Nations Code for Trade & Transport Locations.
 See Appendix A for a link to the codes.
 (http://www.unece.org/cefact/locode/service/location.htm).
        optional string city = 7;
        Returns:
        The bytes for city.

      • hasZip

        boolean hasZip()
         Zip/postal code.
        optional string zip = 8;
        Returns:
        Whether the zip field is set.

      • getZip

        String getZip()
         Zip/postal code.
        optional string zip = 8;
        Returns:
        The zip.

      • getZipBytes

        com.google.protobuf.ByteString getZipBytes()
         Zip/postal code.
        optional string zip = 8;
        Returns:
        The bytes for zip.

      • hasType

        boolean hasType()
         Source of location data; recommended when passing lat/lon.
        optional .com.google.openrtb.LocationType type = 9;
        Returns:
        Whether the type field is set.

      • getType

        OpenRtb.LocationType getType()
         Source of location data; recommended when passing lat/lon.
        optional .com.google.openrtb.LocationType type = 9;
        Returns:
        The type.

      • hasAccuracy

        boolean hasAccuracy()
         Estimated location accuracy in meters; recommended when lat/lon
 are specified and derived from a device's location services
 (i.e., type = 1). Note that this is the accuracy as reported
 from the device. Consult OS specific documentation
 (e.g., Android, iOS) for exact interpretation.
        optional int32 accuracy = 11;
        Returns:
        Whether the accuracy field is set.

      • getAccuracy

        int getAccuracy()
         Estimated location accuracy in meters; recommended when lat/lon
 are specified and derived from a device's location services
 (i.e., type = 1). Note that this is the accuracy as reported
 from the device. Consult OS specific documentation
 (e.g., Android, iOS) for exact interpretation.
        optional int32 accuracy = 11;
        Returns:
        The accuracy.

      • hasLastfix

        boolean hasLastfix()
         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.
        optional int32 lastfix = 12;
        Returns:
        Whether the lastfix field is set.

      • getLastfix

        int 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.
        optional int32 lastfix = 12;
        Returns:
        The lastfix.

      • hasIpservice

        boolean hasIpservice()
         Service or provider used to determine geolocation from IP
 address if applicable (i.e., type = 2).
        optional .com.google.openrtb.LocationService ipservice = 13;
        Returns:
        Whether the ipservice field is set.

      • getIpservice

        OpenRtb.LocationService getIpservice()
         Service or provider used to determine geolocation from IP
 address if applicable (i.e., type = 2).
        optional .com.google.openrtb.LocationService ipservice = 13;
        Returns:
        The ipservice.

      • hasUtcoffset

        boolean hasUtcoffset()
         Local time as the number +/- of minutes from UTC.
        optional int32 utcoffset = 10;
        Returns:
        Whether the utcoffset field is set.

      • getUtcoffset

        int getUtcoffset()
         Local time as the number +/- of minutes from UTC.
        optional int32 utcoffset = 10;
        Returns:
        The utcoffset.