com.adgear.avro.openrtb.Banner.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" : "Banner",
  "namespace" : "com.adgear.avro.openrtb",
  "doc" : "3.3.3 Banner Object\nThe “banner” object _must_ be included directly in the impression object if the impression offered for auction is display or rich media, or it may be _optionally_ embedded in the video object to describe the companion banners available for the linear or non-linear video ad. The banner object may include a unique identifier; this can be useful if these IDs can be leveraged in the VAST response to dictate placement of the companion creatives when multiple companion ad opportunities of the same size are available on a page.",
  "fields" : [ {
    "name" : "w",
    "type" : [ "null", "int" ],
    "doc" : "[01] Width of the impression in pixels. Since some ad types are not restricted by size this field is not required, but it’s highly recommended that this information be included when possible.",
    "default" : null
  }, {
    "name" : "h",
    "type" : [ "null", "int" ],
    "doc" : "[02] Height of the impression in pixels. Since some ad types are not restricted by size this field is not required, but it’s highly recommended that this information be included when possible.",
    "default" : null
  }, {
    "name" : "wmax",
    "type" : [ "null", "int" ],
    "doc" : "[03] Maximum width of the impression in pixels. If included, it indicates that a range of sizes is allowed with this maximum width and \"w\" is taken as recommended. If not included, then \"w\" should be considered an exact requirement.",
    "default" : null
  }, {
    "name" : "hmax",
    "type" : [ "null", "int" ],
    "doc" : "[04] Maximum height of the impression in pixels. If included, it indicates that a range of sizes is allowed with this maximum height and \"h\" is taken as recommended. If not included, then \"h\" should be considered an exact requirement.",
    "default" : null
  }, {
    "name" : "wmin",
    "type" : [ "null", "int" ],
    "doc" : "[05] Minimum width of the impression in pixels. If included, it indicates that a range of sizes is allowed with this minimum width and \"w\" is taken as recommended. If not included, then \"w\" should be considered an exact requirement.",
    "default" : null
  }, {
    "name" : "hmin",
    "type" : [ "null", "int" ],
    "doc" : "[06] Minimum height of the impression in pixels. If included, it indicates that a range of sizes is allowed with this minimum height and \"h\" is taken as recommended. If not included, then \"h\" should be considered an exact requirement.",
    "default" : null
  }, {
    "name" : "id",
    "type" : [ "null", "string" ],
    "doc" : "[07] Unique identifier for this banner object. Useful for tracking multiple banner objects (e.g., in companion banner array). Usually starts with 1, increasing with each object. Combination of impression id banner object should be unique.",
    "default" : null
  }, {
    "name" : "pos",
    "type" : [ "null", "int" ],
    "doc" : "[08] Ad Position. Use Table 6.5",
    "default" : null
  }, {
    "name" : "btype",
    "type" : [ "null", {
      "type" : "array",
      "items" : "int"
    } ],
    "doc" : "[09] Blocked creative types. See Table 6.2 Banner Ad Types. If blank, assume all types are allowed.",
    "default" : null
  }, {
    "name" : "battr",
    "type" : [ "null", {
      "type" : "array",
      "items" : "int"
    } ],
    "doc" : "[10] Blocked creative attributes. See Table 6.3 Creative Attributes. If blank assume all types are allowed.",
    "default" : null
  }, {
    "name" : "mimes",
    "type" : [ "null", {
      "type" : "array",
      "items" : "string"
    } ],
    "doc" : "[11] Whitelist of content MIME types supported. Popular MIME types include, but are not limited to “image/jpg”, “image/gif” and “application/x-shockwave-flash”.",
    "default" : null
  }, {
    "name" : "topframe",
    "type" : "int",
    "doc" : "[12] Specify if the banner is delivered in the top frame or in an iframe. “0” means it is not in the top frame, and “1” means that it is.",
    "default" : 0
  }, {
    "name" : "expdir",
    "type" : [ "null", {
      "type" : "array",
      "items" : "int"
    } ],
    "doc" : "[13] Specify properties for an expandable ad. See Table 6.11 Expandable Direction for possible values.",
    "default" : null
  }, {
    "name" : "api",
    "type" : [ "null", {
      "type" : "array",
      "items" : "int"
    } ],
    "doc" : "[14] List of supported API frameworks for this banner. (See Table 6.4 API Frameworks). If an API is not explicitly listed it is assumed not to be supported.",
    "default" : null
  } ]
}