com.adgear.avro.openrtb.User.avsc Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of anoa-test Show documentation
Test module for other Anoa modules, which exposes complex records (OpenRTB bid requests) through utility classes for use in unit tests within other Anoa modules (anoa-core, for instance).
The newest version!
{
  "type" : "record",
  "name" : "User",
  "namespace" : "com.adgear.avro.openrtb",
  "doc" : "3.3.12 User Object\nThe “user” object contains information known or derived about the human user of the device. Note that the user ID is an exchange artifact (refer to the “device” object for hardware or platform derived IDs) and may be subject to rotation policies. However, this user ID must be stable long enough to serve reasonably as the basis for frequency capping.\nThe user object itself and all of its parameters are optional, so default values are not provided. If an optional parameter is not specified, it should be considered unknown.\nIf device ID is used as a proxy for unique user ID, use the device object.\n\nrequires:\n com.adgear.avro.openrtb.Geo\n com.adgear.avro.openrtb.Data",
  "fields" : [ {
    "name" : "id",
    "type" : [ "null", "string" ],
    "doc" : "[01] Unique consumer ID of this user on the exchange.",
    "default" : null
  }, {
    "name" : "buyeruid",
    "type" : [ "null", "string" ],
    "doc" : "[02] Buyer’s user ID for this user as mapped by exchange for the buyer. (AdGear cookie)",
    "default" : null
  }, {
    "name" : "yob",
    "type" : [ "null", "int" ],
    "doc" : "[03] Year of birth as a 4-digit integer.",
    "default" : null
  }, {
    "name" : "gender",
    "type" : [ "null", "string" ],
    "doc" : "[04] Gender as “M” male, “F” female, “O” Other. (Null indicates unknown).",
    "default" : null
  }, {
    "name" : "keywords",
    "type" : [ "null", "string" ],
    "doc" : "[05] Comma separated list of keywords of consumer interests or intent.",
    "default" : null
  }, {
    "name" : "customdata",
    "type" : [ "null", "string" ],
    "doc" : "[06] If supported by the exchange, this is custom data that the bidder had stored in the exchange’s cookie. The string may be in base85 cookie safe characters, and be in any format. This may useful for storing user features. Note: Proper JSON encoding must be used to include “escaped” quotation marks.",
    "default" : null
  }, {
    "name" : "geo",
    "type" : [ "null", {
      "type" : "record",
      "name" : "Geo",
      "doc" : "3.3.11 Geo Object\nThe geo object itself and all of its parameters are optional, so default values are not provided. If an optional parameter is not specified, it should be considered unknown.\nNote that the Geo Object may appear in one or both the Device Object and the User Object. This is intentional, since the information may be derived from either a device-oriented source (such as IP geo lookup), or by user registration information (for example provided to a publisher through a user registration). If the information is in conflict, it’s up to the bidder to determine which information to use.",
      "fields" : [ {
        "name" : "lat",
        "type" : [ "null", "float" ],
        "doc" : "[01] Latitude from -90 to 90. South is negative. This should only be passed if known to be accurate (For example, not the centroid of a postal code).",
        "default" : null
      }, {
        "name" : "lon",
        "type" : [ "null", "float" ],
        "doc" : "[02] Longitude from -180 to 180. West is negative. This should only be passed if known to be accurate.",
        "default" : null
      }, {
        "name" : "country",
        "type" : [ "null", "string" ],
        "doc" : "[03] Country using ISO-3166-1 Alpha-3.",
        "default" : null
      }, {
        "name" : "region",
        "type" : [ "null", "string" ],
        "doc" : "[04] Region using ISO 3166-2.",
        "default" : null
      }, {
        "name" : "regionfips104",
        "type" : [ "null", "string" ],
        "doc" : "[05] Region of a country using FIPS 10-4 notation (alternative to ISO 3166-2).",
        "default" : null
      }, {
        "name" : "metro",
        "type" : [ "null", "string" ],
        "doc" : "[06] Pass the metro code (seehttp://code.google.com/apis/adwords/docs/appendix/metrocodes.html). Metro codes are similar to but not exactly the same as Nielsen DMAs.",
        "default" : null
      }, {
        "name" : "city",
        "type" : [ "null", "string" ],
        "doc" : "[07] City using United Nations Code for Trade and Transport Locations (http://www.unece.org/cefact/locode/ser vice/location.htm).",
        "default" : null
      }, {
        "name" : "zip",
        "type" : [ "null", "string" ],
        "doc" : "[08] Zip/postal code.",
        "default" : null
      }, {
        "name" : "type",
        "type" : [ "null", "int" ],
        "doc" : "[09] Indicate the source of the geo data (GPS, IP address, user provided). See Table 6.15 Location Type for a list of potential values. Type should be provided when lat/lon is provided.",
        "default" : null
      } ]
    } ],
    "doc" : "[07] Home geo for the user (e.g., based off of registration data); this is different from the current location of the access device (that is defined by the geo object embedded in the Device Object); see Geo Object.",
    "default" : null
  }, {
    "name" : "data",
    "type" : [ "null", {
      "type" : "array",
      "items" : {
        "type" : "record",
        "name" : "Data",
        "doc" : "3.3.13 Data Object\nThe data and segment objects together allow data about the user to be passed to bidders in the bid request. This data may be from multiple sources (e.g., the exchange itself, third party providers) as specified by the data object ID field. A bid request can mix data objects from multiple providers.\nThe data object itself and all of its parameters are optional, so default values are not provided. If an optional parameter is not specified, it should be considered unknown.\n\nrequires:\n com.adgear.avro.openrtb.Segment",
        "fields" : [ {
          "name" : "id",
          "type" : [ "null", "string" ],
          "doc" : "[1] Exchange specific ID for the data provider.",
          "default" : null
        }, {
          "name" : "name",
          "type" : [ "null", "string" ],
          "doc" : "[2] Data provider name.",
          "default" : null
        }, {
          "name" : "segment",
          "type" : [ "null", {
            "type" : "array",
            "items" : {
              "type" : "record",
              "name" : "Segment",
              "doc" : "3.3.14 Segment Object\nThe data and segment objects together allow data about the user to be passed to bidders in the bid request. Segment objects convey specific units of information from the provider identified in the parent data object.\nThe segment object itself and all of its parameters are optional, so default values are not provided; if an optional parameter is not specified, it should be considered unknown.",
              "fields" : [ {
                "name" : "id",
                "type" : [ "null", "string" ],
                "doc" : "[1] ID of a data provider’s segment applicable to the user.",
                "default" : null
              }, {
                "name" : "name",
                "type" : [ "null", "string" ],
                "doc" : "[2] Name of a data provider’s segment applicable to the user.",
                "default" : null
              }, {
                "name" : "value",
                "type" : [ "null", "string" ],
                "doc" : "[3] String representing the value of the segment. The method for transmitting this data should be negotiated offline with the data provider. For example for gender, “male”, or “female”, for age, “30-40”).",
                "default" : null
              } ]
            }
          } ],
          "doc" : "[3] Array of segment objects.",
          "default" : null
        } ]
      }
    } ],
    "doc" : "[08] See Data Object.",
    "default" : null
  } ]
}