com.adgear.avro.openrtb.App.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" : "App",
  "namespace" : "com.adgear.avro.openrtb",
  "doc" : "3.3.6 App Object\nAn “app” object should be included if the ad supported content is part of a mobile application (as opposed to a mobile website). A bid request must not contain both an “app” object and a “site” object.\nThe app 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. At a minimum, it’s useful to provide an App ID or bundle, but this is not strictly required.\n\nrequires:\n com.adgear.avro.openrtb.Publisher\n com.adgear.avro.openrtb.Content",
  "fields" : [ {
    "name" : "id",
    "type" : [ "null", "string" ],
    "doc" : "[01] Application ID on the exchange.",
    "default" : null
  }, {
    "name" : "name",
    "type" : [ "null", "string" ],
    "doc" : "[02] Application name (may be masked at publisher’s request).",
    "default" : null
  }, {
    "name" : "domain",
    "type" : [ "null", "string" ],
    "doc" : "[03] Domain of the application (e.g., “mygame.foo.com”).",
    "default" : null
  }, {
    "name" : "cat",
    "type" : [ "null", {
      "type" : "array",
      "items" : "string"
    } ],
    "doc" : "[04] Array of IAB content categories for the overall application. See Table 6.1 Content Categories.",
    "default" : null
  }, {
    "name" : "sectioncat",
    "type" : [ "null", {
      "type" : "array",
      "items" : "string"
    } ],
    "doc" : "[05] Array of IAB content categories for the current subsection of the app. See Table 6.1 Content Categories.",
    "default" : null
  }, {
    "name" : "pagecat",
    "type" : [ "null", {
      "type" : "array",
      "items" : "string"
    } ],
    "doc" : "[06] Array of IAB content categories for the current page/view of the app. See Table 6.1 Content Categories.",
    "default" : null
  }, {
    "name" : "ver",
    "type" : [ "null", "string" ],
    "doc" : "[07] Application version.",
    "default" : null
  }, {
    "name" : "bundle",
    "type" : [ "null", "string" ],
    "doc" : "[08] Application bundle or package name (e.g., com.foo.mygame). This is intended to be a unique ID across multiple exchanges.",
    "default" : null
  }, {
    "name" : "privacypolicy",
    "type" : [ "null", "int" ],
    "doc" : "[09] Specifies whether the app has a privacy policy. “1” means there is a policy and “0” means there is not.",
    "default" : null
  }, {
    "name" : "paid",
    "type" : [ "null", "int" ],
    "doc" : "[10] “1” if the application is a paid version; else “0” (i.e., free).",
    "default" : null
  }, {
    "name" : "publisher",
    "type" : [ "null", {
      "type" : "record",
      "name" : "Publisher",
      "doc" : "3.3.8 Publisher Object\nThe publisher 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] Publisher ID on the exchange.",
        "default" : null
      }, {
        "name" : "name",
        "type" : [ "null", "string" ],
        "doc" : "[2] Publisher name (may be masked at publisher’s request).",
        "default" : null
      }, {
        "name" : "cat",
        "type" : [ "null", {
          "type" : "array",
          "items" : "string"
        } ],
        "doc" : "[3] Array of IAB content categories for the publisher. See Table 6.1 Content Categories.",
        "default" : null
      }, {
        "name" : "domain",
        "type" : [ "null", "string" ],
        "doc" : "[4] Publisher’s highest level domain name, for example “foopub.com”.",
        "default" : null
      } ]
    } ],
    "doc" : "[11] See Publisher Object.",
    "default" : null
  }, {
    "name" : "content",
    "type" : [ "null", {
      "type" : "record",
      "name" : "Content",
      "doc" : "3.3.7 Content Object\nThe content 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. This object describes the content in which the impression will appear (may be syndicated or non- syndicated content).\nThis object may be useful in the situation where syndicated content contains impressions and does not necessarily match the publisher’s general content. The exchange might or might not have knowledge of the page where the content is running, as a result of the syndication method. (For example, video impressions embedded in an iframe on an unknown web property or device.)\n\nrequires:\n com.adgear.avro.openrtb.Producer",
      "fields" : [ {
        "name" : "id",
        "type" : [ "null", "string" ],
        "doc" : "[01] ID uniquely identifying the content.",
        "default" : null
      }, {
        "name" : "episode",
        "type" : [ "null", "int" ],
        "doc" : "[02] Content episode number (typically applies to video content).",
        "default" : null
      }, {
        "name" : "title",
        "type" : [ "null", "string" ],
        "doc" : "[03] Content title.\n           Video examples: “Search Committee” (television) or “A New Hope” (movie) or “Endgame” (made for web)\n           Non-video example: “Why an Antarctic Glacier Is Melting So Quickly” (Time magazine article)",
        "default" : null
      }, {
        "name" : "series",
        "type" : [ "null", "string" ],
        "doc" : "[04] Content series.\n           Video examples: “The Office” (television) or “Star Wars” (movie) or “Arby ‘N’ The Chief” (made for web)\n           Non-video example: “Ecocentric” (Time magazine blog)",
        "default" : null
      }, {
        "name" : "season",
        "type" : [ "null", "string" ],
        "doc" : "[05] Content season. E.g., “Season 3” (typically applies to video content).",
        "default" : null
      }, {
        "name" : "url",
        "type" : [ "null", "string" ],
        "doc" : "[06] Original URL of the content, for buy-side contextualization or review.",
        "default" : null
      }, {
        "name" : "cat",
        "type" : [ "null", {
          "type" : "array",
          "items" : "string"
        } ],
        "doc" : "[07] Array of IAB content categories for the content. See Table 6.1 Content Categories.",
        "default" : null
      }, {
        "name" : "videoquality",
        "type" : [ "null", "int" ],
        "doc" : "[08] Video quality per the IAB’s classification. See Table 6.14 Video Quality.",
        "default" : null
      }, {
        "name" : "keywords",
        "type" : [ "null", "string" ],
        "doc" : "[09] Comma separated list of keywords describing the content.",
        "default" : null
      }, {
        "name" : "contentrating",
        "type" : [ "null", "string" ],
        "doc" : "[10] Content rating (e.g., MPAA)",
        "default" : null
      }, {
        "name" : "userrating",
        "type" : [ "null", "string" ],
        "doc" : "[11] User rating of the content (e.g., number of stars, likes, etc.).",
        "default" : null
      }, {
        "name" : "context",
        "type" : [ "null", "string" ],
        "doc" : "[12] Specifies the type of content (game, video, text, etc.). See Table 6.13 Content Context.",
        "default" : null
      }, {
        "name" : "livestream",
        "type" : [ "null", "int" ],
        "doc" : "[13] Is content live? E.g., live video stream, live blog. “1” means content is live. “0” means it is not live.",
        "default" : null
      }, {
        "name" : "sourcerelationship",
        "type" : [ "null", "int" ],
        "doc" : "[14] 1 for “direct”; 0 for “indirect”.",
        "default" : null
      }, {
        "name" : "producer",
        "type" : [ "null", {
          "type" : "record",
          "name" : "Producer",
          "doc" : "3.3.9 Producer Object\nThe producer is useful when content where the ad is shown is syndicated, and may appear on a completely different publisher. The producer 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. This object is optional, but useful if the content producer is different from the site publisher.",
          "fields" : [ {
            "name" : "id",
            "type" : [ "null", "string" ],
            "doc" : "[1] Content producer or originator ID. Useful if content is syndicated, and may be posted on a site using embed tags.",
            "default" : null
          }, {
            "name" : "name",
            "type" : [ "null", "string" ],
            "doc" : "[2] Content producer or originator name (e.g., “Warner Bros”).",
            "default" : null
          }, {
            "name" : "cat",
            "type" : [ "null", {
              "type" : "array",
              "items" : "string"
            } ],
            "doc" : "[3] Array of IAB content categories for the content producer. See Table 6.1 Content Categories.",
            "default" : null
          }, {
            "name" : "domain",
            "type" : [ "null", "string" ],
            "doc" : "[4] URL of the content producer.",
            "default" : null
          } ]
        } ],
        "doc" : "[15] See Producer Object.",
        "default" : null
      }, {
        "name" : "len",
        "type" : [ "null", "int" ],
        "doc" : "[16] Length of content (appropriate for video or audio) in seconds.",
        "default" : null
      }, {
        "name" : "qagmediarating",
        "type" : [ "null", "int" ],
        "doc" : "[17] Media rating of the content, per QAG guidelines. See Table 0 QAG Media Ratings for list of possible values.",
        "default" : null
      }, {
        "name" : "embeddable",
        "type" : [ "null", "int" ],
        "doc" : "[18] From QAG Video Addendum. If content can be embedded (such as an embeddable video player) this value should be set to “1”. If content cannot be embedded, then this should be set to “0”.",
        "default" : null
      }, {
        "name" : "language",
        "type" : [ "null", "string" ],
        "doc" : "[19] Language of the content. Use alpha-2/ISO 639-1 codes.",
        "default" : null
      } ]
    } ],
    "doc" : "[12] See Content Object.",
    "default" : null
  }, {
    "name" : "keywords",
    "type" : [ "null", "string" ],
    "doc" : "[13] List of keywords describing this app in a comma separated string.",
    "default" : null
  }, {
    "name" : "storeurl",
    "type" : [ "null", "string" ],
    "doc" : "[14] For QAG 1.5 compliance, an app store URL for an installed app should be passed in the bid request.",
    "default" : null
  } ]
}