Package com.google.openrtb

Interface OpenRtb.BidRequest.DeviceOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getCarrier()
      Carrier or ISP (e.g., "VERIZON") using exchange curated string names which should be published to bidders a priori.
      com.google.protobuf.ByteString getCarrierBytes()
      Carrier or ISP (e.g., "VERIZON") using exchange curated string names which should be published to bidders a priori.
      OpenRtb.ConnectionType getConnectiontype()
      Network connection type.
      OpenRtb.DeviceType getDevicetype()
      The general type of device.
      String getDidmd5()
      Hardware device ID (e.g., IMEI); hashed via MD5.
      com.google.protobuf.ByteString getDidmd5Bytes()
      Hardware device ID (e.g., IMEI); hashed via MD5.
      String getDidsha1()
      Hardware device ID (e.g., IMEI); hashed via SHA1.
      com.google.protobuf.ByteString getDidsha1Bytes()
      Hardware device ID (e.g., IMEI); hashed via SHA1.
      boolean getDnt()
      Standard "Do Not Track" flag as set in the header by the browser, where false = tracking is unrestricted, true = do not track.
      String getDpidmd5()
      Platform device ID (e.g., Android ID); hashed via MD5.
      com.google.protobuf.ByteString getDpidmd5Bytes()
      Platform device ID (e.g., Android ID); hashed via MD5.
      String getDpidsha1()
      Platform device ID (e.g., Android ID); hashed via SHA1.
      com.google.protobuf.ByteString getDpidsha1Bytes()
      Platform device ID (e.g., Android ID); hashed via SHA1.
      String getFlashver()
      Version of Flash supported by the browser.
      com.google.protobuf.ByteString getFlashverBytes()
      Version of Flash supported by the browser.
      OpenRtb.BidRequest.Geo getGeo()
      Location of the device assumed to be the user's current location defined by a Geo object (Section 3.2.12).
      boolean getGeofetch()
      Indicates if the geolocation API will be available to JavaScript code running in the banner.
      OpenRtb.BidRequest.GeoOrBuilder getGeoOrBuilder()
      Location of the device assumed to be the user's current location defined by a Geo object (Section 3.2.12).
      int getH()
      Physical height of the screen in pixels.
      String getHwv()
      Hardware version of the device (e.g., "5S" for iPhone 5S).
      com.google.protobuf.ByteString getHwvBytes()
      Hardware version of the device (e.g., "5S" for iPhone 5S).
      String getIfa()
      ID sanctioned for advertiser use in the clear (i.e., not hashed).
      com.google.protobuf.ByteString getIfaBytes()
      ID sanctioned for advertiser use in the clear (i.e., not hashed).
      String getIp()
      IPv4 address closest to device.
      com.google.protobuf.ByteString getIpBytes()
      IPv4 address closest to device.
      String getIpv6()
      IPv6 address closest to device.
      com.google.protobuf.ByteString getIpv6Bytes()
      IPv6 address closest to device.
      boolean getJs()
      Support for JavaScript.
      String getLanguage()
      Browser language using ISO-639-1-alpha-2.
      com.google.protobuf.ByteString getLanguageBytes()
      Browser language using ISO-639-1-alpha-2.
      boolean getLmt()
      "Limit Ad Tracking" signal commercially endorsed (e.g., iOS, Android), where false = tracking is unrestricted, true = tracking must be limited per commercial guidelines.
      String getMacmd5()
      MAC address of the device; hashed via MD5.
      com.google.protobuf.ByteString getMacmd5Bytes()
      MAC address of the device; hashed via MD5.
      String getMacsha1()
      MAC address of the device; hashed via SHA1.
      com.google.protobuf.ByteString getMacsha1Bytes()
      MAC address of the device; hashed via SHA1.
      String getMake()
      Device make (e.g., "Apple").
      com.google.protobuf.ByteString getMakeBytes()
      Device make (e.g., "Apple").
      String getMccmnc()
      Mobile carrier as the concatenated MCC-MNC code (e.g., "310-005" identifies Verizon Wireless CDMA in the USA).
      com.google.protobuf.ByteString getMccmncBytes()
      Mobile carrier as the concatenated MCC-MNC code (e.g., "310-005" identifies Verizon Wireless CDMA in the USA).
      String getModel()
      Device model (e.g., "iPhone").
      com.google.protobuf.ByteString getModelBytes()
      Device model (e.g., "iPhone").
      String getOs()
      Device operating system (e.g., "iOS").
      com.google.protobuf.ByteString getOsBytes()
      Device operating system (e.g., "iOS").
      String getOsv()
      Device operating system version (e.g., "3.1.2").
      com.google.protobuf.ByteString getOsvBytes()
      Device operating system version (e.g., "3.1.2").
      int getPpi()
      Screen size as pixels per linear inch.
      double getPxratio()
      The ratio of physical pixels to device independent pixels.
      String getUa()
      Browser user agent string.
      com.google.protobuf.ByteString getUaBytes()
      Browser user agent string.
      int getW()
      Physical width of the screen in pixels.
      boolean hasCarrier()
      Carrier or ISP (e.g., "VERIZON") using exchange curated string names which should be published to bidders a priori.
      boolean hasConnectiontype()
      Network connection type.
      boolean hasDevicetype()
      The general type of device.
      boolean hasDidmd5()
      Hardware device ID (e.g., IMEI); hashed via MD5.
      boolean hasDidsha1()
      Hardware device ID (e.g., IMEI); hashed via SHA1.
      boolean hasDnt()
      Standard "Do Not Track" flag as set in the header by the browser, where false = tracking is unrestricted, true = do not track.
      boolean hasDpidmd5()
      Platform device ID (e.g., Android ID); hashed via MD5.
      boolean hasDpidsha1()
      Platform device ID (e.g., Android ID); hashed via SHA1.
      boolean hasFlashver()
      Version of Flash supported by the browser.
      boolean hasGeo()
      Location of the device assumed to be the user's current location defined by a Geo object (Section 3.2.12).
      boolean hasGeofetch()
      Indicates if the geolocation API will be available to JavaScript code running in the banner.
      boolean hasH()
      Physical height of the screen in pixels.
      boolean hasHwv()
      Hardware version of the device (e.g., "5S" for iPhone 5S).
      boolean hasIfa()
      ID sanctioned for advertiser use in the clear (i.e., not hashed).
      boolean hasIp()
      IPv4 address closest to device.
      boolean hasIpv6()
      IPv6 address closest to device.
      boolean hasJs()
      Support for JavaScript.
      boolean hasLanguage()
      Browser language using ISO-639-1-alpha-2.
      boolean hasLmt()
      "Limit Ad Tracking" signal commercially endorsed (e.g., iOS, Android), where false = tracking is unrestricted, true = tracking must be limited per commercial guidelines.
      boolean hasMacmd5()
      MAC address of the device; hashed via MD5.
      boolean hasMacsha1()
      MAC address of the device; hashed via SHA1.
      boolean hasMake()
      Device make (e.g., "Apple").
      boolean hasMccmnc()
      Mobile carrier as the concatenated MCC-MNC code (e.g., "310-005" identifies Verizon Wireless CDMA in the USA).
      boolean hasModel()
      Device model (e.g., "iPhone").
      boolean hasOs()
      Device operating system (e.g., "iOS").
      boolean hasOsv()
      Device operating system version (e.g., "3.1.2").
      boolean hasPpi()
      Screen size as pixels per linear inch.
      boolean hasPxratio()
      The ratio of physical pixels to device independent pixels.
      boolean hasUa()
      Browser user agent string.
      boolean hasW()
      Physical width of the screen in pixels.

      • 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

      • hasGeo

        boolean hasGeo()
         Location of the device assumed to be the user's current location defined
 by a Geo object (Section 3.2.12).
 RECOMMENDED by the OpenRTB specification.
        optional .com.google.openrtb.BidRequest.Geo geo = 4;
        Returns:
        Whether the geo field is set.

      • getGeo

        OpenRtb.BidRequest.Geo getGeo()
         Location of the device assumed to be the user's current location defined
 by a Geo object (Section 3.2.12).
 RECOMMENDED by the OpenRTB specification.
        optional .com.google.openrtb.BidRequest.Geo geo = 4;
        Returns:
        The geo.

      • getGeoOrBuilder

        OpenRtb.BidRequest.GeoOrBuilder getGeoOrBuilder()
         Location of the device assumed to be the user's current location defined
 by a Geo object (Section 3.2.12).
 RECOMMENDED by the OpenRTB specification.
        optional .com.google.openrtb.BidRequest.Geo geo = 4;

      • hasDnt

        boolean hasDnt()
         Standard "Do Not Track" flag as set in the header by the browser,
 where false = tracking is unrestricted, true = do not track.
 RECOMMENDED by the OpenRTB specification.
        optional bool dnt = 1;
        Returns:
        Whether the dnt field is set.

      • getDnt

        boolean getDnt()
         Standard "Do Not Track" flag as set in the header by the browser,
 where false = tracking is unrestricted, true = do not track.
 RECOMMENDED by the OpenRTB specification.
        optional bool dnt = 1;
        Returns:
        The dnt.

      • hasLmt

        boolean hasLmt()
         "Limit Ad Tracking" signal commercially endorsed (e.g., iOS, Android),
 where false = tracking is unrestricted, true = tracking must be limited
 per commercial guidelines.
 RECOMMENDED by the OpenRTB specification.
        optional bool lmt = 23;
        Returns:
        Whether the lmt field is set.

      • getLmt

        boolean getLmt()
         "Limit Ad Tracking" signal commercially endorsed (e.g., iOS, Android),
 where false = tracking is unrestricted, true = tracking must be limited
 per commercial guidelines.
 RECOMMENDED by the OpenRTB specification.
        optional bool lmt = 23;
        Returns:
        The lmt.

      • hasUa

        boolean hasUa()
         Browser user agent string. Certain data may be redacted or replaced.
 RECOMMENDED by the OpenRTB specification.
        optional string ua = 2;
        Returns:
        Whether the ua field is set.

      • getUa

        String getUa()
         Browser user agent string. Certain data may be redacted or replaced.
 RECOMMENDED by the OpenRTB specification.
        optional string ua = 2;
        Returns:
        The ua.

      • getUaBytes

        com.google.protobuf.ByteString getUaBytes()
         Browser user agent string. Certain data may be redacted or replaced.
 RECOMMENDED by the OpenRTB specification.
        optional string ua = 2;
        Returns:
        The bytes for ua.

      • hasIp

        boolean hasIp()
         IPv4 address closest to device.
 RECOMMENDED by the OpenRTB specification.
        optional string ip = 3;
        Returns:
        Whether the ip field is set.

      • getIp

        String getIp()
         IPv4 address closest to device.
 RECOMMENDED by the OpenRTB specification.
        optional string ip = 3;
        Returns:
        The ip.

      • getIpBytes

        com.google.protobuf.ByteString getIpBytes()
         IPv4 address closest to device.
 RECOMMENDED by the OpenRTB specification.
        optional string ip = 3;
        Returns:
        The bytes for ip.

      • hasIpv6

        boolean hasIpv6()
         IPv6 address closest to device.
        optional string ipv6 = 9;
        Returns:
        Whether the ipv6 field is set.

      • getIpv6

        String getIpv6()
         IPv6 address closest to device.
        optional string ipv6 = 9;
        Returns:
        The ipv6.

      • getIpv6Bytes

        com.google.protobuf.ByteString getIpv6Bytes()
         IPv6 address closest to device.
        optional string ipv6 = 9;
        Returns:
        The bytes for ipv6.

      • hasDevicetype

        boolean hasDevicetype()
         The general type of device.
        optional .com.google.openrtb.DeviceType devicetype = 18;
        Returns:
        Whether the devicetype field is set.

      • getDevicetype

        OpenRtb.DeviceType getDevicetype()
         The general type of device.
        optional .com.google.openrtb.DeviceType devicetype = 18;
        Returns:
        The devicetype.

      • hasMake

        boolean hasMake()
         Device make (e.g., "Apple").
        optional string make = 12;
        Returns:
        Whether the make field is set.

      • getMake

        String getMake()
         Device make (e.g., "Apple").
        optional string make = 12;
        Returns:
        The make.

      • getMakeBytes

        com.google.protobuf.ByteString getMakeBytes()
         Device make (e.g., "Apple").
        optional string make = 12;
        Returns:
        The bytes for make.

      • hasModel

        boolean hasModel()
         Device model (e.g., "iPhone").
        optional string model = 13;
        Returns:
        Whether the model field is set.

      • getModel

        String getModel()
         Device model (e.g., "iPhone").
        optional string model = 13;
        Returns:
        The model.

      • getModelBytes

        com.google.protobuf.ByteString getModelBytes()
         Device model (e.g., "iPhone").
        optional string model = 13;
        Returns:
        The bytes for model.

      • hasOs

        boolean hasOs()
         Device operating system (e.g., "iOS").
        optional string os = 14;
        Returns:
        Whether the os field is set.

      • getOs

        String getOs()
         Device operating system (e.g., "iOS").
        optional string os = 14;
        Returns:
        The os.

      • getOsBytes

        com.google.protobuf.ByteString getOsBytes()
         Device operating system (e.g., "iOS").
        optional string os = 14;
        Returns:
        The bytes for os.

      • hasOsv

        boolean hasOsv()
         Device operating system version (e.g., "3.1.2").
        optional string osv = 15;
        Returns:
        Whether the osv field is set.

      • getOsv

        String getOsv()
         Device operating system version (e.g., "3.1.2").
        optional string osv = 15;
        Returns:
        The osv.

      • getOsvBytes

        com.google.protobuf.ByteString getOsvBytes()
         Device operating system version (e.g., "3.1.2").
        optional string osv = 15;
        Returns:
        The bytes for osv.

      • hasHwv

        boolean hasHwv()
         Hardware version of the device (e.g., "5S" for iPhone 5S).
        optional string hwv = 24;
        Returns:
        Whether the hwv field is set.

      • getHwv

        String getHwv()
         Hardware version of the device (e.g., "5S" for iPhone 5S).
        optional string hwv = 24;
        Returns:
        The hwv.

      • getHwvBytes

        com.google.protobuf.ByteString getHwvBytes()
         Hardware version of the device (e.g., "5S" for iPhone 5S).
        optional string hwv = 24;
        Returns:
        The bytes for hwv.

      • hasW

        boolean hasW()
         Physical width of the screen in pixels.
        optional int32 w = 25;
        Returns:
        Whether the w field is set.

      • getW

        int getW()
         Physical width of the screen in pixels.
        optional int32 w = 25;
        Returns:
        The w.

      • hasH

        boolean hasH()
         Physical height of the screen in pixels.
        optional int32 h = 26;
        Returns:
        Whether the h field is set.

      • getH

        int getH()
         Physical height of the screen in pixels.
        optional int32 h = 26;
        Returns:
        The h.

      • hasPpi

        boolean hasPpi()
         Screen size as pixels per linear inch.
        optional int32 ppi = 27;
        Returns:
        Whether the ppi field is set.

      • getPpi

        int getPpi()
         Screen size as pixels per linear inch.
        optional int32 ppi = 27;
        Returns:
        The ppi.

      • hasPxratio

        boolean hasPxratio()
         The ratio of physical pixels to device independent pixels.
        optional double pxratio = 28;
        Returns:
        Whether the pxratio field is set.

      • getPxratio

        double getPxratio()
         The ratio of physical pixels to device independent pixels.
        optional double pxratio = 28;
        Returns:
        The pxratio.

      • hasJs

        boolean hasJs()
         Support for JavaScript.
        optional bool js = 16;
        Returns:
        Whether the js field is set.

      • getJs

        boolean getJs()
         Support for JavaScript.
        optional bool js = 16;
        Returns:
        The js.

      • hasGeofetch

        boolean hasGeofetch()
         Indicates if the geolocation API will be available to JavaScript
 code running in the banner.
        optional bool geofetch = 29;
        Returns:
        Whether the geofetch field is set.

      • getGeofetch

        boolean getGeofetch()
         Indicates if the geolocation API will be available to JavaScript
 code running in the banner.
        optional bool geofetch = 29;
        Returns:
        The geofetch.

      • hasFlashver

        boolean hasFlashver()
         Version of Flash supported by the browser.
        optional string flashver = 19;
        Returns:
        Whether the flashver field is set.

      • getFlashver

        String getFlashver()
         Version of Flash supported by the browser.
        optional string flashver = 19;
        Returns:
        The flashver.

      • getFlashverBytes

        com.google.protobuf.ByteString getFlashverBytes()
         Version of Flash supported by the browser.
        optional string flashver = 19;
        Returns:
        The bytes for flashver.

      • hasLanguage

        boolean hasLanguage()
         Browser language using ISO-639-1-alpha-2.
        optional string language = 11;
        Returns:
        Whether the language field is set.

      • getLanguage

        String getLanguage()
         Browser language using ISO-639-1-alpha-2.
        optional string language = 11;
        Returns:
        The language.

      • getLanguageBytes

        com.google.protobuf.ByteString getLanguageBytes()
         Browser language using ISO-639-1-alpha-2.
        optional string language = 11;
        Returns:
        The bytes for language.

      • hasCarrier

        boolean hasCarrier()
         Carrier or ISP (e.g., "VERIZON") using exchange curated string
 names which should be published to bidders a priori.
        optional string carrier = 10;
        Returns:
        Whether the carrier field is set.

      • getCarrier

        String getCarrier()
         Carrier or ISP (e.g., "VERIZON") using exchange curated string
 names which should be published to bidders a priori.
        optional string carrier = 10;
        Returns:
        The carrier.

      • getCarrierBytes

        com.google.protobuf.ByteString getCarrierBytes()
         Carrier or ISP (e.g., "VERIZON") using exchange curated string
 names which should be published to bidders a priori.
        optional string carrier = 10;
        Returns:
        The bytes for carrier.

      • hasMccmnc

        boolean hasMccmnc()
         Mobile carrier as the concatenated MCC-MNC code (e.g.,
 "310-005" identifies Verizon Wireless CDMA in the USA).
 Refer to https://en.wikipedia.org/wiki/Mobile_country_code
 for further examples. Note that the dash between the MCC
 and MNC parts is required to remove parsing ambiguity.
        optional string mccmnc = 30;
        Returns:
        Whether the mccmnc field is set.

      • getMccmnc

        String getMccmnc()
         Mobile carrier as the concatenated MCC-MNC code (e.g.,
 "310-005" identifies Verizon Wireless CDMA in the USA).
 Refer to https://en.wikipedia.org/wiki/Mobile_country_code
 for further examples. Note that the dash between the MCC
 and MNC parts is required to remove parsing ambiguity.
        optional string mccmnc = 30;
        Returns:
        The mccmnc.

      • getMccmncBytes

        com.google.protobuf.ByteString getMccmncBytes()
         Mobile carrier as the concatenated MCC-MNC code (e.g.,
 "310-005" identifies Verizon Wireless CDMA in the USA).
 Refer to https://en.wikipedia.org/wiki/Mobile_country_code
 for further examples. Note that the dash between the MCC
 and MNC parts is required to remove parsing ambiguity.
        optional string mccmnc = 30;
        Returns:
        The bytes for mccmnc.

      • hasConnectiontype

        boolean hasConnectiontype()
         Network connection type.
        optional .com.google.openrtb.ConnectionType connectiontype = 17;
        Returns:
        Whether the connectiontype field is set.

      • getConnectiontype

        OpenRtb.ConnectionType getConnectiontype()
         Network connection type.
        optional .com.google.openrtb.ConnectionType connectiontype = 17;
        Returns:
        The connectiontype.

      • hasIfa

        boolean hasIfa()
         ID sanctioned for advertiser use in the clear (i.e., not hashed).
        optional string ifa = 20;
        Returns:
        Whether the ifa field is set.

      • getIfa

        String getIfa()
         ID sanctioned for advertiser use in the clear (i.e., not hashed).
        optional string ifa = 20;
        Returns:
        The ifa.

      • getIfaBytes

        com.google.protobuf.ByteString getIfaBytes()
         ID sanctioned for advertiser use in the clear (i.e., not hashed).
        optional string ifa = 20;
        Returns:
        The bytes for ifa.

      • hasDidsha1

        boolean hasDidsha1()
         Hardware device ID (e.g., IMEI); hashed via SHA1.
        optional string didsha1 = 5;
        Returns:
        Whether the didsha1 field is set.

      • getDidsha1

        String getDidsha1()
         Hardware device ID (e.g., IMEI); hashed via SHA1.
        optional string didsha1 = 5;
        Returns:
        The didsha1.

      • getDidsha1Bytes

        com.google.protobuf.ByteString getDidsha1Bytes()
         Hardware device ID (e.g., IMEI); hashed via SHA1.
        optional string didsha1 = 5;
        Returns:
        The bytes for didsha1.

      • hasDidmd5

        boolean hasDidmd5()
         Hardware device ID (e.g., IMEI); hashed via MD5.
        optional string didmd5 = 6;
        Returns:
        Whether the didmd5 field is set.

      • getDidmd5

        String getDidmd5()
         Hardware device ID (e.g., IMEI); hashed via MD5.
        optional string didmd5 = 6;
        Returns:
        The didmd5.

      • getDidmd5Bytes

        com.google.protobuf.ByteString getDidmd5Bytes()
         Hardware device ID (e.g., IMEI); hashed via MD5.
        optional string didmd5 = 6;
        Returns:
        The bytes for didmd5.

      • hasDpidsha1

        boolean hasDpidsha1()
         Platform device ID (e.g., Android ID); hashed via SHA1.
        optional string dpidsha1 = 7;
        Returns:
        Whether the dpidsha1 field is set.

      • getDpidsha1

        String getDpidsha1()
         Platform device ID (e.g., Android ID); hashed via SHA1.
        optional string dpidsha1 = 7;
        Returns:
        The dpidsha1.

      • getDpidsha1Bytes

        com.google.protobuf.ByteString getDpidsha1Bytes()
         Platform device ID (e.g., Android ID); hashed via SHA1.
        optional string dpidsha1 = 7;
        Returns:
        The bytes for dpidsha1.

      • hasDpidmd5

        boolean hasDpidmd5()
         Platform device ID (e.g., Android ID); hashed via MD5.
        optional string dpidmd5 = 8;
        Returns:
        Whether the dpidmd5 field is set.

      • getDpidmd5

        String getDpidmd5()
         Platform device ID (e.g., Android ID); hashed via MD5.
        optional string dpidmd5 = 8;
        Returns:
        The dpidmd5.

      • getDpidmd5Bytes

        com.google.protobuf.ByteString getDpidmd5Bytes()
         Platform device ID (e.g., Android ID); hashed via MD5.
        optional string dpidmd5 = 8;
        Returns:
        The bytes for dpidmd5.

      • hasMacsha1

        boolean hasMacsha1()
         MAC address of the device; hashed via SHA1.
        optional string macsha1 = 21;
        Returns:
        Whether the macsha1 field is set.

      • getMacsha1

        String getMacsha1()
         MAC address of the device; hashed via SHA1.
        optional string macsha1 = 21;
        Returns:
        The macsha1.

      • getMacsha1Bytes

        com.google.protobuf.ByteString getMacsha1Bytes()
         MAC address of the device; hashed via SHA1.
        optional string macsha1 = 21;
        Returns:
        The bytes for macsha1.

      • hasMacmd5

        boolean hasMacmd5()
         MAC address of the device; hashed via MD5.
        optional string macmd5 = 22;
        Returns:
        Whether the macmd5 field is set.

      • getMacmd5

        String getMacmd5()
         MAC address of the device; hashed via MD5.
        optional string macmd5 = 22;
        Returns:
        The macmd5.

      • getMacmd5Bytes

        com.google.protobuf.ByteString getMacmd5Bytes()
         MAC address of the device; hashed via MD5.
        optional string macmd5 = 22;
        Returns:
        The bytes for macmd5.