Package 

Class User

  • 
public final class User

    This object contains information known or derived about the human user of the device (i.e., the audience for advertising). The user id is an exchange artifact and may be subject to rotation or other privacy policies. However, this user ID must be stable long enough to serve reasonably as the basis for frequency capping and retargeting.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public enum User.Gender

    • Constructor Summary

      Constructors 
      Constructor Description
      User()

    • Method Summary

      Modifier and Type Method Description
      final String getId() Exchange-specific ID for the user.
      final Unit setId(@SerializedName(value = id) String id) Exchange-specific ID for the user.
      final String getBuyerUID() Buyer-specific ID for the user as mapped by the exchange for the buyer.
      final Unit setBuyerUID(@SerializedName(value = buyeruid) String buyerUID) Buyer-specific ID for the user as mapped by the exchange for the buyer.
      final Integer getYearOfBirth() Year of birth as a 4-digit integer.
      final Unit setYearOfBirth(@SerializedName(value = yob) Integer yearOfBirth) Year of birth as a 4-digit integer.
      final Character getGender() Gender, where “M” = male, “F” = female, “O” = known to be other (i.e., omitted is unknown).
      final Unit setGender(@SerializedName(value = gender) Character gender) Gender, where “M” = male, “F” = female, “O” = known to be other (i.e., omitted is unknown).
      final String getKeywords() Comma separated list of keywords, interests, or intent.
      final Unit setKeywords(@SerializedName(value = keywords) String keywords) Comma separated list of keywords, interests, or intent.
      final String getCustomData() Optional feature to pass bidder data that was set in the exchange’s cookie.
      final Unit setCustomData(@SerializedName(value = customdata) String customData) Optional feature to pass bidder data that was set in the exchange’s cookie.
      final Geo getGeo() Location of the user’s home base defined by a Geo object.
      final Unit setGeo(@SerializedName(value = geo) Geo geo) Location of the user’s home base defined by a Geo object.
      final Data getData() Additional user data.
      final Unit setData(@SerializedName(value = data) Data data) Additional user data.
      final Object getExtension() Placeholder for exchange-specific extensions to OpenRTB.
      final Unit setExtension(@SerializedName(value = ext) Object extension) Placeholder for exchange-specific extensions to OpenRTB.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • User

        User()

    • Method Detail

      • getId

         final String getId()

        Exchange-specific ID for the user. At least one of id or buyerUID is recommended.

      • setId

         final Unit setId(@SerializedName(value = id) String id)

        Exchange-specific ID for the user. At least one of id or buyerUID is recommended.

      • getBuyerUID

         final String getBuyerUID()

        Buyer-specific ID for the user as mapped by the exchange for the buyer. At least one of buyerUID or id is recommended.

      • setBuyerUID

         final Unit setBuyerUID(@SerializedName(value = buyeruid) String buyerUID)

        Buyer-specific ID for the user as mapped by the exchange for the buyer. At least one of buyerUID or id is recommended.

      • setYearOfBirth

         final Unit setYearOfBirth(@SerializedName(value = yob) Integer yearOfBirth)

        Year of birth as a 4-digit integer.

      • getGender

         final Character getGender()

        Gender, where “M” = male, “F” = female, “O” = known to be other (i.e., omitted is unknown).

      • setGender

         final Unit setGender(@SerializedName(value = gender) Character gender)

        Gender, where “M” = male, “F” = female, “O” = known to be other (i.e., omitted is unknown).

      • getKeywords

         final String getKeywords()

        Comma separated list of keywords, interests, or intent.

      • setKeywords

         final Unit setKeywords(@SerializedName(value = keywords) String keywords)

        Comma separated list of keywords, interests, or intent.

      • getCustomData

         final String getCustomData()

        Optional feature to pass bidder data that was set in the exchange’s cookie. The string must be in base85 cookie safe characters and be in any format. Proper JSON encoding must be used to include “escaped” quotation marks.

      • setCustomData

         final Unit setCustomData(@SerializedName(value = customdata) String customData)

        Optional feature to pass bidder data that was set in the exchange’s cookie. The string must be in base85 cookie safe characters and be in any format. Proper JSON encoding must be used to include “escaped” quotation marks.

      • getGeo

         final Geo getGeo()

        Location of the user’s home base defined by a Geo object. This is not necessarily their current location.

      • setGeo

         final Unit setGeo(@SerializedName(value = geo) Geo geo)

        Location of the user’s home base defined by a Geo object. This is not necessarily their current location.

      • getData

         final Data getData()

        Additional user data. Each Data object represents a different data source.

      • setData

         final Unit setData(@SerializedName(value = data) Data data)

        Additional user data. Each Data object represents a different data source.

      • 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.