webreferrer.schema.json

{
  "meta:license": [
    "Copyright 2018 Adobe Systems Incorporated. All rights reserved.",
    "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
    "you may not use this file except in compliance with the License. You may obtain a copy",
    "of the License at https://creativecommons.org/licenses/by/4.0/"
  ],
  "$id": "https://ns.adobe.com/xdm/context/webreferrer",
  "$schema": "http://json-schema.org/draft-06/schema#",
  "title": "Web Referrer",
  "type": "object",
  "meta:extensible": true,
  "description": "",
  "definitions": {
    "webreferrer": {
      "properties": {
        "xdm:URL": {
          "title": "URL",
          "type": "string",
          "description": "The referrer URL."
        },
        "xdm:type": {
          "title": "Type",
          "type": "string",
          "description": "The referrer type.",
          "enum": [
            "internal",
            "external",
            "search_engine",
            "typed_bookmarked",
            "email",
            "social",
            "unknown",
            "usenet"
          ],
          "meta:enum": {
            "internal": "Referral originated from the current domain or site.",
            "external":
              "Referral originated from a different domain or site that was not a search or social type.",
            "search_engine":
              "Search engine referrers are identified when visitors use a search engine to access the site.",
            "typed_bookmarked":
              "Typed/bookmarked referrers are identified when visitors type your site’s URL directly into their browser, or if they access the site by selecting bookmarks.",
            "email":
              "A referring domain is considered as an email referring domain type when visitors click an emailed message link containing the protocol imap:// or mail:// and arrive at the site.",
            "social": "The referrer is identified as a social network.",
            "unknown":
              "The referrer is unidentifiable (unknown). `No JavaScript` could be the cause.",
            "news":
              "The URL of a referrer started with news://. As such, the referrer link was posted on a Usenet newsgroup rather than a web page."
          }
        }
      }
    }
  },
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
    },
    {
      "$ref": "#/definitions/webreferrer"
    }
  ],
  "meta:status": "stabilizing"
}